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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
/*
* Copyright 2006-2012 Amazon Technologies, Inc. or its affiliates.
* Amazon, Amazon.com and Carbonado are trademarks or registered trademarks
* of Amazon Technologies, Inc. or its affiliates. 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.
*/
package com.amazon.carbonado.adapter;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Adapter that converts 'Y' or 'N' to and from a boolean value.
*
* <p>Example:<pre>
* public interface UserInfo extends Storable {
* <b>@YesNoAdapter</b>
* boolean isAdministrator();
* void setAdministrator(boolean admin);
*
* ...
* }
* </pre>
*
* @author Brian S O'Neill
* @see TrueFalseAdapter
* @see AdapterDefinition
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@AdapterDefinition(storageTypePreferences={
char.class,
Character.class,
String.class
})
public @interface YesNoAdapter {
/**
* Specify that this adapter should be lenient when converting characters
* into booleans. By default it is true, and it accepts the following as
* true: 'Y', 'y', 'T', 't', '1'. For false: 'N', 'n', 'F', 'f', '0'. When
* lenient is false, only 'Y' and 'N' are accepted.
*/
boolean lenient() default true;
/**
* Adapter implementation for {@link YesNoAdapter}.
*/
public static class Adapter {
private final String mPropertyName;
private final boolean mLenient;
/**
* @param type type of object that contains the adapted property
* @param propertyName name of property with adapter
* @param ann specific annotation that binds to this adapter class
*/
public Adapter(Class<?> type, String propertyName, YesNoAdapter ann) {
this(type, propertyName, ann == null ? true : ann.lenient());
}
/**
* @param type type of object that contains the adapted property
* @param propertyName name of property with
* @param lenient lenient when true
*/
public Adapter(Class<?> type, String propertyName, boolean lenient) {
mPropertyName = propertyName;
mLenient = lenient;
}
/**
* Adapts a boolean true or false into 'Y' or 'N'.
*/
public char adaptToChar(boolean value) {
return value ? 'Y' : 'N';
}
/**
* Adapts a boolean true into 'Y', and anything else to 'N'.
*/
public char adaptToChar(Boolean value) {
return (value != null && value) ? 'Y' : 'N';
}
/**
* Adapts a boolean true or false into 'Y' or 'N'.
*/
public Character adaptToCharacter(boolean value) {
return value ? 'Y' : 'N';
}
/**
* Adapts a boolean true into 'Y', and anything else to 'N'.
*/
public Character adaptToCharacter(Boolean value) {
return (value != null && value) ? 'Y' : 'N';
}
/**
* Adapts a boolean true or false into "Y" or "N".
*/
public String adaptToString(boolean value) {
return value ? "Y" : "N";
}
/**
* Adapts a boolean true into "Y", and anything else to "N".
*/
public String adaptToString(Boolean value) {
return (value != null && value) ? "Y" : "N";
}
/**
* Adapts a character 'Y' or 'N' to true or false. If {@link
* YesNoAdapter#lenient lenient}, other characters are accepted as
* well.
*/
public boolean adaptToBoolean(char value) {
switch (value) {
case 'Y':
return true;
case 'N':
return false;
case 'y': case 'T': case 't': case '1':
if (mLenient) {
return true;
}
break;
case 'n': case 'F': case 'f': case '0':
if (mLenient) {
return false;
}
break;
}
throw new IllegalArgumentException
("Cannot adapt '" + value + "' into boolean for property \"" +
mPropertyName + '"');
}
/**
* Adapts a character 'Y' or 'N' to true or false. If {@link
* YesNoAdapter#lenient lenient}, other characters are accepted as
* well.
*/
public boolean adaptToBoolean(Character value) {
if (value == null) {
if (mLenient) {
return false;
}
} else {
return adaptToBoolean(value.charValue());
}
throw new IllegalArgumentException
("Cannot adapt '" + value + "' into boolean for property \"" +
mPropertyName + '"');
}
/**
* Adapts a character "Y" or "N" to true or false. If {@link
* YesNoAdapter#lenient lenient}, other characters are accepted as
* well.
*/
public boolean adaptToBoolean(String value) {
int length;
if (value == null || (length = value.length()) == 0) {
if (mLenient) {
return false;
}
} else if (length == 1 || mLenient) {
return adaptToBoolean(value.charAt(0));
}
throw new IllegalArgumentException
("Cannot adapt '" + value + "' into boolean for property \"" +
mPropertyName + '"');
}
/**
* Adapts a character 'Y' or 'N' to true or false. If {@link
* YesNoAdapter#lenient lenient}, other characters are accepted as
* well.
*/
public Boolean adaptToBooleanObj(char value) {
return adaptToBoolean(value);
}
/**
* Adapts a character 'Y' or 'N' to true or false. If {@link
* YesNoAdapter#lenient lenient}, other characters are accepted as
* well.
*/
public Boolean adaptToBooleanObj(Character value) {
return adaptToBoolean(value);
}
/**
* Adapts a character "Y" or "N" to true or false. If {@link
* YesNoAdapter#lenient lenient}, other characters are accepted as
* well.
*/
public Boolean adaptToBooleanObj(String value) {
return adaptToBoolean(value);
}
}
}
|
