1 /*
2 Copyright 2011 Atlassian
3
4 Licensed under the Apache License, Version 2.0 (the "License");
5 you may not use this file except in compliance with the License.
6 You may obtain a copy of the License at
7
8 http://www.apache.org/licenses/LICENSE-2.0
9
10 Unless required by applicable law or agreed to in writing, software
11 distributed under the License is distributed on an "AS IS" BASIS,
12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 See the License for the specific language governing permissions and
14 limitations under the License.
15 */
16 package io.atlassian.fugue;
17
18 /**
19 * An alternative to {@link java.lang.Void} that is actually once inhabited
20 * (whereas Void is inhabited by null, which causes NPEs).
21 *
22 * @since 2.2
23 */
24 public enum Unit {
25 VALUE;
26
27 /**
28 * Provide ability to statically import {@code Unit.UNIT} and then use
29 * {@code UNIT()} within your code, primarily for readability purposes.
30 *
31 * @return The value for Unit, ie. {@link #VALUE}
32 * @since 2.5
33 */
34 public static Unit Unit() {
35 return VALUE;
36 }
37
38 }