Package dev.metaschema.oscal.lib.model

Class Address

java.lang.Object
dev.metaschema.oscal.lib.model.Address
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Address", description="A postal address for the location.", name="address", moduleClass=OscalMetadataModule.class) public class Address extends Object implements dev.metaschema.core.model.IBoundObject
A postal address for the location.

  • Constructor Details

    • Address

      public Address()
      Constructs a new dev.metaschema.oscal.lib.model.Address instance with no metadata.

    • Address

      public Address(dev.metaschema.core.model.IMetaschemaData data)
      Constructs a new dev.metaschema.oscal.lib.model.Address instance with the specified metadata.
      Parameters:
      data - the metaschema data, or null if none

  • Method Details

    • getMetaschemaData

      public dev.metaschema.core.model.IMetaschemaData getMetaschemaData()
      Specified by:
      getMetaschemaData in interface dev.metaschema.core.model.IBoundObject

    • getType

      @Nullable public String getType()
      Get the "Address Type".

      Indicates the type of address.

      Returns:
      the type value, or null if not set

    • setType

      public void setType(@Nullable String value)
      Set the "Address Type".

      Indicates the type of address.

      Parameters:
      value - the type value to set, or null to clear

    • getAddrLines

      @NonNull public List<String> getAddrLines()
      Get the "Address line".

      A single line of an address.

      Returns:
      the addr-line value

    • setAddrLines

      public void setAddrLines(@NonNull List<String> value)
      Set the "Address line".

      A single line of an address.

      Parameters:
      value - the addr-line value to set

    • addAddrLine

      public boolean addAddrLine(String item)
      Add a new String item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removeAddrLine

      public boolean removeAddrLine(String item)
      Remove the first matching String item from the underlying collection.
      Parameters:
      item - the item to remove
      Returns:
      true if the item was removed or false otherwise

    • getCity

      @Nullable public String getCity()
      Get the "City".

      City, town or geographical region for the mailing address.

      Returns:
      the city value, or null if not set

    • setCity

      public void setCity(@Nullable String value)
      Set the "City".

      City, town or geographical region for the mailing address.

      Parameters:
      value - the city value to set, or null to clear

    • getState

      @Nullable public String getState()
      Get the "State".

      State, province or analogous geographical region for a mailing address.

      Returns:
      the state value, or null if not set

    • setState

      public void setState(@Nullable String value)
      Set the "State".

      State, province or analogous geographical region for a mailing address.

      Parameters:
      value - the state value to set, or null to clear

    • getPostalCode

      @Nullable public String getPostalCode()
      Get the "Postal Code".

      Postal or ZIP code for mailing address.

      Returns:
      the postal-code value, or null if not set

    • setPostalCode

      public void setPostalCode(@Nullable String value)
      Set the "Postal Code".

      Postal or ZIP code for mailing address.

      Parameters:
      value - the postal-code value to set, or null to clear

    • getCountry

      @Nullable public String getCountry()
      Get the "Country Code".

      The ISO 3166-1 alpha-2 country code for the mailing address.

      Returns:
      the country value, or null if not set

    • setCountry

      public void setCountry(@Nullable String value)
      Set the "Country Code".

      The ISO 3166-1 alpha-2 country code for the mailing address.

      Parameters:
      value - the country value to set, or null to clear

    • toString

      public String toString()
      Overrides:
      toString in class Object