de.vdv.ojp20.StopPlaceStructure 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 jakarta.xml.bind.annotation.XmlAccessType;
import jakarta.xml.bind.annotation.XmlAccessorType;
import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlType;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.opentripplanner.ojp.netex.OmitNullsToStringStyle;


/**
 * [an extended view of STOP PLACE in TMv6] a PLACE extended by ACCESSIBILITY LIMITATION properties and some attributes of the associated equipment, comprising one or more locations where vehicles may stop and where passengers may board or leave vehicles or prepare their trip, and which will usually have one or more well-known names
 * 
 * Java class for StopPlaceStructure complex type.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * 
 * {@code
 * 
 *   
 *     
 *       
 *         
 *         
 *         
 *         
 *       
 *     
 *   
 * 
 * }
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "StopPlaceStructure", propOrder = {
    "stopPlaceRef",
    "stopPlaceName",
    "nameSuffix",
    "privateCode",
    "topographicPlaceRef",
    "wheelchairAccessible",
    "lighting",
    "covered"
})
public class StopPlaceStructure {

    /**
     * Reference to a Stop Place
     * 
     */
    @XmlElement(name = "StopPlaceRef", required = true)
    protected StopPlaceRefStructure stopPlaceRef;
    /**
     * Name of this stop place for use in passenger information.
     * 
     */
    @XmlElement(name = "StopPlaceName", required = true)
    protected InternationalTextStructure stopPlaceName;
    /**
     * Additional description of the stop place that may be appended to the name if enough space is available. E.g. "Exhibition Center".
     * 
     */
    @XmlElement(name = "NameSuffix")
    protected InternationalTextStructure nameSuffix;
    /**
     * Code of this stop place in private/foreign/proprietary coding schemes.
     * 
     */
    @XmlElement(name = "PrivateCode")
    protected List privateCode;
    /**
     * Reference to a TopographicPlace
     * 
     */
    @XmlElement(name = "TopographicPlaceRef")
    protected TopographicPlaceRefStructure topographicPlaceRef;
    /**
     * Whether this stop is accessible for wheelchair users.
     * 
     */
    @XmlElement(name = "WheelchairAccessible", defaultValue = "false")
    protected Boolean wheelchairAccessible;
    /**
     * Whether this stop is lit.
     * 
     */
    @XmlElement(name = "Lighting", defaultValue = "false")
    protected Boolean lighting;
    /**
     * Whether this stop offers protection from weather conditions like rain, snow, storm etc.
     * 
     */
    @XmlElement(name = "Covered", defaultValue = "false")
    protected Boolean covered;

    /**
     * Reference to a Stop Place
     * 
     * @return
     *     possible object is
     *     {@link StopPlaceRefStructure }
     *     
     */
    public StopPlaceRefStructure getStopPlaceRef() {
        return stopPlaceRef;
    }

    /**
     * Sets the value of the stopPlaceRef property.
     * 
     * @param value
     *     allowed object is
     *     {@link StopPlaceRefStructure }
     *     
     * @see #getStopPlaceRef()
     */
    public void setStopPlaceRef(StopPlaceRefStructure value) {
        this.stopPlaceRef = value;
    }

    /**
     * Name of this stop place for use in passenger information.
     * 
     * @return
     *     possible object is
     *     {@link InternationalTextStructure }
     *     
     */
    public InternationalTextStructure getStopPlaceName() {
        return stopPlaceName;
    }

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

    /**
     * Additional description of the stop place that may be appended to the name if enough space is available. E.g. "Exhibition Center".
     * 
     * @return
     *     possible object is
     *     {@link InternationalTextStructure }
     *     
     */
    public InternationalTextStructure getNameSuffix() {
        return nameSuffix;
    }

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

    /**
     * Code of this stop place in private/foreign/proprietary coding schemes.
     * 
     * Gets the value of the privateCode 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 privateCode property.
     * 
     * 
     * For example, to add a new item, do as follows:
     * 
     *      * getPrivateCode().add(newItem);
     * 
     * 
     * 
     * 
     * Objects of the following type(s) are allowed in the list
     * {@link PrivateCodeStructure }
     * 
     * 
     * 
     * @return
     *     The value of the privateCode property.
     */
    public List getPrivateCode() {
        if (privateCode == null) {
            privateCode = new ArrayList<>();
        }
        return this.privateCode;
    }

    /**
     * Reference to a TopographicPlace
     * 
     * @return
     *     possible object is
     *     {@link TopographicPlaceRefStructure }
     *     
     */
    public TopographicPlaceRefStructure getTopographicPlaceRef() {
        return topographicPlaceRef;
    }

    /**
     * Sets the value of the topographicPlaceRef property.
     * 
     * @param value
     *     allowed object is
     *     {@link TopographicPlaceRefStructure }
     *     
     * @see #getTopographicPlaceRef()
     */
    public void setTopographicPlaceRef(TopographicPlaceRefStructure value) {
        this.topographicPlaceRef = value;
    }

    /**
     * Whether this stop is accessible for wheelchair users.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isWheelchairAccessible() {
        return wheelchairAccessible;
    }

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

    /**
     * Whether this stop is lit.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isLighting() {
        return lighting;
    }

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

    /**
     * Whether this stop offers protection from weather conditions like rain, snow, storm etc.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isCovered() {
        return covered;
    }

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

    public StopPlaceStructure withStopPlaceRef(StopPlaceRefStructure value) {
        setStopPlaceRef(value);
        return this;
    }

    public StopPlaceStructure withStopPlaceName(InternationalTextStructure value) {
        setStopPlaceName(value);
        return this;
    }

    public StopPlaceStructure withNameSuffix(InternationalTextStructure value) {
        setNameSuffix(value);
        return this;
    }

    public StopPlaceStructure withPrivateCode(PrivateCodeStructure... values) {
        if (values!= null) {
            for (PrivateCodeStructure value: values) {
                getPrivateCode().add(value);
            }
        }
        return this;
    }

    public StopPlaceStructure withPrivateCode(Collection values) {
        if (values!= null) {
            getPrivateCode().addAll(values);
        }
        return this;
    }

    public StopPlaceStructure withTopographicPlaceRef(TopographicPlaceRefStructure value) {
        setTopographicPlaceRef(value);
        return this;
    }

    public StopPlaceStructure withWheelchairAccessible(Boolean value) {
        setWheelchairAccessible(value);
        return this;
    }

    public StopPlaceStructure withLighting(Boolean value) {
        setLighting(value);
        return this;
    }

    public StopPlaceStructure withCovered(Boolean value) {
        setCovered(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);
    }

}