Package com.adobe.granite.resourcestatus

Interface ResourceStatus

  • All Known Implementing Classes:
    EditorResourceStatus
    public interface ResourceStatus

    Represents status information about a Resource. A ResourceStatus is defined by a type, a priority, a data map containing the status information and other data needed to render the status, and possibly a resource (super) type.

    Consuming status components retrieve Resources wrapping a ResourceStatus (see com.adobe.granite.resourcestatus). These resources contain the status data as their properties, and can be rendered using the defined resource (super) type.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Map<java.lang.String,​java.lang.Object> getData()
      Returns an unmodifiable map containing the status information and data needed to render this status.
      int getPriority()
      Returns the priority of this status corresponding to its importance (Integer.MAX_VALUE being the highest priority).
      java.lang.String getResourceSuperType()
      Returns the resource super type to render this status.
      java.lang.String getResourceType()
      Returns the resource type to render this status.
      java.lang.String getType()
      Returns the type of this status defining the module or feature this status is associated with.

    • Method Detail

      • getType

        @Nonnull
java.lang.String getType()
        Returns the type of this status defining the module or feature this status is associated with.
        Returns:
        the status type
        See Also:
        ResourceStatusProvider.getType()

      • getPriority

        int getPriority()
        Returns the priority of this status corresponding to its importance (Integer.MAX_VALUE being the highest priority).
        Returns:
        the status priority

      • getData

        @Nullable
java.util.Map<java.lang.String,​java.lang.Object> getData()
        Returns an unmodifiable map containing the status information and data needed to render this status.
        Returns:
        a map containing key/value pairs

      • getResourceType

        @Nullable
java.lang.String getResourceType()
        Returns the resource type to render this status.
        Returns:
        a resource type or null

      • getResourceSuperType

        @Nullable
java.lang.String getResourceSuperType()
        Returns the resource super type to render this status.
        Returns:
        a resource super type or null