net.time4j.format.ChronoPattern 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-2014 Meno Hochschild, 
 * -----------------------------------------------------------------------
 * This file (ChronoPattern.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.ChronoElement;

import java.util.Locale;
import java.util.Set;


/**
 * Allows a flexible interpretation of symbols in format patterns. 
 *
 * @author  Meno Hochschild
 */
/*[deutsch]
 * Erlaubt eine flexible Interpretation von Symbolen in Formatmustern. 
 *
 * @author  Meno Hochschild
 */
public interface ChronoPattern {

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

    /**
     * Registers a format symbol. 
     *
     * @param   builder     serves for construction of {@code ChronoFormatter}
     * @param   locale      current language- and country setting
     * @param   symbol      pattern symbol to be interpreted
     * @param   count       count of symbols in format pattern
     * @return  set of elements which will replace other already registered
     *          elements of same name after pattern processing
     * @throws  IllegalArgumentException if symbol resolution fails
     */
    /*[deutsch]
     * Registriert ein Formatsymbol. 
     *
     * @param   builder     serves for construction of {@code ChronoFormatter}
     * @param   locale      current language- and country setting
     * @param   symbol      pattern symbol to be interpreted
     * @param   count       count of symbols in format pattern
     * @return  set of elements which will replace other already registered
     *          elements of same name after pattern processing
     * @throws  IllegalArgumentException if symbol resolution fails
     */
    Set> registerSymbol(
        ChronoFormatter.Builder builder,
        Locale locale,
        char symbol,
        int count
    );

}