com.landawn.abacus.util.MutableChar Maven / Gradle / Ivy
/*
* 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;
import java.io.Serial;
import java.io.Serializable;
/**
*
* Note: it's copied from Apache Commons Lang developed at The Apache Software Foundation, or
* under the Apache License 2.0. The methods copied from other products/frameworks may be modified in this class.
*
*
* A mutable {@code char} wrapper.
*
* Note that as MutableChar does not extend Char, it is not treated by {@code String.format} as a Char parameter.
*
*
* {@code MutableChar} is NOT thread-safe.
*
* @version $Id: MutableChar.java 1669791 2015-03-28 15:22:59Z britter $
* @see Character
*/
public final class MutableChar implements Mutable, Serializable, Comparable {
@Serial
private static final long serialVersionUID = 6807507696378901820L;
private char value;
/**
* Constructs a new MutableChar with the default value of zero.
*/
MutableChar() {
}
/**
* Constructs a new MutableChar with the specified value.
*
* @param value the initial value to store
*/
MutableChar(final char value) {
this.value = value;
}
/**
*
* @param value
* @return
*/
public static MutableChar of(final char value) {
return new MutableChar(value);
}
public char value() {
return value;
}
//-----------------------------------------------------------------------
/**
* Gets the value as a Char instance.
*
* @return
* @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;
}
/**
* Returns the current value and then set new value
*
* @param value
* @return
*/
public char getAndSet(final char value) {
final char result = this.value;
this.value = value;
return result;
}
/**
* Sets with the specified value and then return it.
*
* @param value
* @return
*/
public char setAndGet(final char value) {
this.value = value;
return this.value;
}
/**
* Set with the specified new value and returns {@code true} if {@code predicate} returns {@code true}.
* Otherwise just return {@code false} without setting the value to new value.
*
* @param
* @param newValue
* @param predicate - test the current value.
* @return
* @throws E the e
*/
public boolean setIf(final char newValue, final Throwables.CharPredicate predicate) throws E {
if (predicate.test(value)) {
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
// * @param newValue
// * @param predicate the first parameter is the current value, the second parameter is the new value.
// * @return
// * @throws E the e
// * @deprecated
// */
// @Deprecated
// public boolean setIf(char newValue, Throwables.CharBiPredicate predicate) throws E {
// if (predicate.test(this.value, newValue)) {
// this.value = newValue;
// return true;
// }
//
// return false;
// }
//-----------------------------------------------------------------------
/**
* Increments the value.
*
*/
public void increment() {
value++;
}
/**
* Decrements the value.
*
*/
public void decrement() {
value--;
}
//-----------------------------------------------------------------------
/**
* Adds a value to the value of this instance.
*
* @param operand the value to add, not null
*/
public void add(final char operand) {
value += operand;
}
/**
* Subtracts a value from the value of this instance.
*
* @param operand the value to subtract, not null
*/
public void subtract(final char operand) {
value -= operand;
}
/**
* Increments by one the current value.
*
* @return
*/
public char getAndIncrement() {
return value++;
}
/**
* Decrements by one the current value.
*
* @return
*/
public char getAndDecrement() {
return value--;
}
/**
* Increments by one the current value.
*
* @return
*/
public char incrementAndGet() {
return ++value;
}
/**
* Decrements by one the current value.
*
* @return
*/
public char decrementAndGet() {
return --value;
}
/**
* Adds the given value to the current value.
*
* @param delta the value to add
* @return
*/
public 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
*/
public 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 Character.compare(value, other.value);
}
//-----------------------------------------------------------------------
/**
* Compares this object to the specified object. The result is {@code true} if and only if the argument is
* not {@code null} and is a {@code MutableChar} object that contains the same {@code char} value
* as this object.
*
* @param obj the object to compare with, {@code null} returns false
* @return {@code true} if the objects are the same; {@code 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
*/
@Override
public String toString() {
return N.stringOf(value);
}
}