Package com.helger.commons.error

Class ErrorTextProvider.FormattableItem

java.lang.Object

com.helger.commons.error.ErrorTextProvider.FormattableItem

All Implemented Interfaces:

ErrorTextProvider.IFormattableItem

Enclosing class:

ErrorTextProvider

@Immutable
public static class ErrorTextProvider.FormattableItem
extends Object
implements ErrorTextProvider.IFormattableItem

Default placeholder based implementation of ErrorTextProvider.IFormattableItem.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
FormattableItem(ErrorTextProvider.EField eField, String sText)

Method Summary

Modifier and Type	Method	Description
final ErrorTextProvider.EField	getField()
String	getFormattedText(String sReplacement)	Return a formatted version of ErrorTextProvider.IFormattableItem.getUnformattedText() by replacing all ErrorTextProvider.PLACEHOLDER chars with the provided replacement.
String	getUnformattedText()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

FormattableItem

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

Method Details

getField

@Nonnull
public final ErrorTextProvider.EField getField()

Specified by:

getField in interface ErrorTextProvider.IFormattableItem

Returns:

the error field this is about. Never null.

getUnformattedText

@Nonnull
@Nonempty
public String getUnformattedText()

Specified by:

getUnformattedText in interface ErrorTextProvider.IFormattableItem

Returns:

The unformatted text. Never null.

getFormattedText

@Nonnull
public String getFormattedText(@Nonnull
 String sReplacement)

Description copied from interface: ErrorTextProvider.IFormattableItem

Return a formatted version of ErrorTextProvider.IFormattableItem.getUnformattedText() by replacing all ErrorTextProvider.PLACEHOLDER chars with the provided replacement.

Specified by:

getFormattedText in interface ErrorTextProvider.IFormattableItem

Parameters:

sReplacement - The replacement string. Must not be null.

Returns:

The formatted text with the replacement applied.

toString

public String toString()

Overrides:

toString in class Object