org.ccsds.moims.mo.mal.structures.Subscription Maven / Gradle / Ivy
package org.ccsds.moims.mo.mal.structures;
/**
* The Subscription structure shall be used when subscribing for updates using the PUBSUB
* Interaction Pattern. It shall contain a single identifier that identifies the subscription
* being defined and a set of entities being requested.
*/
public final class Subscription implements org.ccsds.moims.mo.mal.structures.Composite {
/**
* Short form for type.
*/
public static final Integer TYPE_SHORT_FORM = 1001;
/**
* Absolute short form for type.
*/
public static final Long SHORT_FORM = 281475027043305L;
private static final long serialVersionUID = 281475027043305L;
/**
* The identifier of this subscription.
*/
private org.ccsds.moims.mo.mal.structures.Identifier subscriptionId;
/**
* Optional domain identifier. If NULL, the subscription shall match with any domain.
*/
private org.ccsds.moims.mo.mal.structures.IdentifierList domain;
/**
* The list of names of the selected Subscription Keys to be transmitted to the consumer.
* The Subscription Keys that are not in this list will be removed. If NULL, then all
* Subscription Keys will be transmitted.
*/
private org.ccsds.moims.mo.mal.structures.IdentifierList selectedKeys;
/**
* The list of filters for this subscription. The list of filters must be ANDed together.
* If NULL, the subscription will not filter specific keys.
*/
private org.ccsds.moims.mo.mal.structures.SubscriptionFilterList filters;
/**
* Default constructor for Subscription.
*
*/
public Subscription() {
}
/**
* Constructor that initialises the values of the structure.
*
* @param subscriptionId The identifier of this subscription.
* @param domain Optional domain identifier. If NULL, the subscription shall match with
* any domain.
* @param selectedKeys The list of names of the selected Subscription Keys to be transmitted
* to the consumer. The Subscription Keys that are not in this list will be removed.
* If NULL, then all Subscription Keys will be transmitted.
* @param filters The list of filters for this subscription. The list of filters must
* be ANDed together. If NULL, the subscription will not filter specific keys.
*/
public Subscription(org.ccsds.moims.mo.mal.structures.Identifier subscriptionId,
org.ccsds.moims.mo.mal.structures.IdentifierList domain,
org.ccsds.moims.mo.mal.structures.IdentifierList selectedKeys,
org.ccsds.moims.mo.mal.structures.SubscriptionFilterList filters) {
this.subscriptionId = subscriptionId;
this.domain = domain;
this.selectedKeys = selectedKeys;
this.filters = filters;
}
/**
* Constructor that initialises the non-nullable values of the structure.
*
* @param subscriptionId The identifier of this subscription.
*/
public Subscription(org.ccsds.moims.mo.mal.structures.Identifier subscriptionId) {
this.subscriptionId = subscriptionId;
this.domain = null;
this.selectedKeys = null;
this.filters = null;
}
/**
* Creates an instance of this type using the default constructor. It is a generic factory
* method.
*
* @return A new instance of this type with default field values.
*/
public org.ccsds.moims.mo.mal.structures.Element createElement() {
return new org.ccsds.moims.mo.mal.structures.Subscription();
}
/**
* Returns the field subscriptionId.
*
* @return The field subscriptionId.
*/
public org.ccsds.moims.mo.mal.structures.Identifier getSubscriptionId() {
return subscriptionId;
}
/**
* Sets the field subscriptionId.
*
* @param __newValue The new value.
*/
@Deprecated
public void setSubscriptionId(org.ccsds.moims.mo.mal.structures.Identifier __newValue) {
subscriptionId = __newValue;
}
/**
* Returns the field domain.
*
* @return The field domain.
*/
public org.ccsds.moims.mo.mal.structures.IdentifierList getDomain() {
return domain;
}
/**
* Sets the field domain.
*
* @param __newValue The new value.
*/
@Deprecated
public void setDomain(org.ccsds.moims.mo.mal.structures.IdentifierList __newValue) {
domain = __newValue;
}
/**
* Returns the field selectedKeys.
*
* @return The field selectedKeys.
*/
public org.ccsds.moims.mo.mal.structures.IdentifierList getSelectedKeys() {
return selectedKeys;
}
/**
* Sets the field selectedKeys.
*
* @param __newValue The new value.
*/
@Deprecated
public void setSelectedKeys(org.ccsds.moims.mo.mal.structures.IdentifierList __newValue) {
selectedKeys = __newValue;
}
/**
* Returns the field filters.
*
* @return The field filters.
*/
public org.ccsds.moims.mo.mal.structures.SubscriptionFilterList getFilters() {
return filters;
}
/**
* Sets the field filters.
*
* @param __newValue The new value.
*/
@Deprecated
public void setFilters(org.ccsds.moims.mo.mal.structures.SubscriptionFilterList __newValue) {
filters = __newValue;
}
/**
* Compares this object to the specified object. The result is true if and only if the
* argument is not null and is the same type that contains the same value as this object.
*
* @param obj The object to compare with.
* @return true if the objects are the same; false otherwise.
*/
public boolean equals(Object obj) {
if (obj instanceof Subscription) {
Subscription other = (Subscription) obj;
if (subscriptionId == null) {
if (other.subscriptionId != null) {
return false;
}
} else {
if (! subscriptionId.equals(other.subscriptionId)) {
return false;
}
}
if (domain == null) {
if (other.domain != null) {
return false;
}
} else {
if (! domain.equals(other.domain)) {
return false;
}
}
if (selectedKeys == null) {
if (other.selectedKeys != null) {
return false;
}
} else {
if (! selectedKeys.equals(other.selectedKeys)) {
return false;
}
}
if (filters == null) {
if (other.filters != null) {
return false;
}
} else {
if (! filters.equals(other.filters)) {
return false;
}
}
return true;
}
return false;
}
/**
* Returns a hash code for this object.
*
* @return a hash code value for this object.
*/
public int hashCode() {
int hash = 7;
hash = 83 * hash + (subscriptionId != null ? subscriptionId.hashCode() : 0);
hash = 83 * hash + (domain != null ? domain.hashCode() : 0);
hash = 83 * hash + (selectedKeys != null ? selectedKeys.hashCode() : 0);
hash = 83 * hash + (filters != null ? filters.hashCode() : 0);
return hash;
}
/**
* Returns a String object representing this type's value.
*
* @return a string representation of the value of this object.
*/
public String toString() {
StringBuilder buf = new StringBuilder();
buf.append("(Subscription: ");
buf.append("subscriptionId=");
buf.append(subscriptionId);
buf.append(", domain=");
buf.append(domain);
buf.append(", selectedKeys=");
buf.append(selectedKeys);
buf.append(", filters=");
buf.append(filters);
buf.append(')');
return buf.toString();
}
/**
* Encodes the value of this object using the provided MALEncoder.
*
* @param encoder The encoder to use for encoding.
* @throws org.ccsds.moims.mo.mal.MALException if any encoding errors are detected.
*/
public void encode(org.ccsds.moims.mo.mal.MALEncoder encoder) throws org.ccsds.moims.mo.mal.MALException {
if (subscriptionId == null) {
throw new org.ccsds.moims.mo.mal.MALException("The field 'subscriptionId' cannot be null!");
}
encoder.encodeIdentifier(subscriptionId);
encoder.encodeNullableElement(domain);
encoder.encodeNullableElement(selectedKeys);
encoder.encodeNullableElement(filters);
}
/**
* Decodes the value of this object using the provided MALDecoder.
*
* @param decoder The decoder to use for decoding.
* @return Returns this object.
* @throws org.ccsds.moims.mo.mal.MALException if any decoding errors are detected.
*/
public org.ccsds.moims.mo.mal.structures.Element decode(org.ccsds.moims.mo.mal.MALDecoder decoder) throws org.ccsds.moims.mo.mal.MALException {
subscriptionId = decoder.decodeIdentifier();
domain = (org.ccsds.moims.mo.mal.structures.IdentifierList) decoder.decodeNullableElement(new org.ccsds.moims.mo.mal.structures.IdentifierList());
selectedKeys = (org.ccsds.moims.mo.mal.structures.IdentifierList) decoder.decodeNullableElement(new org.ccsds.moims.mo.mal.structures.IdentifierList());
filters = (org.ccsds.moims.mo.mal.structures.SubscriptionFilterList) decoder.decodeNullableElement(new org.ccsds.moims.mo.mal.structures.SubscriptionFilterList());
return this;
}
/**
* Returns the absolute short form of this type.
*
* @return The absolute short form of this type.
*/
public Long getShortForm() {
return SHORT_FORM;
}
/**
* Returns the type short form of this type which is unique to the area/service it is
* defined in but not unique across all types.
*
* @return The type short form of this type.
*/
public Integer getTypeShortForm() {
return TYPE_SHORT_FORM;
}
/**
* Returns the area number of this type.
*
* @return The area number of this type.
*/
public org.ccsds.moims.mo.mal.structures.UShort getAreaNumber() {
return org.ccsds.moims.mo.mal.MALHelper.MAL_AREA_NUMBER;
}
/**
* Returns the area version of this type.
*
* @return The area number of this type.
*/
public org.ccsds.moims.mo.mal.structures.UOctet getAreaVersion() {
return org.ccsds.moims.mo.mal.MALHelper.MAL_AREA_VERSION;
}
/**
* Returns the service number of this type.
*
* @return The service number of this type.
*/
public org.ccsds.moims.mo.mal.structures.UShort getServiceNumber() {
return new org.ccsds.moims.mo.mal.structures.UShort(0);
}
}