Interface Actuator.Builder

    • Method Detail

      • fullyQualifiedName

        Actuator.Builder fullyQualifiedName​(String fullyQualifiedName)

        The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be Vehicle.Front.Left.Door.Lock.

        Parameters:
        fullyQualifiedName - The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be Vehicle.Front.Left.Door.Lock.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • dataType

        Actuator.Builder dataType​(String dataType)

        The specified data type of the actuator.

        Parameters:
        dataType - The specified data type of the actuator.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        NodeDataType, NodeDataType
      • dataType

        Actuator.Builder dataType​(NodeDataType dataType)

        The specified data type of the actuator.

        Parameters:
        dataType - The specified data type of the actuator.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        NodeDataType, NodeDataType
      • description

        Actuator.Builder description​(String description)

        A brief description of the actuator.

        Parameters:
        description - A brief description of the actuator.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • unit

        Actuator.Builder unit​(String unit)

        The scientific unit for the actuator.

        Parameters:
        unit - The scientific unit for the actuator.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • allowedValues

        Actuator.Builder allowedValues​(Collection<String> allowedValues)

        A list of possible values an actuator can take.

        Parameters:
        allowedValues - A list of possible values an actuator can take.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • allowedValues

        Actuator.Builder allowedValues​(String... allowedValues)

        A list of possible values an actuator can take.

        Parameters:
        allowedValues - A list of possible values an actuator can take.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • min

        Actuator.Builder min​(Double min)

        The specified possible minimum value of an actuator.

        Parameters:
        min - The specified possible minimum value of an actuator.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • max

        Actuator.Builder max​(Double max)

        The specified possible maximum value of an actuator.

        Parameters:
        max - The specified possible maximum value of an actuator.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • assignedValue

        @Deprecated
        Actuator.Builder assignedValue​(String assignedValue)
        Deprecated.
        assignedValue is no longer in use

        A specified value for the actuator.

        Parameters:
        assignedValue - A specified value for the actuator.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • deprecationMessage

        Actuator.Builder deprecationMessage​(String deprecationMessage)

        The deprecation message for the node or the branch that was moved or deleted.

        Parameters:
        deprecationMessage - The deprecation message for the node or the branch that was moved or deleted.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • comment

        Actuator.Builder comment​(String comment)

        A comment in addition to the description.

        Parameters:
        comment - A comment in addition to the description.
        Returns:
        Returns a reference to this object so that method calls can be chained together.