org.frameworkset.spi.support

类 AbstractMessageSource

java.lang.Object

org.frameworkset.spi.support.MessageSourceSupport

org.frameworkset.spi.support.AbstractMessageSource

所有已实现的接口:

HierarchicalMessageSource, MessageSource

直接已知子类:

HotDeployResourceBundleMessageSource, ReloadableResourceBundleMessageSource, ResourceBundleMessageSource

public abstract class AbstractMessageSource
extends MessageSourceSupport
implements HierarchicalMessageSource

Title: AbstractMessageSource.java

Description:

bboss workgroup

Copyright (c) 2007

字段概要

从类继承的字段 org.frameworkset.spi.support.MessageSourceSupport

logger

构造器概要

构造器

构造器和说明
AbstractMessageSource()

方法概要

限定符和类型	方法和说明
void	destroy()
protected java.lang.String	getDefaultMessage(java.lang.String code) Return a fallback default message for the given code, if any.
java.lang.String	getMessage(MessageSourceResolvable resolvable, java.util.Locale locale) Try to resolve the message using all the attributes contained within the MessageSourceResolvable argument that was passed in.
java.lang.String	getMessage(java.lang.String code)
java.lang.String	getMessage(java.lang.String code, java.util.Locale locale)
java.lang.String	getMessage(java.lang.String code, java.lang.Object[] args, java.util.Locale locale) Try to resolve the message.
java.lang.String	getMessage(java.lang.String code, java.lang.Object[] args, java.lang.String defaultMessage, java.util.Locale locale) Try to resolve the message.
protected java.lang.String	getMessageFromParent(java.lang.String code, java.lang.Object[] args, java.util.Locale locale) Try to retrieve the given message from the parent MessageSource, if any.
protected java.lang.String	getMessageInternal(java.lang.String code, java.lang.Object[] args, java.util.Locale locale) Resolve the given code and arguments as message in the given Locale, returning null if not found.
MessageSource	getParentMessageSource() Return the parent of this MessageSource, or null if none.
protected boolean	isUseCodeAsDefaultMessage() Return whether to use the message code as default message instead of throwing a NoSuchMessageException.
protected java.lang.String	renderDefaultMessage(java.lang.String defaultMessage, java.lang.Object[] args, java.util.Locale locale) Render the given default message String.
protected java.lang.Object[]	resolveArguments(java.lang.Object[] args, java.util.Locale locale) Searches through the given array of objects, find any MessageSourceResolvable objects and resolve them.
protected abstract java.text.MessageFormat	resolveCode(java.lang.String code, java.util.Locale locale) Subclasses must implement this method to resolve a message.
protected java.lang.String	resolveCodeWithoutArguments(java.lang.String code, java.util.Locale locale) Subclasses can override this method to resolve a message without arguments in an optimized fashion, that is, to resolve a message without involving a MessageFormat.
void	setParentMessageSource(MessageSource parent) Set the parent that will be used to try to resolve messages that this object can't resolve.
void	setUseCodeAsDefaultMessage(boolean useCodeAsDefaultMessage) Set whether to use the message code as default message instead of throwing a NoSuchMessageException.

从类继承的方法 org.frameworkset.spi.support.MessageSourceSupport

createMessageFormat, formatMessage, isAlwaysUseMessageFormat, setAlwaysUseMessageFormat

从类继承的方法 java.lang.Object

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

构造器详细资料

AbstractMessageSource

public AbstractMessageSource()

方法详细资料

setParentMessageSource

public void setParentMessageSource(MessageSource parent)

从接口复制的说明: HierarchicalMessageSource

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

指定者:

setParentMessageSource 在接口中 HierarchicalMessageSource

参数:

parent - 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.

getParentMessageSource

public MessageSource getParentMessageSource()

从接口复制的说明: HierarchicalMessageSource

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

指定者:

getParentMessageSource 在接口中 HierarchicalMessageSource

setUseCodeAsDefaultMessage

