CharacterGene (Jenetics 3.5.0)

java.lang.Object
- org.jenetics.CharacterGene

All Implemented Interfaces:

Serializable, Comparable<CharacterGene>, Gene<Character,CharacterGene>, Factory<CharacterGene>, Verifiable
```
public final class CharacterGene
extends Object
implements Gene<Character,CharacterGene>, Comparable<CharacterGene>, Serializable
```
Character gene implementation.
This is a value-based class; use of identity-sensitive operations (including reference equality (==), identity hash code, or synchronization) on instances of CharacterGene may have unpredictable results and should be avoided.

Since:

1.0

Version:

2.0

Author:

Franz Wilhelmstötter

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static CharSeq DEFAULT_CHARACTERS
The default character set used by this gene.

Fields
Modifier and Type	Field and Description
`static CharSeq`	`DEFAULT_CHARACTERS` The default character set used by this gene.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`char`	`charValue()` Return the `char` value of this character gene.
`int`	`compareTo(CharacterGene that)`
`boolean`	`equals(Object obj)`
`Character`	`getAllele()` Return the allele of this gene.
`CharSeq`	`getValidCharacters()` Return a (unmodifiable) set of valid characters.
`int`	`hashCode()`
`boolean`	`isValid()` Check if this object is valid.
`boolean`	`isValidCharacter(Character character)` Test, if the given character is valid.
`CharacterGene`	`newInstance()` Return a new, random gene with the same type and with the same constraints than this gene.
`CharacterGene`	`newInstance(Character character)` Create a new character gene from the given character.
`static CharacterGene`	`of()` Create a new random character gene, chosen from the `DEFAULT_CHARACTERS`.
`static CharacterGene`	`of(Character character)` Create a new character gene from the given character.
`static CharacterGene`	`of(char character, CharSeq validCharacters)` Create a new CharacterGene from the give character.
`static CharacterGene`	`of(CharSeq validCharacters)` Create a new CharacterGene with a randomly chosen character from the set of valid characters.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jenetics.util.Factory
instances

- Field Detail
  - DEFAULT_CHARACTERS
```
public static final CharSeq DEFAULT_CHARACTERS
```
    The default character set used by this gene.
- Method Detail
  - isValid
```
public boolean isValid()
```
    Description copied from interface: Verifiable
    
    Check if this object is valid.
    
    Specified by:
    
    isValid in interface Verifiable
    
    Returns:
    
    true if this object is valid, false otherwise.
  - getAllele
```
public Character getAllele()
```
    Description copied from interface: Gene
    
    Return the allele of this gene.
    
    Specified by:
    
    getAllele in interface Gene<Character,CharacterGene>
    
    Returns:
    
    the allele of this gene.
  - charValue
```
public char charValue()
```
    Return the char value of this character gene.
    
    Returns:
    
    the char value.
  - isValidCharacter
```
public boolean isValidCharacter(Character character)
```
    Test, if the given character is valid.
    
    Parameters:
    
    character - The character to test.
    
    Returns:
    
    true if the character is valid, false otherwise.
  - getValidCharacters
```
public CharSeq getValidCharacters()
```
    Return a (unmodifiable) set of valid characters.
    
    Returns:
    
    the CharSeq of valid characters.
  - compareTo
```
public int compareTo(CharacterGene that)
```
    Specified by:
    
    compareTo in interface Comparable<CharacterGene>
    
    Parameters:
    
    that - The other gene to compare.
    
    Returns:
    
    the value 0 if the argument Character is equal to this Character; a value less than 0 if this Character is numerically less than the Character argument; and a value greater than 0 if this Character is numerically greater than the Character argument (unsigned comparison). Note that this is strictly a numerical comparison; it is not local-dependent.
    
    See Also:
    
    Character.compareTo(java.lang.Character)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - newInstance
```
public CharacterGene newInstance()
```
    Description copied from interface: Gene
    
    Return a new, random gene with the same type and with the same constraints than this gene. For all genes returned by this method holds gene.getClass() == gene.newInstance().getClass(). Implementations of this method has to use the Random object which can be fetched from the RandomRegistry.
    
    Specified by:
    
    newInstance in interface Gene<Character,CharacterGene>
    
    Specified by:
    
    newInstance in interface Factory<CharacterGene>
    
    Returns:
    
    a new instance of type T
  - newInstance
```
public CharacterGene newInstance(Character character)
```
    Create a new character gene from the given character. If the character is not within the getValidCharacters(), an invalid gene will be created.
    
    Specified by:
    
    newInstance in interface Gene<Character,CharacterGene>
    
    Parameters:
    
    character - the character value of the created gene.
    
    Returns:
    
    a new character gene.
    
    Throws:
    
    NullPointerException - if the given character is null.
  - of
```
public static CharacterGene of(CharSeq validCharacters)
```
    Create a new CharacterGene with a randomly chosen character from the set of valid characters.
    
    Parameters:
    
    validCharacters - the valid characters for this gene.
    
    Returns:
    
    a new valid, random gene,
    
    Throws:
    
    NullPointerException - if the validCharacters are null.
  - of
```
public static CharacterGene of(Character character)
```
    Create a new character gene from the given character. If the character is not within the DEFAULT_CHARACTERS, an invalid gene will be created.
    
    Parameters:
    
    character - the character value of the created gene.
    
    Returns:
    
    a new character gene.
    
    Throws:
    
    NullPointerException - if the given character is null.
  - of
```
public static CharacterGene of()
```
    Create a new random character gene, chosen from the DEFAULT_CHARACTERS.
    
    Returns:
    
    a new random character gene.
  - of
```
public static CharacterGene of(char character,
                               CharSeq validCharacters)
```
    Create a new CharacterGene from the give character.
    
    Parameters:
    
    character - The allele.
    
    validCharacters - the valid characters fo the new gene
    
    Returns:
    
    a new CharacterGene with the given parameter
    
    Throws:
    
    NullPointerException - if one of the arguments is null.
    
    IllegalArgumentException - if the validCharacters are empty.

Class CharacterGene

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.jenetics.util.Factory

Field Detail

DEFAULT_CHARACTERS

Method Detail

isValid

getAllele

charValue

isValidCharacter

getValidCharacters

compareTo

hashCode

equals

toString

newInstance

newInstance

of

of

of

of