Enum Class CRS.SeparationMode

Object
Enum<CRS.SeparationMode>
SeparationMode
All Implemented Interfaces:
Serializable, Comparable<CRS​.Separation­Mode>, Constable
Enclosing class:
CRS
public static enum CRS.SeparationMode extends Enum<CRS.SeparationMode>
Action to take when a CRS cannot be separated in components at the requested dimensions. For example, a two-dimensional geographic CRS cannot be separated in a CRS containing only the latitude or only the longitude axis. If only the first dimension of such geographic CRS is requested, the action can be to throw an exception (EXACT), omit the unseparable geographic CRS from the separation result (OMIT_UNSEPARABLE), or keep the whole geographic CRS with all its dimensions (WHOLE_UNSEPARABLE).
Since:
1.6
See Also:

  • Enum Constant Details

    • EXACT

      public static final CRS.SeparationMode EXACT
      Separation result must contain exactly the requested dimensions. If the request cannot be satisfied, then a Factory­Exception will be throw.

    • OMIT_UNSEPARABLE

      public static final CRS.SeparationMode OMIT_UNSEPARABLE
      Separation result contains only the components that can satisfy the requested dimensions. If a CRS cannot be separated in components at the requested dimensions, that CRS is excluded from the result. In other words, the result does not contain any dimension that was not requested, but some requested dimensions may be ignored.

    • WHOLE_UNSEPARABLE

      public static final CRS.SeparationMode WHOLE_UNSEPARABLE
      Separation result contains components for all the requested dimensions. The result contains all requested dimensions, but may also contain some dimensions that were not requested.

  • Method Details

    • values

      public static CRS.SeparationMode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static CRS.SeparationMode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      Illegal­Argument­Exception - if this enum class has no constant with the specified name
      Null­Pointer­Exception - if the argument is null