/*
 * -----------------------------------------------------------------------
 * Copyright © 2013-2014 Meno Hochschild, <http://www.menodata.de/>
 * -----------------------------------------------------------------------
 * This file (CalendarEra.java) is part of project Time4J.
 *
 * Time4J is free software: You can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * Time4J 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Time4J. If not, see <http://www.gnu.org/licenses/>.
 * -----------------------------------------------------------------------
 */

package net.time4j.engine;


/**
 * <p>Represents an era in a calendar system. </p>
 *
 * <p>An era is date-related and defines a reference date which can be
 * interpreted as start or end of an era. Not all calendar systems know
 * an era concept, however. Especially all ISO-calendar systems have no
 * era according to ISO-8601-standard. If an era exists in a given
 * calendar system then the meaning of a year changes such that it
 * means the year of an era counting as positive number from {@code >= 1}. </p>
 *
 * @author  Meno Hochschild
 */
/*[deutsch]
 * <p>Repr&auml;sentiert eine &Auml;ra in einem Kalendersystem. </p>
 *
 * <p>Eine &Auml;ra ist grunds&auml;tzlich datumsbezogen und definiert ein
 * Bezugsdatum, das als Beginn oder Ende der &Auml;ra interpretiert werden
 * kann. Nicht alle Kalender kennen &uuml;berhaupt eine &Auml;ra, insbesondere
 * alle ISO-Kalendersysteme haben dieses Konzept nicht. Wenn eine &Auml;ra
 * existiert, ver&auml;ndert sich die Bedeutung einer Jahresangabe im
 * jeweiligen Kalendersystem dahingehend, da&szlig; die Jahresangabe dann
 * als Jahr innerhalb einer &Auml;ra zu interpretieren ist. Jahre innerhalb
 * einer &Auml;ra sind grunds&auml;tzlich positive Zahlen {@code >= 1}. </p>
 *
 * @author  Meno Hochschild
 */
public interface CalendarEra {

    //~ Methoden ----------------------------------------------------------

    /**
     * <p>Yields the canonical non-localized name. </p>
     *
     * @return  String
     */
    /*[deutsch]
     * <p>Liefert den kanonischen nicht lokalisierten Namen. </p>
     *
     * @return  String
     */
    String name();

    /**
     * <p>Yields an ordinal number which is scaled such that every era
     * which contains the ISO-date of UTC-epoch [1972-01-01] will have
     * the associated value {@code 1}. </p>
     *
     * @return  int
     */
    /*[deutsch]
     * <p>Liefert eine Ordnungsnummer, die so skaliert ist, da&szlig;
     * jede &Auml;ra, die das ISO-Datum der UTC-Epoche [1972-01-01]
     * enth&auml;lt, den Wert {@code 1} ergibt. </p>
     *
     * @return  int
     */
    int getValue();


}

@@ -94,17 +94,17 @@
 2013-201
-4
+6
  Meno Ho
@@ -2831,36 +2831,243 @@
    *%0A     * 
-@return  int
+%3Cp%3EAttention: This number is neither necessarily unique nor%0A     * does it imply any chronological order. %3C/p%3E%0A     *%0A     * @return  int%0A     * @deprecated  no replacement in next major release because it is not useful
 %0A     */%0A   
@@ -3288,28 +3288,275 @@
   * 
-@return  int%0A     */
+%3Cp%3EAchtung: Die so definierte Ordnungsnummer ist weder zwingend eindeutig%0A     * noch legt sie irgendeine zeitliche Ordnung fest. %3C/p%3E%0A     *%0A     * @return  int%0A     * @deprecated  no replacement in next major release because it is not useful%0A     */%0A    @Deprecated
 %0A   
@@ -3573,11 +3573,10 @@
 lue();%0A%0A
-%0A
 %7D%0A

clarify CalendarEra.getValue()