gdv.xport.satz.feld.common.TeildatensatzNummer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gdv-xport-lib Show documentation

gdv-xport-lib ist die Java-Bibliothek fuer den Umgang mit dem GDV-Format. Sie erleichtert den Export und Export dieses Datenformats.

There is a newer version: 7.2.2

Show newest version

/*
 * Copyright (c) 2013 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.
 */

package gdv.xport.satz.feld.common;

/**
 * The Enum TeildatensatzNummer.
 * 
 * TODO: Wird mit v7 entfernt.
 * 
 *
 * @deprecated wird nur zum Auslesen der Satznummer verwendet und ist obsolet
 */
@Deprecated
public enum TeildatensatzNummer {

    /** The null. */
    NULL(-1),

	/** Satznummer 1. */
	EINS(1),

	/** Satznummer 2. */
	ZWEI(2),

	/** Satznummer 3. */
	DREI(3),

    /** The bezugsrechte. */
    BEZUGSRECHTE(6),

    /** The auszahlungen. */
    AUSZAHLUNGEN(7),

    /** The zukuenftige summenaenderung. */
    ZUKUENFTIGE_SUMMENAENDERUNG(8),

    /** The wertungssummen. */
    WERTUNGSSUMMEN(9);

	private int code = -1;

	private TeildatensatzNummer(final int code) {
		this.code = code;
	}

	/**
	 * Gets the code.
	 *
	 * @return the code
	 */
	public int getCode() {
		return code;
	}

	/**
	 * Checks if is in.
	 *
	 * @param code the code
	 * @return the teildatensatz nummer
	 * @deprecated durch {@link TeildatensatzNummer#of(int)} ersetzt
	 */
	@Deprecated
	public static TeildatensatzNummer isIn(final int code) {
		return of(code);
	}

	/**
	 * Liefert zu einer Zahl die entsprechende {@link TeildatensatzNummer}
	 * zurueck.
	 *
	 * @param code Nummer zwischen 1 und 9
	 * @return z.B. BEZUGSRECHTE
	 */
	public static TeildatensatzNummer of(final int code) {
		for (TeildatensatzNummer existing : TeildatensatzNummer.values()) {
			if (existing.getCode() == code) {
				return existing;
			}
		}
		if (code > 0 && code < BEZUGSRECHTE.getCode()) {
			return EINS;
		}
		return TeildatensatzNummer.NULL;
	}
}