org.grouplens.grapht.context

Enum Multiplicity

java.lang.Object

java.lang.Enum<Multiplicity>

org.grouplens.grapht.context.Multiplicity

All Implemented Interfaces:

Serializable, Comparable<Multiplicity>

public enum Multiplicity
extends Enum<Multiplicity>

Multiplicity of element matches - how many times may/must an element match?

Author:

GroupLens Research

Enum Constant Summary

Enum Constants

Enum Constant and Description
ONE Match exactly once.
ZERO_OR_MORE Match zero or more times.

Method Summary

Modifier and Type	Method and Description
abstract boolean	isConsumed()
abstract boolean	isOptional()
static Multiplicity	valueOf(String name) Returns the enum constant of this type with the specified name.
static Multiplicity[]	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

ONE

public static final Multiplicity ONE

Match exactly once.

ZERO_OR_MORE

public static final Multiplicity ZERO_OR_MORE

Match zero or more times.

Method Detail

values

public static Multiplicity[] 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 (Multiplicity c : Multiplicity.values())
    System.out.println(c);

Returns:

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

valueOf

public static Multiplicity 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

isOptional

public abstract boolean isOptional()

isConsumed

public abstract boolean isConsumed()