org.jenetics

Enum BitGene

java.lang.Object

java.lang.Enum<BitGene>

org.jenetics.BitGene

All Implemented Interfaces:

Serializable, Comparable<BitGene>, Gene<Boolean,BitGene>, Factory<BitGene>, Verifiable

public enum BitGene
extends Enum<BitGene>
implements Gene<Boolean,BitGene>, Comparable<BitGene>, Serializable

Implementation of a BitGene.

Since:

1.0

Version:

2.0

Author:

Franz Wilhelmstötter

Enum Constant Summary

Enum Constants

Enum Constant and Description
FALSE
TRUE

Field Summary

Fields

Modifier and Type	Field and Description
static BitGene	ONE
static BitGene	ZERO

Method Summary

Modifier and Type	Method and Description
boolean	booleanValue() Return the boolean value of this gene.
Boolean	getAllele() Return the allele of this gene.
boolean	getBit() Return the value of the BitGene.
boolean	isValid() Return always true.
BitGene	newInstance() Create a new, random gene.
BitGene	newInstance(Boolean value) Create a new gene from the given value..
static BitGene	of(boolean value) Return the corresponding BitGene for the given boolean value.
String	toString()
static BitGene	valueOf(String name) Returns the enum constant of this type with the specified name.
static BitGene[]	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

Methods inherited from interface org.jenetics.util.Factory

instances

Methods inherited from interface java.lang.Comparable

compareTo

Enum Constant Detail

FALSE

public static final BitGene FALSE

TRUE

public static final BitGene TRUE

Field Detail

ZERO

public static final BitGene ZERO

ONE

public static final BitGene ONE

Method Detail

values

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

Returns:

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

valueOf

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

getBit

public final boolean getBit()

Return the value of the BitGene.

Returns:

The value of the BitGene.

booleanValue

public boolean booleanValue()

Return the boolean value of this gene.

Returns:

the boolean value of this gene.

See Also:

getAllele()

getAllele

public Boolean getAllele()

Description copied from interface: Gene

Return the allele of this gene.

Specified by:

getAllele in interface Gene<Boolean,BitGene>

Returns:

the allele of this gene.

isValid

public boolean isValid()

Return always true.

Specified by:

isValid in interface Verifiable

Returns:

always true.

newInstance

public BitGene newInstance()

Create a new, random gene.

Specified by:

newInstance in interface Gene<Boolean,BitGene>

Specified by:

newInstance in interface Factory<BitGene>

Returns:

a new instance of type T

newInstance

public BitGene newInstance(Boolean value)

Create a new gene from the given value..

Specified by:

newInstance in interface Gene<Boolean,BitGene>

Parameters:

value - the value of the new gene.

Returns:

a new gene with the given value.

Since:

1.6

toString

public String toString()

Overrides:

toString in class Enum<BitGene>

of

public static BitGene of(boolean value)

Return the corresponding BitGene for the given boolean value.

Parameters:

value - the value of the returned BitGene.

Returns:

the BitGene for the given boolean value.