001/*
002 * Units of Measurement Reference Implementation
003 * Copyright (c) 2005-2018, 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, Indriya nor the names of their 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 tech.units.indriya.format;
031
032/**
033 * Defines the different variants of unit formatting.
034 * 
035 * @author Werner Keil
036 * @version 1.0
037 * @since 1.0.1
038 */
039// TODO @since should be 1.0 for Indriya here (this is based on uom-se)
040public enum UnitStyle {
041
042  /**
043   * The unit will be rendered as its name.
044   * 
045   * @see javax.measure.Unit#getName()
046   */
047  NAME,
048
049  /**
050   * The unit will be rendered as its symbol.
051   * 
052   * @see javax.measure.Unit#getSymbol()
053   */
054  SYMBOL,
055
056  /**
057   * The unit will be rendered as its label.
058   * 
059   * @see javax.measure.format.UnitFormat#label()
060   */
061  LABEL,
062
063  /**
064   * The unit will be rendered as its symbol and also labeled.
065   * 
066   * @see javax.measure.Unit#getSymbol()
067   * @see javax.measure.format.UnitFormat#label()
068   */
069  SYMBOL_AND_LABEL
070}