eu.toop.connector.api.rest.TCOutgoingMessage Maven / Gradle / Ivy
package eu.toop.connector.api.rest;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlType;
import com.helger.commons.annotation.CodingStyleguideUnaware;
import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.annotation.ReturnsMutableObject;
import com.helger.commons.equals.EqualsHelper;
import com.helger.commons.hashcode.HashCodeGenerator;
import com.helger.commons.lang.IExplicitlyCloneable;
import com.helger.commons.string.ToStringGenerator;
/**
* Java class for TCOutgoingMessage complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="TCOutgoingMessage">
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <sequence>
* <element name="Metadata" type="{urn:eu.toop/toop-connector-ng/2020/05/}TCOutgoingMetadata"/>
* <element name="Payload" type="{urn:eu.toop/toop-connector-ng/2020/05/}TCPayload" maxOccurs="unbounded"/>
* </sequence>
* </restriction>
* </complexContent>
* </complexType>
*
* This class was annotated by ph-jaxb22-plugin -Xph-annotate
* This class contains methods created by ph-jaxb22-plugin -Xph-equalshashcode
* This class contains methods created by ph-jaxb22-plugin -Xph-tostring
* This class contains methods created by ph-jaxb22-plugin -Xph-list-extension
* This class contains methods created by ph-jaxb22-plugin -Xph-cloneable2
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "TCOutgoingMessage", propOrder = {
"metadata",
"payload"
})
@CodingStyleguideUnaware
public class TCOutgoingMessage implements Serializable, IExplicitlyCloneable
{
@XmlElement(name = "Metadata", required = true)
private TCOutgoingMetadata metadata;
@XmlElement(name = "Payload", required = true)
private List payload;
/**
* Gets the value of the metadata property.
*
* @return
* possible object is
* {@link TCOutgoingMetadata }
*
*/
@Nullable
public TCOutgoingMetadata getMetadata() {
return metadata;
}
/**
* Sets the value of the metadata property.
*
* @param value
* allowed object is
* {@link TCOutgoingMetadata }
*
*/
public void setMetadata(
@Nullable
TCOutgoingMetadata value) {
this.metadata = value;
}
/**
* Gets the value of the payload property.
*
*
* This accessor method returns a reference to the live list,
* not a snapshot. Therefore any modification you make to the
* returned list will be present inside the JAXB object.
* This is why there is not a set method for the payload property.
*
*
* For example, to add a new item, do as follows:
*
* getPayload().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link TCPayload }
*
*
*/
@Nonnull
@ReturnsMutableObject("JAXB implementation style")
public List getPayload() {
if (payload == null) {
payload = new ArrayList();
}
return this.payload;
}
/**
* Created by ph-jaxb22-plugin -Xph-equalshashcode
*
*/
@Override
public boolean equals(final Object o) {
if (o == this) {
return true;
}
if ((o == null)||(!getClass().equals(o.getClass()))) {
return false;
}
final TCOutgoingMessage rhs = ((TCOutgoingMessage) o);
if (!EqualsHelper.equals(metadata, rhs.metadata)) {
return false;
}
if (!EqualsHelper.equalsCollection(payload, rhs.payload)) {
return false;
}
return true;
}
/**
* Created by ph-jaxb22-plugin -Xph-equalshashcode
*
*/
@Override
public int hashCode() {
return new HashCodeGenerator(this).append(metadata).append(payload).getHashCode();
}
/**
* Created by ph-jaxb22-plugin -Xph-tostring
*
*/
@Override
public String toString() {
return new ToStringGenerator(this).append("metadata", metadata).append("payload", payload).getToString();
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @param aList
* The new list member to set. May be null.
*/
public void setPayload(
@Nullable
final List aList) {
payload = aList;
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @return
* true if at least one item is contained, false otherwise.
*/
public boolean hasPayloadEntries() {
return (!getPayload().isEmpty());
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @return
* true if no item is contained, false otherwise.
*/
public boolean hasNoPayloadEntries() {
return getPayload().isEmpty();
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @return
* The number of contained elements. Always ≥ 0.
*/
@Nonnegative
public int getPayloadCount() {
return getPayload().size();
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @param index
* The index to retrieve
* @return
* The element at the specified index. May be null
* @throws IndexOutOfBoundsException
* if the index is invalid!
*/
@Nullable
public TCPayload getPayloadAtIndex(
@Nonnegative
final int index)
throws IndexOutOfBoundsException
{
return getPayload().get(index);
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @param elem
* The element to be added. May not be null.
*/
public void addPayload(
@Nonnull
final TCPayload elem) {
getPayload().add(elem);
}
/**
* This method clones all values from this to the passed object. All data in the parameter object is overwritten!Created by ph-jaxb22-plugin -Xph-cloneable2
*
* @param ret
* The target object to clone to. May not be null.
*/
public void cloneTo(
@Nonnull
TCOutgoingMessage ret) {
ret.metadata = ((metadata == null)?null:metadata.clone());
if (payload == null) {
ret.payload = null;
} else {
List retPayload = new ArrayList();
for (TCPayload aItem: getPayload()) {
retPayload.add(((aItem == null)?null:aItem.clone()));
}
ret.payload = retPayload;
}
}
/**
* Created by ph-jaxb22-plugin -Xph-cloneable2
*
* @return
* The cloned object. Never null.
*/
@Nonnull
@ReturnsMutableCopy
@Override
public TCOutgoingMessage clone() {
TCOutgoingMessage ret = new TCOutgoingMessage();
cloneTo(ret);
return ret;
}
}