package org.hl7.fhir.r4.model;

/*
  Copyright (c) 2011+, HL7, Inc.
  All rights reserved.
  
  Redistribution and use in source and binary forms, with or without modification, 
  are permitted provided that the following conditions are met:
  
   * Redistributions of source code must retain the above copyright notice, this 
     list of conditions and the following disclaimer.
   * Redistributions in binary form must reproduce the above copyright notice, 
     this list of conditions and the following disclaimer in the documentation 
     and/or other materials provided with the distribution.
   * Neither the name of HL7 nor the names of its contributors may be used to 
     endorse or promote products derived from this software without specific 
     prior written permission.
  
  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
  POSSIBILITY OF SUCH DAMAGE.
  
*/

// Generated on Tue, May 12, 2020 07:26+1000 for FHIR v4.0.1
import java.util.ArrayList;
import java.util.List;

import org.hl7.fhir.exceptions.FHIRException;
import org.hl7.fhir.instance.model.api.ICompositeType;
import org.hl7.fhir.utilities.Utilities;

import ca.uhn.fhir.model.api.annotation.Child;
import ca.uhn.fhir.model.api.annotation.DatatypeDef;
import ca.uhn.fhir.model.api.annotation.Description;

/**
 * An address expressed using postal conventions (as opposed to GPS or other
 * location definition formats). This data type may be used to convey addresses
 * for use in delivering mail as well as for visiting locations which might not
 * be valid for mail delivery. There are a variety of postal address formats
 * defined around the world.
 */
@DatatypeDef(name = "Address")
public class Address extends Type implements ICompositeType {

  public enum AddressUse {
    /**
     * A communication address at a home.
     */
    HOME,
    /**
     * An office address. First choice for business related contacts during business
     * hours.
     */
    WORK,
    /**
     * A temporary address. The period can provide more detailed information.
     */
    TEMP,
    /**
     * This address is no longer in use (or was never correct but retained for
     * records).
     */
    OLD,
    /**
     * An address to be used to send bills, invoices, receipts etc.
     */
    BILLING,
    /**
     * added to help the parsers with the generic types
     */
    NULL;

    public static AddressUse fromCode(String codeString) throws FHIRException {
      if (codeString == null || "".equals(codeString))
        return null;
      if ("home".equals(codeString))
        return HOME;
      if ("work".equals(codeString))
        return WORK;
      if ("temp".equals(codeString))
        return TEMP;
      if ("old".equals(codeString))
        return OLD;
      if ("billing".equals(codeString))
        return BILLING;
      if (Configuration.isAcceptInvalidEnums())
        return null;
      else
        throw new FHIRException("Unknown AddressUse code '" + codeString + "'");
    }

    public String toCode() {
      switch (this) {
      case HOME:
        return "home";
      case WORK:
        return "work";
      case TEMP:
        return "temp";
      case OLD:
        return "old";
      case BILLING:
        return "billing";
      case NULL:
        return null;
      default:
        return "?";
      }
    }

    public String getSystem() {
      switch (this) {
      case HOME:
        return "http://hl7.org/fhir/address-use";
      case WORK:
        return "http://hl7.org/fhir/address-use";
      case TEMP:
        return "http://hl7.org/fhir/address-use";
      case OLD:
        return "http://hl7.org/fhir/address-use";
      case BILLING:
        return "http://hl7.org/fhir/address-use";
      case NULL:
        return null;
      default:
        return "?";
      }
    }

    public String getDefinition() {
      switch (this) {
      case HOME:
        return "A communication address at a home.";
      case WORK:
        return "An office address. First choice for business related contacts during business hours.";
      case TEMP:
        return "A temporary address. The period can provide more detailed information.";
      case OLD:
        return "This address is no longer in use (or was never correct but retained for records).";
      case BILLING:
        return "An address to be used to send bills, invoices, receipts etc.";
      case NULL:
        return null;
      default:
        return "?";
      }
    }

    public String getDisplay() {
      switch (this) {
      case HOME:
        return "Home";
      case WORK:
        return "Work";
      case TEMP:
        return "Temporary";
      case OLD:
        return "Old / Incorrect";
      case BILLING:
        return "Billing";
      case NULL:
        return null;
      default:
        return "?";
      }
    }
  }

  public static class AddressUseEnumFactory implements EnumFactory<AddressUse> {
    public AddressUse fromCode(String codeString) throws IllegalArgumentException {
      if (codeString == null || "".equals(codeString))
        if (codeString == null || "".equals(codeString))
          return null;
      if ("home".equals(codeString))
        return AddressUse.HOME;
      if ("work".equals(codeString))
        return AddressUse.WORK;
      if ("temp".equals(codeString))
        return AddressUse.TEMP;
      if ("old".equals(codeString))
        return AddressUse.OLD;
      if ("billing".equals(codeString))
        return AddressUse.BILLING;
      throw new IllegalArgumentException("Unknown AddressUse code '" + codeString + "'");
    }

