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 * Marks a class as a representation of a fixed format record
25 *
26 * @author Jacob von Eyben - http://www.ancientprogramming.com
27 * @since 1.0.0
28 */
29
30 @Retention(RetentionPolicy.RUNTIME)
31 @Target({ElementType.TYPE})
32 public @interface Record {
33
34 /**
35 * The fixed length of the record. It means that the record will always be that long padded with {#paddingChar()}'s
36 * @return the length of the record. -1 means no fixed length.
37 */
38 int length() default -1;
39
40 /**
41 * The char to pad with.
42 * @return the char to pad with if the record is set to a fixed length;
43 */
44 char paddingChar() default ' ';
45 }