Package org.apache.tinkerpop.gremlin.process.traversal.strategy.util

Enum StepOutputArityPredictor.Arity

java.lang.Object

java.lang.Enum<StepOutputArityPredictor.Arity>

org.apache.tinkerpop.gremlin.process.traversal.strategy.util.StepOutputArityPredictor.Arity

All Implemented Interfaces:

Serializable, Comparable<StepOutputArityPredictor.Arity>

Enclosing class:

StepOutputArityPredictor

public static enum StepOutputArityPredictor.Arity
extends Enum<StepOutputArityPredictor.Arity>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFINITELY_SINGULAR	This enum value tells that the output arity of the step will be singular definitely.
MAY_BE_SINGULAR	This enum value tells that the output arity of the step could be singular at best.
MULTI	This enum value tells that the output arity of the step is multiple.

Method Summary

Modifier and Type	Method	Description
StepOutputArityPredictor.Arity	computeArity(StepOutputArityPredictor.Arity operandArity)
int	getPriority()
static StepOutputArityPredictor.Arity	valueOf(String name)	Returns the enum constant of this type with the specified name.
static StepOutputArityPredictor.Arity[]	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

MAY_BE_SINGULAR

public static final StepOutputArityPredictor.Arity MAY_BE_SINGULAR

This enum value tells that the output arity of the step could be singular at best. For example: HasStep. HasStep can have atmost 1 output coming out after its execution. But it would never increase the cardinality of the output

DEFINITELY_SINGULAR

public static final StepOutputArityPredictor.Arity DEFINITELY_SINGULAR

This enum value tells that the output arity of the step will be singular definitely. For examples: IdentityStep, IDStep, ValueMapStep.

MULTI

public static final StepOutputArityPredictor.Arity MULTI

This enum value tells that the output arity of the step is multiple. For example: out(), in() unfold etc.

Method Detail

values

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

Returns:

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

valueOf

public static StepOutputArityPredictor.Arity 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

getPriority

public int getPriority()

computeArity

public StepOutputArityPredictor.Arity computeArity(StepOutputArityPredictor.Arity operandArity)