Package io.github.hapjava.characteristics.impl.base

Class StringCharacteristic

    • Constructor Summary

      Constructors 
      Constructor Description
      StringCharacteristic​(java.lang.String type, java.lang.String description, java.util.Optional<java.util.function.Supplier<java.util.concurrent.CompletableFuture<java.lang.String>>> getter, java.util.Optional<ExceptionalConsumer<java.lang.String>> setter, java.util.Optional<java.util.function.Consumer<HomekitCharacteristicChangeCallback>> subscriber, java.util.Optional<java.lang.Runnable> unsubscriber)
      Default constructor

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String convert​(javax.json.JsonValue jsonValue)
      Converts from the JSON value to a Java object of the type T
      java.lang.String getDefault()
      Supplies a default value for the characteristic to send to connected clients when the real value.
      java.util.concurrent.CompletableFuture<java.lang.String> getValue()
      Retrieves the current value of the characteristic.
      protected java.util.concurrent.CompletableFuture<javax.json.JsonObjectBuilder> makeBuilder​(int iid)
      Creates the JSON serialized form of the accessory for use over the HomeKit Accessory Protocol.
      void setValue​(java.lang.String value)
      Update the characteristic value using a new value supplied by the connected client.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • StringCharacteristic

        public StringCharacteristic​(java.lang.String type,
                            java.lang.String description,
                            java.util.Optional<java.util.function.Supplier<java.util.concurrent.CompletableFuture<java.lang.String>>> getter,
                            java.util.Optional<ExceptionalConsumer<java.lang.String>> setter,
                            java.util.Optional<java.util.function.Consumer<HomekitCharacteristicChangeCallback>> subscriber,
                            java.util.Optional<java.lang.Runnable> unsubscriber)
        Default constructor
        Parameters:
        type - a string containing a UUID that indicates the type of characteristic. Apple defines a set of these, however implementors can create their own as well.
        description - a description of the characteristic to be passed to the consuming device.
        getter - getter to retrieve the value
        setter - setter for value
        subscriber - subscriber to subscribe to changes
        unsubscriber - unsubscriber to unsubscribe from chnages

    • Method Detail

      • makeBuilder

        protected java.util.concurrent.CompletableFuture<javax.json.JsonObjectBuilder> makeBuilder​(int iid)
        Creates the JSON serialized form of the accessory for use over the HomeKit Accessory Protocol.
        Overrides:
        makeBuilder in class BaseCharacteristic<java.lang.String>
        Parameters:
        iid - the static id of the accessory.
        Returns:
        a future that will complete with the JSON builder for the object.

      • convert

        public java.lang.String convert​(javax.json.JsonValue jsonValue)
        Converts from the JSON value to a Java object of the type T
        Specified by:
        convert in class BaseCharacteristic<java.lang.String>
        Parameters:
        jsonValue - the JSON value to convert from.
        Returns:
        the converted Java object.

      • setValue

        public void setValue​(java.lang.String value)
              throws java.lang.Exception
        Update the characteristic value using a new value supplied by the connected client.
        Specified by:
        setValue in class BaseCharacteristic<java.lang.String>
        Parameters:
        value - the new value to set.
        Throws:
        java.lang.Exception - if the value cannot be set.

      • getValue

        public java.util.concurrent.CompletableFuture<java.lang.String> getValue()
        Retrieves the current value of the characteristic.
        Specified by:
        getValue in class BaseCharacteristic<java.lang.String>
        Returns:
        a future that will complete with the current value.

      • getDefault

        public java.lang.String getDefault()
        Supplies a default value for the characteristic to send to connected clients when the real value. cannot be retrieved.
        Specified by:
        getDefault in class BaseCharacteristic<java.lang.String>
        Returns:
        a sensible default value.