com.helger.genericode.v10.CodeListRef Maven / Gradle / Ivy
Show all versions of ph-genericode Show documentation
package com.helger.genericode.v10;
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.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlSchemaType;
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;
/**
*
*
* <?xml version="1.0" encoding="UTF-8"?><rule:text xmlns:rule="http://docs.oasis-open.org/codelist/ns/rule/1.0/" xmlns:gc="http://docs.oasis-open.org/codelist/ns/genericode/1.0/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" category="application" id="R3">The code list reference must be valid.
* An application may use the CanonicalVersionUri to select a local copy of the code list.
* If there is no CanonicalVersionUri, the CanonicalUri may be used to select a local copy of the code list.
* Otherwise the LocationUri value(s) may be tried in order, until a valid code list document is retrieved.
* An application must signal an error to the user if it is not able to retrieve a code list document to match the code list reference.</rule:text>
*
*
*
* Java class for CodeListRef complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="CodeListRef">
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <sequence>
* <element name="Annotation" type="{http://docs.oasis-open.org/codelist/ns/genericode/1.0/}Annotation" minOccurs="0"/>
* <element name="CanonicalUri" type="{http://www.w3.org/2001/XMLSchema}anyURI"/>
* <element name="CanonicalVersionUri" type="{http://www.w3.org/2001/XMLSchema}anyURI" minOccurs="0"/>
* <element name="LocationUri" type="{http://www.w3.org/2001/XMLSchema}anyURI" maxOccurs="unbounded" minOccurs="0"/>
* </sequence>
* <attribute ref="{http://www.w3.org/XML/1998/namespace}base"/>
* </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 = "CodeListRef", propOrder = {
"annotation",
"canonicalUri",
"canonicalVersionUri",
"locationUri"
})
@CodingStyleguideUnaware
public class CodeListRef implements Serializable, Cloneable
{
@XmlElement(name = "Annotation")
private Annotation annotation;
@XmlElement(name = "CanonicalUri", required = true)
@XmlSchemaType(name = "anyURI")
private String canonicalUri;
@XmlElement(name = "CanonicalVersionUri")
@XmlSchemaType(name = "anyURI")
private String canonicalVersionUri;
@XmlElement(name = "LocationUri")
@XmlSchemaType(name = "anyURI")
private List locationUri;
@XmlAttribute(name = "base", namespace = "http://www.w3.org/XML/1998/namespace")
@XmlSchemaType(name = "anyURI")
private String base;
/**
* 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 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;
}
/**
*
*
* <?xml version="1.0" encoding="UTF-8"?><rule:text xmlns:rule="http://docs.oasis-open.org/codelist/ns/rule/1.0/" xmlns:gc="http://docs.oasis-open.org/codelist/ns/genericode/1.0/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" category="application" id="R10">xml:base does not apply to canonical URIs.</rule:text>
*
*
*
* @return
* possible object is
* {@link String }
*
*/
@Nullable
public String getBase() {
return base;
}
/**
* Sets the value of the base property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setBase(
@Nullable
String value) {
this.base = 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 CodeListRef rhs = ((CodeListRef) o);
if (!EqualsHelper.equals(annotation, rhs.annotation)) {
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(base, rhs.base)) {
return false;
}
return true;
}
/**
* Created by ph-jaxb22-plugin -Xph-equalshashcode
*
*/
@Override
public int hashCode() {
return new HashCodeGenerator(this).append(annotation).append(canonicalUri).append(canonicalVersionUri).append(locationUri).append(base).getHashCode();
}
/**
* Created by ph-jaxb22-plugin -Xph-tostring
*
*/
@Override
public String toString() {
return new ToStringGenerator(this).append("annotation", annotation).append("canonicalUri", canonicalUri).append("canonicalVersionUri", canonicalVersionUri).append("locationUri", locationUri).append("base", base).getToString();
}
/**
* 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
*
* @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 IndexOutOfBoundsException
* if the index is invalid!
*/
@Nullable
public String getLocationUriAtIndex(
@Nonnegative
final int index)
throws IndexOutOfBoundsException
{
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);
}
/**
* 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
CodeListRef ret) {
ret.annotation = ((annotation == null)?null:annotation.clone());
ret.base = base;
ret.canonicalUri = canonicalUri;
ret.canonicalVersionUri = canonicalVersionUri;
List retLocationUri = new ArrayList();
for (String aItem: getLocationUri()) {
retLocationUri.add(aItem);
}
ret.locationUri = retLocationUri;
}
/**
* Created by ph-jaxb22-plugin -Xph-cloneable
*
* @return
* The cloned object. Never null.
*/
@Nonnull
@ReturnsMutableCopy
@Override
public CodeListRef clone() {
CodeListRef ret = new CodeListRef();
cloneTo(ret);
return ret;
}
}