Top Description Fields Constructors Methods
org.springframework.context.support

public Class DelegatingMessageSource

extends MessageSourceSupport
implements HierarchicalMessageSource
Class Inheritance
All Implemented Interfaces
org.springframework.context.HierarchicalMessageSource, org.springframework.context.MessageSource
Imports
java.util.Locale, org.springframework.context.HierarchicalMessageSource, .MessageSource, .MessageSourceResolvable, .NoSuchMessageException, org.springframework.lang.Nullable
Empty MessageSource that delegates all calls to the parent MessageSource. If no parent is available, it simply won't resolve any message.

Used as placeholder by AbstractApplicationContext, if the context doesn't define its own MessageSource. Not intended for direct use in applications.

Author
Juergen Hoeller
Since
1.1.5
See Also
AbstractApplicationContext

Field Summary

Modifier and TypeField and Description
private MessageSource
parentMessageSource

Inherited from org.springframework.context.support.MessageSourceSupport:
logger

Constructor Summary

AccessConstructor and Description
public
DelegatingMessageSource()

Method Summary

Modifier and TypeMethod and Description
public String
getMessage(String
the message code to look up, e.g. 'calculator.noRateSet'. MessageSource users are encouraged to base message names on qualified class or package names, avoiding potential conflicts and ensuring maximum clarity.
code, Object[]
an array of arguments that will be filled in for params within the message (params look like "{0}", "{1,date}", "{2,time}" within a message), or null if none
args, String
a default message to return if the lookup fails
defaultMessage, Locale
the locale in which to do the lookup
locale)

Implements org.springframework.context.MessageSource.getMessage.

Try to resolve the message.

public String
getMessage(String
the message code to look up, e.g. 'calculator.noRateSet'. MessageSource users are encouraged to base message names on qualified class or package names, avoiding potential conflicts and ensuring maximum clarity.
code, Object[]
an array of arguments that will be filled in for params within the message (params look like "{0}", "{1,date}", "{2,time}" within a message), or null if none
args, Locale
the locale in which to do the lookup
locale)

Implements org.springframework.context.MessageSource.getMessage.

Try to resolve the message.

public String
getMessage(MessageSourceResolvable
the value object storing attributes required to resolve a message (may include a default message)
resolvable, Locale
the locale in which to do the lookup
locale)

Implements org.springframework.context.MessageSource.getMessage.

Try to resolve the message using all the attributes contained within the MessageSourceResolvable argument that was passed in.

Note

We must throw a NoSuchMessageException on this method since at the time of calling this method we aren't able to determine if the defaultMessage property of the resolvable is null or not.

public MessageSource
getParentMessageSource()

Implements org.springframework.context.HierarchicalMessageSource.getParentMessageSource.

Return the parent of this MessageSource, or null if none.

public void
setParentMessageSource(MessageSource
the parent MessageSource that will be used to resolve messages that this object can't resolve. May be null, in which case no further resolution is possible.
parent)

Implements org.springframework.context.HierarchicalMessageSource.setParentMessageSource.

Set the parent that will be used to try to resolve messages that this object can't resolve.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from org.springframework.context.support.MessageSourceSupport:
createMessageFormatformatMessageisAlwaysUseMessageFormatrenderDefaultMessageresolveArgumentssetAlwaysUseMessageFormat

Field Detail

parentMessageSourceback to summary
private MessageSource parentMessageSource
Annotations
@Nullable

Constructor Detail

DelegatingMessageSourceback to summary
public DelegatingMessageSource()

Method Detail

getMessageback to summary
public String getMessage(String code, Object[] args, String defaultMessage, Locale locale)

Implements org.springframework.context.MessageSource.getMessage.

Doc from org.springframework.context.MessageSource.getMessage.

Try to resolve the message. Return default message if no message was found.

Parameters
code:String

the message code to look up, e.g. 'calculator.noRateSet'. MessageSource users are encouraged to base message names on qualified class or package names, avoiding potential conflicts and ensuring maximum clarity.

args:Object[]

an array of arguments that will be filled in for params within the message (params look like "{0}", "{1,date}", "{2,time}" within a message), or null if none

defaultMessage:String

a default message to return if the lookup fails

locale:Locale

the locale in which to do the lookup

Returns:String

the resolved message if the lookup was successful, otherwise the default message passed as a parameter (which may be null)

Annotations
@Override
@Nullable
getMessageback to summary
public String getMessage(String code, Object[] args, Locale locale) throws NoSuchMessageException

Implements org.springframework.context.MessageSource.getMessage.

Doc from org.springframework.context.MessageSource.getMessage.

Try to resolve the message. Treat as an error if the message can't be found.

Parameters
code:String

the message code to look up, e.g. 'calculator.noRateSet'. MessageSource users are encouraged to base message names on qualified class or package names, avoiding potential conflicts and ensuring maximum clarity.

args:Object[]

an array of arguments that will be filled in for params within the message (params look like "{0}", "{1,date}", "{2,time}" within a message), or null if none

locale:Locale

the locale in which to do the lookup

Returns:String

the resolved message (never null)

Annotations
@Override
Exceptions
NoSuchMessageException:
if no corresponding message was found
getMessageback to summary
public String getMessage(MessageSourceResolvable resolvable, Locale locale) throws NoSuchMessageException

Implements org.springframework.context.MessageSource.getMessage.

Doc from org.springframework.context.MessageSource.getMessage.

Try to resolve the message using all the attributes contained within the MessageSourceResolvable argument that was passed in.

Note

We must throw a NoSuchMessageException on this method since at the time of calling this method we aren't able to determine if the defaultMessage property of the resolvable is null or not.

Parameters
resolvable:MessageSourceResolvable

the value object storing attributes required to resolve a message (may include a default message)

locale:Locale

the locale in which to do the lookup

Returns:String

the resolved message (never null since even a MessageSourceResolvable-provided default message needs to be non-null)

Annotations
@Override
Exceptions
NoSuchMessageException:
if no corresponding message was found (and no default message was provided by the MessageSourceResolvable)
getParentMessageSourceback to summary
public MessageSource getParentMessageSource()

Implements org.springframework.context.HierarchicalMessageSource.getParentMessageSource.

Doc from org.springframework.context.HierarchicalMessageSource.getParentMessageSource.

Return the parent of this MessageSource, or null if none.

Annotations
@Override
@Nullable
setParentMessageSourceback to summary
public void setParentMessageSource(MessageSource parent)

Implements org.springframework.context.HierarchicalMessageSource.setParentMessageSource.

Doc from org.springframework.context.HierarchicalMessageSource.setParentMessageSource.

Set the parent that will be used to try to resolve messages that this object can't resolve.

Parameters
parent:MessageSource

the parent MessageSource that will be used to resolve messages that this object can't resolve. May be null, in which case no further resolution is possible.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override