    public Enumeration<AddressUse> fromType(PrimitiveType<?> code) throws FHIRException {
      if (code == null)
        return null;
      if (code.isEmpty())
        return new Enumeration<AddressUse>(this, AddressUse.NULL, code);
      String codeString = code.asStringValue();
      if (codeString == null || "".equals(codeString))
        return new Enumeration<AddressUse>(this, AddressUse.NULL, code);
      if ("home".equals(codeString))
        return new Enumeration<AddressUse>(this, AddressUse.HOME, code);
      if ("work".equals(codeString))
        return new Enumeration<AddressUse>(this, AddressUse.WORK, code);
      if ("temp".equals(codeString))
        return new Enumeration<AddressUse>(this, AddressUse.TEMP, code);
      if ("old".equals(codeString))
        return new Enumeration<AddressUse>(this, AddressUse.OLD, code);
      if ("billing".equals(codeString))
        return new Enumeration<AddressUse>(this, AddressUse.BILLING, code);
      throw new FHIRException("Unknown AddressUse code '" + codeString + "'");
    }

    public String toCode(AddressUse code) {
       if (code == AddressUse.NULL)
           return null;
       if (code == AddressUse.HOME)
        return "home";
      if (code == AddressUse.WORK)
        return "work";
      if (code == AddressUse.TEMP)
        return "temp";
      if (code == AddressUse.OLD)
        return "old";
      if (code == AddressUse.BILLING)
        return "billing";
      return "?";
   }

    public String toSystem(AddressUse code) {
      return code.getSystem();
    }
  }

  public enum AddressType {
    /**
     * Mailing addresses - PO Boxes and care-of addresses.
     */
    POSTAL,
    /**
     * A physical address that can be visited.
     */
    PHYSICAL,
    /**
     * An address that is both physical and postal.
     */
    BOTH,
    /**
     * added to help the parsers with the generic types
     */
    NULL;

    public static AddressType fromCode(String codeString) throws FHIRException {
      if (codeString == null || "".equals(codeString))
        return null;
      if ("postal".equals(codeString))
        return POSTAL;
      if ("physical".equals(codeString))
        return PHYSICAL;
      if ("both".equals(codeString))
        return BOTH;
      if (Configuration.isAcceptInvalidEnums())
        return null;
      else
        throw new FHIRException("Unknown AddressType code '" + codeString + "'");
    }

    public String toCode() {
      switch (this) {
      case POSTAL:
        return "postal";
      case PHYSICAL:
        return "physical";
      case BOTH:
        return "both";
      case NULL:
        return null;
      default:
        return "?";
      }
    }

    public String getSystem() {
      switch (this) {
      case POSTAL:
        return "http://hl7.org/fhir/address-type";
      case PHYSICAL:
        return "http://hl7.org/fhir/address-type";
      case BOTH:
        return "http://hl7.org/fhir/address-type";
      case NULL:
        return null;
      default:
        return "?";
      }
    }

    public String getDefinition() {
      switch (this) {
      case POSTAL:
        return "Mailing addresses - PO Boxes and care-of addresses.";
      case PHYSICAL:
        return "A physical address that can be visited.";
      case BOTH:
        return "An address that is both physical and postal.";
      case NULL:
        return null;
      default:
        return "?";
      }
    }

    public String getDisplay() {
      switch (this) {
      case POSTAL:
        return "Postal";
      case PHYSICAL:
        return "Physical";
      case BOTH:
        return "Postal & Physical";
      case NULL:
        return null;
      default:
        return "?";
      }
    }
  }

  public static class AddressTypeEnumFactory implements EnumFactory<AddressType> {
    public AddressType fromCode(String codeString) throws IllegalArgumentException {
      if (codeString == null || "".equals(codeString))
        if (codeString == null || "".equals(codeString))
          return null;
      if ("postal".equals(codeString))
        return AddressType.POSTAL;
      if ("physical".equals(codeString))
        return AddressType.PHYSICAL;
      if ("both".equals(codeString))
        return AddressType.BOTH;
      throw new IllegalArgumentException("Unknown AddressType code '" + codeString + "'");
    }

    public Enumeration<AddressType> fromType(PrimitiveType<?> code) throws FHIRException {
      if (code == null)
        return null;
      if (code.isEmpty())
        return new Enumeration<AddressType>(this, AddressType.NULL, code);
      String codeString = code.asStringValue();
      if (codeString == null || "".equals(codeString))
        return new Enumeration<AddressType>(this, AddressType.NULL, code);
      if ("postal".equals(codeString))
        return new Enumeration<AddressType>(this, AddressType.POSTAL, code);
      if ("physical".equals(codeString))
        return new Enumeration<AddressType>(this, AddressType.PHYSICAL, code);
      if ("both".equals(codeString))
        return new Enumeration<AddressType>(this, AddressType.BOTH, code);
      throw new FHIRException("Unknown AddressType code '" + codeString + "'");
    }

    public String toCode(AddressType code) {
       if (code == AddressType.NULL)
           return null;
       if (code == AddressType.POSTAL)
        return "postal";
      if (code == AddressType.PHYSICAL)
        return "physical";
      if (code == AddressType.BOTH)
        return "both";
      return "?";
   }

    public String toSystem(AddressType code) {
      return code.getSystem();
    }
  }

