aboutsummaryrefslogtreecommitdiffstats
path: root/src/net/java/sip/communicator/impl/protocol/irc/Result.java
blob: ee2f27c93726aae60a66423bf9aa49f369aa5114 (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
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
/*
 * Jitsi, the OpenSource Java VoIP and Instant Messaging client.
 *
 * Copyright @ 2015 Atlassian Pty Ltd
 *
 * 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.
 */
package net.java.sip.communicator.impl.protocol.irc;

/**
 * Small container class that can contain a result and/or an exception.
 *
 * The container can be used for synchronizing between threads and
 * simultaneously provide a container for storing a result and/or an exception
 * that occurred within the separate thread that should be passed on to the
 * calling thread.
 *
 * @author Danny van Heumen
 *
 * @param <T> type of the value
 * @param <E> type of the exception
 */
public class Result<T, E extends Exception>
{
    /**
     * Boolean flag done.
     */
    private boolean done = false;

    /**
     * The result.
     */
    private T value = null;

    /**
     * The (possible) exception.
     */
    private E exception = null;

    /**
     * Constructor for result without initial value.
     */
    public Result()
    {
    }

    /**
     * Constructor for result with initial value.
     *
     * @param initialValue initial value
     */
    public Result(final T initialValue)
    {
        this.value = initialValue;
    }

    /**
     * Check whether it is actually done.
     *
     * @return return true when done or false otherwise
     */
    public boolean isDone()
    {
        return this.done;
    }

    /**
     * Set done without setting anything else.
     */
    public void setDone()
    {
        this.done = true;
    }

    /**
     * Set done and provide a result.
     *
     * @param value the result
     */
    public void setDone(final T value)
    {
        this.value = value;
        this.setDone();
    }

    /**
     * Set done and provide an exception.
     *
     * @param exception the exception
     */
    public void setDone(final E exception)
    {
        this.exception = exception;
        this.setDone();
    }

    /**
     * Set done and set both result and exception.
     *
     * @param value the value
     * @param exception the exception
     */
    public void setDone(final T value, final E exception)
    {
        this.value = value;
        this.exception = exception;
        this.setDone();
    }

    /**
     * Get the value.
     *
     * @return return the value
     */
    public T getValue()
    {
        return this.value;
    }

    /**
     * Get the exception.
     *
     * @return return the exception
     */
    public E getException()
    {
        return this.exception;
    }
}