Package org.openhab.core.voice.text

Record Class Rule.InterpretationContext

java.lang.Object

java.lang.Record

org.openhab.core.voice.text.Rule.InterpretationContext

Record Components:

itemFilter - Restricts rule compatibility to allowed items.

locationItem - Location item to prioritize item matches or null.

Enclosing class:

Rule

public static record Rule.InterpretationContext(AbstractRuleBasedInterpreter.ItemFilter itemFilter, boolean isForced, boolean isSilent, @Nullable String locationItem)
extends Record

Context for rule execution.

Author:

Miguel Álvarez - Initial contribution

Constructor Summary

Constructors

Constructor	Description
InterpretationContext(AbstractRuleBasedInterpreter.ItemFilter itemFilter, boolean isForced, boolean isSilent, @Nullable String locationItem)	Creates an instance of a InterpretationContext record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
boolean	isForced()	Returns the value of the isForced record component.
boolean	isSilent()	Returns the value of the isSilent record component.
AbstractRuleBasedInterpreter.ItemFilter	itemFilter()	Returns the value of the itemFilter record component.
@Nullable String	locationItem()	Returns the value of the locationItem record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

InterpretationContext

public InterpretationContext(AbstractRuleBasedInterpreter.ItemFilter itemFilter,
 boolean isForced,
 boolean isSilent,
 @Nullable String locationItem)

Creates an instance of a InterpretationContext record class.

Parameters:

itemFilter - the value for the itemFilter record component

isForced - the value for the isForced record component

isSilent - the value for the isSilent record component

locationItem - the value for the locationItem record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

itemFilter

public AbstractRuleBasedInterpreter.ItemFilter itemFilter()

Returns the value of the itemFilter record component.

Returns:

the value of the itemFilter record component

isForced

public boolean isForced()

Returns the value of the isForced record component.

Returns:

the value of the isForced record component

isSilent

public boolean isSilent()

Returns the value of the isSilent record component.

Returns:

the value of the isSilent record component

locationItem

public @Nullable String locationItem()

Returns the value of the locationItem record component.

Returns:

the value of the locationItem record component