de.vdv.ojp20.AddressStructure 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.XmlSchemaType;
import jakarta.xml.bind.annotation.XmlType;
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;


/**
 * descriptive data associated with a PLACE that can be used to describe the unique geographical context of a PLACE for the purposes of identifying it. May be refined as either a ROAD ADDRESS, a POSTAL ADDRESS or both
 * 
 * Java class for AddressStructure complex type.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * 
 * {@code
 * 
 *   
 *     
 *       
 *         
 *         
 *         
 *         
 *         
 *       
 *     
 *   
 * 
 * }
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "AddressStructure", propOrder = {
    "publicCode",
    "privateCode",
    "name",
    "nameSuffix",
    "countryName",
    "postCode",
    "topographicPlaceName",
    "topographicPlaceRef",
    "street",
    "houseNumber",
    "crossRoad"
})
public class AddressStructure {

    /**
     * ID of this address.
     * 
     */
    @XmlElement(name = "PublicCode", required = true)
    @XmlJavaTypeAdapter(NormalizedStringAdapter.class)
    @XmlSchemaType(name = "normalizedString")
    protected String publicCode;
    /**
     * Code of this address in private/foreign/proprietary coding schemes.
     * 
     */
    @XmlElement(name = "PrivateCode")
    protected List privateCode;
    /**
     * Name or description of address for use in passenger information.
     * 
     */
    @XmlElement(name = "Name", required = true)
    protected InternationalTextStructure name;
    /**
     * Additional description of the address that may be appended to the name if enough space is available. E.g. "Crossing with Peterstraße".
     * 
     */
    @XmlElement(name = "NameSuffix")
    protected InternationalTextStructure nameSuffix;
    /**
     * Country of the address.
     * 
     */
    @XmlElement(name = "CountryName")
    protected String countryName;
    /**
     * Postal code of the address.
     * 
     */
    @XmlElement(name = "PostCode")
    protected String postCode;
    /**
     * TopographicPlace name of the address. If set it should at least contain the city name.
     * 
     */
    @XmlElement(name = "TopographicPlaceName")
    protected String topographicPlaceName;
    /**
     * Reference to a TopographicPlace
     * 
     */
    @XmlElement(name = "TopographicPlaceRef")
    protected TopographicPlaceRefStructure topographicPlaceRef;
    /**
     * Street name of the address.
     * 
     */
    @XmlElement(name = "Street")
    protected String street;
    /**
     * House number of the address. If none is given, either a crossing street can be given, or the whole street is meant.
     * 
     */
    @XmlElement(name = "HouseNumber")
    protected String houseNumber;
    /**
     * Crossing. This can be used to be more specific without using house numbers.
     * 
     */
    @XmlElement(name = "CrossRoad")
    protected String crossRoad;

    /**
     * ID of this address.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getPublicCode() {
        return publicCode;
    }

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

    /**
     * Code of this address 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;
    }

    /**
     * Name or description of address for use in passenger information.
     * 
     * @return
     *     possible object is
     *     {@link InternationalTextStructure }
     *     
     */
    public InternationalTextStructure getName() {
        return name;
    }

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

    /**
     * Additional description of the address that may be appended to the name if enough space is available. E.g. "Crossing with Peterstraße".
     * 
     * @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;
    }

    /**
     * Country of the address.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getCountryName() {
        return countryName;
    }

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

    /**
     * Postal code of the address.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getPostCode() {
        return postCode;
    }

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

    /**
     * TopographicPlace name of the address. If set it should at least contain the city name.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getTopographicPlaceName() {
        return topographicPlaceName;
    }

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

    /**
     * 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;
    }

    /**
     * Street name of the address.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getStreet() {
        return street;
    }

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

    /**
     * House number of the address. If none is given, either a crossing street can be given, or the whole street is meant.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getHouseNumber() {
        return houseNumber;
    }

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

    /**
     * Crossing. This can be used to be more specific without using house numbers.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getCrossRoad() {
        return crossRoad;
    }

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

    public AddressStructure withPublicCode(String value) {
        setPublicCode(value);
        return this;
    }

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

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

    public AddressStructure withName(InternationalTextStructure value) {
        setName(value);
        return this;
    }

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

    public AddressStructure withCountryName(String value) {
        setCountryName(value);
        return this;
    }

    public AddressStructure withPostCode(String value) {
        setPostCode(value);
        return this;
    }

    public AddressStructure withTopographicPlaceName(String value) {
        setTopographicPlaceName(value);
        return this;
    }

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

    public AddressStructure withStreet(String value) {
        setStreet(value);
        return this;
    }

    public AddressStructure withHouseNumber(String value) {
        setHouseNumber(value);
        return this;
    }

    public AddressStructure withCrossRoad(String value) {
        setCrossRoad(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);
    }

}