de.vdv.ojp20.ExchangePointsResultStructure 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.time.Duration;
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.XmlSchemaType;
import jakarta.xml.bind.annotation.XmlType;
import jakarta.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.opentripplanner.ojp.netex.OmitNullsToStringStyle;
import org.opentripplanner.ojp.util.DurationXmlAdapter;


/**
 * Java class for ExchangePointsResultStructure complex type.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * 
 * {@code
 * 
 *   
 *     
 *       
 *         
 *         
 *         
 *         
 *         
 *         
 *         
 *       
 *     
 *   
 * 
 * }
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "ExchangePointsResultStructure", propOrder = {
    "errorCondition",
    "place",
    "travelDurationEstimate",
    "waitDuration",
    "borderPoint",
    "mode",
    "priority"
})
public class ExchangePointsResultStructure {

    /**
     * Problems related to this EXCHANGE POINTS result.
     * 
     */
    @XmlElement(name = "ErrorCondition")
    protected List errorCondition;
    /**
     * Place object that describes this exchange point.
     * 
     */
    @XmlElement(name = "Place", required = true)
    protected PlaceStructure place;
    /**
     * Rough estimate of the travel duration from the specified reference location/place to this exchange point.
     * 
     */
    @XmlElement(name = "TravelDurationEstimate", type = String.class)
    @XmlJavaTypeAdapter(DurationXmlAdapter.class)
    @XmlSchemaType(name = "duration")
    protected Duration travelDurationEstimate;
    /**
     * Duration needed at this exchange point to change from one service to another. If a journey planning orchestrator puts together a trip at this exchange point, it must take care, that feeding arrival and fetching departure are at least this duration apart.
     * 
     */
    @XmlElement(name = "WaitDuration", type = String.class, defaultValue = "PT0M")
    @XmlJavaTypeAdapter(DurationXmlAdapter.class)
    @XmlSchemaType(name = "duration")
    protected Duration waitDuration;
    /**
     * Flag if this exchange point is an administrative border point where timetables are cut off while services still may run through and connect the regions. At this kind of points passengers may continue their journey within the same service. Default is FALSE.
     * 
     */
    @XmlElement(name = "BorderPoint", defaultValue = "false")
    protected Boolean borderPoint;
    /**
     * List of transport modes that call at this place object. This list should only be filled in case of stop points or stop places – and only when explicitly requested.
     * 
     */
    @XmlElement(name = "Mode")
    protected List mode;
    /**
     * The priority of the exchange point. 100 is the maximum. The priority can be used to select given ExchangePoints more often (e.g., because the station is a main hub).
     * 
     */
    @XmlElement(name = "Priority")
    @XmlSchemaType(name = "nonNegativeInteger")
    protected Integer priority;

    /**
     * Problems related to this EXCHANGE POINTS result.
     * 
     * Gets the value of the errorCondition 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 errorCondition property.
     * 
     * 
     * For example, to add a new item, do as follows:
     * 
     *      * getErrorCondition().add(newItem);
     * 
     * 
     * 
     * 
     * Objects of the following type(s) are allowed in the list
     * {@link OJPErrorStructure }
     * 
     * 
     * 
     * @return
     *     The value of the errorCondition property.
     */
    public List getErrorCondition() {
        if (errorCondition == null) {
            errorCondition = new ArrayList<>();
        }
        return this.errorCondition;
    }

    /**
     * Place object that describes this exchange point.
     * 
     * @return
     *     possible object is
     *     {@link PlaceStructure }
     *     
     */
    public PlaceStructure getPlace() {
        return place;
    }

    /**
     * Sets the value of the place property.
     * 
     * @param value
     *     allowed object is
     *     {@link PlaceStructure }
     *     
     * @see #getPlace()
     */
    public void setPlace(PlaceStructure value) {
        this.place = value;
    }

    /**
     * Rough estimate of the travel duration from the specified reference location/place to this exchange point.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public Duration getTravelDurationEstimate() {
        return travelDurationEstimate;
    }

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

    /**
     * Duration needed at this exchange point to change from one service to another. If a journey planning orchestrator puts together a trip at this exchange point, it must take care, that feeding arrival and fetching departure are at least this duration apart.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public Duration getWaitDuration() {
        return waitDuration;
    }

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

    /**
     * Flag if this exchange point is an administrative border point where timetables are cut off while services still may run through and connect the regions. At this kind of points passengers may continue their journey within the same service. Default is FALSE.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isBorderPoint() {
        return borderPoint;
    }

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

    /**
     * List of transport modes that call at this place object. This list should only be filled in case of stop points or stop places – and only when explicitly requested.
     * 
     * Gets the value of the mode 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 mode property.
     * 
     * 
     * For example, to add a new item, do as follows:
     * 
     *      * getMode().add(newItem);
     * 
     * 
     * 
     * 
     * Objects of the following type(s) are allowed in the list
     * {@link ModeStructure }
     * 
     * 
     * 
     * @return
     *     The value of the mode property.
     */
    public List getMode() {
        if (mode == null) {
            mode = new ArrayList<>();
        }
        return this.mode;
    }

    /**
     * The priority of the exchange point. 100 is the maximum. The priority can be used to select given ExchangePoints more often (e.g., because the station is a main hub).
     * 
     * @return
     *     possible object is
     *     {@link Integer }
     *     
     */
    public Integer getPriority() {
        return priority;
    }

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

    public ExchangePointsResultStructure withErrorCondition(OJPErrorStructure... values) {
        if (values!= null) {
            for (OJPErrorStructure value: values) {
                getErrorCondition().add(value);
            }
        }
        return this;
    }

    public ExchangePointsResultStructure withErrorCondition(Collection values) {
        if (values!= null) {
            getErrorCondition().addAll(values);
        }
        return this;
    }

    public ExchangePointsResultStructure withPlace(PlaceStructure value) {
        setPlace(value);
        return this;
    }

    public ExchangePointsResultStructure withTravelDurationEstimate(Duration value) {
        setTravelDurationEstimate(value);
        return this;
    }

    public ExchangePointsResultStructure withWaitDuration(Duration value) {
        setWaitDuration(value);
        return this;
    }

    public ExchangePointsResultStructure withBorderPoint(Boolean value) {
        setBorderPoint(value);
        return this;
    }

    public ExchangePointsResultStructure withMode(ModeStructure... values) {
        if (values!= null) {
            for (ModeStructure value: values) {
                getMode().add(value);
            }
        }
        return this;
    }

    public ExchangePointsResultStructure withMode(Collection values) {
        if (values!= null) {
            getMode().addAll(values);
        }
        return this;
    }

    public ExchangePointsResultStructure withPriority(Integer value) {
        setPriority(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);
    }

}