Module org.osgeo.proj

Package org.osgeo.proj

Enum Class ComparisonCriterion

Object

Enum<ComparisonCriterion>

ComparisonCriterion

All Implemented Interfaces:

Serializable, Comparable<ComparisonCriterion>, Constable

public enum ComparisonCriterion
extends Enum<ComparisonCriterion>

The criterion to use for comparing PROJ objects.

Since:

1.0

See Also:

• Proj.areEquivalent(Object, Object, ComparisonCriterion)
• PROJ C++ API

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EQUIVALENT	The objects are equivalent for the purpose of coordinate operations.
EQUIVALENT_EXCEPT_AXIS_ORDER_GEOGCRS	Same as EQUIVALENT, relaxed with an exception that the axis order of the base CRS of a DerivedCRS/ProjectedCRS or the axis order of a GeographicCRS is ignored.
STRICT	All properties are identical.

Method Summary

Modifier and Type	Method	Description
static ComparisonCriterion	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ComparisonCriterion[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

STRICT

public static final ComparisonCriterion STRICT

All properties are identical.

EQUIVALENT

public static final ComparisonCriterion EQUIVALENT

The objects are equivalent for the purpose of coordinate operations. They can differ by the name of their objects, identifiers, other metadata. Parameters may be expressed in different units, provided that the value is (with some tolerance) the same once expressed in a common unit.

EQUIVALENT_EXCEPT_AXIS_ORDER_GEOGCRS

public static final ComparisonCriterion EQUIVALENT_EXCEPT_AXIS_ORDER_GEOGCRS

Same as EQUIVALENT, relaxed with an exception that the axis order of the base CRS of a DerivedCRS/ProjectedCRS or the axis order of a GeographicCRS is ignored. Only to be used with DerivedCRS, ProjectedCRS or GeographicCRS.

Method Details

values

public static ComparisonCriterion[] 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 ComparisonCriterion 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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null