com.helger.commons.error.text

Class DynamicHasErrorTextWithArgs

java.lang.Object

com.helger.commons.error.text.DynamicHasErrorTextWithArgs

All Implemented Interfaces:

IHasErrorText, IHasDisplayText

@Immutable
 @MustImplementEqualsAndHashcode
public class DynamicHasErrorTextWithArgs
extends Object
implements IHasErrorText

A special implementation of IHasErrorText that encapsulates arguments to be put into the message.

Since:

8.5.2

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
DynamicHasErrorTextWithArgs(IHasDisplayText aParentText, Object... aArgs)
DynamicHasErrorTextWithArgs(IHasText aParentText, Object... aArgs)

Method Summary

Modifier and Type	Method and Description
Object[]	getAllArgs() Get all arguments from the constructor.
String	getDisplayText(Locale aContentLocale)
IHasText	getParentText()
boolean	isMultiLingual()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.text.display.IHasDisplayText

getAsHasText, getComparatorCollating

Constructor Detail

DynamicHasErrorTextWithArgs

public DynamicHasErrorTextWithArgs(@Nonnull
                                   IHasDisplayText aParentText,
                                   @Nonnull @Nonempty
                                   Object... aArgs)

DynamicHasErrorTextWithArgs

public DynamicHasErrorTextWithArgs(@Nonnull
                                   IHasText aParentText,
                                   @Nonnull @Nonempty
                                   Object... aArgs)

Method Detail

getParentText

@Nonnull
public IHasText getParentText()

getAllArgs

@Nonnull
 @Nonempty
 @ReturnsMutableCopy
public Object[] getAllArgs()

Get all arguments from the constructor.

Returns:

a copy of all arguments. Neither null nor empty-

getDisplayText

@Nullable
public String getDisplayText(@Nonnull
                                        Locale aContentLocale)

Specified by:

getDisplayText in interface IHasDisplayText

Parameters:

aContentLocale - The locale to be used for resolving. May not be null.

Returns:

The display text of the object in the given locale. May be null if the text could not be resolved in the passed locale.

isMultiLingual

public boolean isMultiLingual()

Specified by:

isMultiLingual in interface IHasErrorText

Returns:

true if the error text is multilingual, false otherwise.

toString

public String toString()

Overrides:

toString in class Object