Package com.tccc.kos.commons.core.service.handle

Interface ContextHandleAware

All Superinterfaces:
HandleAware
All Known Implementing Classes:
AbstractConfigurableService, AbstractService, AnalyticsClient, AnalyticsServer, ApiClient, Application, AppService, AssemblyService, BrokerClient, BrowserService, ConfigSerialNumberProvider, ConfigServer, ConfigService, CriticalDataService, DeviceService, ExtensionService, FirmwareService, FuseService, HandleService, HardwareService, KeyValService, LocalizationService, LogService, ManifestService, NetworkService, NodeMgrService, NodeResolverService, OTAService, RegionService, SerialService, SpawnService, StateService, StorageService, SystemApplication, TimeService, TroubleService, UdevService, UpdateService
public interface ContextHandleAware extends HandleAware
Extension of HandleAware for objects that should be children of the Handle associated with a BeanContext. These objects are automatically connected to the BeanContext Handle by virtue of being added to the context.
Since:
1.0
Version:
2023-01-13

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    getHandlePrefix()
    Returns the prefix for the object to be used when the handle is allocated by the context.

    Methods inherited from interface com.tccc.kos.commons.core.service.handle.HandleAware

    addHandleChild, getHandle, getName, getPath

  • Method Details

    • getHandlePrefix

      default String getHandlePrefix()
      Returns the prefix for the object to be used when the handle is allocated by the context. The prefix typically reflects the type of the object, such that two objects with the same name but different types are uniquely identified. This value should be the name of the getter if this object was to be fetched from a parent object. For example, if class was Pump there may be two instances: water and carb. The prefix for the water pump may be "water" while the prefix for carb may be "carb", as this distinguishes them. In cases where there is a single getter, it's not uncommon for the prefix to be the type of the object or null. The default implementation returns null.