Skip to main content
summaryrefslogtreecommitdiffstats
blob: 895f566f5d18e26b6b494453770404ea6f2f7d00 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
/*******************************************************************************
 * Copyright (c) 2008, 2009 Oracle. All rights reserved.
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0, which accompanies this distribution
 * and is available at http://www.eclipse.org/legal/epl-v10.html.
 * 
 * Contributors:
 *     Oracle - initial API and implementation
 ******************************************************************************/
package org.eclipse.jpt.utility.internal;

import java.io.Serializable;

/**
 * Provide a container for passing a flag that can be changed by the recipient.
 * 
 * @see SynchronizedBoolean
 */
public class BooleanReference
	implements Cloneable, Serializable
{
	/** Backing <code>boolean</code>. */
	private volatile boolean value;

	private static final long serialVersionUID = 1L;


	// ********** constructors **********

	/**
	 * Create a <code>boolean</code> reference with the specified initial value.
	 */
	public BooleanReference(boolean value) {
		super();
		this.value = value;
	}

	/**
	 * Create a <code>boolean</code> reference with an initial value of
	 * <code>false</code>.
	 */
	public BooleanReference() {
		this(false);
	}


	// ********** accessors **********

	/**
	 * Return the current <code>boolean</code> value.
	 */
	public boolean getValue() {
		return this.value;
	}

	/**
	 * Return whether the current <code>boolean</code> value is the specified
	 * value.
	 */
	public boolean is(boolean v) {
		return this.value == v;
	}

	/**
	 * Return whether the current <code>boolean</code> value is not the
	 * specified value.
	 */
	public boolean isNot(boolean v) {
		return this.value != v;
	}

	/**
	 * Return whether the current <code>boolean</code> value is
	 * <code>true</code>.
	 */
	public boolean isTrue() {
		return this.value;
	}

	/**
	 * Return whether the current <code>boolean</code> value is
	 * <code>false</code>.
	 */
	public boolean isFalse() {
		return ! this.value;
	}

	/**
	 * Set the <code>boolean</code> value.
	 * Return the previous value.
	 */
	public boolean setValue(boolean value) {
		boolean old = this.value;
		this.value = value;
		return old;
	}

	/**
	 * Set the <code>boolean</code> value to the NOT of its current value.
	 * Return the new value.
	 */
	public boolean flip() {
		return this.value = ! this.value;
	}

	/**
	 * Set the <code>boolean</code> value to the NOT of the specified value.
	 * Return the previous value.
	 */
	public boolean setNot(boolean v) {
		return this.setValue( ! v);
	}

	/**
	 * Set the <code>boolean</code> value to <code>true</code>.
	 * Return the previous value.
	 */
	public boolean setTrue() {
		return this.setValue(true);
	}

	/**
	 * Set the <code>boolean</code> value to <code>false</code>.
	 * Return the previous value.
	 */
	public boolean setFalse() {
		return this.setValue(false);
	}


	// ********** standard methods **********

	@Override
	public Object clone() {
		try {
			return super.clone();
		} catch (CloneNotSupportedException ex) {
			throw new InternalError();
		}
	}

	@Override
	public boolean equals(Object o) {
		return (o instanceof BooleanReference) &&
			(this.value == ((BooleanReference) o).value);
	}

	@Override
	public int hashCode() {
		return this.value ? 1 : 0;
	}

	@Override
	public String toString() {
		return '[' + String.valueOf(this.value) + ']';
	}

}

Back to the top