All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.helger.genericode.v10.CodeListSetDocument Maven / Gradle / Ivy

Go to download

Library to read and write OASIS GeneriCode and CVA documents

There is a newer version: 7.1.3
Show newest version

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.XmlElements;
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;


/**
 * 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://docs.oasis-open.org/codelist/ns/genericode/1.0/}DocumentHeader"/>
 *         <group ref="{http://docs.oasis-open.org/codelist/ns/genericode/1.0/}CodeListSetChoice" 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 = "CodeListSetDocument", propOrder = {
    "annotation",
    "identification",
    "codeListSetChoice"
})
@CodingStyleguideUnaware
public class CodeListSetDocument implements Serializable, Cloneable
{

    @XmlElement(name = "Annotation")
    private Annotation annotation;
    @XmlElement(name = "Identification", required = true)
    private Identification identification;
    @XmlElements({
        @XmlElement(name = "CodeListRef", type = CodeListRef.class),
        @XmlElement(name = "CodeListSet", type = CodeListSetDocument.class),
        @XmlElement(name = "CodeListSetRef", type = CodeListSetRef.class)
    })
    private List codeListSetChoice;
    @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 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;
    }

    /**
     * Contents of the code list set.  If the code list set does not have any contents, it is a CodeListSet Metadata definition.Gets the value of the codeListSetChoice 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 codeListSetChoice property.
     * 
     * 

     * For example, to add a new item, do as follows:
     * 
     *    getCodeListSetChoice().add(newItem);
     * 

     * 
     * 
     * 

     * Objects of the following type(s) are allowed in the list
     * {@link CodeListRef }
     * {@link CodeListSetDocument }
     * {@link CodeListSetRef }
     * 
     * 
     */
    @Nonnull
    @ReturnsMutableObject("JAXB implementation style")
    public List getCodeListSetChoice() {
        if (codeListSetChoice == null) {
            codeListSetChoice = new ArrayList();
        }
        return this.codeListSetChoice;
    }

    /**
     * 
     * 
     * <?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="R11">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 CodeListSetDocument rhs = ((CodeListSetDocument) o);
        if (!EqualsHelper.equals(annotation, rhs.annotation)) {
            return false;
        }
        if (!EqualsHelper.equals(identification, rhs.identification)) {
            return false;
        }
        if (!EqualsHelper.equals(codeListSetChoice, rhs.codeListSetChoice)) {
            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(identification).append(codeListSetChoice).append(base).getHashCode();
    }

    /**
     * Created by ph-jaxb22-plugin -Xph-tostring
     * 
     */
    @Override
    public String toString() {
        return new ToStringGenerator(this).append("annotation", annotation).append("identification", identification).append("codeListSetChoice", codeListSetChoice).append("base", base).toString();
    }

    /**
     * Created by ph-jaxb22-plugin -Xph-list-extension
     * 
     * @param aList
     *     The new list member to set. May be null.
     */
    public void setCodeListSetChoice(
        @Nullable
        final List aList) {
        codeListSetChoice = aList;
    }

    /**
     * Created by ph-jaxb22-plugin -Xph-list-extension
     * 
     * @return
     *     true if at least one item is contained, false otherwise.
     */
    public boolean hasCodeListSetChoiceEntries() {
        return (!getCodeListSetChoice().isEmpty());
    }

    /**
     * Created by ph-jaxb22-plugin -Xph-list-extension
     * 
     * @return
     *     true if no item is contained, false otherwise.
     */
    public boolean hasNoCodeListSetChoiceEntries() {
        return getCodeListSetChoice().isEmpty();
    }

    /**
     * Created by ph-jaxb22-plugin -Xph-list-extension
     * 
     * @return
     *     The number of contained elements. Always ≥ 0.
     */
    @Nonnegative
    public int getCodeListSetChoiceCount() {
        return getCodeListSetChoice().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 Object getCodeListSetChoiceAtIndex(
        @Nonnegative
        final int index) {
        return getCodeListSetChoice().get(index);
    }

    /**
     * Created by ph-jaxb22-plugin -Xph-list-extension
     * 
     * @param elem
     *     The element to be added. May not be null.
     */
    public void addCodeListSetChoice(
        @Nonnull
        final Object elem) {
        getCodeListSetChoice().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());
        ret.base = base;
        List retCodeListSetChoice = new ArrayList();
        for (Object aItem: getCodeListSetChoice()) {
            retCodeListSetChoice.add(aItem);
        }
        ret.codeListSetChoice = retCodeListSetChoice;
        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;
    }

}
 















© 2015 - 2024 Weber Informatics LLC | Privacy Policy