  /**
   * The purpose of this address.
   */
  @Child(name = "use", type = { CodeType.class }, order = 0, min = 0, max = 1, modifier = true, summary = true)
  @Description(shortDefinition = "home | work | temp | old | billing - purpose of this address", formalDefinition = "The purpose of this address.")
  @ca.uhn.fhir.model.api.annotation.Binding(valueSet = "http://hl7.org/fhir/ValueSet/address-use")
  protected Enumeration<AddressUse> use;

  /**
   * Distinguishes between physical addresses (those you can visit) and mailing
   * addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
   */
  @Child(name = "type", type = { CodeType.class }, order = 1, min = 0, max = 1, modifier = false, summary = true)
  @Description(shortDefinition = "postal | physical | both", formalDefinition = "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.")
  @ca.uhn.fhir.model.api.annotation.Binding(valueSet = "http://hl7.org/fhir/ValueSet/address-type")
  protected Enumeration<AddressType> type;

  /**
   * Specifies the entire address as it should be displayed e.g. on a postal
   * label. This may be provided instead of or as well as the specific parts.
   */
  @Child(name = "text", type = { StringType.class }, order = 2, min = 0, max = 1, modifier = false, summary = true)
  @Description(shortDefinition = "Text representation of the address", formalDefinition = "Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.")
  protected StringType text;

  /**
   * This component contains the house number, apartment number, street name,
   * street direction, P.O. Box number, delivery hints, and similar address
   * information.
   */
  @Child(name = "line", type = {
      StringType.class }, order = 3, min = 0, max = Child.MAX_UNLIMITED, modifier = false, summary = true)
  @Description(shortDefinition = "Street name, number, direction & P.O. Box etc.", formalDefinition = "This component contains the house number, apartment number, street name, street direction,  P.O. Box number, delivery hints, and similar address information.")
  protected List<StringType> line;

  /**
   * The name of the city, town, suburb, village or other community or delivery
   * center.
   */
  @Child(name = "city", type = { StringType.class }, order = 4, min = 0, max = 1, modifier = false, summary = true)
  @Description(shortDefinition = "Name of city, town etc.", formalDefinition = "The name of the city, town, suburb, village or other community or delivery center.")
  protected StringType city;

  /**
   * The name of the administrative area (county).
   */
  @Child(name = "district", type = { StringType.class }, order = 5, min = 0, max = 1, modifier = false, summary = true)
  @Description(shortDefinition = "District name (aka county)", formalDefinition = "The name of the administrative area (county).")
  protected StringType district;

  /**
   * Sub-unit of a country with limited sovereignty in a federally organized
   * country. A code may be used if codes are in common use (e.g. US 2 letter
   * state codes).
   */
  @Child(name = "state", type = { StringType.class }, order = 6, min = 0, max = 1, modifier = false, summary = true)
  @Description(shortDefinition = "Sub-unit of country (abbreviations ok)", formalDefinition = "Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).")
  protected StringType state;

  /**
   * A postal code designating a region defined by the postal service.
   */
  @Child(name = "postalCode", type = {
      StringType.class }, order = 7, min = 0, max = 1, modifier = false, summary = true)
  @Description(shortDefinition = "Postal code for area", formalDefinition = "A postal code designating a region defined by the postal service.")
  protected StringType postalCode;

  /**
   * Country - a nation as commonly understood or generally accepted.
   */
  @Child(name = "country", type = { StringType.class }, order = 8, min = 0, max = 1, modifier = false, summary = true)
  @Description(shortDefinition = "Country (e.g. can be ISO 3166 2 or 3 letter code)", formalDefinition = "Country - a nation as commonly understood or generally accepted.")
  protected StringType country;

  /**
   * Time period when address was/is in use.
   */
  @Child(name = "period", type = { Period.class }, order = 9, min = 0, max = 1, modifier = false, summary = true)
  @Description(shortDefinition = "Time period when address was/is in use", formalDefinition = "Time period when address was/is in use.")
  protected Period period;

  private static final long serialVersionUID = 561490318L;

  /**
   * Constructor
   */
  public Address() {
    super();
  }

  /**
   * @return {@link #use} (The purpose of this address.). This is the underlying
   *         object with id, value and extensions. The accessor "getUse" gives
   *         direct access to the value
   */
  public Enumeration<AddressUse> getUseElement() {
    if (this.use == null)
      if (Configuration.errorOnAutoCreate())
        throw new Error("Attempt to auto-create Address.use");
      else if (Configuration.doAutoCreate())
        this.use = new Enumeration<AddressUse>(new AddressUseEnumFactory()); // bb
    return this.use;
  }

  public boolean hasUseElement() {
    return this.use != null && !this.use.isEmpty();
  }

  public boolean hasUse() {
    return this.use != null && !this.use.isEmpty();
  }

  /**
   * @param value {@link #use} (The purpose of this address.). This is the
   *              underlying object with id, value and extensions. The accessor
   *              "getUse" gives direct access to the value
   */
  public Address setUseElement(Enumeration<AddressUse> value) {
    this.use = value;
    return this;
  }

  /**
   * @return The purpose of this address.
   */
  public AddressUse getUse() {
    return this.use == null ? null : this.use.getValue();
  }

