Module jonix.common

Package com.tectonica.jonix.common.codelist

Enum Class QuantityUnits

java.lang.Object

java.lang.Enum<QuantityUnits>

com.tectonica.jonix.common.codelist.QuantityUnits

All Implemented Interfaces:

OnixCodelist, Serializable, Comparable<QuantityUnits>, Constable

public enum QuantityUnits
extends Enum<QuantityUnits>
implements OnixCodelist

Enum that corresponds to ONIX Codelist 169

Description: Quantity unit

See Also:

• About ONIX Codelists
• ONIX Codelist 169 in Reference Guide

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface com.tectonica.jonix.common.OnixCodelist

OnixCodelist.Pair

Enum Constant Summary

Enum Constants

Enum Constant	Description
Classes	Multiple copies or units suitable for a class.
Days
Months
Units	The quantity refers to a unit implied by the quantity type
Weeks
Years

Field Summary

Fields

Modifier and Type	Field	Description
final String	code
final String	description

Method Summary

Modifier and Type	Method	Description
static QuantityUnits	byCode(String code)
static Optional<QuantityUnits>	byCodeOptional(String code)
static String	codeToDesciption(String code)
String	getCode()
String	getDescription()
static QuantityUnits	valueOf(String name)	Returns the enum constant of this class with the specified name.
static QuantityUnits[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.tectonica.jonix.common.OnixCodelist

pair

Enum Constant Details

Units

public static final QuantityUnits Units

The quantity refers to a unit implied by the quantity type

Days

public static final QuantityUnits Days

Weeks

public static final QuantityUnits Weeks

Months

public static final QuantityUnits Months

Years

public static final QuantityUnits Years

Classes

public static final QuantityUnits Classes

Multiple copies or units suitable for a class. A 'class' is a group of learners attending a specific course or lesson and generally taught as a group

Jonix-Comment: Introduced in Onix3

Field Details

code

public final String code

description

public final String description

Method Details

values

public static QuantityUnits[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static QuantityUnits valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getCode

public String getCode()

Specified by:

getCode in interface OnixCodelist

getDescription

public String getDescription()

Specified by:

getDescription in interface OnixCodelist

byCode

public static QuantityUnits byCode(String code)

byCodeOptional

public static Optional<QuantityUnits> byCodeOptional(String code)

codeToDesciption

public static String codeToDesciption(String code)