Class EditorResourceStatus

    • Constructor Detail

      • EditorResourceStatus

        public EditorResourceStatus​(@Nonnull
                                    java.lang.String type,
                                    @Nonnull
                                    java.lang.String title,
                                    @Nonnull
                                    java.lang.String message,
                                    @Nullable
                                    java.lang.Integer priority,
                                    @Nullable
                                    EditorResourceStatus.Variant variant,
                                    @Nullable
                                    java.lang.String icon,
                                    @Nullable
                                    java.util.List<EditorResourceStatus.Action> actions,
                                    @Nullable
                                    java.util.Map<java.lang.String,​java.lang.Object> data)
        Creates a status.
        Parameters:
        type - the status type (see ResourceStatus.getType())
        title - the title
        message - the message
        priority - the priority or null
        variant - the variant or null
        icon - the icon or null
        actions - a list of actions or null
        data - additional status data or null
        See Also:
        EditorResourceStatus
    • Method Detail

      • getPriority

        public int getPriority()
        Description copied from interface: ResourceStatus
        Returns the priority of this status corresponding to its importance (Integer.MAX_VALUE being the highest priority).
        Specified by:
        getPriority in interface ResourceStatus
        Returns:
        the status priority
      • getData

        @Nullable
        public java.util.Map<java.lang.String,​java.lang.Object> getData()
        Description copied from interface: ResourceStatus
        Returns an unmodifiable map containing the status information and data needed to render this status.
        Specified by:
        getData in interface ResourceStatus
        Returns:
        a map containing key/value pairs
      • getResourceType

        @Nullable
        public java.lang.String getResourceType()
        Description copied from interface: ResourceStatus
        Returns the resource type to render this status.
        Specified by:
        getResourceType in interface ResourceStatus
        Returns:
        a resource type or null
      • getResourceSuperType

        @Nullable
        public java.lang.String getResourceSuperType()
        Description copied from interface: ResourceStatus
        Returns the resource super type to render this status.
        Specified by:
        getResourceSuperType in interface ResourceStatus
        Returns:
        a resource super type or null
      • getTitle

        @Nonnull
        public java.lang.String getTitle()
        Returns the title of this status, which describes the module or feature the status is associated with. In contrast to the the status type (see getType()), the title is meant to be displayed in the user interface.
        Returns:
        the status title
      • getMessage

        public java.lang.String getMessage()
        Returns the status message.
        Returns:
        the status message
      • getIcon

        @Nullable
        public java.lang.String getIcon()
        Returns the name of a CoralUI icon to be displayed in the status. If no icon is set, then a default icon is assumed (depending on the specified EditorResourceStatus.Variant).
        Returns:
        the status icon or null
      • getAdditionalData

        @Nonnull
        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalData()
        Returns the additional data defined for this status, corresponding to the data that was added using EditorResourceStatus.Builder.addData(String, Object). In contrast, getData() returns a map containing all information defining this status (i.e. including title, message etc).
        Returns:
        the additional data of this status