Package org.apache.juneau.commons.lang

Class CharHolder

java.lang.Object
org.apache.juneau.commons.lang.Holder<Character>
org.apache.juneau.commons.lang.CharHolder
public class CharHolder extends Holder<Character>
A simple mutable character value.

This class extends Holder<Character> and provides a convenient way to pass mutable character references to lambdas, inner classes, or methods.

Notes:
  • This class is not thread-safe.
Example:

// Create a character value to track the last character seen CharHolder lastChar = CharHolder.create(); // Use in a lambda to track state charStream.forEach(ch -> { if (Character.isUpperCase(ch)) { lastChar.set(ch); } }); log("Last uppercase char: " + lastChar.get());

See Also:

  • Constructor Details

    • CharHolder

      public CharHolder(Character value)
      Constructor.
      Parameters:
      value - The initial value. Can be null.

  • Method Details

    • create

      public static CharHolder create()
      Creates a new character value initialized to '\0' (null character).
      Example:

      CharHolder value = CharHolder.create(); assertEquals('\0', value.get());

      Returns:
      A new character value.

    • of

      public static CharHolder of(Character value)
      Creates a new character value with the specified initial value.
      Example:

      CharHolder value = CharHolder.of('A'); assertEquals('A', value.get());

      Parameters:
      value - The initial value. Can be null.
      Returns:
      A new character value.

    • add

      public CharHolder add(Character x)
      Adds the specified value to the current value.
      Example:

      CharHolder value = CharHolder.of('A'); value.add((char)5); assertEquals('F', value.get());

      Parameters:
      x - The value to add. Can be null (treated as 0).
      Returns:
      This object.

    • addAndGet

      public Character addAndGet(Character x)
      Adds the specified value to the current value and returns the new value.
      Example:

      CharHolder value = CharHolder.of('A'); char result = value.addAndGet((char)5); // Returns 'F' assertEquals('F', value.get());

      Parameters:
      x - The value to add. Can be null (treated as 0).
      Returns:
      The new value after addition.

    • decrement

      public CharHolder decrement()
      Decrements the value by 1.
      Example:

      CharHolder value = CharHolder.of('B'); value.decrement(); assertEquals('A', value.get());

      Returns:
      This object.

    • decrementAndGet

      public Character decrementAndGet()
      Decrements the value by 1 and returns the new value.
      Example:

      CharHolder value = CharHolder.of('B'); char result = value.decrementAndGet(); // Returns 'A' assertEquals('A', value.get());

      Returns:
      The decremented value.

    • increment

      public CharHolder increment()
      Increments the value by 1.
      Example:

      CharHolder value = CharHolder.of('A'); value.increment(); assertEquals('B', value.get());

      Returns:
      This object.

    • incrementAndGet

      public Character incrementAndGet()
      Increments the value by 1 and returns the new value.
      Example:

      CharHolder value = CharHolder.of('A'); char result = value.incrementAndGet(); // Returns 'B' assertEquals('B', value.get());

      Returns:
      The incremented value.

    • is

      public boolean is(Character value)
      Checks if the current value is equal to the specified character.

      Uses Shorts.eq(Object, Object) for deep equality comparison, which handles nulls safely.

      Example:

      CharHolder value = CharHolder.of('A'); assertTrue(value.is('A')); assertFalse(value.is('B'));

      Overrides:
      is in class Holder<Character>
      Parameters:
      value - The character to compare to. Can be null.
      Returns:
      true if the current value is equal to the specified character.

    • isAny

      public boolean isAny(Character... values)
      Checks if the current value matches any of the specified characters.

      Uses Shorts.eq(Object, Object) for deep equality comparison of each character.

      Example:

      CharHolder value = CharHolder.of('B'); assertTrue(value.isAny('A', 'B', 'C')); assertFalse(value.isAny('X', 'Y'));

      Parameters:
      values - The characters to compare to. Must not be null.
      Returns:
      true if the current value matches any of the specified characters.

    • isAny

      public boolean isAny(String values)
      Checks if the current value matches any character in the specified string.
      Example:

      CharHolder value = CharHolder.of('B'); assertTrue(value.isAny("ABC")); assertFalse(value.isAny("XYZ")); // Null/empty string returns false assertFalse(value.isAny((null)); assertFalse(value.isAny(""));

      Parameters:
      values - The string containing characters to compare to. Can be null or empty.
      Returns:
      true if the current value matches any character in the string.