public void setUseCodeAsDefaultMessage(boolean useCodeAsDefaultMessage)

Set whether to use the message code as default message instead of throwing a NoSuchMessageException. Useful for development and debugging. Default is "false".

Note: In case of a MessageSourceResolvable with multiple codes (like a FieldError) and a MessageSource that has a parent MessageSource, do not activate "useCodeAsDefaultMessage" in the parent: Else, you'll get the first code returned as message by the parent, without attempts to check further codes.

To be able to work with "useCodeAsDefaultMessage" turned on in the parent, AbstractMessageSource and AbstractApplicationContext contain special checks to delegate to the internal getMessageInternal method if available. In general, it is recommended to just use "useCodeAsDefaultMessage" during development and not rely on it in production in the first place, though.

另请参阅:

getMessage(String, Object[], Locale), getMessageInternal(java.lang.String, java.lang.Object[], java.util.Locale)

isUseCodeAsDefaultMessage

protected boolean isUseCodeAsDefaultMessage()

Return whether to use the message code as default message instead of throwing a NoSuchMessageException. Useful for development and debugging. Default is "false".

Alternatively, consider overriding the getDefaultMessage method to return a custom fallback message for an unresolvable code.

另请参阅:

getDefaultMessage(String)

getMessage

public final java.lang.String getMessage(java.lang.String code,
                                         java.lang.Object[] args,
                                         java.lang.String defaultMessage,
                                         java.util.Locale locale)

从接口复制的说明: MessageSource

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

指定者:

getMessage 在接口中 MessageSource

参数:

code - the code to lookup up, such as 'calculator.noRateSet'. Users of this class are encouraged to base message names on the relevant fully qualified class name, thus avoiding conflict and ensuring maximum clarity.

args - 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 to return if the lookup fails

locale - the Locale in which to do the lookup

返回:

the resolved message if the lookup was successful; otherwise the default message passed as a parameter

另请参阅:

MessageFormat

getMessage

public final java.lang.String getMessage(java.lang.String code,
                                         java.util.Locale locale)
                                  throws NoSuchMessageException

指定者:

getMessage 在接口中 MessageSource

抛出:

NoSuchMessageException

getMessage

public final java.lang.String getMessage(java.lang.String code)
                                  throws NoSuchMessageException

指定者:

getMessage 在接口中 MessageSource

抛出:

NoSuchMessageException

getMessage

public final java.lang.String getMessage(java.lang.String code,
                                         java.lang.Object[] args,
                                         java.util.Locale locale)
                                  throws NoSuchMessageException

从接口复制的说明: MessageSource

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

指定者:

getMessage 在接口中 MessageSource

参数:

code - the code to lookup up, such as 'calculator.noRateSet'

args - 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 - the Locale in which to do the lookup

返回:

the resolved message

抛出:

NoSuchMessageException - if the message wasn't found

另请参阅:

MessageFormat

getMessage

public final java.lang.String getMessage(MessageSourceResolvable resolvable,
                                         java.util.Locale locale)
                                  throws NoSuchMessageException

从接口复制的说明: MessageSource

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.

指定者:

getMessage 在接口中 MessageSource

参数:

resolvable - value object storing attributes required to properly resolve a message

locale - the Locale in which to do the lookup

返回:

the resolved message

抛出:

NoSuchMessageException - if the message wasn't found

另请参阅:

MessageFormat

getMessageInternal

protected java.lang.String getMessageInternal(java.lang.String code,
                                              java.lang.Object[] args,
                                              java.util.Locale locale)

Resolve the given code and arguments as message in the given Locale, returning null if not found. Does not fall back to the code as default message. Invoked by getMessage methods.

参数:

code - the code to lookup up, such as 'calculator.noRateSet'

args - array of arguments that will be filled in for params within the message

locale - the Locale in which to do the lookup

返回:

the resolved message, or null if not found

另请参阅:

getMessage(String, Object[], String, Locale), getMessage(String, Object[], Locale), getMessage(MessageSourceResolvable, Locale), setUseCodeAsDefaultMessage(boolean)

getMessageFromParent

protected java.lang.String getMessageFromParent(java.lang.String code,
                                                java.lang.Object[] args,
                                                java.util.Locale locale)

Try to retrieve the given message from the parent MessageSource, if any.

参数:

code - the code to lookup up, such as 'calculator.noRateSet'

args - array of arguments that will be filled in for params within the message

locale - the Locale in which to do the lookup

返回:

the resolved message, or null if not found

另请参阅:

getParentMessageSource()

getDefaultMessage

protected java.lang.String getDefaultMessage(java.lang.String code)

Return a fallback default message for the given code, if any.

Default is to return the code itself if "useCodeAsDefaultMessage" is activated, or return no fallback else. In case of no fallback, the caller will usually receive a NoSuchMessageException from getMessage.

参数:

code - the message code that we couldn't resolve and that we didn't receive an explicit default message for

返回:

the default message to use, or null if none

另请参阅:

setUseCodeAsDefaultMessage(boolean)

renderDefaultMessage

protected java.lang.String renderDefaultMessage(java.lang.String defaultMessage,
                                                java.lang.Object[] args,
                                                java.util.Locale locale)

Render the given default message String. The default message is passed in as specified by the caller and can be rendered into a fully formatted default message shown to the user.

The default implementation passes the String to formatMessage, resolving any argument placeholders found in them. Subclasses may override this method to plug in custom processing of default messages.

覆盖:

renderDefaultMessage 在类中 MessageSourceSupport

参数:

defaultMessage - the passed-in default message String

args - array of arguments that will be filled in for params within the message, or null if none.

locale - the Locale used for formatting

返回:

the rendered default message (with resolved arguments)

另请参阅:

MessageSourceSupport.formatMessage(String, Object[], java.util.Locale)

resolveArguments

protected java.lang.Object[] resolveArguments(java.lang.Object[] args,
                                              java.util.Locale locale)

Searches through the given array of objects, find any MessageSourceResolvable objects and resolve them.

Allows for messages to have MessageSourceResolvables as arguments.

覆盖:

resolveArguments 在类中 MessageSourceSupport

参数:

args - array of arguments for a message

locale - the locale to resolve through

返回:

an array of arguments with any MessageSourceResolvables resolved

resolveCodeWithoutArguments

protected java.lang.String resolveCodeWithoutArguments(java.lang.String code,
                                                       java.util.Locale locale)

Subclasses can override this method to resolve a message without arguments in an optimized fashion, that is, to resolve a message without involving a MessageFormat.

The default implementation does use MessageFormat, through delegating to the resolveCode method. Subclasses are encouraged to replace this with optimized resolution.

Unfortunately, java.text.MessageFormat is not implemented in an efficient fashion. In particular, it does not detect that a message pattern doesn't contain argument placeholders in the first place. Therefore, it's advisable to circumvent MessageFormat completely for messages without arguments.

参数:

code - the code of the message to resolve

locale - the Locale to resolve the code for (subclasses are encouraged to support internationalization)

返回:

the message String, or null if not found

另请参阅:

resolveCode(java.lang.String, java.util.Locale), MessageFormat

resolveCode

protected abstract java.text.MessageFormat resolveCode(java.lang.String code,
                                                       java.util.Locale locale)

Subclasses must implement this method to resolve a message.

Returns a MessageFormat instance rather than a message String, to allow for appropriate caching of MessageFormats in subclasses.

Subclasses are encouraged to provide optimized resolution for messages without arguments, not involving MessageFormat. See resolveCodeWithoutArguments javadoc for details.

参数:

code - the code of the message to resolve

locale - the Locale to resolve the code for (subclasses are encouraged to support internationalization)

返回:

the MessageFormat for the message, or null if not found

另请参阅:

resolveCodeWithoutArguments(String, java.util.Locale)

destroy

public void destroy()