  /**
   * @param value The purpose of this address.
   */
  public Address setUse(AddressUse value) {
    if (value == null)
      this.use = null;
    else {
      if (this.use == null)
        this.use = new Enumeration<AddressUse>(new AddressUseEnumFactory());
      this.use.setValue(value);
    }
    return this;
  }

  /**
   * @return {@link #type} (Distinguishes between physical addresses (those you
   *         can visit) and mailing addresses (e.g. PO Boxes and care-of
   *         addresses). Most addresses are both.). This is the underlying object
   *         with id, value and extensions. The accessor "getType" gives direct
   *         access to the value
   */
  public Enumeration<AddressType> getTypeElement() {
    if (this.type == null)
      if (Configuration.errorOnAutoCreate())
        throw new Error("Attempt to auto-create Address.type");
      else if (Configuration.doAutoCreate())
        this.type = new Enumeration<AddressType>(new AddressTypeEnumFactory()); // bb
    return this.type;
  }

  public boolean hasTypeElement() {
    return this.type != null && !this.type.isEmpty();
  }

  public boolean hasType() {
    return this.type != null && !this.type.isEmpty();
  }

  /**
   * @param value {@link #type} (Distinguishes between physical addresses (those
   *              you can visit) and mailing addresses (e.g. PO Boxes and care-of
   *              addresses). Most addresses are both.). This is the underlying
   *              object with id, value and extensions. The accessor "getType"
   *              gives direct access to the value
   */
  public Address setTypeElement(Enumeration<AddressType> value) {
    this.type = value;
    return this;
  }

  /**
   * @return Distinguishes between physical addresses (those you can visit) and
   *         mailing addresses (e.g. PO Boxes and care-of addresses). Most
   *         addresses are both.
   */
  public AddressType getType() {
    return this.type == null ? null : this.type.getValue();
  }

  /**
   * @param value Distinguishes between physical addresses (those you can visit)
   *              and mailing addresses (e.g. PO Boxes and care-of addresses).
   *              Most addresses are both.
   */
  public Address setType(AddressType value) {
    if (value == null)
      this.type = null;
    else {
      if (this.type == null)
        this.type = new Enumeration<AddressType>(new AddressTypeEnumFactory());
      this.type.setValue(value);
    }
    return this;
  }

  /**
   * @return {@link #text} (Specifies the entire address as it should be displayed
   *         e.g. on a postal label. This may be provided instead of or as well as
   *         the specific parts.). This is the underlying object with id, value
   *         and extensions. The accessor "getText" gives direct access to the
   *         value
   */
  public StringType getTextElement() {
    if (this.text == null)
      if (Configuration.errorOnAutoCreate())
        throw new Error("Attempt to auto-create Address.text");
      else if (Configuration.doAutoCreate())
        this.text = new StringType(); // bb
    return this.text;
  }

  public boolean hasTextElement() {
    return this.text != null && !this.text.isEmpty();
  }

  public boolean hasText() {
    return this.text != null && !this.text.isEmpty();
  }

  /**
   * @param value {@link #text} (Specifies the entire address as it should be
   *              displayed e.g. on a postal label. This may be provided instead
   *              of or as well as the specific parts.). This is the underlying
   *              object with id, value and extensions. The accessor "getText"
   *              gives direct access to the value
   */
  public Address setTextElement(StringType value) {
    this.text = value;
    return this;
  }

  /**
   * @return Specifies the entire address as it should be displayed e.g. on a
   *         postal label. This may be provided instead of or as well as the
   *         specific parts.
   */
  public String getText() {
    return this.text == null ? null : this.text.getValue();
  }

  /**
   * @param value Specifies the entire address as it should be displayed e.g. on a
   *              postal label. This may be provided instead of or as well as the
   *              specific parts.
   */
  public Address setText(String value) {
    if (Utilities.noString(value))
      this.text = null;
    else {
      if (this.text == null)
        this.text = new StringType();
      this.text.setValue(value);
    }
    return this;
  }

  /**
   * @return {@link #line} (This component contains the house number, apartment
   *         number, street name, street direction, P.O. Box number, delivery
   *         hints, and similar address information.)
   */
  public List<StringType> getLine() {
    if (this.line == null)
      this.line = new ArrayList<StringType>();
    return this.line;
  }

  /**
   * @return Returns a reference to <code>this</code> for easy method chaining
   */
  public Address setLine(List<StringType> theLine) {
    this.line = theLine;
    return this;
  }

  public boolean hasLine() {
    if (this.line == null)
      return false;
    for (StringType item : this.line)
      if (!item.isEmpty())
        return true;
    return false;
  }

  /**
   * @return {@link #line} (This component contains the house number, apartment
   *         number, street name, street direction, P.O. Box number, delivery
   *         hints, and similar address information.)
   */
  public StringType addLineElement() {// 2
    StringType t = new StringType();
    if (this.line == null)
      this.line = new ArrayList<StringType>();
    this.line.add(t);
    return t;
  }

  /**
   * @param value {@link #line} (This component contains the house number,
   *              apartment number, street name, street direction, P.O. Box
   *              number, delivery hints, and similar address information.)
   */
  public Address addLine(String value) { // 1
    StringType t = new StringType();
    t.setValue(value);
    if (this.line == null)
      this.line = new ArrayList<StringType>();
    this.line.add(t);
    return this;
  }

