Package org.apache.commons.lang

Class CharSet

java.lang.Object
org.apache.commons.lang.CharSet
All Implemented Interfaces:
Serializable
@Deprecated(since="2021-04-30") public class CharSet extends Object implements Serializable
Deprecated.
Commons Lang 2 is in maintenance mode. Commons Lang 3 should be used instead.

A set of characters.

Instances are immutable, but instances of subclasses may not be.

#ThreadSafe#

Since:
1.0
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final CharSet
    ASCII_ALPHA
    Deprecated.
    A CharSet defining ASCII alphabetic characters "a-zA-Z".
    static final CharSet
    ASCII_ALPHA_LOWER
    Deprecated.
    A CharSet defining ASCII alphabetic characters "a-z".
    static final CharSet
    ASCII_ALPHA_UPPER
    Deprecated.
    A CharSet defining ASCII alphabetic characters "A-Z".
    static final CharSet
    ASCII_NUMERIC
    Deprecated.
    A CharSet defining ASCII alphabetic characters "0-9".
    static final CharSet
    EMPTY
    Deprecated.
    A CharSet defining no characters.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    contains(char ch)
    Deprecated.
    Does the CharSet contain the specified character ch.
    boolean
    equals(Object obj)
    Deprecated.
    Compares two CharSet objects, returning true if they represent exactly the same set of characters defined in the same way.
    CharRange[]
    getCharRanges()
    Deprecated.
    Gets the internal set as an array of CharRange objects.
    static CharSet
    getInstance(String setStr)
    Deprecated.
    Factory method to create a new CharSet using a special syntax.
    static CharSet
    getInstance(String[] setStrs)
    Deprecated.
    Constructs a new CharSet using the set syntax.
    int
    hashCode()
    Deprecated.
    Gets a hashCode compatible with the equals method.
    String
    toString()
    Deprecated.
    Gets a string representation of the set.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • EMPTY

      public static final CharSet EMPTY
      Deprecated.
      A CharSet defining no characters.
      Since:
      2.0

    • ASCII_ALPHA

      public static final CharSet ASCII_ALPHA
      Deprecated.
      A CharSet defining ASCII alphabetic characters "a-zA-Z".
      Since:
      2.0

    • ASCII_ALPHA_LOWER

      public static final CharSet ASCII_ALPHA_LOWER
      Deprecated.
      A CharSet defining ASCII alphabetic characters "a-z".
      Since:
      2.0

    • ASCII_ALPHA_UPPER

      public static final CharSet ASCII_ALPHA_UPPER
      Deprecated.
      A CharSet defining ASCII alphabetic characters "A-Z".
      Since:
      2.0

    • ASCII_NUMERIC

      public static final CharSet ASCII_NUMERIC
      Deprecated.
      A CharSet defining ASCII alphabetic characters "0-9".
      Since:
      2.0

  • Method Details

    • getInstance

      public static CharSet getInstance(String setStr)
      Deprecated.

      Factory method to create a new CharSet using a special syntax.

      • null or empty string ("") - set containing no characters
      • Single character, such as "a" - set containing just that character
      • Multi character, such as "a-e" - set containing characters from one character to the other
      • Negated, such as "^a" or "^a-e" - set containing all characters except those defined
      • Combinations, such as "abe-g" - set containing all the characters from the individual sets

      The matching order is:

      1. Negated multi character range, such as "^a-e"
      2. Ordinary multi character range, such as "a-e"
      3. Negated single character, such as "^a"
      4. Ordinary single character, such as "a"

      Matching works left to right. Once a match is found the search starts again from the next character.

      If the same range is defined twice using the same syntax, only one range will be kept. Thus, "a-ca-c" creates only one range of "a-c".

      If the start and end of a range are in the wrong order, they are reversed. Thus "a-e" is the same as "e-a". As a result, "a-ee-a" would create only one range, as the "a-e" and "e-a" are the same.

      The set of characters represented is the union of the specified ranges.

      All CharSet objects returned by this method will be immutable.

      Parameters:
      setStr - the String describing the set, may be null
      Returns:
      a CharSet instance
      Since:
      2.0

    • getInstance

      public static CharSet getInstance(String[] setStrs)
      Deprecated.

      Constructs a new CharSet using the set syntax. Each string is merged in with the set.

      Parameters:
      setStrs - Strings to merge into the initial set, may be null
      Returns:
      a CharSet instance
      Since:
      2.4

    • getCharRanges

      public CharRange[] getCharRanges()
      Deprecated.

      Gets the internal set as an array of CharRange objects.

      Returns:
      an array of immutable CharRange objects
      Since:
      2.0

    • contains

      public boolean contains(char ch)
      Deprecated.

      Does the CharSet contain the specified character ch.

      Parameters:
      ch - the character to check for
      Returns:
      true if the set contains the characters

    • equals

      public boolean equals(Object obj)
      Deprecated.

      Compares two CharSet objects, returning true if they represent exactly the same set of characters defined in the same way.

      The two sets abc and a-c are not equal according to this method.

      Overrides:
      equals in class Object
      Parameters:
      obj - the object to compare to
      Returns:
      true if equal
      Since:
      2.0

    • hashCode

      public int hashCode()
      Deprecated.

      Gets a hashCode compatible with the equals method.

      Overrides:
      hashCode in class Object
      Returns:
      a suitable hashCode
      Since:
      2.0

    • toString

      public String toString()
      Deprecated.

      Gets a string representation of the set.

      Overrides:
      toString in class Object
      Returns:
      string representation of the set