View Javadoc

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.format;
17  
18  import com.ancientprogramming.fixedformat4j.annotation.Field;
19  import com.ancientprogramming.fixedformat4j.exception.FixedFormatException;
20  import com.ancientprogramming.fixedformat4j.format.impl.DateFormatter;
21  
22  /**
23   * Formatter capable of transforming data to and from a string used in text records.
24   * <p/>
25   * A concrete class is used together with the @{@link Field} annotation.
26   * <p/>
27   * Example: <p><code>@Field(offset = 1, length = 20, formatter = {@link DateFormatter}.class)</code></p>
28   *
29   * @author Jacob von Eyben - http://www.ancientprogramming.com
30   * @since 1.0.0
31   */
32  public interface FixedFormatter<T> {
33  
34    T parse(String value, FormatInstructions instructions) throws FixedFormatException;
35  
36    String format(T value, FormatInstructions instructions) throws FixedFormatException;
37  }