com.sun.electric.database.variable
Enum CodeExpression.Code

java.lang.Object
  java.lang.Enum<CodeExpression.Code>
      com.sun.electric.database.variable.CodeExpression.Code

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CodeExpression.Code>

Enclosing class:

CodeExpression

public static enum CodeExpression.Code
extends java.lang.Enum<CodeExpression.Code>

The type of Code that determines how this Variable's value should be evaluated. If NONE, no evaluation is done.

Enum Constant Summary

JAVA
Indicator that code is in Java.

NONE
Indicator that this is not code.

SPICE
Indicator that code is in Lisp.

TCL
Indicator that code is in TCL.

Method Summary

static CodeExpression.Code	getByCBits(int cBits) Method to convert a bits value to a Code object.
static CodeExpression.Code	getByOrdinal(int ordinal) Method to get a Code constant by its ordinal number.
int	getCFlags() Method to return the bits value of this code type.
static java.util.Iterator<CodeExpression.Code>	getCodes() Method to get an iterator over all Code types.
java.lang.String	toString() Method to return a printable version of this Code.
static CodeExpression.Code	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CodeExpression.Code[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

JAVA

public static final CodeExpression.Code JAVA

Indicator that code is in Java.

SPICE

public static final CodeExpression.Code SPICE

Indicator that code is in Lisp.

TCL

public static final CodeExpression.Code TCL

Indicator that code is in TCL.

NONE

public static final CodeExpression.Code NONE

Indicator that this is not code.

Method Detail

values

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

Returns:

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

valueOf

public static CodeExpression.Code valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getCFlags

public int getCFlags()

Method to return the bits value of this code type. This is used in I/O.

Returns:

the bits value of this code type.

toString

public java.lang.String toString()

Method to return a printable version of this Code.

Overrides:

toString in class java.lang.Enum<CodeExpression.Code>

Returns:

a printable version of this Code.

getCodes

public static java.util.Iterator<CodeExpression.Code> getCodes()

Method to get an iterator over all Code types.

getByCBits

public static CodeExpression.Code getByCBits(int cBits)

Method to convert a bits value to a Code object.

Parameters:

cBits - the bits value (from I/O).

Returns:

the Code associated with those bits.

getByOrdinal

public static CodeExpression.Code getByOrdinal(int ordinal)

Method to get a Code constant by its ordinal number.

Parameters:

ordinal - the ordinal number of this Code constant ( as returned by ordinal()

Returns:

the Code associated with this ordinal number.