1 /*
2 * Copyright 2004 the original author or authors.
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 com.ancientprogramming.fixedformat4j.annotation;
17
18 import java.lang.annotation.Retention;
19 import java.lang.annotation.RetentionPolicy;
20 import java.lang.annotation.Target;
21 import java.lang.annotation.ElementType;
22
23 /**
24 * Define representations for {@link Boolean#TRUE} and {@link Boolean#FALSE}
25 *
26 * @author Jacob von Eyben - http://www.ancientprogramming.com
27 * @since 1.0.0
28 */
29
30 @Retention(RetentionPolicy.RUNTIME)
31 @Target({ElementType.METHOD, ElementType.FIELD})
32 public @interface FixedFormatBoolean {
33
34 /**
35 * The default <code>true</code> value
36 */
37 public static final String TRUE_VALUE = "T";
38
39 /**
40 * The default <code>false</code> value
41 */
42 public static final String FALSE_VALUE = "F";
43
44 /**
45 * The string to map a boolean true value to.
46 * @return contains the string representation of a <code>true</code> value
47 */
48 String trueValue() default TRUE_VALUE;
49
50 /**
51 * The string to map a boolean false value to.
52 * @return contains the string representation of a <code>false</code> value
53 */
54 String falseValue() default FALSE_VALUE;
55 }