Package com.day.cq.wcm.commons.status

Class EditorResourceStatus.Builder

java.lang.Object

com.day.cq.wcm.commons.status.EditorResourceStatus.Builder

Enclosing class:

EditorResourceStatus

public static class EditorResourceStatus.Builder
extends java.lang.Object

Builder class to build EditorResourceStatus instances.

Constructor Summary

Constructors

Constructor	Description
Builder(java.lang.String type, java.lang.String title, java.lang.String message)	Creates a new Builder.

Method Summary

Modifier and Type	Method	Description
EditorResourceStatus.Builder	addAction(java.lang.String id, java.lang.String label)	Associates an action with this status.
EditorResourceStatus.Builder	addData(java.lang.String key, java.lang.Object value)	Associates additional data with this status.
EditorResourceStatus	build()	Builds and returns the EditorResourceStatus instance.
EditorResourceStatus.Builder	setIcon(java.lang.String icon)	Sets the status icon.
EditorResourceStatus.Builder	setPriority(java.lang.Integer priority)	Sets the status priority.
EditorResourceStatus.Builder	setVariant(EditorResourceStatus.Variant variant)	Sets the status variant.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(@Nonnull
               java.lang.String type,
               @Nonnull
               java.lang.String title,
               @Nonnull
               java.lang.String message)

Creates a new Builder.

Parameters:

type - the status type (see EditorResourceStatus.getType())

title - the status title (see EditorResourceStatus.getTitle())

message - the status message (see EditorResourceStatus.getMessage())

Method Detail

setPriority

@Nonnull
public EditorResourceStatus.Builder setPriority(@Nullable
                                                java.lang.Integer priority)

Sets the status priority.

Parameters:

priority - the status priority or null to unset it

Returns:

the current Builder

See Also:

EditorResourceStatus.getPriority()

setVariant

@Nonnull
public EditorResourceStatus.Builder setVariant(@Nullable
                                               EditorResourceStatus.Variant variant)

Sets the status variant.

Parameters:

variant - the status variant or null to unset it

Returns:

the current Builder

See Also:

EditorResourceStatus.getVariant(), EditorResourceStatus.Variant

setIcon

@Nonnull
public EditorResourceStatus.Builder setIcon(@Nullable
                                            java.lang.String icon)

Sets the status icon.

Parameters:

icon - the status icon or null to unset it

Returns:

the current Builder

See Also:

EditorResourceStatus.getIcon()

addData

public EditorResourceStatus.Builder addData(java.lang.String key,
                                            java.lang.Object value)

Associates additional data with this status. This data is available as properties when retrieving status resources (see ResourceStatus).

Parameters:

key - the key

value - the value

Returns:

this

addAction

public EditorResourceStatus.Builder addAction(java.lang.String id,
                                              java.lang.String label)

Associates an action with this status.

Parameters:

id - the action id (see EditorResourceStatus.Action.getId())

label - the action label (see EditorResourceStatus.Action.getLabel())

Returns:

this

build

public EditorResourceStatus build()

Builds and returns the EditorResourceStatus instance.

Returns:

the EditorResourceStatus instance