Enum Class ArmOption

Javadoc 27 generates this reference during each site build from the exported packages and the annotation processor. The Java guide shows the API in use.

java.lang.Object

java.lang.Enum<ArmOption>

dev.gecode.iris.build.ArmOption

All Implemented Interfaces:

Serializable, Comparable<ArmOption>, Constable

public enum ArmOption extends Enum<ArmOption>

An option of a sections arm.

• Nested Class Summary

  Nested classes/interfaces inherited from class Enum

  Enum.EnumDesc<E>

• Enum Constant Summary

  Enum Constants

  Enum Constant

  Description

  LAST

  last: the sections end after this arm.

  OPTIONAL

  optional: the arm may not match, so what it defines may be absent.

• Method Summary

  Modifier and Type

  Method

  Description

  static ArmOption

  valueOf(String name)

  Returns the enum constant of this class with the specified name.

  static ArmOption[]

  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

  • OPTIONAL

    public static final ArmOption OPTIONAL

    optional: the arm may not match, so what it defines may be absent.

  • LAST

    public static final ArmOption LAST

    last: the sections end after this arm.

• Method Details

  • values

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