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.exception.FixedFormatException;
19  
20  /**
21   * Interface used to interact with fixed format annotations.
22   *
23   * A <code>FixedFormatManager</code> is associated with one type of fixed format data.
24   * @author Jacob von Eyben - http://www.ancientprogramming.com
25   * @since 1.0.0
26   */
27  public interface FixedFormatManager {
28  
29    /**
30     * Create an instance of the fixedFormatClass and load the data string into the object according to the annotations.
31     * @param clazz the class to instanciate
32     * @param data the data to load
33     * @return an object loaded with the fixedformat data
34     * @throws FixedFormatException in case the fixedFormatRecord class cannot be loaded
35     */
36    <T> T load(Class<T> clazz, String data) throws FixedFormatException;
37  
38    <T> String export(T instance) throws FixedFormatException;
39  
40    <T> String export(String data, T instance) throws FixedFormatException;
41  
42  
43  }