Package org.geotools.api.util

Interface LocalName

All Superinterfaces:
Comparable<GenericName>, GenericName
All Known Subinterfaces:
MemberName, TypeName
All Known Implementing Classes:
LocalName
public interface LocalName extends GenericName
Identifier within a name space for a local object. Local names are names which are directly accessible to and maintained by a name space. Names are local to one and only one name space. The name space within which they are local is indicated by the scope.
Since:
GeoAPI 2.0
Author:
Martin Desruisseaux (IRD), Bryce Nordgren (USDA)
See Also:

  • Method Details

    • depth

      int depth()
      Returns the depth, which is always 1 for a local name.
      Specified by:
      depth in interface GenericName
      Returns:
      The depth of this name.

    • getParsedNames

      List<? extends LocalName> getParsedNames()
      Returns the sequence of local name. Since this object is itself a locale name, this method always returns a singleton containing only this.
      Specified by:
      getParsedNames in interface GenericName
      Returns:
      The local names making this generic name, without the scope. Shall never be null neither empty.

    • head

      LocalName head()
      Returns this since this object is already a local name.
      Specified by:
      head in interface GenericName
      Returns:
      The first element in the list of parsed names.
      Since:
      GeoAPI 2.2

    • tip

      LocalName tip()
      Returns this since this object is already a local name.
      Specified by:
      tip in interface GenericName
      Returns:
      The last element in the list of parsed names.
      Since:
      GeoAPI 2.1

    • toString

      String toString()
      Returns a locale-independant string representation of this local name.
      Specified by:
      toString in interface GenericName
      Overrides:
      toString in class Object
      Returns:
      A local-independant string representation of this name.