/
Callback.java
158 lines (130 loc) · 3.97 KB
/
Callback.java
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
/*
* Copyright 2012 OmniFaces.
*
* 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 org.omnifaces.util;
import java.io.Serializable;
/**
* Collection of callback interfaces. Useful in (mini) visitor and strategy patterns.
*
* @author Bauke Scholtz
*/
public final class Callback {
// Interfaces -----------------------------------------------------------------------------------------------------
/**
* Use this if you need a void callback.
*
* @author Bauke Scholtz
*/
public interface Void {
/**
* This method should be invoked by the method where you're passing this callback instance to.
*/
void invoke();
}
/**
* Use this if you need a serializable void callback.
*
* @author Bauke Scholtz
* @since 2.1
*/
public interface SerializableVoid extends Serializable {
/**
* This method should be invoked by the method where you're passing this callback instance to.
*/
void invoke();
}
/**
* Use this if you need a callback which returns a value.
*
* @author Bauke Scholtz
* @param <R> The return type.
*/
public interface Returning<R> {
/**
* This method should be invoked by the method where you're passing this callback instance to.
* @return The callback result.
*/
R invoke();
}
/**
* Use this if you need a serializable callback which returns a value.
*
* @author Bauke Scholtz
* @param <R> The return type.
* @since 2.1
*/
public interface SerializableReturning<R> extends Serializable {
/**
* This method should be invoked by the method where you're passing this callback instance to.
* @return The callback result.
*/
R invoke();
}
/**
* Use this if you need a callback which takes an argument.
*
* @author Bauke Scholtz
* @param <A> The argument type.
*/
public interface WithArgument<A> {
/**
* This method should be invoked by the method where you're passing this callback instance to.
* @param a The callback argument to work with.
*/
void invoke(A a);
}
/**
* Use this if you need a serializable callback which takes an argument.
*
* @author Bauke Scholtz
* @param <A> The argument type.
* @since 2.1
*/
public interface SerializableWithArgument<A> extends Serializable {
/**
* This method should be invoked by the method where you're passing this callback instance to.
* @param a The callback argument to work with.
*/
void invoke(A a);
}
/**
* Use this if you need a callback which takes an argument and returns a value.
*
* @author Bauke Scholtz
* @param <R> The return type.
* @param <A> The argument type.
*/
public interface ReturningWithArgument<R, A> {
/**
* This method should be invoked by the method where you're passing this callback instance to.
* @param a The callback argument to work with.
* @return The callback result.
*/
R invoke(A a);
}
/**
* Use this if you need a serializable callback which takes an argument and returns a value.
*
* @author Bauke Scholtz
* @param <R> The return type.
* @param <A> The argument type.
* @since 2.1
*/
public interface SerializableReturningWithArgument<R, A> extends Serializable {
/**
* This method should be invoked by the method where you're passing this callback instance to.
* @param a The callback argument to work with.
* @return The callback result.
*/
R invoke(A a);
}
}