io.github.hapjava.characteristics.impl.base.StaticStringCharacteristic Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hap Show documentation

Homekit Accessory Protocol for Java

There is a newer version: 2.0.7

package io.github.hapjava.characteristics.impl.base;

import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import java.util.function.Supplier;
import javax.json.JsonObjectBuilder;
import javax.json.JsonString;
import javax.json.JsonValue;

/**
 * A characteristic that provides an immutable String value.
 *
 * @author Andy Lintner
 */
public class StaticStringCharacteristic extends BaseCharacteristic {

  private static final int MAX_LEN = 255;

  private final Optional>> getter;
  /**
   * Default constructor
   *
   * @param 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.
   * @param description a description of the characteristic to be passed to the consuming device.
   * @param getter getter to retrieve the value
   * @param subscriber subscriber to subscribe to changes
   * @param unsubscriber unsubscriber to unsubscribe from chnages
   */
  public StaticStringCharacteristic(
      String type,
      String description,
      Optional>> getter,
      Optional> subscriber,
      Optional unsubscriber) {
    super(type, "string", description, getter.isPresent(), false, subscriber, unsubscriber);
    this.getter = getter;
  }

  /** {@inheritDoc} */
  @Override
  protected CompletableFuture makeBuilder(int iid) {
    return super.makeBuilder(iid).thenApply(builder -> builder.add("maxLen", MAX_LEN));
  }

  /** {@inheritDoc} */
  @Override
  public String convert(JsonValue jsonValue) {
    return ((JsonString) jsonValue).getString();
  }

  /** {@inheritDoc} */
  @Override
  public void setValue(String value) throws Exception {
    throw new Exception("Cannot modify static strings");
  }

  /** {@inheritDoc} */
  @Override
  protected CompletableFuture getValue() {
    return getter.map(stringGetter -> stringGetter.get()).get();
  }

  /** {@inheritDoc} */
  @Override
  protected String getDefault() {
    return "Unknown";
  }
}