001/*
002 * Units of Measurement API
003 * Copyright (c) 2014-2016, Jean-Marie Dautelle, Werner Keil, V2COM.
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-363 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.UnitFormat;
035
036/**
037 * This interface represent the service to obtain {@link UnitFormat} instances.
038 *
039 * @author <a href="mailto:[email protected]">Jean-Marie Dautelle</a>
040 * @author <a href="mailto:[email protected]">Werner Keil</a>
041 * @version 1.0, August 8, 2016
042 * @since 1.0
043 */
044public interface UnitFormatService {
045
046  /**
047   * Returns the default unit format.
048   *
049   * It is up to implementations what to consider a suitable default. For some (locale-sensitive) implementations it may be a unit format based on
050   * <code>Locale.current()</code> while others may return <code>getUnitFormat("Simple")</code> or <code>getUnitFormat("ISO")</code>
051   *
052   * @return the default {@link UnitFormat} implementation.
053   */
054  UnitFormat getUnitFormat();
055
056  /**
057   * Returns the unit format having the specified name or <code>null</code> if none.
058   *
059   * For example <code>getUnitFormat("UCUM")</code> to return a UCUM specific {@link UnitFormat} implementation.
060   *
061   * @param name
062   *          the name of the format.
063   * @return the corresponding unit format.
064   */
065  UnitFormat getUnitFormat(String name);
066
067  /**
068   * Gets a list with available format names for this format service.
069   *
070   * @return list of available formats, never null.
071   */
072  Set<String> getAvailableFormatNames();
073}