Interface ComponentMixin

All Superinterfaces:
Broadcaster, Component, Listener, Mixin, NamedObject, Receiver<Transmittable>, Repeater, RepeaterMixin, Transceiver, Transmitter<Transmittable>

public interface ComponentMixin extends Component, Mixin, RepeaterMixin
A mixin for BaseComponent which can be used by a class that already extends another base class.
Author:
jonathanl (shibo)
See Also:
Component, Mixin
  • Method Details

    • component

      default BaseComponent component()
      Returns:
      The BaseComponent implementation associated with this mixin
    • lookup

      default <T> T lookup(Class<T> type, InstanceIdentifier instance)
      Specified by:
      lookup in interface Component
      Returns:
      Any settings object of the given type and instance
    • registerAllSettings

      default void registerAllSettings(Settings settings)
      Description copied from interface: Component
      Registers the settings from the given settings registry with the settings registry for this component
      Specified by:
      registerAllSettings in interface Component
    • registerAllSettingsIn

      default void registerAllSettingsIn(Folder folder)
      Description copied from interface: Component
      Registers the settings in the given folder with the settings registry for this component
      Specified by:
      registerAllSettingsIn in interface Component
    • registerAllSettingsIn

      default void registerAllSettingsIn(Package package_)
      Description copied from interface: Component
      Registers the settings in the given package with the registry for this component
      Specified by:
      registerAllSettingsIn in interface Component
    • registerObject

      default <T> T registerObject(T object, InstanceIdentifier instance)
      Description copied from interface: Component
      Registers the given object and instance in the global object Registry
      Specified by:
      registerObject in interface Component
    • registerSettingsObject

      default void registerSettingsObject(Object settings, InstanceIdentifier instance)
      Description copied from interface: Component
      Registers the given instance of the given settings object with the lookup registry for this component
      Specified by:
      registerSettingsObject in interface Component
    • require

      default <T> T require(Class<T> type, InstanceIdentifier instance)
      Specified by:
      require in interface Component
      Returns:
      The settings object of the given instance and type, or Ensure.fail() is called if there is no such object
    • settings

      default <T> T settings(Class<T> type, InstanceIdentifier instance)
      Specified by:
      settings in interface Component
      Returns:
      The settings object of the given instance and type or null if there is no such object