net.time4j.format.FormatEngine Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of time4j-core Show documentation
There is a newer version: 4.38
/*
 * -----------------------------------------------------------------------
 * Copyright © 2013-2015 Meno Hochschild, 
 * -----------------------------------------------------------------------
 * This file (FormatEngine.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 .
 * -----------------------------------------------------------------------
 */

package net.time4j.format;

import net.time4j.engine.ChronoEntity;
import net.time4j.scale.UniversalTime;

import java.util.Locale;


/**
 * This SPI-interface allows the creation of temporal formats via a builder-approach. 
 *
 * Specification:
 * Implementations must have a public no-arg constructor.
 *
 * @param    generic type of applicable format patterns
 * @author  Meno Hochschild
 * @since   3.0
 */
/*[deutsch]
 * 
Dieses SPI-Interface erlaubt die Erzeugung von temporalen Formatobjekten
 * via Builder-Entwurfsmuster. 
 *
 * Specification:
 * Implementations must have a public no-arg constructor.
 *
 * @param    generic type of applicable format patterns
 * @author  Meno Hochschild
 * @since   3.0
 */
public interface FormatEngine
> {

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

    /**
     * 
Creates a new temporal format object applicable on given chronological type. 
     *
     * @param    generic chronological type
     * @param   chronoType      chronological type any creatable format must work with
     * @param   formatPattern   pattern of symbols to be used in formatting and parsing
     * @param   patternType     type of pattern how to interprete symbols
     * @param   locale          language and regional setting
     * @return  temporal format object
     * @throws  IllegalArgumentException if given chronological type is not formattable
     * @since   3.0
     */
    /*[deutsch]
     * Erzeugt ein neues Zeitformatobjekt, das auf den angegebenen chronologischen Typ anwendbar ist. 
     *
     * @param    generic chronological type
     * @param   chronoType      chronological type any creatable format must work with
     * @param   formatPattern   pattern of symbols to be used in formatting and parsing
     * @param   patternType     type of pattern how to interprete symbols
     * @param   locale          language and regional setting
     * @return  temporal format object
     * @throws  IllegalArgumentException if given chronological type is not formattable
     * @since   3.0
     */
    > TemporalFormatter create(
        Class chronoType,
        String formatPattern,
        P patternType,
        Locale locale
    );

    /**
     * Creates a specialized formatter for RFC-1123. 
     *
     * SPECIFICATION: The chronological type must be net.time4j.Moment. 
     *
     * @return  temporal format object
     */
    TemporalFormatter createRFC1123();

    /**
     * Yields the default pattern type. 
     *
     * @return  {@code ChronoPattern}
     * @since   3.0
     */
    /*[deutsch]
     * Liefert den Standard-Formatmustertyp. 
     *
     * @return  {@code ChronoPattern}
     * @since   3.0
     */
    P getDefaultPatternType();

    /**
     * Helps to find out if given chronological type is supported. 
     *
     * @param   chronoType      chronological type to be queried
     * @return  {@code true} if given type is formattable else {@code false}
     * @since   3.0
     */
    /*[deutsch]
     * Hilft herauszufinden, ob der angegebene chronologische Typ formatierbar ist. 
     *
     * @param   chronoType      chronological type to be queried
     * @return  {@code true} if given type is formattable else {@code false}
     * @since   3.0
     */
    boolean isSupported(Class chronoType);

}