cz.ues.core.content.exception

Class UESSheetRTBBCodeException.UESSheetBBCodeValidationErrorItem

java.lang.Object

cz.ues.core.content.exception.UESSheetRTBBCodeException.UESSheetBBCodeValidationErrorItem

Enclosing class:

UESSheetRTBBCodeException

public static class UESSheetRTBBCodeException.UESSheetBBCodeValidationErrorItem
extends java.lang.Object

BBCodeValidationErrorItem - one concrete error which happened during BBCode validation (transformation from BBCode to BBXML, merging original UXML with BBXML, XSD validation... It contains information about tag (type-name, number, if it is start or end tag). It is used in List inside UESSheetRTBBCodeException. If fatal flag is set to true on some item, it means further BBCode processing was stopped when this error occurred in legacy logic and exception was thrown immediately after this item was added to list of error items.

Since:

UES6-06

Field Summary

Fields

Modifier and Type	Field and Description
private UESSheetRTBBCodeException.UESSheetBBCodeValidationErrorCode	errorCode Error code from UESSheetBBCodeValidationErrorCode enumeration
private boolean	fatal Flag determining whether error is fatal (which means further BBCode processing was stopped when this error occurred in legacy logic and exception was thrown immediately after this item was added to list of error items) Fatal error is e.g. error in XSD validation
static java.lang.String	FIELD_DELIMITER Delimiter used for serializing fields
private java.lang.String	fullMessage Default message of the error item with with prepend part containing fields values in human readable form added to it
private boolean	onEndTag Flag determining if the error is on start tag or on end tag
private java.lang.Object[]	params Parameters used for formatting of the message
private java.lang.String	tagName Tag type(name)
private int	tagNumber Number of tag of given type(name) in the BBCode, either number of start tag of given type or end tag of given type, depending on the onEndTag field

Constructor Summary

Constructors

Constructor and Description
UESSheetRTBBCodeException.UESSheetBBCodeValidationErrorItem(UESSheetRTBBCodeException.UESSheetBBCodeValidationErrorCode errorCode, int tagNumber, java.lang.String tagName, boolean onEndTag, boolean fatal, java.lang.String message, java.lang.Object... params) Creates a new instance of UESSheetBBCodeValidationErrorItem.
UESSheetRTBBCodeException.UESSheetBBCodeValidationErrorItem(UESSheetRTBBCodeException.UESSheetBBCodeValidationErrorCode errorCode, java.lang.String serializedFields, java.lang.String fullMessage) Creates a new instance of UESSheetBBCodeValidationErrorItem from supplied serialized fields.

Method Summary

Methods

Modifier and Type	Method and Description
private static void	addPart(java.lang.StringBuilder sb, java.lang.Object newPart)
UESSheetRTBBCodeException.UESSheetBBCodeValidationErrorCode	getErrorCode()
java.lang.String	getFullMessage()
java.lang.Object[]	getParams()
java.lang.String	getSerializedFields() Returns string containing serialized fields (tagNumber, onEndTag, fatal, tagName) separated by FIELD_DELIMITER
java.lang.String	getTagName()
int	getTagNumber()
boolean	isFatal()
boolean	isOnEndTag()
private java.lang.String	prepareFullMessage(java.lang.String message) Adds prepend part containing fields values in human readable form added to given error message.

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_DELIMITER

public static final FIELD_DELIMITER

Delimiter used for serializing fields

See Also:

Constant Field Values

tagNumber

private final tagNumber

Number of tag of given type(name) in the BBCode, either number of start tag of given type or end tag of given type, depending on the onEndTag field

tagName

private final tagName

Tag type(name)

onEndTag

private onEndTag

Flag determining if the error is on start tag or on end tag

fatal

private fatal

Flag determining whether error is fatal (which means further BBCode processing was stopped when this error occurred in legacy logic and exception was thrown immediately after this item was added to list of error items) Fatal error is e.g. error in XSD validation

errorCode

private final errorCode

Error code from UESSheetBBCodeValidationErrorCode enumeration

fullMessage

private final fullMessage

Default message of the error item with with prepend part containing fields values in human readable form added to it

params

private params

Parameters used for formatting of the message

Constructor Detail

UESSheetRTBBCodeException.UESSheetBBCodeValidationErrorItem

public UESSheetRTBBCodeException.UESSheetBBCodeValidationErrorItem(UESSheetRTBBCodeException.UESSheetBBCodeValidationErrorCode errorCode,
int tagNumber,
java.lang.String tagName,
boolean onEndTag,
boolean fatal,
java.lang.String message,
java.lang.Object... params)

Creates a new instance of UESSheetBBCodeValidationErrorItem.

Parameters:

errorCode - errorCode from UESSheetBBCodeValidationErrorCode enumeration

tagNumber - Number of tag of given type(name) in the BBCode, either number of start tag of given type or end tag of given type, depending on the onEndTag field

tagName - Tag type(name)

onEndTag - Flag determining if the error is on start tag or on end tag

fatal - Flag determining whether error is fatal (which means further BBCode processing was stopped when this error occurred in legacy logic and exception was thrown immediately after this item was added to list of error items) Fatal error is e.g. error in XSD validation

message - Default message of the error item

params - Parameters used for formatting of the message

Since:

UES6-06

UESSheetRTBBCodeException.UESSheetBBCodeValidationErrorItem

public UESSheetRTBBCodeException.UESSheetBBCodeValidationErrorItem(UESSheetRTBBCodeException.UESSheetBBCodeValidationErrorCode errorCode,
java.lang.String serializedFields,
java.lang.String fullMessage)

Creates a new instance of UESSheetBBCodeValidationErrorItem from supplied serialized fields.

Parameters:

errorCode - errorCode from UESSheetBBCodeValidationErrorCode enumeration

serializedFields - fields of this object (tagNumber, tagName, onEndTag, fatal) serialized into String by getSerializedFields method

message - Full message with prepend part already added and with parameters already filled

Since:

UES6-06

Method Detail

prepareFullMessage

private java.lang.String prepareFullMessage(java.lang.String message)

Adds prepend part containing fields values in human readable form added to given error message.

Parameters:

message - Default message of the error item

Returns:

message with prepend part containing fields values in human readable form added to it

Since:

UES6-06

getFullMessage

public java.lang.String getFullMessage()

getTagNumber

public int getTagNumber()

getTagName

public java.lang.String getTagName()

isOnEndTag

public boolean isOnEndTag()

isFatal

public boolean isFatal()

getErrorCode

public UESSheetRTBBCodeException.UESSheetBBCodeValidationErrorCode getErrorCode()

getParams

public java.lang.Object[] getParams()

getSerializedFields

public java.lang.String getSerializedFields()

Returns string containing serialized fields (tagNumber, onEndTag, fatal, tagName) separated by FIELD_DELIMITER

Returns:

Since:

UES6-06

addPart

private static void addPart(java.lang.StringBuilder sb,
java.lang.Object newPart)