net.time4j.engine.AttributeQuery 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 (AttributeQuery.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.engine;


/**
 * Type-safe query for format attributes which control the formatting
 * process. 
 *
 * @author  Meno Hochschild
 * @see     ChronoMerger#createFrom(ChronoEntity, AttributeQuery, boolean)
 */
/*[deutsch]
 * Typsichere Abfrage von Formatattributen zur Steuerung eines
 * Formatier- oder Parse-Vorgangs. 
 *
 * @author  Meno Hochschild
 * @see     ChronoMerger#createFrom(ChronoEntity, AttributeQuery, boolean)
 */
public interface AttributeQuery {

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

    /**
     * Queries if a format attribute exists for given key. 
     *
     * @param   key     attribute key
     * @return  {@code true} if attribute exists else {@code false}
     */
    /*[deutsch]
     * Ermittelt, ob ein Formatattribut zum angegebenen Schlüssel
     * existiert. 
     *
     * @param   key     attribute key
     * @return  {@code true} if attribute exists else {@code false}
     */
    boolean contains(AttributeKey key);

    /**
     * Yields a format attribute for given key. 
     *
     * @param    generic type of attribute value
     * @param   key     attribute key
     * @return  attribute value
     * @throws  java.util.NoSuchElementException if attribute does not exist
     */
    /*[deutsch]
     * Ermittelt ein Formatattribut zum angegebenen Schlüssel. 
     *
     * @param    generic type of attribute value
     * @param   key     attribute key
     * @return  attribute value
     * @throws  java.util.NoSuchElementException if attribute does not exist
     */
     A get(AttributeKey key);

    /**
     * Yields a format attribute for given key. 
     *
     * @param    generic type of attribute value
     * @param   key             attribute key
     * @param   defaultValue    replacement value to be used if attribute does
     *                          not exist
     * @return  attribute value
     */
    /*[deutsch]
     * Ermittelt ein Formatattribut zum angegebenen Schlüssel. 
     *
     * @param    generic type of attribute value
     * @param   key             attribute key
     * @param   defaultValue    replacement value to be used if attribute does
     *                          not exist
     * @return  attribute value
     */
     A get(
        AttributeKey key,
        A defaultValue
    );

}