cdm.base.math.WeatherUnitEnum Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cdm-java Show documentation

There is a newer version: 6.0.0-dev.89

package cdm.base.math;

import cdm.base.math.WeatherUnitEnum;
import com.rosetta.model.lib.annotations.RosettaEnum;
import com.rosetta.model.lib.annotations.RosettaEnumValue;
import java.util.Collections;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;


/**
 * Provides enumerated values for weather units, generally used in the context of defining quantities for commodities.
 * @version 6.0.0-dev.82
 */
@RosettaEnum("WeatherUnitEnum")
public enum WeatherUnitEnum {

	/**
	 * Denotes Cooling Degree Days as a standard unit.
	 */
	@RosettaEnumValue(value = "CDD") 
	CDD("CDD", null),
	
	/**
	 * Denotes Critical Precipitation Day as a standard unit.
	 */
	@RosettaEnumValue(value = "CPD") 
	CPD("CPD", null),
	
	/**
	 * Heating Degree Day as a standard unit.
	 */
	@RosettaEnumValue(value = "HDD") 
	HDD("HDD", null)
;
	private static Map values;
	static {
        Map map = new ConcurrentHashMap<>();
		for (WeatherUnitEnum instance : WeatherUnitEnum.values()) {
			map.put(instance.toDisplayString(), instance);
		}
		values = Collections.unmodifiableMap(map);
    }

	private final String rosettaName;
	private final String displayName;

	WeatherUnitEnum(String rosettaName, String displayName) {
		this.rosettaName = rosettaName;
		this.displayName = displayName;
	}

	public static WeatherUnitEnum fromDisplayName(String name) {
		WeatherUnitEnum value = values.get(name);
		if (value == null) {
			throw new IllegalArgumentException("No enum constant with display name \"" + name + "\".");
		}
		return value;
	}

	@Override
	public String toString() {
		return toDisplayString();
	}

	public String toDisplayString() {
		return displayName != null ?  displayName : rosettaName;
	}
}