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 * Used together with FixedFormatField annotations to provide a pattern for the data.
25 * This annotation is required for {@link java.util.Date} datatype.
26 *
27 * @author Jacob von Eyben - http://www.ancientprogramming.com
28 * @since 1.0.0
29 */
30
31 @Retention(RetentionPolicy.RUNTIME)
32 @Target({ElementType.METHOD, ElementType.FIELD})
33 public @interface FixedFormatPattern {
34
35 public static final String DATE_PATTERN = "yyyyMMdd";
36
37 /**
38 * The pattern used in formatting and parsing a fixed format field.
39 * Date: yyyyMMdd
40 * Other: ####-######.##
41 * Currency: ???
42 * @return the pattern
43 */
44 String value();
45 }