summaryrefslogtreecommitdiffstats
path: root/policy-utils/src/main/java/org/onap/policy/drools/utils/Reference.java
blob: 0c4155febf9a67c0c70b652804968c638ade6fb9 (plain)
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
/*
 * ============LICENSE_START=======================================================
 * ONAP
 * ================================================================================
 * Copyright (C) 2018 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * Licensed 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.
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.drools.utils;

/**
 * Reference to an object. Used within functional methods, where thread-safety is not
 * required.
 * 
 * @param <T> type of object contained within the reference
 */
public class Reference<T> {
    private T value;

    /**
     * 
     * @param value
     */
    public Reference(T value) {
        this.value = value;
    }

    /**
     * @return the current value
     */
    public final T get() {
        return value;
    }

    /**
     * Sets the reference to point to a new value.
     * 
     * @param newValue
     */
    public final void set(T newValue) {
        this.value = newValue;
    }

    /**
     * Sets the value to a new value, if the value is currently the same as the old value.
     * 
     * @param oldValue
     * @param newValue
     * @return {@code true} if the value was updated, {@code false} otherwise
     */
    public boolean compareAndSet(T oldValue, T newValue) {
        if (value == oldValue) {
            value = newValue;
            return true;

        } else {
            return false;
        }
    }
}