Package org.openhab.core.thing.type

Interface StateChannelTypeBuilder

All Superinterfaces:

ChannelTypeBuilder<StateChannelTypeBuilder>

@NonNullByDefault
public interface StateChannelTypeBuilder
extends ChannelTypeBuilder<StateChannelTypeBuilder>

Interface for builders for ChannelTypes of kind STATE

Author:

Stefan Triller - Initial contribution, Mark Herwege - added unit hint

Method Summary

Modifier and Type	Method	Description
StateChannelTypeBuilder	withAutoUpdatePolicy(@Nullable AutoUpdatePolicy autoUpdatePolicy)	Sets the AutoUpdatePolicy for the ChannelType
StateChannelTypeBuilder	withCommandDescription(@Nullable CommandDescription commandDescription)	Sets the list of CommandOptions for the ChannelType
StateChannelTypeBuilder	withStateDescriptionFragment(@Nullable StateDescriptionFragment stateDescriptionFragment)	Sets the StateDescriptionFragment for the ChannelType
StateChannelTypeBuilder	withUnitHint(@Nullable String unitHint)	Sets the unitHint for the ChannelType

Methods inherited from interface org.openhab.core.thing.type.ChannelTypeBuilder

build, isAdvanced, withCategory, withConfigDescriptionURI, withDescription, withTag, withTags, withTags

Method Details

withStateDescriptionFragment

StateChannelTypeBuilder withStateDescriptionFragment(@Nullable StateDescriptionFragment stateDescriptionFragment)

Sets the StateDescriptionFragment for the ChannelType

Parameters:

stateDescriptionFragment - StateDescriptionFragment for the ChannelType

Returns:

this Builder

withAutoUpdatePolicy

StateChannelTypeBuilder withAutoUpdatePolicy(@Nullable AutoUpdatePolicy autoUpdatePolicy)

Sets the AutoUpdatePolicy for the ChannelType

Parameters:

autoUpdatePolicy - the AutoUpdatePolicy for the ChannelType

Returns:

this builder

withCommandDescription

StateChannelTypeBuilder withCommandDescription(@Nullable CommandDescription commandDescription)

Sets the list of CommandOptions for the ChannelType

Parameters:

commandDescription - the list of CommandOptions

Returns:

this builder

withUnitHint

StateChannelTypeBuilder withUnitHint(@Nullable String unitHint)

Sets the unitHint for the ChannelType

Parameters:

unitHint - the unit hint

Returns:

this builder