org.xwiki.rendering.util

Interface ErrorBlockGenerator

@Role
public interface ErrorBlockGenerator

Generates error blocks to render an error in a wiki page.

Since:

8.1M1

Version:

$Id: fbb0a7966a413b222974b70f04438a9c248333ef $

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_ATTRIBUTE_DESCRIPTION_VALUE The CSS class attribute value to use for the block displaying the description.
static String	CLASS_ATTRIBUTE_MESSAGE_VALUE The CSS class attribute value to use for the block displaying the message.
static String	CLASS_ATTRIBUTE_NAME The CSS class attribute name to use for the generated top level error block.

Method Summary

Modifier and Type	Method and Description
List<Block>	generateErrorBlocks(String message, String description, boolean isInline) Generates error blocks to render an error in a wiki page.
List<Block>	generateErrorBlocks(String messagePrefix, Throwable throwable, boolean isInline) Generates error blocks to render an error in a wiki page.

Field Detail

CLASS_ATTRIBUTE_NAME

static final String CLASS_ATTRIBUTE_NAME

The CSS class attribute name to use for the generated top level error block.

See Also:

Constant Field Values

CLASS_ATTRIBUTE_MESSAGE_VALUE

static final String CLASS_ATTRIBUTE_MESSAGE_VALUE

The CSS class attribute value to use for the block displaying the message.

See Also:

Constant Field Values

CLASS_ATTRIBUTE_DESCRIPTION_VALUE

static final String CLASS_ATTRIBUTE_DESCRIPTION_VALUE

The CSS class attribute value to use for the block displaying the description.

See Also:

Constant Field Values

Method Detail

generateErrorBlocks

List<Block> generateErrorBlocks(String message,
                                String description,
                                boolean isInline)

Generates error blocks to render an error in a wiki page.

Parameters:

message - the short message that will be displayed to the user

description - the description that will be displayed to the user when he clicks on the message

isInline - whether the generated blocks should be inline or not

Returns:

the generated blocks

generateErrorBlocks

List<Block> generateErrorBlocks(String messagePrefix,
                                Throwable throwable,
                                boolean isInline)

Generates error blocks to render an error in a wiki page.

Parameters:

messagePrefix - the prefix of the short message that will be displayed to the user. This message will be augmented with the root cause of the error extracted from the passed throwable and an additional text inviting the user to click the message will be added to the message prefix

throwable - the exception from which the description will be extracted from

isInline - whether the generated blocks should be inline or not

Returns:

the generated blocks