com.helger.genericode.v04.CodeListSetDocument 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;
/**
* Document type for the definition of a set of code lists.
*
* Java class for CodeListSetDocument complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="CodeListSetDocument">
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <sequence>
* <group ref="{http://genericode.org/2006/ns/CodeList/0.4/}DocumentHeader"/>
* <element name="CodeListRef" type="{http://genericode.org/2006/ns/CodeList/0.4/}CodeListRef" maxOccurs="unbounded" minOccurs="0"/>
* </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 = "CodeListSetDocument", propOrder = {
"annotation",
"identification",
"codeListRef"
})
@CodingStyleguideUnaware
public class CodeListSetDocument implements Serializable, Cloneable
{
@XmlElement(name = "Annotation")
private Annotation annotation;
@XmlElement(name = "Identification", required = true)
private Identification identification;
@XmlElement(name = "CodeListRef")
private List codeListRef;
/**
* 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 identification property.
*
* @return
* possible object is
* {@link Identification }
*
*/
@Nullable
public Identification getIdentification() {
return identification;
}
/**
* Sets the value of the identification property.
*
* @param value
* allowed object is
* {@link Identification }
*
*/
public void setIdentification(
@Nullable
Identification value) {
this.identification = value;
}
/**
* Gets the value of the codeListRef 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 codeListRef property.
*
*
* For example, to add a new item, do as follows:
*
* getCodeListRef().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link CodeListRef }
*
*
*/
@Nonnull
@ReturnsMutableObject("JAXB implementation style")
public List getCodeListRef() {
if (codeListRef == null) {
codeListRef = new ArrayList();
}
return this.codeListRef;
}
/**
* 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 CodeListSetDocument rhs = ((CodeListSetDocument) o);
if (!EqualsHelper.equals(annotation, rhs.annotation)) {
return false;
}
if (!EqualsHelper.equals(identification, rhs.identification)) {
return false;
}
if (!EqualsHelper.equals(codeListRef, rhs.codeListRef)) {
return false;
}
return true;
}
/**
* Created by ph-jaxb22-plugin -Xph-equalshashcode
*
*/
@Override
public int hashCode() {
return new HashCodeGenerator(this).append(annotation).append(identification).append(codeListRef).getHashCode();
}
/**
* Created by ph-jaxb22-plugin -Xph-tostring
*
*/
@Override
public String toString() {
return new ToStringGenerator(this).append("annotation", annotation).append("identification", identification).append("codeListRef", codeListRef).toString();
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @param aList
* The new list member to set. May be null
.
*/
public void setCodeListRef(
@Nullable
final List aList) {
codeListRef = aList;
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @return
* true
if at least one item is contained, false
otherwise.
*/
public boolean hasCodeListRefEntries() {
return (!getCodeListRef().isEmpty());
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @return
* true
if no item is contained, false
otherwise.
*/
public boolean hasNoCodeListRefEntries() {
return getCodeListRef().isEmpty();
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @return
* The number of contained elements. Always ≥ 0.
*/
@Nonnegative
public int getCodeListRefCount() {
return getCodeListRef().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 ArrayIndexOutOfBoundsException
* if the index is invalid!
*/
@Nullable
public CodeListRef getCodeListRefAtIndex(
@Nonnegative
final int index) {
return getCodeListRef().get(index);
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @param elem
* The element to be added. May not be null
.
*/
public void addCodeListRef(
@Nonnull
final CodeListRef elem) {
getCodeListRef().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
CodeListSetDocument ret) {
ret.annotation = ((annotation == null)?null:annotation.clone());
List retCodeListRef = new ArrayList();
for (CodeListRef aItem: getCodeListRef()) {
retCodeListRef.add(((aItem == null)?null:aItem.clone()));
}
ret.codeListRef = retCodeListRef;
ret.identification = ((identification == null)?null:identification.clone());
}
/**
* Created by ph-jaxb22-plugin -Xph-cloneable
*
* @return
* The cloned object. Never null
.
*/
@Nonnull
@ReturnsMutableCopy
@Override
public CodeListSetDocument clone() {
CodeListSetDocument ret = new CodeListSetDocument();
cloneTo(ret);
return ret;
}
}