Package com.landawn.abacus.util

Class MutableChar

java.lang.Object
com.landawn.abacus.util.MutableChar
All Implemented Interfaces:
Mutable, Serializable, Comparable<MutableChar>
public final class MutableChar extends Object implements Mutable, Serializable, Comparable<MutableChar>

Note: it's copied from Apache Commons Lang developed at The Apache Software Foundation (http://www.apache.org/), or under the Apache License 2.0. The methods copied from other products/frameworks may be modified in this class.

A mutable char wrapper.

Note that as MutableChar does not extend Char, it is not treated by String.format as a Char parameter.

MutableChar is NOT thread-safe.

Since:
2.1
Version:
$Id: MutableChar.java 1669791 2015-03-28 15:22:59Z britter $
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(char operand)
    Adds a value to the value of this instance.
    char
    addAndGet(char delta)
    Adds the given value to the current value.
    int
    compareTo(MutableChar other)
    Compares this mutable to another in ascending order.
    void
    decrement()
    Decrements the value.
    char
    decrementAndGet()
    Decrements by one the current value.
    boolean
    equals(Object obj)
    Compares this object to the specified object.
    char
    getAndAdd(char delta)
    Adds the given value to the current value.
    char
    getAndDecrement()
    Decrements by one the current value.
    char
    getAndIncrement()
    Increments by one the current value.
    char
    getAndSet(char value)
    Gets the and set.
    char
    getValue()
    Deprecated.
    replace by value().
    int
    hashCode()
    Returns a suitable hash code for this mutable.
    void
    increment()
    Increments the value.
    char
    incrementAndGet()
    Increments by one the current value.
    static MutableChar
    of(char value)
     
    char
    setAndGet(char value)
    Sets the and get.
    <E extends Exception>
    boolean
    setIf(char newValue, Throwables.CharPredicate<E> predicate)
    Set with the specified new value and returns true if predicate returns true.
    void
    setValue(char value)
    Sets the value.
    void
    subtract(char operand)
    Subtracts a value from the value of this instance.
    String
    toString()
    Returns the String value of this mutable.
    char
    value()
     

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Method Details

    • of

      public static MutableChar of(char value)
      Parameters:
      value -
      Returns:

    • value

      public char value()
      Returns:

    • getValue

      @Deprecated public char getValue()
      Deprecated.
      replace by value().
      Gets the value as a Char instance.
      Returns:

    • setValue

      public void setValue(char value)
      Sets the value.
      Parameters:
      value - the value to set

    • getAndSet

      public char getAndSet(char value)
      Gets the and set.
      Parameters:
      value -
      Returns:

    • setAndGet

      public char setAndGet(char value)
      Sets the and get.
      Parameters:
      value -
      Returns:

    • setIf

      public <E extends Exception> boolean setIf(char newValue, Throwables.CharPredicate<E> predicate) throws E
      Set with the specified new value and returns true if predicate returns true. Otherwise just return false without setting the value to new value.
      Type Parameters:
      E -
      Parameters:
      newValue -
      predicate - - test the current value.
      Returns:
      Throws:
      E - the e

    • increment

      public void increment()
      Increments the value.
      Since:
      Commons Lang 2.2

    • decrement

      public void decrement()
      Decrements the value.
      Since:
      Commons Lang 2.2

    • add

      public void add(char operand)
      Adds a value to the value of this instance.
      Parameters:
      operand - the value to add, not null
      Since:
      Commons Lang 2.2

    • subtract

      public void subtract(char operand)
      Subtracts a value from the value of this instance.
      Parameters:
      operand - the value to subtract, not null
      Since:
      Commons Lang 2.2

    • getAndIncrement

      public char getAndIncrement()
      Increments by one the current value.
      Returns:

    • getAndDecrement

      public char getAndDecrement()
      Decrements by one the current value.
      Returns:

    • incrementAndGet

      public char incrementAndGet()
      Increments by one the current value.
      Returns:

    • decrementAndGet

      public char decrementAndGet()
      Decrements by one the current value.
      Returns:

    • getAndAdd

      public char getAndAdd(char delta)
      Adds the given value to the current value.
      Parameters:
      delta - the value to add
      Returns:

    • addAndGet

      public char addAndGet(char delta)
      Adds the given value to the current value.
      Parameters:
      delta - the value to add
      Returns:

    • compareTo

      public int compareTo(MutableChar other)
      Compares this mutable to another in ascending order.
      Specified by:
      compareTo in interface Comparable<MutableChar>
      Parameters:
      other - the other mutable to compare to, not null
      Returns:
      negative if this is less, zero if equal, positive if greater

    • equals

      public boolean equals(Object obj)
      Compares this object to the specified object. The result is true if and only if the argument is not null and is a MutableChar object that contains the same char value as this object.
      Overrides:
      equals in class Object
      Parameters:
      obj - the object to compare with, null returns false
      Returns:
      true if the objects are the same; false otherwise.

    • hashCode

      public int hashCode()
      Returns a suitable hash code for this mutable.
      Overrides:
      hashCode in class Object
      Returns:
      a suitable hash code

    • toString

      public String toString()
      Returns the String value of this mutable.
      Overrides:
      toString in class Object
      Returns: