Package com.helger.commons.error

Class ErrorTextProvider

java.lang.Object

com.helger.commons.error.ErrorTextProvider

All Implemented Interfaces:

IErrorTextProvider, ICloneable<ErrorTextProvider>

@NotThreadSafe
public class ErrorTextProvider
extends Object
implements IErrorTextProvider, ICloneable<ErrorTextProvider>

Default implementation of IErrorTextProvider with a customizable layout.

Since:

8.5.1

Author:

Philip Helger

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ErrorTextProvider.EField
static class	ErrorTextProvider.FormattableItem	Default placeholder based implementation of ErrorTextProvider.IFormattableItem.
static interface	ErrorTextProvider.IFormattableItem	Base interface for objects that format a single field.

Field Summary

Fields

Modifier and Type	Field	Description
static final IErrorTextProvider	DEFAULT
static final char	PLACEHOLDER
static final String	PLACEHOLDER_STR

Constructor Summary

Constructors

Constructor	Description
ErrorTextProvider()
ErrorTextProvider(ErrorTextProvider aOther)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
ErrorTextProvider	addItem(ErrorTextProvider.EField eField, String sText)	Add an error item to be disabled.
ErrorTextProvider	addItem(ErrorTextProvider.IFormattableItem aItem)
ICommonsList<ErrorTextProvider.IFormattableItem>	getAllItems()
ErrorTextProvider	getClone()
String	getErrorText(IError aError, Locale aContentLocale)	Get the provided error as a String
String	getFieldSeparator()
ErrorTextProvider	setFieldSeparator(String sFieldSep)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

PLACEHOLDER

public static final char PLACEHOLDER

See Also:

• Constant Field Values

PLACEHOLDER_STR

public static final String PLACEHOLDER_STR

DEFAULT

public static final IErrorTextProvider DEFAULT

Constructor Details

ErrorTextProvider

public ErrorTextProvider()

ErrorTextProvider

public ErrorTextProvider(@Nonnull
 ErrorTextProvider aOther)

Copy constructor.

Parameters:

aOther - Object to copy from. May not be null.

Since:

8.5.5

Method Details

getAllItems

@Nonnull
@ReturnsMutableCopy
public ICommonsList<ErrorTextProvider.IFormattableItem> getAllItems()

addItem

@Nonnull
public ErrorTextProvider addItem(@Nonnull
 ErrorTextProvider.EField eField,
 @Nonnull @Nonempty
 String sText)

Add an error item to be disabled.

Parameters:

eField - The field to be used. May not be null.

sText - The text that should contain the placeholder ('$') that will be replaced

Returns:

this for chaining

addItem

@Nonnull
public ErrorTextProvider addItem(@Nonnull
 ErrorTextProvider.IFormattableItem aItem)

getFieldSeparator

@Nonnull
public String getFieldSeparator()

setFieldSeparator

@Nonnull
public ErrorTextProvider setFieldSeparator(@Nonnull
 String sFieldSep)

getErrorText

@Nonnull
public String getErrorText(@Nonnull
 IError aError,
 @Nonnull
 Locale aContentLocale)

Description copied from interface: IErrorTextProvider

Get the provided error as a String

Specified by:

getErrorText in interface IErrorTextProvider

Parameters:

aError - The error to be converted. May not be null.

aContentLocale - The content locale to be used. May not be null.

Returns:

A non-null String.

getClone

@Nonnull
@ReturnsMutableCopy
public ErrorTextProvider getClone()

Specified by:

getClone in interface ICloneable<ErrorTextProvider>

Returns:

A 100% deep-copy of the implementing class.

toString

public String toString()

Overrides:

toString in class Object