Module org.opengis.geoapi

Package org.opengis.parameter

Enum Class ParameterDirection

Object

Enum<ParameterDirection>

ParameterDirection

All Implemented Interfaces:

Serializable, Comparable<ParameterDirection>, Constable, ControlledVocabulary

@UML(identifier="SV_ParameterDirection",
     specification=ISO_19115)
public enum ParameterDirection
extends Enum<ParameterDirection>
implements ControlledVocabulary

Class of information to which the referencing entity applies.

Since:

3.1

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
IN	The parameter is an input parameter to the service instance.
IN_OUT	The parameter is both an input and output parameter to the service instance.
OUT	The parameter is an output parameter to the service instance.

Method Summary

Modifier and Type	Method	Description
ParameterDirection[]	family()	Returns all constants defined by this enumeration type.
String	identifier()	Returns the UML identifier for this enumeration constant.
String[]	names()	Returns the programmatic name of this constant together with its identifier.
static ParameterDirection	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ParameterDirection[]	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

Methods inherited from interface ControlledVocabulary

name, ordinal

Enum Constant Details

IN

@UML(identifier="in",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ParameterDirection IN

The parameter is an input parameter to the service instance.

OUT

@UML(identifier="out",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ParameterDirection OUT

The parameter is an output parameter to the service instance.

IN_OUT

@UML(identifier="in/out",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ParameterDirection IN_OUT

The parameter is both an input and output parameter to the service instance.

Method Details

values

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

identifier

public String identifier()

Returns the UML identifier for this enumeration constant.

Specified by:

identifier in interface ControlledVocabulary

Returns:

the ISO/OGC identifier for this constant, or null if none.

names

public String[] names()

Returns the programmatic name of this constant together with its identifier.

Specified by:

names in interface ControlledVocabulary

Returns:

all names of this constant. This array is never null and never empty.

family

public ParameterDirection[] family()

Returns all constants defined by this enumeration type. Invoking this method is equivalent to invoking values(), except that this method can be invoked on an instance of the ControlledVocabulary interface (i.e. the enumeration type does not need to be known at compile-time).

Specified by:

family in interface ControlledVocabulary

Returns:

all values for this enumeration.