  /**
   * @param value {@link #line} (This component contains the house number,
   *              apartment number, street name, street direction, P.O. Box
   *              number, delivery hints, and similar address information.)
   */
  public boolean hasLine(String value) {
    if (this.line == null)
      return false;
    for (StringType v : this.line)
      if (v.getValue().equals(value)) // string
        return true;
    return false;
  }

  /**
   * @return {@link #city} (The name of the city, town, suburb, village or other
   *         community or delivery center.). This is the underlying object with
   *         id, value and extensions. The accessor "getCity" gives direct access
   *         to the value
   */
  public StringType getCityElement() {
    if (this.city == null)
      if (Configuration.errorOnAutoCreate())
        throw new Error("Attempt to auto-create Address.city");
      else if (Configuration.doAutoCreate())
        this.city = new StringType(); // bb
    return this.city;
  }

  public boolean hasCityElement() {
    return this.city != null && !this.city.isEmpty();
  }

  public boolean hasCity() {
    return this.city != null && !this.city.isEmpty();
  }

  /**
   * @param value {@link #city} (The name of the city, town, suburb, village or
   *              other community or delivery center.). This is the underlying
   *              object with id, value and extensions. The accessor "getCity"
   *              gives direct access to the value
   */
  public Address setCityElement(StringType value) {
    this.city = value;
    return this;
  }

  /**
   * @return The name of the city, town, suburb, village or other community or
   *         delivery center.
   */
  public String getCity() {
    return this.city == null ? null : this.city.getValue();
  }

  /**
   * @param value The name of the city, town, suburb, village or other community
   *              or delivery center.
   */
  public Address setCity(String value) {
    if (Utilities.noString(value))
      this.city = null;
    else {
      if (this.city == null)
        this.city = new StringType();
      this.city.setValue(value);
    }
    return this;
  }

  /**
   * @return {@link #district} (The name of the administrative area (county).).
   *         This is the underlying object with id, value and extensions. The
   *         accessor "getDistrict" gives direct access to the value
   */
  public StringType getDistrictElement() {
    if (this.district == null)
      if (Configuration.errorOnAutoCreate())
        throw new Error("Attempt to auto-create Address.district");
      else if (Configuration.doAutoCreate())
        this.district = new StringType(); // bb
    return this.district;
  }

  public boolean hasDistrictElement() {
    return this.district != null && !this.district.isEmpty();
  }

  public boolean hasDistrict() {
    return this.district != null && !this.district.isEmpty();
  }

  /**
   * @param value {@link #district} (The name of the administrative area
   *              (county).). This is the underlying object with id, value and
   *              extensions. The accessor "getDistrict" gives direct access to
   *              the value
   */
  public Address setDistrictElement(StringType value) {
    this.district = value;
    return this;
  }

  /**
   * @return The name of the administrative area (county).
   */
  public String getDistrict() {
    return this.district == null ? null : this.district.getValue();
  }

  /**
   * @param value The name of the administrative area (county).
   */
  public Address setDistrict(String value) {
    if (Utilities.noString(value))
      this.district = null;
    else {
      if (this.district == null)
        this.district = new StringType();
      this.district.setValue(value);
    }
    return this;
  }

  /**
   * @return {@link #state} (Sub-unit of a country with limited sovereignty in a
   *         federally organized country. A code may be used if codes are in
   *         common use (e.g. US 2 letter state codes).). This is the underlying
   *         object with id, value and extensions. The accessor "getState" gives
   *         direct access to the value
   */
  public StringType getStateElement() {
    if (this.state == null)
      if (Configuration.errorOnAutoCreate())
        throw new Error("Attempt to auto-create Address.state");
      else if (Configuration.doAutoCreate())
        this.state = new StringType(); // bb
    return this.state;
  }

  public boolean hasStateElement() {
    return this.state != null && !this.state.isEmpty();
  }

  public boolean hasState() {
    return this.state != null && !this.state.isEmpty();
  }

  /**
   * @param value {@link #state} (Sub-unit of a country with limited sovereignty
   *              in a federally organized country. A code may be used if codes
   *              are in common use (e.g. US 2 letter state codes).). This is the
   *              underlying object with id, value and extensions. The accessor
   *              "getState" gives direct access to the value
   */
  public Address setStateElement(StringType value) {
    this.state = value;
    return this;
  }

  /**
   * @return Sub-unit of a country with limited sovereignty in a federally
   *         organized country. A code may be used if codes are in common use
   *         (e.g. US 2 letter state codes).
   */
  public String getState() {
    return this.state == null ? null : this.state.getValue();
  }

  /**
   * @param value Sub-unit of a country with limited sovereignty in a federally
   *              organized country. A code may be used if codes are in common use
   *              (e.g. US 2 letter state codes).
   */
  public Address setState(String value) {
    if (Utilities.noString(value))
      this.state = null;
    else {
      if (this.state == null)
        this.state = new StringType();
      this.state.setValue(value);
    }
    return this;
  }

