001/*
002 * Units of Measurement API
003 * Copyright (c) 2014-2015, 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.Collection;
033
034/**
035 * <p>
036 * This interface represents the service to obtain a {@link SystemOfUnits system
037 * of units}.
038 * </p>
039 * 
040 * <p>
041 * Common system of units are "SI" (System International), "Imperial" (British),
042 * "US" (US Customary).
043 * </p>
044 * 
045 * @author <a href="mailto:[email protected]">Jean-Marie Dautelle</a>
046 * @author <a href="mailto:[email protected]">Werner Keil</a>
047 * @version 0.7, $Date: 2015-11-08 $
048 */
049public interface SystemOfUnitsService {
050
051        /**
052         * Returns the default {@link SystemOfUnits system
053     * of units}. Depending on the implementation this may be the <a
054         * href=http://en.wikipedia.org/wiki/International_System_of_Units">
055         * International System of Units</a> or another default system.
056         * 
057         * @return the default system of units.
058         */
059        SystemOfUnits getSystemOfUnits();
060
061    /**
062     * Returns the system of units having the specified name or
063     * <code>null</code> if none.
064     *
065     * @param name the system of unit name.
066     * @return the given system of units.
067     */
068        SystemOfUnits getSystemOfUnits(String name);
069
070    /**
071     * Gets a list with available systems for this {@link SystemOfUnitsService}.
072     * @return list of available systems of units, never null.
073     */
074        Collection<SystemOfUnits> getAvailableSystemsOfUnits();
075}