| /* |
| * 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 org.apache.commons.lang.mutable; |
| |
| import java.io.Serializable; |
| |
| import org.apache.commons.lang.BooleanUtils; |
| |
| /** |
| * A mutable <code>boolean</code> wrapper. |
| * |
| * @see Boolean |
| * @since 2.2 |
| * @author Apache Software Foundation |
| * @version $Id$ |
| */ |
| public class MutableBoolean implements Mutable, Serializable, Comparable { |
| |
| /** |
| * Required for serialization support. |
| * |
| * @see java.io.Serializable |
| */ |
| private static final long serialVersionUID = -4830728138360036487L; |
| |
| /** The mutable value. */ |
| private boolean value; |
| |
| /** |
| * Constructs a new MutableBoolean with the default value of false. |
| */ |
| public MutableBoolean() { |
| super(); |
| } |
| |
| /** |
| * Constructs a new MutableBoolean with the specified value. |
| * |
| * @param value the initial value to store |
| */ |
| public MutableBoolean(boolean value) { |
| super(); |
| this.value = value; |
| } |
| |
| /** |
| * Constructs a new MutableBoolean with the specified value. |
| * |
| * @param value the initial value to store, not null |
| * @throws NullPointerException if the object is null |
| */ |
| public MutableBoolean(Boolean value) { |
| super(); |
| this.value = value.booleanValue(); |
| } |
| |
| //----------------------------------------------------------------------- |
| /** |
| * Gets the value as a Boolean instance. |
| * |
| * @return the value as a Boolean, never null |
| */ |
| public Object getValue() { |
| return BooleanUtils.toBooleanObject(this.value); |
| } |
| |
| /** |
| * Sets the value. |
| * |
| * @param value the value to set |
| */ |
| public void setValue(boolean value) { |
| this.value = value; |
| } |
| |
| /** |
| * Sets the value from any Boolean instance. |
| * |
| * @param value the value to set, not null |
| * @throws NullPointerException if the object is null |
| */ |
| public void setValue(Object value) { |
| setValue(((Boolean) value).booleanValue()); |
| } |
| |
| //----------------------------------------------------------------------- |
| /** |
| * Checks if the current value is <code>true</code>. |
| * |
| * @return <code>true</code> if the current value is <code>true</code> |
| * @since 2.5 |
| */ |
| public boolean isTrue() { |
| return value == true; |
| } |
| |
| /** |
| * Checks if the current value is <code>false</code>. |
| * |
| * @return <code>true</code> if the current value is <code>false</code> |
| * @since 2.5 |
| */ |
| public boolean isFalse() { |
| return value == false; |
| } |
| |
| //----------------------------------------------------------------------- |
| /** |
| * Returns the value of this MutableBoolean as a boolean. |
| * |
| * @return the boolean value represented by this object. |
| */ |
| public boolean booleanValue() { |
| return value; |
| } |
| |
| //----------------------------------------------------------------------- |
| /** |
| * Gets this mutable as an instance of Boolean. |
| * |
| * @return a Boolean instance containing the value from this mutable, never null |
| * @since 2.5 |
| */ |
| public Boolean toBoolean() { |
| return BooleanUtils.toBooleanObject(this.value); |
| } |
| |
| //----------------------------------------------------------------------- |
| /** |
| * Compares this object to the specified object. The result is <code>true</code> if and only if the argument is |
| * not <code>null</code> and is an <code>MutableBoolean</code> object that contains the same |
| * <code>boolean</code> value as this object. |
| * |
| * @param obj the object to compare with, null returns false |
| * @return <code>true</code> if the objects are the same; <code>false</code> otherwise. |
| */ |
| public boolean equals(Object obj) { |
| if (obj instanceof MutableBoolean) { |
| return value == ((MutableBoolean) obj).booleanValue(); |
| } |
| return false; |
| } |
| |
| /** |
| * Returns a suitable hash code for this mutable. |
| * |
| * @return the hash code returned by <code>Boolean.TRUE</code> or <code>Boolean.FALSE</code> |
| */ |
| public int hashCode() { |
| return value ? Boolean.TRUE.hashCode() : Boolean.FALSE.hashCode(); |
| } |
| |
| //----------------------------------------------------------------------- |
| /** |
| * Compares this mutable to another in ascending order. |
| * |
| * @param obj the other mutable to compare to, not null |
| * @return negative if this is less, zero if equal, positive if greater |
| * where false is less than true |
| */ |
| public int compareTo(Object obj) { |
| MutableBoolean other = (MutableBoolean) obj; |
| boolean anotherVal = other.value; |
| return value == anotherVal ? 0 : (value ? 1 : -1); |
| } |
| |
| //----------------------------------------------------------------------- |
| /** |
| * Returns the String value of this mutable. |
| * |
| * @return the mutable value as a string |
| */ |
| public String toString() { |
| return String.valueOf(value); |
| } |
| |
| } |