content: /*
   * Licensed to the Apache Software Foundation (ASF) under one or more
   * contributor license agreements.  See the NOTICE file distributed with
   * this work for additional information regarding copyright ownership.
   * The ASF licenses this file to You under the Apache License, Version 2.0
   * (the "License"); you may not use this file except in compliance with
   * the License.  You may obtain a copy of the License at
   *
   *      http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package org.apache.camel.dataformat.bindy.annotation;
  
  import java.lang.annotation.Documented;
  import java.lang.annotation.Retention;
  import java.lang.annotation.RetentionPolicy;
  
  /**
   * This annotation represents the root class of the model. When a fixed-length record must be described in the model we
   * will use this annotation to split the data during the unmarshal process.
   */
  @Documented
  @Retention(RetentionPolicy.RUNTIME)
  public @interface FixedLengthRecord {
  
      /**
       * Name describing the record (optional)
       *
       * @return String
       */
      String name() default "";
  
      /**
       * Character to be used to add a carriage return after each record (optional). Possible values: WINDOWS, UNIX, MAC,
       * or custom. This option is used only during marshalling, whereas unmarshalling uses system default JDK provided
       * line delimiter unless eol is customized.
       *
       * @return String
       */
      String crlf() default "WINDOWS";
  
      /**
       * Character to be used to process considering end of line after each record while unmarshalling (optional -
       * default: "", which helps default JDK provided line delimiter to be used unless any other line delimiter provided)
       * This option is used only during unmarshalling, where marshalling uses system default provided line delimiter as
       * "WINDOWS" unless any other value is provided.
       *
       * @return String
       */
      String eol() default "";
  
      /**
       * The char to pad with.
       *
       * @return the char to pad with if the record is set to a fixed length;
       */
      char paddingChar() default ' ';
  
      /**
       * The fixed length of the record (number of characters). It means that the record will always be that long padded
       * with {#paddingChar()}'s
       *
       * @return the length of the record.
       */
      int length() default 0;
  
      /**
       * Indicates that the record(s) of this type may be preceded by a single header record at the beginning of in the
       * file
       */
      Class<?> header() default void.class;
  
      /**
       * Indicates that the record(s) of this type may be followed by a single footer record at the end of the file
       */
      Class<?> footer() default void.class;
  
      /**
       * Configures the data format to skip marshalling / unmarshalling of the header record. Configure this parameter on
       * the primary record (e.g., not the header or footer).
       */
      boolean skipHeader() default false;
  
      /**
       * Configures the data format to skip marshalling / unmarshalling of the footer record. Configure this parameter on
       * the primary record (e.g., not the header or footer).
       */
      boolean skipFooter() default false;
  
      /**
       * Indicates that characters beyond the last mapped filed can be ignored when unmarshalling / parsing. This
       * annotation is associated to the root class of the model and must be declared one time.
       */
      boolean ignoreTrailingChars() default false;
  
      /**
       * Indicates whether too short lines will be ignored
       */
      boolean ignoreMissingChars() default false;
  
      /**
       * Indicates how chars are counted
       */
      boolean countGrapheme() default false;
  }
  