Interface Annotated

All Known Subinterfaces:
FlowDefinition, StateDefinition, TransitionableStateDefinition, TransitionDefinition
All Known Implementing Classes:
ActionState, AnnotatedAction, AnnotatedObject, DecisionState, EndState, Flow, FlowVariable, State, SubflowState, Transition, TransitionableState, ViewState, ViewVariable

public interface Annotated
An interface to be implemented by objects that are annotated with attributes they wish to expose to clients.
Author:
Keith Donald, Erwin Vervaet
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns a attribute map containing the attributes annotating this object.
    Returns a short summary of this object, suitable for display as an icon caption or tool tip.
    Returns a longer, more detailed description of this object.
  • Method Details

    • getCaption

      String getCaption()
      Returns a short summary of this object, suitable for display as an icon caption or tool tip.
      Returns:
      the caption
    • getDescription

      String getDescription()
      Returns a longer, more detailed description of this object.
      Returns:
      the description
    • getAttributes

      MutableAttributeMap<Object> getAttributes()
      Returns a attribute map containing the attributes annotating this object. These attributes provide descriptive characteristics or properties that may affect object behavior.
      Returns:
      the attribute map