arez.spy.ComponentInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of arez-core Show documentation

Arez Core

There is a newer version: 0.213

package arez.spy;

import arez.ComputableValue;
import java.util.List;
import javax.annotation.Nonnull;

/**
 * A representation of a component instance exposed to spy framework.
 */
public interface ComponentInfo
  extends ElementInfo
{
  /**
   * Return the component type.
   * This is an opaque string specified by the user.
   *
   * @return the component type.
   */
  @Nonnull
  String getType();

  /**
   * Return the unique id of the component.
   * This will return null for singletons.
   *
   * @return the unique id of the component.
   */
  @Nonnull
  Object getId();

  /**
   * Return the Observables associated with the component.
   * This does NOT include observables that are associated with a {@link ComputableValue}.
   * This collection returned is unmodifiable.
   *
   * @return the associated observables.
   */
  List getObservableValues();

  /**
   * Return the Observers associated with the component.
   * This does NOT include observers that are associated with a {@link ComputableValue}.
   * This collection returned is unmodifiable. This operation recreates the list and is
   * a relatively expensive operation.
   *
   * @return the associated observers.
   */
  List getObservers();

  /**
   * Return the ComputableValues associated with the component.
   * This collection returned is unmodifiable.
   *
   * @return the associated computable values.
   */
  List getComputableValues();
}