Package org.openhab.core.library.types

Class PercentType

java.lang.Object

java.lang.Number

org.openhab.core.library.types.DecimalType

org.openhab.core.library.types.PercentType

All Implemented Interfaces:

Serializable, Comparable<DecimalType>, Command, PrimitiveType, State, Type

Direct Known Subclasses:

HSBType

@NonNullByDefault
public class PercentType
extends DecimalType

The PercentType extends the DecimalType by putting constraints for its value on top (0-100).

Author:

Kai Kreuzer - Initial contribution

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final PercentType	HUNDRED
static final PercentType	ZERO

Fields inherited from class org.openhab.core.library.types.DecimalType

BIG_DECIMAL_HUNDRED, value

Constructor Summary

Constructors

Constructor	Description
PercentType()	Creates a new PercentType with 0 as value.
PercentType(int value)	Creates a new PercentType with the given value.
PercentType(String value)	Creates a new PercentType with the given value.
PercentType(String value, Locale locale)	Creates a new PercentType with the given value.
PercentType(BigDecimal value)	Creates a new PercentType with the given value.

Method Summary

Modifier and Type	Method	Description
<T extends State> @Nullable T	as(@Nullable Class<T> target)	Convert this State's value into another type
static PercentType	valueOf(String value)	Static access to PercentType(String).

Methods inherited from class org.openhab.core.library.types.DecimalType

compareTo, defaultConversion, doubleValue, equals, floatValue, format, hashCode, intValue, longValue, toBigDecimal, toFullString, toString

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

ZERO

public static final PercentType ZERO

HUNDRED

public static final PercentType HUNDRED

Constructor Details

PercentType

public PercentType()

Creates a new PercentType with 0 as value.

PercentType

public PercentType(int value)

Creates a new PercentType with the given value.

Parameters:

value - the value representing a percentage

Throws:

IllegalArgumentException - when the value is not between 0 and 100

PercentType

public PercentType(String value)

Creates a new PercentType with the given value. The English locale is used to determine (decimal/grouping) separator characters.

Parameters:

value - the non null value representing a percentage

Throws:

NumberFormatException - when the number could not be parsed to a BigDecimal

IllegalArgumentException - when the value is not between 0 and 100

PercentType

public PercentType(String value,
 Locale locale)

Creates a new PercentType with the given value.

Parameters:

value - the non null value representing a percentage

locale - the locale used to determine (decimal/grouping) separator characters

Throws:

NumberFormatException - when the number could not be parsed to a BigDecimal

IllegalArgumentException - when the value is not between 0 and 100

PercentType

public PercentType(BigDecimal value)

Creates a new PercentType with the given value.

Parameters:

value - the value representing a percentage.

Throws:

IllegalArgumentException - when the value is not between 0 and 100

Method Details

valueOf

public static PercentType valueOf(String value)

Static access to PercentType(String).

Parameters:

value - the non null value representing a percentage

Returns:

new PercentType

Throws:

NumberFormatException - when the number could not be parsed to a BigDecimal

IllegalArgumentException - when the value is not between 0 and 100

as

public <T extends State> @Nullable T as(@Nullable Class<T> target)

Description copied from interface: State

Convert this State's value into another type

Specified by:

as in interface State

Overrides:

as in class DecimalType

Parameters:

target - the desired State type

Returns:

the State's value in the given type's representation, or null if the conversion was not possible