  /**
   * @return {@link #postalCode} (A postal code designating a region defined by
   *         the postal service.). This is the underlying object with id, value
   *         and extensions. The accessor "getPostalCode" gives direct access to
   *         the value
   */
  public StringType getPostalCodeElement() {
    if (this.postalCode == null)
      if (Configuration.errorOnAutoCreate())
        throw new Error("Attempt to auto-create Address.postalCode");
      else if (Configuration.doAutoCreate())
        this.postalCode = new StringType(); // bb
    return this.postalCode;
  }

  public boolean hasPostalCodeElement() {
    return this.postalCode != null && !this.postalCode.isEmpty();
  }

  public boolean hasPostalCode() {
    return this.postalCode != null && !this.postalCode.isEmpty();
  }

  /**
   * @param value {@link #postalCode} (A postal code designating a region defined
   *              by the postal service.). This is the underlying object with id,
   *              value and extensions. The accessor "getPostalCode" gives direct
   *              access to the value
   */
  public Address setPostalCodeElement(StringType value) {
    this.postalCode = value;
    return this;
  }

  /**
   * @return A postal code designating a region defined by the postal service.
   */
  public String getPostalCode() {
    return this.postalCode == null ? null : this.postalCode.getValue();
  }

  /**
   * @param value A postal code designating a region defined by the postal
   *              service.
   */
  public Address setPostalCode(String value) {
    if (Utilities.noString(value))
      this.postalCode = null;
    else {
      if (this.postalCode == null)
        this.postalCode = new StringType();
      this.postalCode.setValue(value);
    }
    return this;
  }

  /**
   * @return {@link #country} (Country - a nation as commonly understood or
   *         generally accepted.). This is the underlying object with id, value
   *         and extensions. The accessor "getCountry" gives direct access to the
   *         value
   */
  public StringType getCountryElement() {
    if (this.country == null)
      if (Configuration.errorOnAutoCreate())
        throw new Error("Attempt to auto-create Address.country");
      else if (Configuration.doAutoCreate())
        this.country = new StringType(); // bb
    return this.country;
  }

  public boolean hasCountryElement() {
    return this.country != null && !this.country.isEmpty();
  }

  public boolean hasCountry() {
    return this.country != null && !this.country.isEmpty();
  }

  /**
   * @param value {@link #country} (Country - a nation as commonly understood or
   *              generally accepted.). This is the underlying object with id,
   *              value and extensions. The accessor "getCountry" gives direct
   *              access to the value
   */
  public Address setCountryElement(StringType value) {
    this.country = value;
    return this;
  }

  /**
   * @return Country - a nation as commonly understood or generally accepted.
   */
  public String getCountry() {
    return this.country == null ? null : this.country.getValue();
  }

  /**
   * @param value Country - a nation as commonly understood or generally accepted.
   */
  public Address setCountry(String value) {
    if (Utilities.noString(value))
      this.country = null;
    else {
      if (this.country == null)
        this.country = new StringType();
      this.country.setValue(value);
    }
    return this;
  }

  /**
   * @return {@link #period} (Time period when address was/is in use.)
   */
  public Period getPeriod() {
    if (this.period == null)
      if (Configuration.errorOnAutoCreate())
        throw new Error("Attempt to auto-create Address.period");
      else if (Configuration.doAutoCreate())
        this.period = new Period(); // cc
    return this.period;
  }

  public boolean hasPeriod() {
    return this.period != null && !this.period.isEmpty();
  }

  /**
   * @param value {@link #period} (Time period when address was/is in use.)
   */
  public Address setPeriod(Period value) {
    this.period = value;
    return this;
  }

  protected void listChildren(List<Property> children) {
    super.listChildren(children);
    children.add(new Property("use", "code", "The purpose of this address.", 0, 1, use));
    children.add(new Property("type", "code",
        "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.",
        0, 1, type));
    children.add(new Property("text", "string",
        "Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.",
        0, 1, text));
    children.add(new Property("line", "string",
        "This component contains the house number, apartment number, street name, street direction,  P.O. Box number, delivery hints, and similar address information.",
        0, java.lang.Integer.MAX_VALUE, line));
    children.add(new Property("city", "string",
        "The name of the city, town, suburb, village or other community or delivery center.", 0, 1, city));
    children.add(new Property("district", "string", "The name of the administrative area (county).", 0, 1, district));
    children.add(new Property("state", "string",
        "Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).",
        0, 1, state));
    children.add(new Property("postalCode", "string",
        "A postal code designating a region defined by the postal service.", 0, 1, postalCode));
    children.add(new Property("country", "string", "Country - a nation as commonly understood or generally accepted.",
        0, 1, country));
    children.add(new Property("period", "Period", "Time period when address was/is in use.", 0, 1, period));
  }

