Class DeprecatedName

All Implemented Interfaces:
Serializable, Comparable<org.opengis.util.GenericName>, Deprecable, org.opengis.metadata.Identifier, org.opengis.referencing.ReferenceIdentifier, org.opengis.util.GenericName

public final class DeprecatedName extends NamedIdentifier implements Deprecable
A deprecated name. This is used mostly for names which were used in legacy versions of the EPSG database.
Implementation note: this class opportunistically recycles the description property into a remarks property. This is a lazy way to inherit NamedIdentifier.equals(Object) and NamedIdentifier.hashCode() implementations without adding code in this class for taking in account a new field.
Since:
0.6
Version:
0.7
See Also:
  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      For cross-version compatibility.
      See Also:
  • Constructor Details

    • DeprecatedName

      public DeprecatedName(org.opengis.metadata.citation.Citation authority, String codeSpace, CharSequence code, String version, org.opengis.util.InternationalString remarks)
      Creates a new deprecated EPSG name.
      Parameters:
      authority - Organization or party responsible for definition and maintenance of the name.
      codeSpace - Name or identifier of the person or organization responsible for namespace.
      code - Name, optionally from a controlled list or pattern defined by a namespace.
      version - The version of the associated namespace or name as specified by the code authority, or null if none.
      remarks - Comments on or information about why this name is deprecated, or null if none.
  • Method Details

    • isDeprecated

      public boolean isDeprecated()
      Returns true since this name is deprecated.
      Specified by:
      isDeprecated in interface Deprecable
      Returns:
      true.
    • getRemarks

      public org.opengis.util.InternationalString getRemarks()
      Information about the replacement for this name.
      Example: "superseded by code XYZ".
      Specified by:
      getRemarks in interface Deprecable
      Returns:
      information about the replacement for this name, or null if none.
    • getDescription

      public org.opengis.util.InternationalString getDescription()
      Returns null, since we used the description for the superseded information. See "Implementation note" in class javadoc.
      Overrides:
      getDescription in class ImmutableIdentifier
      Returns:
      null.