Skip to main content
summaryrefslogtreecommitdiffstats
blob: 0a73528e4e27698c81dec7639498b88f28f87616 (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
159
160
161
162
163
164
165
166
/*******************************************************************************
 * Copyright (c) 2010, 2012 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.common.utility;

import java.io.Serializable;

/**
 * Interface for a container for holding a <code>boolean</code> that cannot be
 * changed by clients.
 * <p>
 * Provisional API: This interface is part of an interim API that is still
 * under development and expected to change significantly before reaching
 * stability. It is available at this early stage to solicit feedback from
 * pioneering adopters on the understanding that any code that uses this API
 * will almost certainly be broken (repeatedly) as the API evolves.
 */
public interface BooleanReference {

	/**
	 * Return the current <code>boolean</code> value.
	 */
	boolean getValue();

	/**
	 * Return whether the current <code>boolean</code> value is equal to the
	 * specified value.
	 */
	boolean is(boolean value);

	/**
	 * Return whether the current <code>boolean</code> value is not equal to
	 * the specified value.
	 */
	boolean isNot(boolean value);

	/**
	 * Return whether the current <code>boolean</code> value is
	 * <code>true</code>.
	 */
	boolean isTrue();

	/**
	 * Return whether the current <code>boolean</code> value is
	 * <code>false</code>.
	 */
	boolean isFalse();


	/**
	 * Convenience method.
	 */
	final class Value {
		public static BooleanReference of(boolean value) {
			return value ? True.instance() : False.instance();
		}
	}


	/**
	 * Singleton implementation of the read-only boolean reference interface
	 * whose value is always <code>true</code>.
	 */
	final class True
		implements BooleanReference, Serializable
	{
		public static final BooleanReference INSTANCE = new True();

		public static BooleanReference instance() {
			return INSTANCE;
		}

		// ensure single instance
		private True() {
			super();
		}

		public boolean getValue() {
			return true;
		}

		public boolean is(boolean value) {
			return value;
		}

		public boolean isNot(boolean value) {
			return ! value;
		}

		public boolean isTrue() {
			return true;
		}

		public boolean isFalse() {
			return false;
		}

		@Override
		public String toString() {
			return "[true]"; //$NON-NLS-1$
		}

		private static final long serialVersionUID = 1L;
		private Object readResolve() {
			// replace this object with the singleton
			return INSTANCE;
		}
	}


	/**
	 * Singleton implementation of the read-only boolean reference interface
	 * whose value is always <code>false</code>.
	 */
	final class False
		implements BooleanReference, Serializable
	{
		public static final BooleanReference INSTANCE = new False();

		public static BooleanReference instance() {
			return INSTANCE;
		}

		// ensure single instance
		private False() {
			super();
		}

		public boolean getValue() {
			return false;
		}

		public boolean is(boolean value) {
			return ! value;
		}

		public boolean isNot(boolean value) {
			return value;
		}

		public boolean isTrue() {
			return false;
		}

		public boolean isFalse() {
			return false;
		}

		@Override
		public String toString() {
			return "[false]"; //$NON-NLS-1$
		}

		private static final long serialVersionUID = 1L;
		private Object readResolve() {
			// replace this object with the singleton
			return INSTANCE;
		}
	}
}

Back to the top