  @Override
  public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws FHIRException {
    switch (_hash) {
    case 116103:
      /* use */ return new Property("use", "code", "The purpose of this address.", 0, 1, use);
    case 3575610:
      /* type */ return new Property("type", "code",
          "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.",
          0, 1, type);
    case 3556653:
      /* text */ return new Property("text", "string",
          "Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.",
          0, 1, text);
    case 3321844:
      /* line */ return new Property("line", "string",
          "This component contains the house number, apartment number, street name, street direction,  P.O. Box number, delivery hints, and similar address information.",
          0, java.lang.Integer.MAX_VALUE, line);
    case 3053931:
      /* city */ return new Property("city", "string",
          "The name of the city, town, suburb, village or other community or delivery center.", 0, 1, city);
    case 288961422:
      /* district */ return new Property("district", "string", "The name of the administrative area (county).", 0, 1,
          district);
    case 109757585:
      /* state */ return new Property("state", "string",
          "Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).",
          0, 1, state);
    case 2011152728:
      /* postalCode */ return new Property("postalCode", "string",
          "A postal code designating a region defined by the postal service.", 0, 1, postalCode);
    case 957831062:
      /* country */ return new Property("country", "string",
          "Country - a nation as commonly understood or generally accepted.", 0, 1, country);
    case -991726143:
      /* period */ return new Property("period", "Period", "Time period when address was/is in use.", 0, 1, period);
    default:
      return super.getNamedProperty(_hash, _name, _checkValid);
    }

  }

  @Override
  public Base[] getProperty(int hash, String name, boolean checkValid) throws FHIRException {
    switch (hash) {
    case 116103:
      /* use */ return this.use == null ? new Base[0] : new Base[] { this.use }; // Enumeration<AddressUse>
    case 3575610:
      /* type */ return this.type == null ? new Base[0] : new Base[] { this.type }; // Enumeration<AddressType>
    case 3556653:
      /* text */ return this.text == null ? new Base[0] : new Base[] { this.text }; // StringType
    case 3321844:
      /* line */ return this.line == null ? new Base[0] : this.line.toArray(new Base[this.line.size()]); // StringType
    case 3053931:
      /* city */ return this.city == null ? new Base[0] : new Base[] { this.city }; // StringType
    case 288961422:
      /* district */ return this.district == null ? new Base[0] : new Base[] { this.district }; // StringType
    case 109757585:
      /* state */ return this.state == null ? new Base[0] : new Base[] { this.state }; // StringType
    case 2011152728:
      /* postalCode */ return this.postalCode == null ? new Base[0] : new Base[] { this.postalCode }; // StringType
    case 957831062:
      /* country */ return this.country == null ? new Base[0] : new Base[] { this.country }; // StringType
    case -991726143:
      /* period */ return this.period == null ? new Base[0] : new Base[] { this.period }; // Period
    default:
      return super.getProperty(hash, name, checkValid);
    }

  }

  @Override
  public Base setProperty(int hash, String name, Base value) throws FHIRException {
    switch (hash) {
    case 116103: // use
      value = new AddressUseEnumFactory().fromType(castToCode(value));
      this.use = (Enumeration) value; // Enumeration<AddressUse>
      return value;
    case 3575610: // type
      value = new AddressTypeEnumFactory().fromType(castToCode(value));
      this.type = (Enumeration) value; // Enumeration<AddressType>
      return value;
    case 3556653: // text
      this.text = castToString(value); // StringType
      return value;
    case 3321844: // line
      this.getLine().add(castToString(value)); // StringType
      return value;
    case 3053931: // city
      this.city = castToString(value); // StringType
      return value;
    case 288961422: // district
      this.district = castToString(value); // StringType
      return value;
    case 109757585: // state
      this.state = castToString(value); // StringType
      return value;
    case 2011152728: // postalCode
      this.postalCode = castToString(value); // StringType
      return value;
    case 957831062: // country
      this.country = castToString(value); // StringType
      return value;
    case -991726143: // period
      this.period = castToPeriod(value); // Period
      return value;
    default:
      return super.setProperty(hash, name, value);
    }

  }

  @Override
  public Base setProperty(String name, Base value) throws FHIRException {
    if (name.equals("use")) {
      value = new AddressUseEnumFactory().fromType(castToCode(value));
      this.use = (Enumeration) value; // Enumeration<AddressUse>
    } else if (name.equals("type")) {
      value = new AddressTypeEnumFactory().fromType(castToCode(value));
      this.type = (Enumeration) value; // Enumeration<AddressType>
    } else if (name.equals("text")) {
      this.text = castToString(value); // StringType
    } else if (name.equals("line")) {
      this.getLine().add(castToString(value));
    } else if (name.equals("city")) {
      this.city = castToString(value); // StringType
    } else if (name.equals("district")) {
      this.district = castToString(value); // StringType
    } else if (name.equals("state")) {
      this.state = castToString(value); // StringType
    } else if (name.equals("postalCode")) {
      this.postalCode = castToString(value); // StringType
    } else if (name.equals("country")) {
      this.country = castToString(value); // StringType
    } else if (name.equals("period")) {
      this.period = castToPeriod(value); // Period
    } else
      return super.setProperty(name, value);
    return value;
  }

  @Override
  public void removeChild(String name, Base value) throws FHIRException {
    if (name.equals("use")) {
      this.use = null;
    } else if (name.equals("type")) {
      this.type = null;
    } else if (name.equals("text")) {
      this.text = null;
    } else if (name.equals("line")) {
      this.getLine().remove(castToString(value));
    } else if (name.equals("city")) {
      this.city = null;
    } else if (name.equals("district")) {
      this.district = null;
    } else if (name.equals("state")) {
      this.state = null;
    } else if (name.equals("postalCode")) {
      this.postalCode = null;
    } else if (name.equals("country")) {
      this.country = null;
    } else if (name.equals("period")) {
      this.period = null;
    } else
      super.removeChild(name, value);
    
  }

  @Override
  public Base makeProperty(int hash, String name) throws FHIRException {
    switch (hash) {
    case 116103:
      return getUseElement();
    case 3575610:
      return getTypeElement();
    case 3556653:
      return getTextElement();
    case 3321844:
      return addLineElement();
    case 3053931:
      return getCityElement();
    case 288961422:
      return getDistrictElement();
    case 109757585:
      return getStateElement();
    case 2011152728:
      return getPostalCodeElement();
    case 957831062:
      return getCountryElement();
    case -991726143:
      return getPeriod();
    default:
      return super.makeProperty(hash, name);
    }

  }

  @Override
  public String[] getTypesForProperty(int hash, String name) throws FHIRException {
    switch (hash) {
    case 116103:
      /* use */ return new String[] { "code" };
    case 3575610:
      /* type */ return new String[] { "code" };
    case 3556653:
      /* text */ return new String[] { "string" };
    case 3321844:
      /* line */ return new String[] { "string" };
    case 3053931:
      /* city */ return new String[] { "string" };
    case 288961422:
      /* district */ return new String[] { "string" };
    case 109757585:
      /* state */ return new String[] { "string" };
    case 2011152728:
      /* postalCode */ return new String[] { "string" };
    case 957831062:
      /* country */ return new String[] { "string" };
    case -991726143:
      /* period */ return new String[] { "Period" };
    default:
      return super.getTypesForProperty(hash, name);
    }

  }

  @Override
  public Base addChild(String name) throws FHIRException {
    if (name.equals("use")) {
      throw new FHIRException("Cannot call addChild on a singleton property Address.use");
    } else if (name.equals("type")) {
      throw new FHIRException("Cannot call addChild on a singleton property Address.type");
    } else if (name.equals("text")) {
      throw new FHIRException("Cannot call addChild on a singleton property Address.text");
    } else if (name.equals("line")) {
      throw new FHIRException("Cannot call addChild on a singleton property Address.line");
    } else if (name.equals("city")) {
      throw new FHIRException("Cannot call addChild on a singleton property Address.city");
    } else if (name.equals("district")) {
      throw new FHIRException("Cannot call addChild on a singleton property Address.district");
    } else if (name.equals("state")) {
      throw new FHIRException("Cannot call addChild on a singleton property Address.state");
    } else if (name.equals("postalCode")) {
      throw new FHIRException("Cannot call addChild on a singleton property Address.postalCode");
    } else if (name.equals("country")) {
      throw new FHIRException("Cannot call addChild on a singleton property Address.country");
    } else if (name.equals("period")) {
      this.period = new Period();
      return this.period;
    } else
      return super.addChild(name);
  }

  public String fhirType() {
    return "Address";

  }

  public Address copy() {
    Address dst = new Address();
    copyValues(dst);
    return dst;
  }

  public void copyValues(Address dst) {
    super.copyValues(dst);
    dst.use = use == null ? null : use.copy();
    dst.type = type == null ? null : type.copy();
    dst.text = text == null ? null : text.copy();
    if (line != null) {
      dst.line = new ArrayList<StringType>();
      for (StringType i : line)
        dst.line.add(i.copy());
    }
    ;
    dst.city = city == null ? null : city.copy();
    dst.district = district == null ? null : district.copy();
    dst.state = state == null ? null : state.copy();
    dst.postalCode = postalCode == null ? null : postalCode.copy();
    dst.country = country == null ? null : country.copy();
    dst.period = period == null ? null : period.copy();
  }

  protected Address typedCopy() {
    return copy();
  }

  @Override
  public boolean equalsDeep(Base other_) {
    if (!super.equalsDeep(other_))
      return false;
    if (!(other_ instanceof Address))
      return false;
    Address o = (Address) other_;
    return compareDeep(use, o.use, true) && compareDeep(type, o.type, true) && compareDeep(text, o.text, true)
        && compareDeep(line, o.line, true) && compareDeep(city, o.city, true) && compareDeep(district, o.district, true)
        && compareDeep(state, o.state, true) && compareDeep(postalCode, o.postalCode, true)
        && compareDeep(country, o.country, true) && compareDeep(period, o.period, true);
  }

  @Override
  public boolean equalsShallow(Base other_) {
    if (!super.equalsShallow(other_))
      return false;
    if (!(other_ instanceof Address))
      return false;
    Address o = (Address) other_;
    return compareValues(use, o.use, true) && compareValues(type, o.type, true) && compareValues(text, o.text, true)
        && compareValues(line, o.line, true) && compareValues(city, o.city, true)
        && compareValues(district, o.district, true) && compareValues(state, o.state, true)
        && compareValues(postalCode, o.postalCode, true) && compareValues(country, o.country, true);
  }

  public boolean isEmpty() {
    return super.isEmpty() && ca.uhn.fhir.util.ElementUtil.isEmpty(use, type, text, line, city, district, state,
        postalCode, country, period);
  }

}