com.helger.genericode.v04.Agency 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;
/**
* Details of an agency which produces code lists or related artefacts.
*
* Java class for Agency complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="Agency">
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <sequence>
* <element name="ShortName" type="{http://genericode.org/2006/ns/CodeList/0.4/}ShortName" minOccurs="0"/>
* <element name="LongName" type="{http://genericode.org/2006/ns/CodeList/0.4/}LongName" maxOccurs="unbounded" minOccurs="0"/>
* <element name="Identifier" type="{http://genericode.org/2006/ns/CodeList/0.4/}GeneralIdentifier" 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 = "Agency", propOrder = {
"shortName",
"longName",
"identifier"
})
@CodingStyleguideUnaware
public class Agency implements Serializable, Cloneable
{
@XmlElement(name = "ShortName")
private ShortName shortName;
@XmlElement(name = "LongName")
private List longName;
@XmlElement(name = "Identifier")
private List identifier;
/**
* Gets the value of the shortName property.
*
* @return
* possible object is
* {@link ShortName }
*
*/
@Nullable
public ShortName getShortName() {
return shortName;
}
/**
* Sets the value of the shortName property.
*
* @param value
* allowed object is
* {@link ShortName }
*
*/
public void setShortName(
@Nullable
ShortName value) {
this.shortName = value;
}
/**
* Gets the value of the longName 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 longName property.
*
*
* For example, to add a new item, do as follows:
*
* getLongName().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link LongName }
*
*
*/
@Nonnull
@ReturnsMutableObject("JAXB implementation style")
public List getLongName() {
if (longName == null) {
longName = new ArrayList();
}
return this.longName;
}
/**
* Gets the value of the identifier 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 identifier property.
*
*
* For example, to add a new item, do as follows:
*
* getIdentifier().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link GeneralIdentifier }
*
*
*/
@Nonnull
@ReturnsMutableObject("JAXB implementation style")
public List getIdentifier() {
if (identifier == null) {
identifier = new ArrayList();
}
return this.identifier;
}
/**
* 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 Agency rhs = ((Agency) o);
if (!EqualsHelper.equals(shortName, rhs.shortName)) {
return false;
}
if (!EqualsHelper.equals(longName, rhs.longName)) {
return false;
}
if (!EqualsHelper.equals(identifier, rhs.identifier)) {
return false;
}
return true;
}
/**
* Created by ph-jaxb22-plugin -Xph-equalshashcode
*
*/
@Override
public int hashCode() {
return new HashCodeGenerator(this).append(shortName).append(longName).append(identifier).getHashCode();
}
/**
* Created by ph-jaxb22-plugin -Xph-tostring
*
*/
@Override
public String toString() {
return new ToStringGenerator(this).append("shortName", shortName).append("longName", longName).append("identifier", identifier).getToString();
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @param aList
* The new list member to set. May be null.
*/
public void setLongName(
@Nullable
final List aList) {
longName = aList;
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @param aList
* The new list member to set. May be null.
*/
public void setIdentifier(
@Nullable
final List aList) {
identifier = aList;
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @return
* true if at least one item is contained, false otherwise.
*/
public boolean hasLongNameEntries() {
return (!getLongName().isEmpty());
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @return
* true if no item is contained, false otherwise.
*/
public boolean hasNoLongNameEntries() {
return getLongName().isEmpty();
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @return
* The number of contained elements. Always ≥ 0.
*/
@Nonnegative
public int getLongNameCount() {
return getLongName().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 LongName getLongNameAtIndex(
@Nonnegative
final int index)
throws IndexOutOfBoundsException
{
return getLongName().get(index);
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @param elem
* The element to be added. May not be null.
*/
public void addLongName(
@Nonnull
final LongName elem) {
getLongName().add(elem);
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @return
* true if at least one item is contained, false otherwise.
*/
public boolean hasIdentifierEntries() {
return (!getIdentifier().isEmpty());
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @return
* true if no item is contained, false otherwise.
*/
public boolean hasNoIdentifierEntries() {
return getIdentifier().isEmpty();
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @return
* The number of contained elements. Always ≥ 0.
*/
@Nonnegative
public int getIdentifierCount() {
return getIdentifier().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 GeneralIdentifier getIdentifierAtIndex(
@Nonnegative
final int index)
throws IndexOutOfBoundsException
{
return getIdentifier().get(index);
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @param elem
* The element to be added. May not be null.
*/
public void addIdentifier(
@Nonnull
final GeneralIdentifier elem) {
getIdentifier().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
Agency ret) {
List retIdentifier = new ArrayList();
for (GeneralIdentifier aItem: getIdentifier()) {
retIdentifier.add(((aItem == null)?null:aItem.clone()));
}
ret.identifier = retIdentifier;
List retLongName = new ArrayList();
for (LongName aItem: getLongName()) {
retLongName.add(((aItem == null)?null:aItem.clone()));
}
ret.longName = retLongName;
ret.shortName = ((shortName == null)?null:shortName.clone());
}
/**
* Created by ph-jaxb22-plugin -Xph-cloneable
*
* @return
* The cloned object. Never null.
*/
@Nonnull
@ReturnsMutableCopy
@Override
public Agency clone() {
Agency ret = new Agency();
cloneTo(ret);
return ret;
}
}