gdv.xport.annotation.FeldInfo Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2011-2021 by Oli B.
 *
 * Licensed 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 orimplied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * (c)reated 06.03.2011 by Oli B. ([email protected])
 */

package gdv.xport.annotation;

import gdv.xport.feld.Align;
import gdv.xport.feld.Feld;

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

/**
 * Diese Annotation dient als Behaelter fuer einige Meta-Informationen wie
 * Byte-Adresse oder Datentyp.
 *
 * @author oliver ([email protected])
 * @since 0.6 (06.03.2011)
 * @deprecated Enums mit dieser Annotation werden ab v6 nicht mehr unterstuetzt
 */
@Deprecated
@Retention(RetentionPolicy.RUNTIME)
public @interface FeldInfo {

    /**
     * Teildatensatz.
     *
     * @return the int
     */
    int teildatensatz() default 1;

    /**
     * Feld-Nummer im Teildatensatz.
     *
     * @return the int
     */
    int nr() default 1;

    /**
     * Erwarteter Datentyp, der angegeben werden muss.
     *
     * @return Datentyp
     */
    Class type();

    /**
     * Ausrichtung: rechts- oder linksbuendig.
     *
     * @return the align
     */
    Align align() default Align.UNKNOWN;

    /**
     * Anzahl bytes.
     *
     * @return the int
     */
    int anzahlBytes() default 1;

    /**
     * Byte adresse.
     *
     * @return the int
     */
    int byteAdresse() default -1;

    /**
     * Anzahl Nachkommastellen.
     *
     * @return the int
     */
    int nachkommaStellen() default 0;

    /**
     * Erlaeuterung.
     *
     * @return the string
     */
    String erlaeuterung() default "siehe Handbuch GDV-Datensatz";

    /**
     * Normalerweise wird der Bezeichnung aus dem Namen abgeleitet. In manchen
     * Faellen muss man (wie z.B. der VU-Nummer) koennen wir etwas nachhelfen.
     *
     * @return the string
     * @since 0.9
     */
    String bezeichnung() default "";

    /**
     * Hierueber kann ein Default-Wert fuer ein Element mitgegeben werden.
     *
     * @return the string
     * @since 1.0
     */
    String value() default "";

}