de.vdv.ojp20.GeneralAttributeStructure Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ojp-java-model Show documentation
Generates Java model from OJP xsds using jaxb.
The newest version!
//
// This file was generated by the Eclipse Implementation of JAXB, v4.0.5 
// See https://eclipse-ee4j.github.io/jaxb-ri 
// Any modifications to this file will be lost upon recompilation of the source schema. 
//


package de.vdv.ojp20;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import de.vdv.ojp20.siri.AllFacilitiesFeatureStructure;
import jakarta.xml.bind.annotation.XmlAccessType;
import jakarta.xml.bind.annotation.XmlAccessorType;
import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlSchemaType;
import jakarta.xml.bind.annotation.XmlSeeAlso;
import jakarta.xml.bind.annotation.XmlType;
import jakarta.xml.bind.annotation.adapters.CollapsedStringAdapter;
import jakarta.xml.bind.annotation.adapters.NormalizedStringAdapter;
import jakarta.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.opentripplanner.ojp.netex.OmitNullsToStringStyle;


/**
 * Structured attribute classification with associated text. If URL is given, it refers to the whole attribute text.
 * 
 * Java class for GeneralAttributeStructure complex type.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * 
 * {@code
 * 
 *   
 *     
 *       
 *         
 *         
 *         
 *         
 *         
 *         
 *         
 *         
 *       
 *     
 *   
 * 
 * }
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "GeneralAttributeStructure", propOrder = {
    "userText",
    "code",
    "key",
    "value",
    "facility",
    "mandatory",
    "importance",
    "url",
    "mimeType",
    "embeddable"
})
@XmlSeeAlso({
    LegAttributeStructure.class
})
public class GeneralAttributeStructure {

    /**
     * Text of the attribute to be shown to the user.
     * 
     */
    @XmlElement(name = "UserText", required = true)
    protected InternationalTextStructure userText;
    /**
     * Internal code of the attribute. Can be used for detection of double occurrences.
     * 
     */
    @XmlElement(name = "Code", required = true)
    @XmlJavaTypeAdapter(CollapsedStringAdapter.class)
    @XmlSchemaType(name = "NMTOKEN")
    protected String code;
    /**
     * Key if the attribute is used as a key/value pair.
     * 
     */
    @XmlElement(name = "Key")
    @XmlJavaTypeAdapter(CollapsedStringAdapter.class)
    @XmlSchemaType(name = "NMTOKEN")
    protected String key;
    /**
     * Value if the attribute is used as a key/value pair.
     * 
     */
    @XmlElement(name = "Value")
    protected String value;
    /**
     * Facilities associated with this attribute.
     * 
     */
    @XmlElement(name = "Facility")
    protected List facility;
    /**
     * Defines whether the attribute has to be shown to the user.
     * 
     */
    @XmlElement(name = "Mandatory", defaultValue = "false")
    protected Boolean mandatory;
    /**
     * Importance of the attribute.
     * 
     */
    @XmlElement(name = "Importance")
    @XmlSchemaType(name = "nonNegativeInteger")
    protected Integer importance;
    /**
     * URL to resource on web.
     * 
     */
    @XmlElement(name = "Url")
    @XmlSchemaType(name = "anyURI")
    protected String url;
    /**
     * MIME type of the referenced resource. To which kind of resource does the URL point to?
     * 
     */
    @XmlElement(name = "MimeType", defaultValue = "text/html")
    @XmlJavaTypeAdapter(NormalizedStringAdapter.class)
    @XmlSchemaType(name = "normalizedString")
    protected String mimeType;
    /**
     * Is the referenced resource meant to be embedded as a webview in a surrounding context, e.g., app or web page? If yes, the resource has to be fully responsive. Default is false.
     * 
     */
    @XmlElement(name = "Embeddable", defaultValue = "false")
    protected Boolean embeddable;

    /**
     * Text of the attribute to be shown to the user.
     * 
     * @return
     *     possible object is
     *     {@link InternationalTextStructure }
     *     
     */
    public InternationalTextStructure getUserText() {
        return userText;
    }

    /**
     * Sets the value of the userText property.
     * 
     * @param value
     *     allowed object is
     *     {@link InternationalTextStructure }
     *     
     * @see #getUserText()
     */
    public void setUserText(InternationalTextStructure value) {
        this.userText = value;
    }

    /**
     * Internal code of the attribute. Can be used for detection of double occurrences.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getCode() {
        return code;
    }

    /**
     * Sets the value of the code property.
     * 
     * @param value
     *     allowed object is
     *     {@link String }
     *     
     * @see #getCode()
     */
    public void setCode(String value) {
        this.code = value;
    }

    /**
     * Key if the attribute is used as a key/value pair.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getKey() {
        return key;
    }

    /**
     * Sets the value of the key property.
     * 
     * @param value
     *     allowed object is
     *     {@link String }
     *     
     * @see #getKey()
     */
    public void setKey(String value) {
        this.key = value;
    }

    /**
     * Value if the attribute is used as a key/value pair.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getValue() {
        return value;
    }

    /**
     * Sets the value of the value property.
     * 
     * @param value
     *     allowed object is
     *     {@link String }
     *     
     * @see #getValue()
     */
    public void setValue(String value) {
        this.value = value;
    }

    /**
     * Facilities associated with this attribute.
     * 
     * Gets the value of the facility 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 facility property.
     * 
     * 
     * For example, to add a new item, do as follows:
     * 
     *      * getFacility().add(newItem);
     * 
     * 
     * 
     * 
     * Objects of the following type(s) are allowed in the list
     * {@link AllFacilitiesFeatureStructure }
     * 
     * 
     * 
     * @return
     *     The value of the facility property.
     */
    public List getFacility() {
        if (facility == null) {
            facility = new ArrayList<>();
        }
        return this.facility;
    }

    /**
     * Defines whether the attribute has to be shown to the user.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isMandatory() {
        return mandatory;
    }

    /**
     * Sets the value of the mandatory property.
     * 
     * @param value
     *     allowed object is
     *     {@link Boolean }
     *     
     * @see #isMandatory()
     */
    public void setMandatory(Boolean value) {
        this.mandatory = value;
    }

    /**
     * Importance of the attribute.
     * 
     * @return
     *     possible object is
     *     {@link Integer }
     *     
     */
    public Integer getImportance() {
        return importance;
    }

    /**
     * Sets the value of the importance property.
     * 
     * @param value
     *     allowed object is
     *     {@link Integer }
     *     
     * @see #getImportance()
     */
    public void setImportance(Integer value) {
        this.importance = value;
    }

    /**
     * URL to resource on web.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getUrl() {
        return url;
    }

    /**
     * Sets the value of the url property.
     * 
     * @param value
     *     allowed object is
     *     {@link String }
     *     
     * @see #getUrl()
     */
    public void setUrl(String value) {
        this.url = value;
    }

    /**
     * MIME type of the referenced resource. To which kind of resource does the URL point to?
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getMimeType() {
        return mimeType;
    }

    /**
     * Sets the value of the mimeType property.
     * 
     * @param value
     *     allowed object is
     *     {@link String }
     *     
     * @see #getMimeType()
     */
    public void setMimeType(String value) {
        this.mimeType = value;
    }

    /**
     * Is the referenced resource meant to be embedded as a webview in a surrounding context, e.g., app or web page? If yes, the resource has to be fully responsive. Default is false.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isEmbeddable() {
        return embeddable;
    }

    /**
     * Sets the value of the embeddable property.
     * 
     * @param value
     *     allowed object is
     *     {@link Boolean }
     *     
     * @see #isEmbeddable()
     */
    public void setEmbeddable(Boolean value) {
        this.embeddable = value;
    }

    public GeneralAttributeStructure withUserText(InternationalTextStructure value) {
        setUserText(value);
        return this;
    }

    public GeneralAttributeStructure withCode(String value) {
        setCode(value);
        return this;
    }

    public GeneralAttributeStructure withKey(String value) {
        setKey(value);
        return this;
    }

    public GeneralAttributeStructure withValue(String value) {
        setValue(value);
        return this;
    }

    public GeneralAttributeStructure withFacility(AllFacilitiesFeatureStructure... values) {
        if (values!= null) {
            for (AllFacilitiesFeatureStructure value: values) {
                getFacility().add(value);
            }
        }
        return this;
    }

    public GeneralAttributeStructure withFacility(Collection values) {
        if (values!= null) {
            getFacility().addAll(values);
        }
        return this;
    }

    public GeneralAttributeStructure withMandatory(Boolean value) {
        setMandatory(value);
        return this;
    }

    public GeneralAttributeStructure withImportance(Integer value) {
        setImportance(value);
        return this;
    }

    public GeneralAttributeStructure withUrl(String value) {
        setUrl(value);
        return this;
    }

    public GeneralAttributeStructure withMimeType(String value) {
        setMimeType(value);
        return this;
    }

    public GeneralAttributeStructure withEmbeddable(Boolean value) {
        setEmbeddable(value);
        return this;
    }

    /**
     * Generates a String representation of the contents of this type.
     * This is an extension method, produced by the 'ts' xjc plugin
     * 
     */
    @Override
    public String toString() {
        return ToStringBuilder.reflectionToString(this, OmitNullsToStringStyle.INSTANCE);
    }

}