com.mgz.afp.base.annotations.AFPField Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alpheusafpparser Show documentation

Alpheus AFP Parser is a library and parser for the IBM Advanced Function Presentation (AFP) document/print stream format. Alpheus covers all AFP specifications: MO:DCA, BCOCA, CMOCA, FOCA, GOCA, IOCA, and PTOCA. It is a complete implementation. Every Structured Field, Repeating Group, and Triplet is fully implemented as Java class. Alpheus AFP Parser was written from scratch and has no external dependencies. Copyright 2015,2016 Rudolf Fiala Alpheus AFP Parser is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

The newest version!

/*
Copyright 2015 Rudolf Fiala

This file is part of Alpheus AFP Parser.

Alpheus AFP Parser is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Alpheus AFP Parser is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with Alpheus AFP Parser.  If not, see 
*/
package com.mgz.afp.base.annotations;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME)
public @interface AFPField {
  /**
   * Indicates if a field shown in editor.
   */
  boolean isHidden() default false;

  /**
   * Indicates if a field is editable.
   */
  boolean isEditable() default true;

  /**
   * Indicates that a field is optional.
   */
  boolean isOptional() default false;

  /**
   * The default value in String form.
   */
  String defaultValue() default "";

  /**
   * Constraints for a field value: min, max, range, list.
   */
  String constraintValue() default "";

  /**
   * Constraints for a field size. Applies to field of type String, arrays, and collections.
   */
  int size() default -1;

  int minSize() default -1;

  int maxSize() default -1;

  /**
   * Constraints for a field's serialized representation. Applies to field of type String, arrays,
   * and collections.
   */
  int serializedSize() default -1;

  int serializedMinSize() default -1;

  int serializedMaxSize() default -1;

  /**
   * Index nr. Used to describe interdependency of optional fields. Make sure all optional fields
   * with lower indexNr have also values.
   */
  int indexNr() default -1;
}