com.landawn.abacus.util.MutableChar Maven / Gradle / Ivy
Show all versions of abacus-android Show documentation
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.landawn.abacus.util;
/**
*
* 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.
*
* @see Char
* @since 2.1
* @version $Id: MutableChar.java 1669791 2015-03-28 15:22:59Z britter $
*/
public final class MutableChar implements Comparable, Mutable {
/** The mutable value. */
private char value;
/**
* Constructs a new MutableChar with the default value of zero.
*/
MutableChar() {
super();
}
/**
* Constructs a new MutableChar with the specified value.
*
* @param value the initial value to store
*/
MutableChar(final char value) {
super();
this.value = value;
}
public static MutableChar of(final char value) {
return new MutableChar(value);
}
public char value() {
return value;
}
//-----------------------------------------------------------------------
/**
* Gets the value as a Char instance.
*
* @return the value as a Char, never null
* @deprecated replace by {@link #value()}.
*/
@Deprecated
public char getValue() {
return value;
}
/**
* Sets the value.
*
* @param value the value to set
*/
public void setValue(final char value) {
this.value = value;
}
public char getAndSet(final char value) {
final char result = this.value;
this.value = value;
return result;
}
public char setAndGet(final char value) {
this.value = value;
return this.value;
}
/**
* Set with the specified new value and returns true if predicate returns true.
* Otherwise just return false without setting the value to new value.
*
* @param newValue
* @param predicate - test the current value.
* @return
*/
public boolean setIf(char newValue, Try.CharPredicate predicate) throws E {
if (predicate.test(this.value)) {
this.value = newValue;
return true;
}
return false;
}
/**
* Set with the specified new value and returns true if predicate returns true.
* Otherwise just return false without setting the value to new value.
*
* @param newValue
* @param predicate the first parameter is the current value, the second parameter is the new value.
* @return
*/
public boolean setIf(char newValue, Try.CharBiPredicate predicate) throws E {
if (predicate.test(this.value, newValue)) {
this.value = newValue;
return true;
}
return false;
}
//-----------------------------------------------------------------------
/**
* Increments the value.
*
* @since Commons Lang 2.2
*/
public void increment() {
value++;
}
/**
* Decrements the value.
*
* @since Commons Lang 2.2
*/
public void decrement() {
value--;
}
//-----------------------------------------------------------------------
/**
* Adds a value to the value of this instance.
*
* @param operand the value to add, not null
* @since Commons Lang 2.2
*/
public void add(final char operand) {
this.value += operand;
}
/**
* Subtracts a value from the value of this instance.
*
* @param operand the value to subtract, not null
* @since Commons Lang 2.2
*/
public void subtract(final char operand) {
this.value -= operand;
}
/**
* Increments by one the current value.
*
* @return the previous value
*/
public final char getAndIncrement() {
return value++;
}
/**
* Decrements by one the current value.
*
* @return the previous value
*/
public final char getAndDecrement() {
return value--;
}
/**
* Increments by one the current value.
*
* @return the updated value
*/
public final char incrementAndGet() {
return ++value;
}
/**
* Decrements by one the current value.
*
* @return the updated value
*/
public final char decrementAndGet() {
return --value;
}
/**
* Adds the given value to the current value.
*
* @param delta the value to add
* @return the previous value
*/
public final char getAndAdd(final char delta) {
final char prev = value;
value += delta;
return prev;
}
/**
* Adds the given value to the current value.
*
* @param delta the value to add
* @return the updated value
*/
public final char addAndGet(final char delta) {
return value += delta;
}
//-----------------------------------------------------------------------
/**
* Compares this mutable to another in ascending order.
*
* @param other the other mutable to compare to, not null
* @return negative if this is less, zero if equal, positive if greater
*/
@Override
public int compareTo(final MutableChar other) {
return (this.value > other.value) ? 1 : ((this.value == other.value) ? 0 : -1);
}
//-----------------------------------------------------------------------
/**
* 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.
*
* @param obj the object to compare with, null returns false
* @return true if the objects are the same; false otherwise.
*/
@Override
public boolean equals(final Object obj) {
if (obj instanceof MutableChar) {
return value == ((MutableChar) obj).value;
}
return false;
}
/**
* Returns a suitable hash code for this mutable.
*
* @return a suitable hash code
*/
@Override
public int hashCode() {
return value;
}
//-----------------------------------------------------------------------
/**
* Returns the String value of this mutable.
*
* @return the mutable value as a string
*/
@Override
public String toString() {
return String.valueOf(value);
}
}