de.gold.scim.common.resources.complex.Address Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scim-common Show documentation
The newest version!
package de.gold.scim.common.resources.complex;

import java.util.Optional;

import de.gold.scim.common.constants.AttributeNames;
import de.gold.scim.common.resources.base.ScimObjectNode;
import lombok.Builder;


/**
 * author Pascal Knueppel 

 * created at: 11.10.2019 - 12:36 

 * 

 * A physical mailing address for this user. Canonical type values of "work", "home", and "other". This
 * attribute is a complex type with the following sub-attributes. All sub-attributes are OPTIONAL.
 */
public class Address extends ScimObjectNode
{

  public Address()
  {
    super(null);
  }

  @Builder
  public Address(String formatted,
                 String streetAddress,
                 String locality,
                 String region,
                 String postalCode,
                 String country)
  {
    this();
    setFormatted(formatted);
    setStreetAddress(streetAddress);
    setLocality(locality);
    setRegion(region);
    setPostalCode(postalCode);
    setCountry(country);
  }

  /**
   * The full mailing address, formatted for display or use with a mailing label. This attribute MAY contain
   * newlines.
   */
  public Optional getFormatted()
  {
    return getStringAttribute(AttributeNames.RFC7643.FORMATTED);
  }

  /**
   * The full mailing address, formatted for display or use with a mailing label. This attribute MAY contain
   * newlines.
   */
  public void setFormatted(String formatted)
  {
    setAttribute(AttributeNames.RFC7643.FORMATTED, formatted);
  }

  /**
   * The full street address component, which may include house number, street name, P.O. box, and multi-line
   * extended street address information. This attribute MAY contain newlines.
   */
  public Optional getStreetAddress()
  {
    return getStringAttribute(AttributeNames.RFC7643.STREET_ADDRESS);
  }

  /**
   * The full street address component, which may include house number, street name, P.O. box, and multi-line
   * extended street address information. This attribute MAY contain newlines.
   */
  public void setStreetAddress(String streetAddress)
  {
    setAttribute(AttributeNames.RFC7643.STREET_ADDRESS, streetAddress);
  }

  /**
   * The city or locality component.
   */
  public Optional getLocality()
  {
    return getStringAttribute(AttributeNames.RFC7643.LOCALITY);
  }

  /**
   * The city or locality component.
   */
  public void setLocality(String locality)
  {
    setAttribute(AttributeNames.RFC7643.LOCALITY, locality);
  }

  /**
   * The state or region component.
   */
  public Optional getRegion()
  {
    return getStringAttribute(AttributeNames.RFC7643.REGION);
  }

  /**
   * The state or region component.
   */
  public void setRegion(String region)
  {
    setAttribute(AttributeNames.RFC7643.REGION, region);
  }

  /**
   * The zip code or postal code component.
   */
  public Optional getPostalCode()
  {
    return getStringAttribute(AttributeNames.RFC7643.POSTAL_CODE);
  }

  /**
   * The zip code or postal code component.
   */
  public void setPostalCode(String postalCode)
  {
    setAttribute(AttributeNames.RFC7643.POSTAL_CODE, postalCode);
  }

  /**
   * The country name component. When specified, the value MUST be in ISO 3166-1 "alpha-2" code format
   * [ISO3166]; e.g., the United States and Sweden are "US" and "SE", respectively.
   */
  public Optional getCountry()
  {
    return getStringAttribute(AttributeNames.RFC7643.COUNTRY);
  }

  /**
   * The country name component. When specified, the value MUST be in ISO 3166-1 "alpha-2" code format
   * [ISO3166]; e.g., the United States and Sweden are "US" and "SE", respectively.
   */
  public void setCountry(String country)
  {
    setAttribute(AttributeNames.RFC7643.COUNTRY, country);
  }
}