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.test.format;
031
032import java.io.IOException;
033import java.util.HashMap;
034import java.util.Map;
035
036import javax.measure.Unit;
037import javax.measure.format.UnitFormat;
038
039/**
040 * Provides a simple interface for formatting and parsing {@linkplain Unit units}.
041 *
042 * @author <a href="mailto:werner@uom.technology">Werner Keil</a>
043 * @version 1.0, February 13, 2021
044 */
045public class SimpleTestUnitFormat extends TestUnitFormat {
046    private final Map<String, String> symbolMap = new HashMap<>();
047
048    private static final TestUnitFormat DEFAULT = new SimpleTestUnitFormat();
049
050    // /////////////////
051    // Class methods //
052    // /////////////////
053
054    /**
055     * Returns the instance for formatting and parsing using case insensitive symbols
056     @return the default instance
057     */
058    public static UnitFormat geInstance() {
059        return DEFAULT;
060    }
061
062    // ////////////////
063    // Constructors //
064    // ////////////////
065    /**
066     * Base constructor.
067     */
068    private SimpleTestUnitFormat() {
069    }
070
071    // //////////////
072    // Formatting //
073    // //////////////
074    public Appendable format(final Unit<?> unit, final Appendable appendable) throws IOException {
075        CharSequence symbol;
076        @SuppressWarnings("unlikely-arg-type")
077        String mapSymbol = symbolMap.get(unit);
078        if (mapSymbol != null) {
079            symbol = mapSymbol;
080        } else {
081            throw new IllegalArgumentException("Symbol mapping for unit of type " + //$NON-NLS-1$
082                unit.getClass().getName() + " has not been set " + //$NON-NLS-1$
083                "(see UnitFormat.SymbolMap)"); //$NON-NLS-1$
084        }
085        appendable.append(symbol);
086        return appendable;
087    }
088
089    public void label(Unit<?> unit, String label) {
090    }
091}