[
https://issues.apache.org/jira/browse/WW-4099?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13714704#comment-13714704
]
ASF subversion and git services commented on WW-4099:
-----------------------------------------------------
Commit 1505390 from [~bphillips] in branch 'struts2/trunk'
[ https://svn.apache.org/r1505390 ]
WW-4099 updated JavaDoc for getText methods to clearly state that if there is
no value found for the provided key then the method should return the provided
key.
> Javadoc for ActionSupport.getText() incorrectly states null is returned when
> no message is found
> ------------------------------------------------------------------------------------------------
>
> Key: WW-4099
> URL: https://issues.apache.org/jira/browse/WW-4099
> Project: Struts 2
> Issue Type: Bug
> Components: Documentation
> Affects Versions: 2.2.3.1, 2.3.14.3
> Reporter: Chris De Angelis
> Assignee: Bruce Phillips
> Priority: Minor
> Fix For: 2.3.16
>
>
> The javadoc description of ActionSupport.getText(String aTextName) states:
> Description copied from interface: TextProvider
> Gets a message based on a message key, or null if no message is found.
> This is not correct, because the default text provider is
> TextProviderSupport, which uses the supplied key as the value to return if no
> message matching the key is found. This is true with all descriptions of the
> method variants that do not take a default value as a parameter.
> Additionally, the the descriptions of these methods in the TextProvider
> interface should not state "or null if no message is found" because this is
> just an interface, and the underlying behavior is really determined by the
> implementation class of course.
> The descriptions of getText() in ActionSupport should contain links to the
> corresponding descriptions in TextProviderSupport, along with a note that
> says that class is the default text provider. The TextProviderSupport
> methods should indicate that the message key is returned in cases where no
> default value is a parameter.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
