com.helger.genericode.v04.Identification 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.XmlSchemaType;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.adapters.CollapsedStringAdapter;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
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;
/**
* Identification and location information for a resource.
*
* Java class for Identification complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="Identification">
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <sequence>
* <group ref="{http://genericode.org/2006/ns/CodeList/0.4/}NameSet"/>
* <element name="Version" type="{http://www.w3.org/2001/XMLSchema}token"/>
* <element name="CanonicalUri" type="{http://www.w3.org/2001/XMLSchema}anyURI"/>
* <group ref="{http://genericode.org/2006/ns/CodeList/0.4/}IdentificationUriSet"/>
* <element name="Agency" type="{http://genericode.org/2006/ns/CodeList/0.4/}Agency" 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 = "Identification", propOrder = {
"shortName",
"longName",
"version",
"canonicalUri",
"canonicalVersionUri",
"locationUri",
"alternateFormatLocationUri",
"agency"
})
@CodingStyleguideUnaware
public class Identification implements Serializable, Cloneable
{
@XmlElement(name = "ShortName", required = true)
private ShortName shortName;
@XmlElement(name = "LongName")
private List longName;
@XmlElement(name = "Version", required = true)
@XmlJavaTypeAdapter(CollapsedStringAdapter.class)
@XmlSchemaType(name = "token")
private String version;
@XmlElement(name = "CanonicalUri", required = true)
@XmlSchemaType(name = "anyURI")
private String canonicalUri;
@XmlElement(name = "CanonicalVersionUri", required = true)
@XmlSchemaType(name = "anyURI")
private String canonicalVersionUri;
@XmlElement(name = "LocationUri")
@XmlSchemaType(name = "anyURI")
private List locationUri;
@XmlElement(name = "AlternateFormatLocationUri")
private List alternateFormatLocationUri;
@XmlElement(name = "Agency")
private Agency agency;
/**
* 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 version property.
*
* @return
* possible object is
* {@link String }
*
*/
@Nullable
public String getVersion() {
return version;
}
/**
* Sets the value of the version property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setVersion(
@Nullable
String value) {
this.version = value;
}
/**
* Gets the value of the canonicalUri property.
*
* @return
* possible object is
* {@link String }
*
*/
@Nullable
public String getCanonicalUri() {
return canonicalUri;
}
/**
* Sets the value of the canonicalUri property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setCanonicalUri(
@Nullable
String value) {
this.canonicalUri = value;
}
/**
* Gets the value of the canonicalVersionUri property.
*
* @return
* possible object is
* {@link String }
*
*/
@Nullable
public String getCanonicalVersionUri() {
return canonicalVersionUri;
}
/**
* Sets the value of the canonicalVersionUri property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setCanonicalVersionUri(
@Nullable
String value) {
this.canonicalVersionUri = value;
}
/**
* Gets the value of the locationUri 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 locationUri property.
*
*
* For example, to add a new item, do as follows:
*
* getLocationUri().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link String }
*
*
*/
@Nonnull
@ReturnsMutableObject("JAXB implementation style")
public List getLocationUri() {
if (locationUri == null) {
locationUri = new ArrayList();
}
return this.locationUri;
}
/**
* Gets the value of the alternateFormatLocationUri 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 alternateFormatLocationUri property.
*
*
* For example, to add a new item, do as follows:
*
* getAlternateFormatLocationUri().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link MimeTypedUri }
*
*
*/
@Nonnull
@ReturnsMutableObject("JAXB implementation style")
public List getAlternateFormatLocationUri() {
if (alternateFormatLocationUri == null) {
alternateFormatLocationUri = new ArrayList();
}
return this.alternateFormatLocationUri;
}
/**
* Gets the value of the agency property.
*
* @return
* possible object is
* {@link Agency }
*
*/
@Nullable
public Agency getAgency() {
return agency;
}
/**
* Sets the value of the agency property.
*
* @param value
* allowed object is
* {@link Agency }
*
*/
public void setAgency(
@Nullable
Agency value) {
this.agency = value;
}
/**
* 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 Identification rhs = ((Identification) o);
if (!EqualsHelper.equals(shortName, rhs.shortName)) {
return false;
}
if (!EqualsHelper.equals(longName, rhs.longName)) {
return false;
}
if (!EqualsHelper.equals(version, rhs.version)) {
return false;
}
if (!EqualsHelper.equals(canonicalUri, rhs.canonicalUri)) {
return false;
}
if (!EqualsHelper.equals(canonicalVersionUri, rhs.canonicalVersionUri)) {
return false;
}
if (!EqualsHelper.equals(locationUri, rhs.locationUri)) {
return false;
}
if (!EqualsHelper.equals(alternateFormatLocationUri, rhs.alternateFormatLocationUri)) {
return false;
}
if (!EqualsHelper.equals(agency, rhs.agency)) {
return false;
}
return true;
}
/**
* Created by ph-jaxb22-plugin -Xph-equalshashcode
*
*/
@Override
public int hashCode() {
return new HashCodeGenerator(this).append(shortName).append(longName).append(version).append(canonicalUri).append(canonicalVersionUri).append(locationUri).append(alternateFormatLocationUri).append(agency).getHashCode();
}
/**
* Created by ph-jaxb22-plugin -Xph-tostring
*
*/
@Override
public String toString() {
return new ToStringGenerator(this).append("shortName", shortName).append("longName", longName).append("version", version).append("canonicalUri", canonicalUri).append("canonicalVersionUri", canonicalVersionUri).append("locationUri", locationUri).append("alternateFormatLocationUri", alternateFormatLocationUri).append("agency", agency).toString();
}
/**
* 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 setLocationUri(
@Nullable
final List aList) {
locationUri = aList;
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @param aList
* The new list member to set. May be null.
*/
public void setAlternateFormatLocationUri(
@Nullable
final List aList) {
alternateFormatLocationUri = 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 ArrayIndexOutOfBoundsException
* if the index is invalid!
*/
@Nullable
public LongName getLongNameAtIndex(
@Nonnegative
final int index) {
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 hasLocationUriEntries() {
return (!getLocationUri().isEmpty());
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @return
* true if no item is contained, false otherwise.
*/
public boolean hasNoLocationUriEntries() {
return getLocationUri().isEmpty();
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @return
* The number of contained elements. Always ≥ 0.
*/
@Nonnegative
public int getLocationUriCount() {
return getLocationUri().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 String getLocationUriAtIndex(
@Nonnegative
final int index) {
return getLocationUri().get(index);
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @param elem
* The element to be added. May not be null.
*/
public void addLocationUri(
@Nonnull
final String elem) {
getLocationUri().add(elem);
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @return
* true if at least one item is contained, false otherwise.
*/
public boolean hasAlternateFormatLocationUriEntries() {
return (!getAlternateFormatLocationUri().isEmpty());
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @return
* true if no item is contained, false otherwise.
*/
public boolean hasNoAlternateFormatLocationUriEntries() {
return getAlternateFormatLocationUri().isEmpty();
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @return
* The number of contained elements. Always ≥ 0.
*/
@Nonnegative
public int getAlternateFormatLocationUriCount() {
return getAlternateFormatLocationUri().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 MimeTypedUri getAlternateFormatLocationUriAtIndex(
@Nonnegative
final int index) {
return getAlternateFormatLocationUri().get(index);
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @param elem
* The element to be added. May not be null.
*/
public void addAlternateFormatLocationUri(
@Nonnull
final MimeTypedUri elem) {
getAlternateFormatLocationUri().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
Identification ret) {
ret.agency = ((agency == null)?null:agency.clone());
List retAlternateFormatLocationUri = new ArrayList();
for (MimeTypedUri aItem: getAlternateFormatLocationUri()) {
retAlternateFormatLocationUri.add(((aItem == null)?null:aItem.clone()));
}
ret.alternateFormatLocationUri = retAlternateFormatLocationUri;
ret.canonicalUri = canonicalUri;
ret.canonicalVersionUri = canonicalVersionUri;
List retLocationUri = new ArrayList();
for (String aItem: getLocationUri()) {
retLocationUri.add(aItem);
}
ret.locationUri = retLocationUri;
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());
ret.version = version;
}
/**
* Created by ph-jaxb22-plugin -Xph-cloneable
*
* @return
* The cloned object. Never null.
*/
@Nonnull
@ReturnsMutableCopy
@Override
public Identification clone() {
Identification ret = new Identification();
cloneTo(ret);
return ret;
}
}