Class DefaultMessageSourceResolvable
java.lang.Object
org.springframework.context.support.DefaultMessageSourceResolvable
- All Implemented Interfaces:
Serializable
,MessageSourceResolvable
- Direct Known Subclasses:
ObjectError
public class DefaultMessageSourceResolvable
extends Object
implements MessageSourceResolvable, Serializable
Spring's default implementation of the
MessageSourceResolvable
interface.
Offers an easy way to store all the necessary values needed to resolve
a message via a MessageSource
.- Since:
- 13.02.2004
- Author:
- Juergen Hoeller
- See Also:
-
Constructor Summary
ConstructorDescriptionCreate a new DefaultMessageSourceResolvable.DefaultMessageSourceResolvable
(String[] codes) Create a new DefaultMessageSourceResolvable.DefaultMessageSourceResolvable
(String[] codes, Object[] arguments) Create a new DefaultMessageSourceResolvable.DefaultMessageSourceResolvable
(String[] codes, Object[] arguments, String defaultMessage) Create a new DefaultMessageSourceResolvable.DefaultMessageSourceResolvable
(String[] codes, String defaultMessage) Create a new DefaultMessageSourceResolvable.Copy constructor: Create a new instance from another resolvable. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Object[]
Return the array of arguments to be used to resolve this message.getCode()
Return the default code of this resolvable, that is, the last one in the codes array.String[]
getCodes()
Return the codes to be used to resolve this message, in the order that they should get tried.Return the default message to be used to resolve this message.int
hashCode()
protected final String
Build a default String representation for this MessageSourceResolvable: including codes, arguments, and default message.boolean
Indicate whether the specified default message needs to be rendered for substituting placeholders and/orMessageFormat
escaping.toString()
The default implementation exposes the attributes of this MessageSourceResolvable.
-
Constructor Details
-
DefaultMessageSourceResolvable
Create a new DefaultMessageSourceResolvable.- Parameters:
code
- the code to be used to resolve this message
-
DefaultMessageSourceResolvable
Create a new DefaultMessageSourceResolvable.- Parameters:
codes
- the codes to be used to resolve this message
-
DefaultMessageSourceResolvable
Create a new DefaultMessageSourceResolvable.- Parameters:
codes
- the codes to be used to resolve this messagedefaultMessage
- the default message to be used to resolve this message
-
DefaultMessageSourceResolvable
Create a new DefaultMessageSourceResolvable.- Parameters:
codes
- the codes to be used to resolve this messagearguments
- the array of arguments to be used to resolve this message
-
DefaultMessageSourceResolvable
public DefaultMessageSourceResolvable(@Nullable String[] codes, @Nullable Object[] arguments, @Nullable String defaultMessage) Create a new DefaultMessageSourceResolvable.- Parameters:
codes
- the codes to be used to resolve this messagearguments
- the array of arguments to be used to resolve this messagedefaultMessage
- the default message to be used to resolve this message
-
DefaultMessageSourceResolvable
Copy constructor: Create a new instance from another resolvable.- Parameters:
resolvable
- the resolvable to copy from
-
-
Method Details
-
getCode
Return the default code of this resolvable, that is, the last one in the codes array. -
getCodes
Description copied from interface:MessageSourceResolvable
Return the codes to be used to resolve this message, in the order that they should get tried. The last code will therefore be the default one.- Specified by:
getCodes
in interfaceMessageSourceResolvable
- Returns:
- a String array of codes which are associated with this message
-
getArguments
Description copied from interface:MessageSourceResolvable
Return the array of arguments to be used to resolve this message.The default implementation simply returns
null
.- Specified by:
getArguments
in interfaceMessageSourceResolvable
- Returns:
- an array of objects to be used as parameters to replace placeholders within the message text
- See Also:
-
getDefaultMessage
Description copied from interface:MessageSourceResolvable
Return the default message to be used to resolve this message.The default implementation simply returns
null
. Note that the default message may be identical to the primary message code (MessageSourceResolvable.getCodes()
), which effectively enforcesAbstractMessageSource.setUseCodeAsDefaultMessage(boolean)
for this particular message.- Specified by:
getDefaultMessage
in interfaceMessageSourceResolvable
- Returns:
- the default message, or
null
if no default
-
shouldRenderDefaultMessage
public boolean shouldRenderDefaultMessage()Indicate whether the specified default message needs to be rendered for substituting placeholders and/orMessageFormat
escaping.- Returns:
true
if the default message may contain argument placeholders;false
if it definitely does not contain placeholders or custom escaping and can therefore be simply exposed as-is- Since:
- 5.1.7
- See Also:
-
resolvableToString
Build a default String representation for this MessageSourceResolvable: including codes, arguments, and default message. -
toString
The default implementation exposes the attributes of this MessageSourceResolvable.To be overridden in more specific subclasses, potentially including the resolvable content through
resolvableToString()
. -
equals
-
hashCode
public int hashCode()
-