Package net.officefloor.frame.api.managedobject.source

Interface ManagedObjectDependencyMetaData<O extends Enum<O>>

All Known Implementing Classes:
ManagedObjectDependencyMetaDataImpl
public interface ManagedObjectDependencyMetaData<O extends Enum<O>>
Describes an object which the ManagedObject for the ManagedObjectSource is dependent upon.
Author:
Daniel Sagenschneider

  • Method Summary

    Modifier and Type
    Method
    Description
    Object[]
    getAnnotations()
    Obtains the annotations for the dependency.
    O
    getKey()
    Obtains the Enum key identifying this dependency.
    String
    getLabel()
    Provides a descriptive name for this dependency.
    Class<?>
    getType()
    Obtains the Class that the dependent object must extend/implement.
    String
    getTypeQualifier()
    Obtains the qualifier on the type.

  • Method Details

    • getKey

      O getKey()
      Obtains the Enum key identifying this dependency. If null then dependency will be referenced by this instance's index in the array returned from ManagedObjectSourceMetaData.
      Returns:
      Enum key identifying the dependency or null indicating identified by an index.

    • getType

      Class<?> getType()
      Obtains the Class that the dependent object must extend/implement.
      Returns:
      Type of the dependency.

    • getTypeQualifier

      String getTypeQualifier()

      Obtains the qualifier on the type.

      This is to enable qualifying the type of dependency required.

      Returns:
      Qualifier on the type. May be null if not qualifying the type.

    • getAnnotations

      Object[] getAnnotations()

      Obtains the annotations for the dependency.

      This enables further description of required dependency.

      Returns:
      Annotations for the dependency.

    • getLabel

      String getLabel()
      Provides a descriptive name for this dependency. This is useful to better describe the dependency.
      Returns:
      Descriptive name for this dependency.