Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 8c8b862501fc632e696d8794ab8ac75249a7dcde (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
/*******************************************************************************
 * Copyright (c) 2009, 2015 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.internal.reference;

import java.io.Serializable;
import org.eclipse.jpt.common.utility.internal.ObjectTools;
import org.eclipse.jpt.common.utility.predicate.Predicate;
import org.eclipse.jpt.common.utility.reference.ModifiableObjectReference;

/**
 * Provide a container for passing an object that can be changed by the recipient.
 * 
 * @param <V> the type of the reference's value
 * @see SynchronizedObject
 */
public class SimpleObjectReference<V>
	implements ModifiableObjectReference<V>, Cloneable, Serializable
{
	/** Backing value. */
	private volatile V value;

	private static final long serialVersionUID = 1L;


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

	/**
	 * Create an object reference with the specified initial value.
	 */
	public SimpleObjectReference(V value) {
		super();
		this.value = value;
	}

	/**
	 * Create an object reference with an initial value of
	 * <code>null</code>.
	 */
	public SimpleObjectReference() {
		this(null);
	}


	// ********** ObjectReference **********

	public V getValue() {
		return this.value;
	}

	public boolean valueEquals(Object object) {
		return ObjectTools.equals(this.value, object);
	}

	public boolean valueNotEqual(Object object) {
		return ObjectTools.notEquals(this.value, object);
	}

	public boolean is(Object object) {
		return this.value == object;
	}

	public boolean isNot(Object object) {
		return this.value != object;
	}

	public boolean isNull() {
		return this.value == null;
	}

	public boolean isNotNull() {
		return this.value != null;
	}

	public boolean isMemberOf(Predicate<? super V> predicate) {
		return predicate.evaluate(this.value);
	}

	public boolean isNotMemberOf(Predicate<? super V> predicate) {
		return ! predicate.evaluate(this.value);
	}


	// ********** ModifiableObjectReference **********

	public V setValue(V value) {
		V old = this.value;
		this.value = value;
		return old;
	}

	public V setNull() {
		return this.setValue(null);
	}

	public boolean commit(V newValue, V expectedValue) {
		if (ObjectTools.equals(this.value, expectedValue)) {
			this.setValue(newValue);
			return true;
		}
		return false;
	}

	public V swap(ModifiableObjectReference<V> other) {
		if (other == this) {
			return this.value;
		}
		V otherValue = other.getValue();
		if (ObjectTools.equals(this.value, otherValue)) {
			return this.value;
		}
		other.setValue(this.value);
		this.setValue(otherValue);
		return otherValue;
	}


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

	@Override
	public SimpleObjectReference<V> clone() {
		try {
			@SuppressWarnings("unchecked")
			SimpleObjectReference<V> clone = (SimpleObjectReference<V>) super.clone();
			return clone;
		} catch (CloneNotSupportedException ex) {
			throw new InternalError();
		}
	}

	/**
	 * Object identity is critical to object references.
	 * There is no reason for two different object references to be
	 * <em>equal</em>.
	 * 
	 * @see #valueEquals(Object)
	 */
	@Override
	public boolean equals(Object obj) {
		return super.equals(obj);
	}

	/**
	 * @see #equals(Object)
	 */
	@Override
	public int hashCode() {
		return super.hashCode();
	}

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

Back to the top