org.pepstock.charba.client.intl.enums.MeasureUnitDisplay Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of charba Show documentation

Charba, GWT Chart library based on CHART.JS

There is a newer version: 6.5-gwt

/**
    Copyright 2017 Andrea "Stock" Stocchero

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

	    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
*/
package org.pepstock.charba.client.intl.enums;

import org.pepstock.charba.client.commons.Key;

/**
 * Enumerated the options to set the unit formatting style to use in unit formatting.

 * The defaults is "short".
 * 
 * @author Andrea "Stock" Stocchero
 *
 */
public enum MeasureUnitDisplay implements Key
{

	/**
	 * Long representation of unit of measure (e.g., 16 litres).
	 */
	LONG("long"),

	/**
	 * Short representation of unit of measure (e.g., e.g., 16 l).
	 */
	SHORT("short"),

	/**
	 * Short representation of unit of measure without spaces (e.g., 16l).
	 */
	NARROW("narrow");

	// name value of property
	private final String value;

	/**
	 * Creates with the property value to use in the native object.
	 * 
	 * @param value value of property name
	 */
	private MeasureUnitDisplay(String value) {
		this.value = value;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.pepstock.charba.client.commons.Key#value()
	 */
	@Override
	public String value() {
		return value;
	}

}