com.helger.genericode.v04.CodeListUnion Maven / Gradle / Ivy
Show all versions of ph-genericode Show documentation
package com.helger.genericode.v04;
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.string.ToStringGenerator;
/**
* Union of one or more code lists.
*
* Java class for CodeListUnion complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="CodeListUnion">
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <sequence>
* <element name="Annotation" type="{http://genericode.org/2006/ns/CodeList/0.4/}Annotation" minOccurs="0"/>
* <element name="Source" type="{http://genericode.org/2006/ns/CodeList/0.4/}InputCodeList" 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-cloneable
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "CodeListUnion", propOrder = {
"annotation",
"source"
})
@CodingStyleguideUnaware
public class CodeListUnion implements Serializable, Cloneable
{
@XmlElement(name = "Annotation")
private Annotation annotation;
@XmlElement(name = "Source", required = true)
private List source;
/**
* Gets the value of the annotation property.
*
* @return
* possible object is
* {@link Annotation }
*
*/
@Nullable
public Annotation getAnnotation() {
return annotation;
}
/**
* Sets the value of the annotation property.
*
* @param value
* allowed object is
* {@link Annotation }
*
*/
public void setAnnotation(
@Nullable
Annotation value) {
this.annotation = value;
}
/**
* Gets the value of the source 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 source property.
*
*
* For example, to add a new item, do as follows:
*
* getSource().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link InputCodeList }
*
*
*/
@Nonnull
@ReturnsMutableObject("JAXB implementation style")
public List getSource() {
if (source == null) {
source = new ArrayList();
}
return this.source;
}
/**
* 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 CodeListUnion rhs = ((CodeListUnion) o);
if (!EqualsHelper.equals(annotation, rhs.annotation)) {
return false;
}
if (!EqualsHelper.equals(source, rhs.source)) {
return false;
}
return true;
}
/**
* Created by ph-jaxb22-plugin -Xph-equalshashcode
*
*/
@Override
public int hashCode() {
return new HashCodeGenerator(this).append(annotation).append(source).getHashCode();
}
/**
* Created by ph-jaxb22-plugin -Xph-tostring
*
*/
@Override
public String toString() {
return new ToStringGenerator(this).append("annotation", annotation).append("source", source).getToString();
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @param aList
* The new list member to set. May be null.
*/
public void setSource(
@Nullable
final List aList) {
source = aList;
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @return
* true if at least one item is contained, false otherwise.
*/
public boolean hasSourceEntries() {
return (!getSource().isEmpty());
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @return
* true if no item is contained, false otherwise.
*/
public boolean hasNoSourceEntries() {
return getSource().isEmpty();
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @return
* The number of contained elements. Always ≥ 0.
*/
@Nonnegative
public int getSourceCount() {
return getSource().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 InputCodeList getSourceAtIndex(
@Nonnegative
final int index)
throws IndexOutOfBoundsException
{
return getSource().get(index);
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @param elem
* The element to be added. May not be null.
*/
public void addSource(
@Nonnull
final InputCodeList elem) {
getSource().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-cloneable
*
* @param ret
* The target object to clone to. May not be null.
*/
public void cloneTo(
@Nonnull
CodeListUnion ret) {
ret.annotation = ((annotation == null)?null:annotation.clone());
List retSource = new ArrayList();
for (InputCodeList aItem: getSource()) {
retSource.add(((aItem == null)?null:aItem.clone()));
}
ret.source = retSource;
}
/**
* Created by ph-jaxb22-plugin -Xph-cloneable
*
* @return
* The cloned object. Never null.
*/
@Nonnull
@ReturnsMutableCopy
@Override
public CodeListUnion clone() {
CodeListUnion ret = new CodeListUnion();
cloneTo(ret);
return ret;
}
}