Module io.jenetics.base
Package io.jenetics

Class CharacterGene

java.lang.Object
io.jenetics.CharacterGene
All Implemented Interfaces:
Gene<Character,CharacterGene>, Factory<CharacterGene>, Self<CharacterGene>, Verifiable, Serializable, Comparable<CharacterGene>
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:
6.0
See Also:
Implementation Note:
This class is immutable and thread-safe.

  • Field Details

  • Method Details

    • 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.

    • allele

      public Character allele()
      Description copied from interface: Gene
      Return the allele of this gene.
      Specified by:
      allele 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 allele)
      Test, if the given character is valid.
      Parameters:
      allele - The character to test.
      Returns:
      true if the character is valid, false otherwise.

    • validChars

      public CharSeq validChars()
      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:
      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:

    • 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 as this gene. For all genes returned by this method holds gene.getClass() == gene.newInstance().getClass(). Implementations of this method have to use the RandomGenerator object which can be fetched from the RandomRegistry.
      Specified by:
      newInstance in interface Factory<CharacterGene>
      Specified by:
      newInstance in interface Gene<Character,CharacterGene>
      Returns:
      a new instance of type T

    • newInstance

      public CharacterGene newInstance(Character allele)
      Create a new character gene from the given character. If the character is not within the validChars(), an invalid gene will be created.
      Specified by:
      newInstance in interface Gene<Character,CharacterGene>
      Parameters:
      allele - 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(char allele)
      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:
      allele - the character value of the created gene.
      Returns:
      a new character gene.

    • 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 allele, CharSeq validCharacters)
      Create a new CharacterGene from the give character.
      Parameters:
      allele - The allele.
      validCharacters - the valid characters for 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.