Module gov.nist.secauto.metaschema.core

Package gov.nist.secauto.metaschema.core.metapath.function

Enum Occurrence

java.lang.Object

java.lang.Enum<Occurrence>

gov.nist.secauto.metaschema.core.metapath.function.Occurrence

All Implemented Interfaces:

Serializable, Comparable<Occurrence>

public enum Occurrence
extends Enum<Occurrence>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ONE	No occurrence indicator.
ONE_OR_MORE	The occurrence indicator "+".
ZERO	An empty sequence.
ZERO_OR_MORE	The occurrence indicator "*".
ZERO_OR_ONE	The occurrence indicator "?".

Method Summary

Modifier and Type	Method	Description
String	getIndicator()	Get the occurrence indicator to use in the signature string for the argument.
boolean	isOptional()	Determine if providing a value is optional based on the occurrence.
static Occurrence	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Occurrence[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ZERO

public static final Occurrence ZERO

An empty sequence.

ZERO_OR_ONE

public static final Occurrence ZERO_OR_ONE

The occurrence indicator "?".

ONE

public static final Occurrence ONE

No occurrence indicator.

ZERO_OR_MORE

public static final Occurrence ZERO_OR_MORE

The occurrence indicator "*".

ONE_OR_MORE

public static final Occurrence ONE_OR_MORE

The occurrence indicator "+".

Method Detail

values

public static Occurrence[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Occurrence c : Occurrence.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Occurrence valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getIndicator

public String getIndicator()

Get the occurrence indicator to use in the signature string for the argument.

Returns:

the occurrence indicator

isOptional

public boolean isOptional()

Determine if providing a value is optional based on the occurrence.

Returns:

true if providing a value is optional or false if required