Package org.openhab.core.types

Class StateDescriptionFragmentBuilder

java.lang.Object

org.openhab.core.types.StateDescriptionFragmentBuilder

@NonNullByDefault
public class StateDescriptionFragmentBuilder
extends Object

Builds a StateDescriptionFragment with the relevant parts only.

Author:

Henning Treu - Initial contribution

Method Summary

Modifier and Type	Method	Description
StateDescriptionFragment	build()	Builds a StateDescriptionFragment from the values of this builder.
static StateDescriptionFragmentBuilder	create()	Creates and returns a fresh builder instance.
static StateDescriptionFragmentBuilder	create(StateDescription legacy)	Creates a builder instance and initializes all fields from the given StateDescription.
static StateDescriptionFragmentBuilder	create(StateDescriptionFragment fragment)	Creates a builder instance and initializes all fields from the given StateDescriptionFragment.
StateDescriptionFragmentBuilder	withMaximum(BigDecimal maximum)	Set the maximum for the resulting StateDescriptionFragment.
StateDescriptionFragmentBuilder	withMinimum(BigDecimal minimum)	Set the minimum for the resulting StateDescriptionFragment.
StateDescriptionFragmentBuilder	withOption(StateOption option)	Ass a StateOption for the resulting StateDescriptionFragment.
StateDescriptionFragmentBuilder	withOptions(List<StateOption> options)	Set the StateOptions for the resulting StateDescriptionFragment.
StateDescriptionFragmentBuilder	withPattern(String pattern)	Set the pattern for the resulting StateDescriptionFragment.
StateDescriptionFragmentBuilder	withReadOnly(Boolean readOnly)	Set readOnly for the resulting StateDescriptionFragment.
StateDescriptionFragmentBuilder	withStep(BigDecimal step)	Set the step for the resulting StateDescriptionFragment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

public static StateDescriptionFragmentBuilder create()

Creates and returns a fresh builder instance.

Returns:

a fresh StateDescriptionFragmentBuilder instance.

create

public static StateDescriptionFragmentBuilder create(StateDescriptionFragment fragment)

Creates a builder instance and initializes all fields from the given StateDescriptionFragment. Note: State options will only be taken into account if the list is not empty.

Parameters:

fragment - the StateDescriptionFragment this builder be initialized from.

Returns:

the builder.

create

public static StateDescriptionFragmentBuilder create(StateDescription legacy)

Creates a builder instance and initializes all fields from the given StateDescription. Note: State options will only be taken into account if the list is not empty.

Parameters:

legacy - the StateDescription this builder be initialized from.

Returns:

the builder.

build

public StateDescriptionFragment build()

Builds a StateDescriptionFragment from the values of this builder.

Returns:

a StateDescriptionFragment from the values of this builder.

withMaximum

public StateDescriptionFragmentBuilder withMaximum(BigDecimal maximum)

Set the maximum for the resulting StateDescriptionFragment.

Parameters:

maximum - the maximum for the resulting StateDescriptionFragment.

Returns:

this builder.

withMinimum

public StateDescriptionFragmentBuilder withMinimum(BigDecimal minimum)

Set the minimum for the resulting StateDescriptionFragment.

Parameters:

minimum - the minimum for the resulting StateDescriptionFragment.

Returns:

this builder.

withStep

public StateDescriptionFragmentBuilder withStep(BigDecimal step)

Set the step for the resulting StateDescriptionFragment.

Parameters:

step - the step for the resulting StateDescriptionFragment.

Returns:

this builder.

withPattern

public StateDescriptionFragmentBuilder withPattern(String pattern)

Set the pattern for the resulting StateDescriptionFragment.

Parameters:

pattern - the pattern for the resulting StateDescriptionFragment.

Returns:

this builder.

withReadOnly

public StateDescriptionFragmentBuilder withReadOnly(Boolean readOnly)

Set readOnly for the resulting StateDescriptionFragment.

Parameters:

readOnly - readOnly for the resulting StateDescriptionFragment.

Returns:

this builder.

withOption

public StateDescriptionFragmentBuilder withOption(StateOption option)

Ass a StateOption for the resulting StateDescriptionFragment.

Parameters:

option - a StateOption for the resulting StateDescriptionFragment.

Returns:

this builder.

withOptions

public StateDescriptionFragmentBuilder withOptions(List<StateOption> options)

Set the StateOptions for the resulting StateDescriptionFragment.

Parameters:

options - the StateOptions for the resulting StateDescriptionFragment.

Returns:

this builder.