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

Show more of this group Show more artifacts with this name
Show all versions of ph-genericode Show documentation
Library to read and write OASIS GeneriCode and CVA documents
There is a newer version: 7.1.3

package com.helger.genericode.v10;

import java.io.Serializable;
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.XmlIDREF;
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.equals.EqualsHelper;
import com.helger.commons.hashcode.HashCodeGenerator;
import com.helger.commons.string.ToStringGenerator;


/**
 * Reference to a column which forms part of a key.
 * 
 * Java class for KeyColumnRef complex type.
 * 
 * 
The following schema fragment specifies the expected content contained within this class.
 * 
 * 
 * <complexType name="KeyColumnRef">
 *   <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"/>
 *       </sequence>
 *       <attribute name="Ref" use="required" type="{http://www.w3.org/2001/XMLSchema}IDREF" />
 *     </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-cloneable
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "KeyColumnRef", propOrder = {
    "annotation"
})
@CodingStyleguideUnaware
public class KeyColumnRef implements Serializable, Cloneable
{

    @XmlElement(name = "Annotation")
    private Annotation annotation;
    @XmlAttribute(name = "Ref", required = true)
    @XmlIDREF
    @XmlSchemaType(name = "IDREF")
    private Object ref;

    /**
     * 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 ref property.
     * 
     * @return
     *     possible object is
     *     {@link Object }
     *     
     */
    @Nullable
    public Object getRef() {
        return ref;
    }

    /**
     * Sets the value of the ref property.
     * 
     * @param value
     *     allowed object is
     *     {@link Object }
     *     
     */
    public void setRef(
        @Nullable
        Object value) {
        this.ref = 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 KeyColumnRef rhs = ((KeyColumnRef) o);
        if (!EqualsHelper.equals(annotation, rhs.annotation)) {
            return false;
        }
        if (!EqualsHelper.equals(ref, rhs.ref)) {
            return false;
        }
        return true;
    }

    /**
     * Created by ph-jaxb22-plugin -Xph-equalshashcode
     * 
     */
    @Override
    public int hashCode() {
        return new HashCodeGenerator(this).append(annotation).append(ref).getHashCode();
    }

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

    /**
     * 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
        KeyColumnRef ret) {
        ret.annotation = ((annotation == null)?null:annotation.clone());
        ret.ref = ref;
    }

    /**
     * Created by ph-jaxb22-plugin -Xph-cloneable
     * 
     * @return
     *     The cloned object. Never null.
     */
    @Nonnull
    @ReturnsMutableCopy
    @Override
    public KeyColumnRef clone() {
        KeyColumnRef ret = new KeyColumnRef();
        cloneTo(ret);
        return ret;
    }

}