forestry.api.circuits

Enum CircuitSocketType

java.lang.Object

java.lang.Enum<CircuitSocketType>

forestry.api.circuits.CircuitSocketType

All Implemented Interfaces:

ICircuitSocketType, java.io.Serializable, java.lang.Comparable<CircuitSocketType>

public enum CircuitSocketType
extends java.lang.Enum<CircuitSocketType>
implements ICircuitSocketType

Enum Constant Summary

Enum Constants

Enum Constant and Description
ELECTRIC_ENGINE
FARM
MACHINE
NONE

Method Summary

Modifier and Type	Method and Description
boolean	equals(ICircuitSocketType socketType) comparison using uid
java.lang.String	getUid() unique identifier for this socket type
static CircuitSocketType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CircuitSocketType[]	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

NONE

public static final CircuitSocketType NONE

FARM

public static final CircuitSocketType FARM

ELECTRIC_ENGINE

public static final CircuitSocketType ELECTRIC_ENGINE

MACHINE

public static final CircuitSocketType MACHINE

Method Detail

values

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

Returns:

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

valueOf

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

getUid

public java.lang.String getUid()

Description copied from interface: ICircuitSocketType

unique identifier for this socket type

Specified by:

getUid in interface ICircuitSocketType

equals

public boolean equals(ICircuitSocketType socketType)

Description copied from interface: ICircuitSocketType

comparison using uid

Specified by:

equals in interface ICircuitSocketType