001/*
002 * Units of Measurement API
003 * Copyright (c) 2014-2023, Jean-Marie Dautelle, Werner Keil, Otavio Santana.
004 *
005 * All rights reserved.
006 *
007 * Redistribution and use in source and binary forms, with or without modification,
008 * are permitted provided that the following conditions are met:
009 *
010 * 1. Redistributions of source code must retain the above copyright notice,
011 *    this list of conditions and the following disclaimer.
012 *
013 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions
014 *    and the following disclaimer in the documentation and/or other materials provided with the distribution.
015 *
016 * 3. Neither the name of JSR-385 nor the names of its contributors may be used to endorse or promote products
017 *    derived from this software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
020 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
021 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
022 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
023 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
026 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
028 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package javax.measure.spi;
031
032import java.util.Set;
033
034import javax.measure.format.QuantityFormat;
035import javax.measure.format.UnitFormat;
036
037/**
038 * This interface represents the service to obtain instances of {@link UnitFormat} and {@link QuantityFormat}.
039 *
040 * @author <a href="mailto:werner@uom.technology">Werner Keil</a>
041 * @version 2.3, May 20, 2023
042 * @since 2.0
043 */
044public interface FormatService {
045
046        /** The type of format, either a {@link UnitFormat} or {@link QuantityFormat} */
047    public static enum FormatType {
048        /** Format of type {@link UnitFormat} */
049        UNIT_FORMAT, 
050        /** Format of type {@link QuantityFormat} */
051        QUANTITY_FORMAT
052    }
053
054    /**
055     * Returns the default quantity format.
056     *
057     * It is up to implementations what to consider a suitable default. For some (locale-sensitive) implementations it may be a quantity format based on
058     * {@code Locale.current()} while others may return {@code getQuantityFormat("Simple")} or {@code getQuantityFormat("ISO")}.
059     *
060     * @return the default {@link QuantityFormat} implementation.
061     */
062    QuantityFormat getQuantityFormat();
063
064    /**
065     * Returns the quantity format having the specified name or {@code null} if none.
066     *
067     * For example (@code getQuantityFormat("Simple")} to return the simple {@link QuantityFormat} implementation.
068     *
069     * @param name
070     *          the name of the format.
071     * @return the corresponding quantity format.
072     */
073    QuantityFormat getQuantityFormat(String name);
074
075    /**
076     * Returns the default unit format.
077     *
078     * It is up to implementations what to consider a suitable default. For some (locale-sensitive) implementations it may be a unit format based on
079     * {@code Locale.current()} while others may return {@code getUnitFormat("Simple")} or {@code getUnitFormat("ISO")}.
080     *
081     * @return the default {@link UnitFormat} implementation.
082     */
083    UnitFormat getUnitFormat();
084
085    /**
086     * Returns the unit format having the specified name or {@code null} if none.
087     *
088     * For example {@code getUnitFormat("Simple")} to return a simple {@link UnitFormat} implementation.
089     *
090     * @param name
091     *          the name of the format.
092     * @return the corresponding unit format.
093     */
094    UnitFormat getUnitFormat(String name);
095    
096    /**
097     * Returns the unit format having the specified name or {@code null} if none.
098     *
099     * For example {@code getUnitFormat("Simple")} to return a simple {@link UnitFormat} implementation.<br>
100     * The variant is an arbitrary value to allow a variation of a {@link UnitFormat}, 
101     * for example <code>UTF</code> vs. <code>ASCII</code> encoding of the simple <code>UnitFormat</code> 
102     * or <code>case sensitive</code> vs. <code>case insensitive</code> <a href="https://ucum.org/ucum.html">UCUM</a> format.
103     * <p>If no variant is applicable, the <code>UnitFormat</code> matching the name only is returned.</p> 
104     * @param name
105     *          the name of the format.
106     * @param variant any arbitrary value used to indicate a variation of a <code>UnitFormat</code>.
107     * @return the corresponding unit format.
108     */
109    UnitFormat getUnitFormat(String name, String variant);
110    
111    /**
112     * Gets a list with available format names of a given type for this format service.
113     *
114     * @param type
115     *          the {@link FormatType}
116     * @return list of available formats, never null.
117     */
118    Set<String> getAvailableFormatNames(FormatType type);
119}