Address.java

/* Copyright (C) 2014 konik.io
 *
 * This file is part of the Konik library.
 *
 * The Konik library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * The Konik library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with the Konik library. If not, see <http://www.gnu.org/licenses/>.
 */
package io.konik.zugferd.entity;

import com.neovisionaries.i18n.CountryCode;
import io.konik.validator.annotation.Basic;

import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.adapters.CollapsedStringAdapter;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import java.io.Serializable;

/**
 * = The Address
 * 
 * The postal address of an entity.
 */
@XmlType(name = "TradeAddressType", propOrder = { "postcode", "lineOne", "lineTwo", "city", "country" })
public class Address implements Serializable {

   @XmlElement(name = "PostcodeCode")
   @XmlJavaTypeAdapter(CollapsedStringAdapter.class)
   private String postcode;

   @XmlElement(name = "LineOne")
   private String lineOne;

   @XmlElement(name = "LineTwo")
   private String lineTwo;

   @XmlElement(name = "CityName")
   private String city;

   @XmlElement(name = "CountryID")
   private CountryCode country;

   /** Instantiates a new trade address. */
   public Address() {
   }

   /**
    * Instantiates a new trade address.
    *
    * @param postcode the post code
    * @param lineOne the line one
    * @param lineTwo the line two
    * @param cityName the city name
    * @param countryCode the ISO 3166-2A country code
    */
   public Address(String postcode, String lineOne, String lineTwo, String cityName, CountryCode countryCode) {
      super();
      this.postcode = postcode;
      this.lineOne = lineOne;
      this.lineTwo = lineTwo;
      this.city = cityName;
      this.country = countryCode;
   }

   /**
    * Instantiates a new trade address.
    *
    * @param postcode the postal code
    * @param lineOne the line one
    * @param cityName the city name
    * @param countryCode the ISO 3166-2A country code
    */
   public Address(String postcode, String lineOne, String cityName, CountryCode countryCode) {
      super();
      this.postcode = postcode;
      this.lineOne = lineOne;
      this.city = cityName;
      this.country = countryCode;
   }

   /**
    * Gets the post code.
    * 
    * Profile:: BASIC when part of Trade.agreements.seller.
    * 
    * Example:: {@code DE-123456}
    *
    * @return the post code
    */
   @Basic
   public String getPostcode() {
      return postcode;
   }

   /**
    * Sets the post code.
    * 
    * Profile:: BASIC when part of Trade.agreements.seller.
    * 
    * Example:: {@code DE-123456}
    * 
    * @param postcode the postcode
    * @return the trade address
    */
   public Address setPostcode(String postcode) {
      this.postcode = postcode;
      return this;
   }

   /**
    * Gets the line one. Usually the Street name.
    * 
    * Profile:: BASIC when part of Trade.agreements.seller.
    * 
    * Example:: {@code Elm Street 13}
    *
    * @return the line one
    */
   @Basic
   public String getLineOne() {
      return lineOne;
   }

   /**
    * Sets the line one. Usually the Street name.
    * 
    * Profile:: BASIC when part of Trade.agreements.seller.
    * 
    * Example:: {@code Elm Street 13}
    *
    * @param lineOne the new line one
    * @return the trade address
    */
   public Address setLineOne(String lineOne) {
      this.lineOne = lineOne;
      return this;
   }

   /**
    * Gets the line two. Location like Building name or department.
    * 
    * Profile:: BASIC when part of Trade.agreements.seller.
    * 
    * Example:: {@code Department of broken dreams}
    *
    * @return the line two
    */
   @Basic
   public String getLineTwo() {
      return lineTwo;
   }

   /**
    * Sets the line two.. Location like Building name or department.
    * 
    * Profile:: BASIC when part of Trade.agreements.seller.
    * 
    * Example:: {@code Department of broken dreams}
    *
    * @param lineTwo the new line two
    * @return the trade address
    */
   public Address setLineTwo(String lineTwo) {
      this.lineTwo = lineTwo;
      return this;
   }

   /**
    * Gets the city name.
    * 
    * Profile:: BASIC when part of Trade.agreements.seller.
    * 
    * Example:: {@code Zürich}
    *
    * @return the city name
    */
   @Basic
   public String getCity() {
      return city;
   }

   /**
    * Sets the city name.
    * 
    * Profile:: BASIC when part of Trade.agreements.seller.
    * 
    * Example:: {@code Zürich}
    *
    * @param cityName the new city name
    * @return the trade address
    */
   public Address setCity(String cityName) {
      this.city = cityName;
      return this;
   }

   /**
    * Gets the country.
    * 
    * Two-letter country codes defined in ISO 3166-1,
    * 
    * Profile:: BASIC when part of Trade.agreements.seller.
    * 
    * Example:: {@code CH}
    *
    * @return the ISO 3166-2A country
    * @see <a href="http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO 3166-2A Country Codes</a>
    */
   @Basic
   public CountryCode getCountry() {
      return country;
   }

   /**
    * Sets the country.
    * 
    * Two-letter country codes defined in ISO 3166-1,
    * 
    * Profile:: BASIC when part of Trade.agreements.seller.
    * 
    * Example:: {@code CH}
    *
    * @param country the country
    * @return the trade address
    * @see <a href="http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO 3166-2A Country Codes</a>
    */
   public Address setCountry(CountryCode country) {
      this.country = country;
      return this;
   }
}