You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@struts.apache.org by jo...@apache.org on 2015/07/24 20:28:00 UTC
[15/15] struts git commit: WW-4531- Improve javadoc to be compatible
with more strict JDK8 javadoc standard
WW-4531- Improve javadoc to be compatible with more strict JDK8 javadoc standard
Project: http://git-wip-us.apache.org/repos/asf/struts/repo
Commit: http://git-wip-us.apache.org/repos/asf/struts/commit/775c82a7
Tree: http://git-wip-us.apache.org/repos/asf/struts/tree/775c82a7
Diff: http://git-wip-us.apache.org/repos/asf/struts/diff/775c82a7
Branch: refs/heads/master
Commit: 775c82a74306918f9f333a2947375c09582a9198
Parents: 98d7756
Author: Johannes Geppert <jo...@apache.org>
Authored: Fri Jul 24 20:27:30 2015 +0200
Committer: Johannes Geppert <jo...@apache.org>
Committed: Fri Jul 24 20:27:31 2015 +0200
----------------------------------------------------------------------
.../opensymphony/xwork2/ActionChainResult.java | 2 +
.../com/opensymphony/xwork2/ActionContext.java | 2 +-
.../xwork2/CompositeTextProvider.java | 107 +-
.../xwork2/DefaultActionInvocation.java | 2 +-
.../opensymphony/xwork2/DefaultActionProxy.java | 8 +-
.../xwork2/DefaultTextProvider.java | 2 +-
.../xwork2/DefaultUnknownHandlerManager.java | 14 +-
.../com/opensymphony/xwork2/ObjectFactory.java | 34 +-
.../com/opensymphony/xwork2/UnknownHandler.java | 4 +-
.../xwork2/config/Configuration.java | 7 +-
.../xwork2/config/ConfigurationException.java | 8 +
.../xwork2/config/ConfigurationManager.java | 2 +-
.../xwork2/config/PackageProvider.java | 8 +-
.../xwork2/config/entities/ActionConfig.java | 6 +-
.../config/entities/InterceptorStackConfig.java | 19 +-
.../xwork2/config/entities/PackageConfig.java | 12 +-
.../xwork2/config/impl/AbstractMatcher.java | 5 +-
.../xwork2/config/impl/ActionConfigMatcher.java | 1 +
.../config/impl/DefaultConfiguration.java | 10 +-
.../xwork2/config/impl/NamespaceMatch.java | 2 +-
.../xwork2/config/impl/NamespaceMatcher.java | 2 +-
.../config/providers/InterceptorBuilder.java | 17 +-
.../providers/XmlConfigurationProvider.java | 40 +-
.../xwork2/config/providers/XmlHelper.java | 33 +-
.../xwork2/conversion/NullHandler.java | 37 +-
.../conversion/TypeConversionException.java | 4 +-
.../conversion/annotations/Conversion.java | 4 +-
.../conversion/annotations/TypeConversion.java | 24 +-
.../conversion/impl/DefaultTypeConverter.java | 2 +
.../impl/InstantiatingNullHandler.java | 15 +-
.../xwork2/conversion/impl/XWorkConverter.java | 4 +-
.../metadata/ConversionDescription.java | 11 +-
.../xwork2/factory/ActionFactory.java | 9 +
.../xwork2/factory/ConverterFactory.java | 3 +
.../xwork2/factory/InterceptorFactory.java | 4 +
.../xwork2/factory/UnknownHandlerFactory.java | 3 +
.../xwork2/factory/ValidatorFactory.java | 6 +-
.../opensymphony/xwork2/inject/Container.java | 24 +-
.../xwork2/inject/ContainerBuilder.java | 98 +-
.../com/opensymphony/xwork2/inject/Context.java | 10 +-
.../com/opensymphony/xwork2/inject/Inject.java | 5 +-
.../com/opensymphony/xwork2/inject/Scope.java | 33 +
.../com/opensymphony/xwork2/inject/Scoped.java | 2 +-
.../xwork2/inject/util/ReferenceCache.java | 15 +
.../xwork2/interceptor/ChainingInterceptor.java | 12 +-
.../interceptor/DefaultWorkflowInterceptor.java | 37 +-
.../ExceptionMappingInterceptor.java | 4 +-
.../xwork2/interceptor/I18nInterceptor.java | 2 +
.../xwork2/interceptor/Interceptor.java | 2 +-
.../xwork2/interceptor/LoggingInterceptor.java | 2 +-
.../interceptor/MethodFilterInterceptor.java | 4 +-
.../interceptor/ParameterFilterInterceptor.java | 3 +-
.../xwork2/interceptor/ParameterNameAware.java | 8 +-
.../interceptor/PrefixMethodInvocationUtil.java | 6 +-
.../xwork2/interceptor/ScopedModelDriven.java | 4 +-
.../StaticParametersInterceptor.java | 2 +-
.../xwork2/interceptor/annotations/After.java | 2 +-
.../xwork2/interceptor/annotations/Before.java | 4 +-
.../interceptor/annotations/BeforeResult.java | 2 +-
.../interceptor/annotations/InputConfig.java | 2 +-
.../xwork2/mock/MockObjectTypeDeterminer.java | 8 +-
.../com/opensymphony/xwork2/ognl/OgnlUtil.java | 16 +-
.../xwork2/spring/SpringObjectFactory.java | 26 +-
.../spring/SpringProxyableObjectFactory.java | 3 +-
.../ActionAutowiringInterceptor.java | 20 +-
.../xwork2/util/AnnotationUtils.java | 23 +-
.../xwork2/util/ClassLoaderUtil.java | 19 +
.../xwork2/util/ClassPathFinder.java | 12 +-
.../opensymphony/xwork2/util/CreateIfNull.java | 7 +-
.../com/opensymphony/xwork2/util/DomHelper.java | 13 +
.../com/opensymphony/xwork2/util/Element.java | 9 +-
.../java/com/opensymphony/xwork2/util/Key.java | 7 +-
.../opensymphony/xwork2/util/KeyProperty.java | 7 +-
.../xwork2/util/LocalizedTextUtil.java | 36 +-
.../util/NamedVariablePatternMatcher.java | 20 +-
.../opensymphony/xwork2/util/ResolverUtil.java | 41 +-
.../opensymphony/xwork2/util/TextParseUtil.java | 95 +-
.../xwork2/util/finder/ResourceFinder.java | 103 +-
.../opensymphony/xwork2/util/finder/UrlSet.java | 21 +-
.../xwork2/util/fs/DefaultFileManager.java | 4 +-
.../util/location/LocationAttributes.java | 7 +-
.../xwork2/util/location/LocationImpl.java | 14 +-
.../xwork2/util/location/LocationUtils.java | 4 +-
.../xwork2/util/profiling/ObjectProfiler.java | 15 +-
.../util/profiling/ProfilingTimerBean.java | 4 +-
.../xwork2/util/profiling/UtilTimerStack.java | 26 +-
.../util/reflection/ReflectionContextState.java | 5 +-
.../util/reflection/ReflectionProvider.java | 16 +-
.../AnnotationActionValidatorManager.java | 1 +
.../validator/DefaultValidatorFileParser.java | 15 +-
.../validator/DelegatingValidatorContext.java | 4 +
.../validator/ShortCircuitableValidator.java | 4 +-
.../xwork2/validator/ValidationInterceptor.java | 13 +-
.../xwork2/validator/Validator.java | 28 +-
.../xwork2/validator/ValidatorConfig.java | 2 +-
.../xwork2/validator/ValidatorFactory.java | 14 +-
.../xwork2/validator/ValidatorFileParser.java | 2 +
.../ConditionalVisitorFieldValidator.java | 21 +-
.../ConversionErrorFieldValidator.java | 15 +-
.../validator/annotations/CustomValidator.java | 8 +-
.../annotations/DateRangeFieldValidator.java | 28 +-
.../annotations/DoubleRangeFieldValidator.java | 37 +-
.../validator/annotations/EmailValidator.java | 13 +-
.../annotations/ExpressionValidator.java | 11 +-
.../annotations/FieldExpressionValidator.java | 13 +-
.../annotations/IntRangeFieldValidator.java | 25 +-
.../annotations/RegexFieldValidator.java | 13 +-
.../annotations/RequiredFieldValidator.java | 13 +-
.../annotations/RequiredStringValidator.java | 19 +-
.../annotations/ShortRangeFieldValidator.java | 25 +-
.../annotations/StringLengthFieldValidator.java | 31 +-
.../validator/annotations/UrlValidator.java | 16 +-
.../validator/annotations/Validation.java | 4 +-
.../annotations/ValidationParameter.java | 2 +-
.../validator/annotations/Validations.java | 4 +-
.../annotations/VisitorFieldValidator.java | 17 +-
.../ConditionalVisitorFieldValidator.java | 2 +-
.../ConversionErrorFieldValidator.java | 4 +-
.../validators/DateRangeFieldValidator.java | 2 +-
.../validators/DoubleRangeFieldValidator.java | 6 +-
.../validators/IntRangeFieldValidator.java | 4 +-
.../validators/LongRangeFieldValidator.java | 4 +-
.../validators/RegexFieldValidator.java | 18 +-
.../validators/RequiredStringValidator.java | 4 +-
.../validators/ShortRangeFieldValidator.java | 4 +-
.../validator/validators/ValidatorSupport.java | 2 +-
.../validators/VisitorFieldValidator.java | 6 +-
.../struts2/components/ActionComponent.java | 40 +-
.../org/apache/struts2/components/Bean.java | 2 +-
.../org/apache/struts2/components/ComboBox.java | 8 +-
.../apache/struts2/components/Component.java | 15 +-
.../components/ComponentUrlProvider.java | 2 +-
.../apache/struts2/components/ContextBean.java | 2 +
.../org/apache/struts2/components/Date.java | 70 +-
.../org/apache/struts2/components/Form.java | 7 +-
.../struts2/components/GenericUIBean.java | 4 +-
.../org/apache/struts2/components/Include.java | 4 +-
.../org/apache/struts2/components/Label.java | 2 +-
.../org/apache/struts2/components/Param.java | 8 +-
.../org/apache/struts2/components/Property.java | 10 +-
.../org/apache/struts2/components/Radio.java | 2 +-
.../org/apache/struts2/components/Text.java | 6 +-
.../org/apache/struts2/components/TextArea.java | 2 +-
.../org/apache/struts2/components/Token.java | 3 +-
.../org/apache/struts2/components/UIBean.java | 26 +-
.../java/org/apache/struts2/components/URL.java | 4 +-
.../apache/struts2/components/UpDownSelect.java | 2 +-
.../apache/struts2/components/UrlRenderer.java | 2 +-
.../config/DefaultBeanSelectionProvider.java | 9 +-
.../config/PropertiesConfigurationProvider.java | 4 +-
.../dispatcher/DefaultStaticContentLoader.java | 2 +-
.../apache/struts2/dispatcher/Dispatcher.java | 6 +-
.../struts2/dispatcher/ExecuteOperations.java | 14 +-
.../struts2/dispatcher/InitOperations.java | 13 +
.../struts2/dispatcher/PrepareOperations.java | 27 +-
.../filter/StrutsPrepareAndExecuteFilter.java | 3 +
.../dispatcher/filter/StrutsPrepareFilter.java | 3 +
.../dispatcher/mapper/DefaultActionMapper.java | 3 +-
.../JakartaStreamMultiPartRequest.java | 93 +-
.../dispatcher/multipart/MultiPartRequest.java | 3 +-
.../multipart/MultiPartRequestWrapper.java | 3 +-
.../struts2/interceptor/CookieInterceptor.java | 20 +-
.../interceptor/ExecuteAndWaitInterceptor.java | 8 +-
.../interceptor/FileUploadInterceptor.java | 3 +-
.../interceptor/MessageStoreInterceptor.java | 31 +-
.../struts2/interceptor/RolesInterceptor.java | 11 +-
.../struts2/interceptor/ScopeInterceptor.java | 7 +-
.../struts2/interceptor/TokenInterceptor.java | 1 +
.../debugging/DebuggingInterceptor.java | 4 +-
.../apache/struts2/result/PostbackResult.java | 3 +-
.../result/ServletActionRedirectResult.java | 22 +-
.../struts2/result/ServletRedirectResult.java | 6 +-
.../org/apache/struts2/result/StreamResult.java | 1 +
.../struts2/result/StrutsResultSupport.java | 14 +-
.../apache/struts2/result/VelocityResult.java | 4 +
.../org/apache/struts2/util/ContainUtil.java | 16 +-
.../struts2/util/InvocationSessionStore.java | 6 +-
.../struts2/util/RegexPatternMatcher.java | 9 +-
.../struts2/util/StrutsTestCaseHelper.java | 2 +
.../struts2/util/StrutsTypeConverter.java | 6 +-
.../struts2/util/fs/JBossFileManager.java | 5 +-
.../views/freemarker/FreemarkerManager.java | 23 +-
.../views/freemarker/FreemarkerResult.java | 35 +-
.../FreemarkerThemeTemplateLoader.java | 2 +
.../struts2/views/jsp/IteratorStatus.java | 2 +-
.../jsp/iterator/IteratorGeneratorTag.java | 10 +-
.../views/jsp/iterator/SortIteratorTag.java | 2 +-
.../views/jsp/iterator/SubsetIteratorTag.java | 8 +-
.../struts2/views/velocity/VelocityManager.java | 54 +-
.../velocity/components/AbstractDirective.java | 17 +-
.../struts2/views/xslt/AbstractAdapterNode.java | 10 +-
.../struts2/views/xslt/AdapterFactory.java | 92 +-
.../apache/struts2/views/xslt/AdapterNode.java | 25 +-
.../apache/struts2/views/xslt/BeanAdapter.java | 2 +-
.../apache/struts2/views/xslt/MapAdapter.java | 12 +-
.../struts2/views/xslt/ProxyElementAdapter.java | 6 +-
.../struts2/views/xslt/ProxyNodeAdapter.java | 7 +-
.../struts2/views/xslt/StringAdapter.java | 15 +-
.../apache/struts2/views/xslt/XSLTResult.java | 17 +-
.../beanvalidation/constraints/FieldMatch.java | 8 +-
.../interceptor/BeanValidationInterceptor.java | 11 +
.../DefaultBeanValidationManager.java | 10 +-
.../ClasspathConfigurationProvider.java | 12 +-
.../convention/DefaultResultMapBuilder.java | 19 +-
.../PackageBasedActionConfigBuilder.java | 11 +-
.../struts2/convention/ReflectionTools.java | 1 +
.../convention/annotation/Namespace.java | 2 +-
.../convention/annotation/ParentPackage.java | 2 +-
.../convention/annotation/ResultPath.java | 2 +-
.../java/org/apache/struts2/JSPRuntime.java | 2 +-
.../struts2/compiler/MemoryClassLoader.java | 4 +-
.../apache/struts2/el/MethodExpressionImpl.java | 13 +-
.../apache/struts2/el/ValueExpressionImpl.java | 8 +-
.../org/apache/struts2/el/lang/ELSupport.java | 37 +-
.../struts2/el/lang/ExpressionBuilder.java | 3 -
.../struts2/el/lang/FunctionMapperImpl.java | 3 -
.../struts2/el/parser/ArithmeticNode.java | 2 +-
.../apache/struts2/el/parser/BooleanNode.java | 2 +-
.../org/apache/struts2/el/parser/ELParser.java | 4569 ++++++++++--------
.../struts2/el/parser/ELParserTokenManager.java | 2603 +++++-----
.../java/org/apache/struts2/el/parser/Node.java | 98 +-
.../struts2/el/parser/ParseException.java | 48 +-
.../struts2/el/parser/SimpleCharStream.java | 999 ++--
.../org/apache/struts2/el/parser/Token.java | 14 +-
.../apache/struts2/el/parser/TokenMgrError.java | 47 +-
.../apache/struts2/el/util/ReflectionUtil.java | 25 +-
.../struts2/jasper/EmbeddedServletOptions.java | 7 +-
.../apache/struts2/jasper/JasperException.java | 7 +-
.../java/org/apache/struts2/jasper/JspC.java | 49 +-
.../struts2/jasper/JspCompilationContext.java | 63 +-
.../java/org/apache/struts2/jasper/Options.java | 52 +-
.../struts2/jasper/compiler/BeanRepository.java | 5 +-
.../struts2/jasper/compiler/Compiler.java | 36 +-
.../jasper/compiler/ELFunctionMapper.java | 2 +
.../jasper/compiler/ErrorDispatcher.java | 467 +-
.../struts2/jasper/compiler/ErrorHandler.java | 35 +-
.../struts2/jasper/compiler/JspConfig.java | 10 +-
.../jasper/compiler/JspRuntimeContext.java | 194 +-
.../apache/struts2/jasper/compiler/JspUtil.java | 1126 ++---
.../struts2/jasper/compiler/ServletWriter.java | 84 +-
.../struts2/jasper/compiler/SmapGenerator.java | 2 +-
.../struts2/jasper/compiler/SmapStratum.java | 26 +-
.../struts2/jasper/compiler/SmapUtil.java | 1 +
.../jasper/compiler/TldLocationsCache.java | 36 +-
.../compiler/tagplugin/TagPluginContext.java | 13 +-
.../jasper/runtime/AnnotationHelper.java | 13 +
.../struts2/jasper/runtime/BodyContentImpl.java | 77 +-
.../jasper/runtime/JspRuntimeLibrary.java | 1256 ++---
.../jasper/runtime/JspSourceDependent.java | 2 +-
.../struts2/jasper/runtime/JspWriterImpl.java | 79 +-
.../struts2/jasper/runtime/PageContextImpl.java | 5 +
.../jasper/runtime/ProtectedFunctionMapper.java | 3 +
.../struts2/jasper/security/SecurityUtil.java | 3 +-
.../jasper/servlet/JspCServletContext.java | 42 +-
.../struts2/jasper/tagplugins/jstl/Util.java | 64 +-
.../struts2/jasper/xmlparser/EncodingMap.java | 520 +-
.../struts2/jasper/xmlparser/ParserUtils.java | 12 +-
.../struts2/jasper/xmlparser/SymbolTable.java | 27 +-
.../struts2/jasper/xmlparser/TreeNode.java | 20 +-
.../struts2/jasper/xmlparser/XMLChar.java | 45 +-
.../jasper/xmlparser/XMLEncodingDetector.java | 1467 +++---
.../struts2/jasper/xmlparser/XMLString.java | 17 +-
.../jasper/xmlparser/XMLStringBuffer.java | 91 +-
.../apache/struts2/views/gxp/AbstractGxp.java | 33 +-
.../struts2/views/gxp/AbstractGxpResult.java | 14 +-
.../java/org/apache/struts2/views/gxp/Gxp.java | 8 +
.../apache/struts2/views/gxp/GxpInstance.java | 12 +-
.../org/apache/struts2/views/gxp/GxpResult.java | 24 +-
.../apache/struts2/dispatcher/ChartResult.java | 2 +-
.../apache/struts2/json/JSONInterceptor.java | 22 +-
.../org/apache/struts2/json/JSONResult.java | 42 +-
.../java/org/apache/struts2/json/JSONUtil.java | 61 +-
.../struts2/json/JSONValidationInterceptor.java | 4 +-
.../org/apache/struts2/json/JSONWriter.java | 56 +-
.../struts2/osgi/DefaultBundleAccessor.java | 13 +-
.../struts2/osgi/OsgiConfigurationProvider.java | 12 +-
.../java/org/apache/struts2/osgi/OsgiUtil.java | 19 +-
.../apache/struts2/osgi/host/BaseOsgiHost.java | 13 +-
.../apache/struts2/osgi/host/FelixOsgiHost.java | 2 +-
.../osgi/interceptor/OsgiInterceptor.java | 2 +-
.../portlet/dispatcher/Jsr168Dispatcher.java | 35 +-
.../interceptor/PortletPreferencesAware.java | 2 +-
.../result/PortletActionRedirectResult.java | 4 +-
.../struts2/portlet/result/PortletResult.java | 39 +-
.../portlet/result/PortletResultHelper.java | 5 +
.../portlet/result/PortletVelocityResult.java | 6 +
.../struts2/portlet/util/PortletUrlHelper.java | 16 +-
.../freemarker/PortletFreemarkerResult.java | 39 +-
.../struts2/rest/ContentTypeHandlerManager.java | 1 +
.../org/apache/struts2/rest/HttpHeaders.java | 6 +-
.../apache/struts2/rest/RestActionMapper.java | 16 +-
.../apache/struts2/rest/RestActionSupport.java | 2 +-
.../rest/handler/ContentTypeHandler.java | 1 +
.../rest/handler/FormUrlEncodedHandler.java | 12 +-
.../rest/handler/MultipartFormDataHandler.java | 13 +-
.../ClassReloadingXMLWebApplicationContext.java | 13 +-
.../spring/StrutsSpringObjectFactory.java | 3 +
297 files changed, 9840 insertions(+), 7938 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/ActionChainResult.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/ActionChainResult.java b/core/src/main/java/com/opensymphony/xwork2/ActionChainResult.java
index 859ccfd..5ec1513 100644
--- a/core/src/main/java/com/opensymphony/xwork2/ActionChainResult.java
+++ b/core/src/main/java/com/opensymphony/xwork2/ActionChainResult.java
@@ -181,6 +181,8 @@ public class ActionChainResult implements Result {
/**
* Get the XWork chain history.
* The stack is a list of <code>namespace/action!method</code> keys.
+ *
+ * @return the chain history as string list
*/
public static LinkedList<String> getChainHistory() {
LinkedList<String> chainHistory = (LinkedList<String>) ActionContext.getContext().get(CHAIN_HISTORY);
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/ActionContext.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/ActionContext.java b/core/src/main/java/com/opensymphony/xwork2/ActionContext.java
index 74e45d3..426d3c6 100644
--- a/core/src/main/java/com/opensymphony/xwork2/ActionContext.java
+++ b/core/src/main/java/com/opensymphony/xwork2/ActionContext.java
@@ -36,7 +36,7 @@ import java.util.Map;
* this is you don't need to worry about a user specific action context, you just get it:
* </p>
*
- * <ul><code>ActionContext context = ActionContext.getContext();</code></ul>
+ * <code>ActionContext context = ActionContext.getContext();</code>
*
* <p>
* Finally, because of the thread local usage you don't need to worry about making your actions thread safe.
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/CompositeTextProvider.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/CompositeTextProvider.java b/core/src/main/java/com/opensymphony/xwork2/CompositeTextProvider.java
index 3927610..28b79da 100644
--- a/core/src/main/java/com/opensymphony/xwork2/CompositeTextProvider.java
+++ b/core/src/main/java/com/opensymphony/xwork2/CompositeTextProvider.java
@@ -13,7 +13,6 @@ import java.util.*;
* javadoc for each methods.
*
* @author tmjee
- * @version $Date$ $Id$
*/
public class CompositeTextProvider implements TextProvider {
@@ -24,7 +23,7 @@ public class CompositeTextProvider implements TextProvider {
/**
* Instantiates a {@link CompositeTextProvider} with some predefined <code>textProviders</code>.
*
- * @param textProviders
+ * @param textProviders list of text providers
*/
public CompositeTextProvider(List<TextProvider> textProviders) {
this.textProviders.addAll(textProviders);
@@ -33,18 +32,20 @@ public class CompositeTextProvider implements TextProvider {
/**
* Instantiates a {@link CompositeTextProvider} with some predefined <code>textProviders</code>.
*
- * @param textProviders
+ * @param textProviders array of text providers
*/
public CompositeTextProvider(TextProvider[] textProviders) {
this(Arrays.asList(textProviders));
}
/**
- * @param key The key to lookup in ressource bundles.
- * @return <tt>true</tt>, if the requested key is found in one of the ressource bundles.
- * @see {@link com.opensymphony.xwork2.TextProvider#hasKey(String)}
- * It will consult each individual {@link TextProvider}s and return true if either one of the
- * {@link TextProvider} has such a <code>key></code> else false.
+ * It will consult each individual {@link TextProvider}s and return true if either one of the {@link TextProvider}" has such a <code>key</code> else false.
+ *
+ * @param key The key to lookup in resource bundles.
+ * @return <tt>true</tt>, if the requested key is found in one of the resource bundles.
+ *
+ * @see com.opensymphony.xwork2.TextProvider#hasKey(String)
+ *
*/
public boolean hasKey(String key) {
// if there's a key in either text providers we are ok, else try the next text provider
@@ -62,7 +63,7 @@ public class CompositeTextProvider implements TextProvider {
*
* @param key The key to lookup in resource bundles.
* @return The i18n text for the requested key.
- * @see {@link com.opensymphony.xwork2.TextProvider#getText(String)}
+ * @see com.opensymphony.xwork2.TextProvider#getText(String)
*/
public String getText(String key) {
return getText(key, key, Collections.emptyList());
@@ -72,10 +73,10 @@ public class CompositeTextProvider implements TextProvider {
* It will consult each {@link TextProvider}s and return the first valid message for this
* <code>key</code> before returning <code>defaultValue</code> if every else fails.
*
- * @param key
- * @param defaultValue
- * @return
- * @see {@link com.opensymphony.xwork2.TextProvider#getText(String, String)}
+ * @param key the message key
+ * @param defaultValue the default value
+ * @return the first valid message for the key or default value
+ * @see com.opensymphony.xwork2.TextProvider#getText(String, String)
*/
public String getText(String key, String defaultValue) {
return getText(key, defaultValue, Collections.emptyList());
@@ -86,11 +87,11 @@ public class CompositeTextProvider implements TextProvider {
* <code>key</code>, before returning <code>defaultValue</code>
* if every else fails.
*
- * @param key
- * @param defaultValue
- * @param obj
- * @return
- * @see {@link com.opensymphony.xwork2.TextProvider#getText(String, String, String)}
+ * @param key the message key
+ * @param defaultValue the default value
+ * @param obj object
+ * @return the first valid message for the key or default value
+ * @see com.opensymphony.xwork2.TextProvider#getText(String, String, String)
*/
public String getText(String key, String defaultValue, final String obj) {
return getText(key, defaultValue, new ArrayList<Object>() {
@@ -104,10 +105,10 @@ public class CompositeTextProvider implements TextProvider {
* It will consult each {@link TextProvider}s and return the first valid message for this
* <code>key</code>.
*
- * @param key
- * @param args
- * @return
- * @see {@link com.opensymphony.xwork2.TextProvider#getText(String, java.util.List)}
+ * @param key the message key
+ * @param args additional arguments
+ * @return the first valid message for the key
+ * @see com.opensymphony.xwork2.TextProvider#getText(String, java.util.List)
*/
public String getText(String key, List<?> args) {
return getText(key, key, args);
@@ -117,10 +118,10 @@ public class CompositeTextProvider implements TextProvider {
* It will consult each {@link TextProvider}s and return the first valid message for this
* <code>key</code>.
*
- * @param key
- * @param args
- * @return
- * @see {@link com.opensymphony.xwork2.TextProvider#getText(String, String[])}
+ * @param key the message key
+ * @param args additional arguments
+ * @return the first valid message for the key or default value
+ * @see com.opensymphony.xwork2.TextProvider#getText(String, String[])
*/
public String getText(String key, String[] args) {
return getText(key, key, args);
@@ -131,11 +132,11 @@ public class CompositeTextProvider implements TextProvider {
* It will consult each {@link TextProvider}s and return the first valid message for this
* <code>key</code>, before returning <code>defaultValue</code>
*
- * @param key
- * @param defaultValue
- * @param args
- * @return
- * @see {@link com.opensymphony.xwork2.TextProvider#getText#getText(String, String, java.util.List)}
+ * @param key the message key
+ * @param defaultValue the default value
+ * @param args additional arguments
+ * @return the first valid message for the key or default value
+ * @see com.opensymphony.xwork2.TextProvider#getText(String, String, java.util.List)
*/
public String getText(String key, String defaultValue, List<?> args) {
// if there's one text provider that gives us a msg not the same as defaultValue
@@ -155,11 +156,11 @@ public class CompositeTextProvider implements TextProvider {
* It will consult each {@link TextProvider}s and return the first valid message for this
* <code>key</code>, before returning <code>defaultValue</code>.
*
- * @param key
- * @param defaultValue
- * @param args
- * @return
- * @see {@link com.opensymphony.xwork2.TextProvider#getText(String, String, String[])}
+ * @param key the message key
+ * @param defaultValue the default value
+ * @param args additional arguments
+ * @return the first valid message for the key or default value
+ * @see com.opensymphony.xwork2.TextProvider#getText(String, String, String[])
*/
public String getText(String key, String defaultValue, String[] args) {
// if there's one text provider that gives us a msg not the same as defaultValue
@@ -179,12 +180,12 @@ public class CompositeTextProvider implements TextProvider {
* It will consult each {@link TextProvider}s and return the first valid message for this
* <code>key</code>, before returning <code>defaultValue</code>
*
- * @param key
- * @param defaultValue
- * @param args
- * @param stack
- * @return
- * @see {@link com.opensymphony.xwork2.TextProvider#getText(String, String, java.util.List, com.opensymphony.xwork2.util.ValueStack)}
+ * @param key the message key
+ * @param defaultValue the default value
+ * @param args additional arguments
+ * @param stack the value stack
+ * @return the first valid message for the key or default value
+ * @see com.opensymphony.xwork2.TextProvider#getText(String, String, java.util.List, com.opensymphony.xwork2.util.ValueStack)
*/
public String getText(String key, String defaultValue, List<?> args, ValueStack stack) {
// if there's one text provider that gives us a msg not the same as defaultValue
@@ -203,12 +204,12 @@ public class CompositeTextProvider implements TextProvider {
* It will consult each {@link TextProvider}s and return the first valid message for this
* <code>key</code>, before returning <code>defaultValue</code>
*
- * @param key
- * @param defaultValue
- * @param args
- * @param stack
- * @return
- * @see {@link com.opensymphony.xwork2.TextProvider#getText(String, String, String[], com.opensymphony.xwork2.util.ValueStack)}
+ * @param key the message key
+ * @param defaultValue the default value
+ * @param args additional arguments
+ * @param stack the value stack
+ * @return the first valid message for the key or default value
+ * @see com.opensymphony.xwork2.TextProvider#getText(String, String, String[], com.opensymphony.xwork2.util.ValueStack)
*/
public String getText(String key, String defaultValue, String[] args, ValueStack stack) {
// if there's one text provider that gives us a msg not the same as defaultValue
@@ -227,9 +228,9 @@ public class CompositeTextProvider implements TextProvider {
/**
* It will consult each {@link TextProvider}s and return the first non-null {@link ResourceBundle}.
*
- * @param bundleName
- * @return
- * @see {@link TextProvider#getTexts(String)}
+ * @param bundleName the bundle name
+ * @return the resource bundle found for bundle name
+ * @see TextProvider#getTexts(String)
*/
public ResourceBundle getTexts(String bundleName) {
// if there's one text provider that gives us a non-null resource bundle for this bundleName, we are ok, else try the next
@@ -246,8 +247,8 @@ public class CompositeTextProvider implements TextProvider {
/**
* It will consult each {@link com.opensymphony.xwork2.TextProvider}s and return the first non-null {@link ResourceBundle}.
*
- * @return
- * @see {@link TextProvider#getTexts()}
+ * @return the resource bundle
+ * @see TextProvider#getTexts()
*/
public ResourceBundle getTexts() {
// if there's one text provider that gives us a non-null resource bundle, we are ok, else try the next
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/DefaultActionInvocation.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/DefaultActionInvocation.java b/core/src/main/java/com/opensymphony/xwork2/DefaultActionInvocation.java
index da9fce6..a5b4723 100644
--- a/core/src/main/java/com/opensymphony/xwork2/DefaultActionInvocation.java
+++ b/core/src/main/java/com/opensymphony/xwork2/DefaultActionInvocation.java
@@ -126,7 +126,7 @@ public class DefaultActionInvocation implements ActionInvocation {
* the result params.
*
* @return a Result instance
- * @throws Exception
+ * @throws Exception in case of any error
*/
public Result getResult() throws Exception {
Result returnResult = result;
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/DefaultActionProxy.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/DefaultActionProxy.java b/core/src/main/java/com/opensymphony/xwork2/DefaultActionProxy.java
index 1e4170d..d1bfd71 100644
--- a/core/src/main/java/com/opensymphony/xwork2/DefaultActionProxy.java
+++ b/core/src/main/java/com/opensymphony/xwork2/DefaultActionProxy.java
@@ -41,7 +41,6 @@ import java.util.Locale;
* @author Rainer Hermanns
* @author Revised by <a href="mailto:hu_pengfei@yahoo.com.cn">Henry Hu</a>
* @author tmjee
- * @version $Date$ $Id$
* @since 2005-8-6
*/
public class DefaultActionProxy implements ActionProxy, Serializable {
@@ -74,6 +73,13 @@ public class DefaultActionProxy implements ActionProxy, Serializable {
* </p>
*
* (like a RMIActionProxy).
+ *
+ * @param inv the action invocation
+ * @param namespace the namespace
+ * @param actionName the action name
+ * @param methodName the method name
+ * @param executeResult execute result
+ * @param cleanupContext cleanup context
*/
protected DefaultActionProxy(ActionInvocation inv, String namespace, String actionName, String methodName, boolean executeResult, boolean cleanupContext) {
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/DefaultTextProvider.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/DefaultTextProvider.java b/core/src/main/java/com/opensymphony/xwork2/DefaultTextProvider.java
index eb57deb..1d72161 100644
--- a/core/src/main/java/com/opensymphony/xwork2/DefaultTextProvider.java
+++ b/core/src/main/java/com/opensymphony/xwork2/DefaultTextProvider.java
@@ -29,7 +29,7 @@ import java.util.ResourceBundle;
* DefaultTextProvider gets texts from only the default resource bundles associated with the
* LocalizedTextUtil.
*
- * @author Jason Carreira <jc...@gmail.com>
+ * @author Jason Carreira jcarreira@gmail.com
* @author Rainer Hermanns
* @see LocalizedTextUtil#addDefaultResourceBundle(String)
*/
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/DefaultUnknownHandlerManager.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/DefaultUnknownHandlerManager.java b/core/src/main/java/com/opensymphony/xwork2/DefaultUnknownHandlerManager.java
index e2a4175..5cafe9a 100644
--- a/core/src/main/java/com/opensymphony/xwork2/DefaultUnknownHandlerManager.java
+++ b/core/src/main/java/com/opensymphony/xwork2/DefaultUnknownHandlerManager.java
@@ -51,6 +51,8 @@ public class DefaultUnknownHandlerManager implements UnknownHandlerManager {
/**
* Builds a list of UnknownHandlers in the order specified by the configured "unknown-handler-stack".
* If "unknown-handler-stack" was not configured, all UnknownHandlers will be returned, in no specific order
+ *
+ * @throws Exception in case of any error
*/
protected void build() throws Exception {
Configuration configuration = container.getInstance(Configuration.class);
@@ -79,6 +81,11 @@ public class DefaultUnknownHandlerManager implements UnknownHandlerManager {
/**
* Iterate over UnknownHandlers and return the result of the first one that can handle it
+ *
+ * @param actionContext the action context
+ * @param actionName the action name
+ * @param actionConfig the action config
+ * @param resultCode the result code
*/
public Result handleUnknownResult(ActionContext actionContext, String actionName, ActionConfig actionConfig, String resultCode) {
for (UnknownHandler unknownHandler : unknownHandlers) {
@@ -95,7 +102,9 @@ public class DefaultUnknownHandlerManager implements UnknownHandlerManager {
* Iterate over UnknownHandlers and return the result of the first one that can handle it.
* Must throw an exception if method cannot be handled.
*
- * @throws NoSuchMethodException
+ * @param action the action
+ * @param methodName the method name
+ * @throws NoSuchMethodException if method con not be handled
*/
public Object handleUnknownMethod(Object action, String methodName) throws NoSuchMethodException {
for (UnknownHandler unknownHandler : unknownHandlers) {
@@ -114,6 +123,9 @@ public class DefaultUnknownHandlerManager implements UnknownHandlerManager {
/**
* Iterate over UnknownHandlers and return the result of the first one that can handle it
+ *
+ * @param namespace the namespace
+ * @param actionName the action name
*/
public ActionConfig handleUnknownAction(String namespace, String actionName) {
for (UnknownHandler unknownHandler : unknownHandlers) {
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/ObjectFactory.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/ObjectFactory.java b/core/src/main/java/com/opensymphony/xwork2/ObjectFactory.java
index 0b055a8..c5ffbb9 100644
--- a/core/src/main/java/com/opensymphony/xwork2/ObjectFactory.java
+++ b/core/src/main/java/com/opensymphony/xwork2/ObjectFactory.java
@@ -114,7 +114,7 @@ public class ObjectFactory implements Serializable {
*
* @param className The fully qualified name of the class to return
* @return The class itself
- * @throws ClassNotFoundException
+ * @throws ClassNotFoundException if class not found in classpath
*/
public Class getClassInstance(String className) throws ClassNotFoundException {
if (ccl != null) {
@@ -131,7 +131,7 @@ public class ObjectFactory implements Serializable {
* @param config the action configuration found in the config for the actionName / namespace
* @param extraContext a Map of extra context which uses the same keys as the {@link com.opensymphony.xwork2.ActionContext}
* @return instance of the action class to handle a web request
- * @throws Exception
+ * @throws Exception in case of any error
*/
public Object buildAction(String actionName, String namespace, ActionConfig config, Map<String, Object> extraContext) throws Exception {
return actionFactory.buildAction(actionName, namespace, config, extraContext);
@@ -142,13 +142,16 @@ public class ObjectFactory implements Serializable {
*
* @param clazz the type of Object to build
* @param extraContext a Map of extra context which uses the same keys as the {@link com.opensymphony.xwork2.ActionContext}
+ * @return object for the given type
+ * @throws Exception in case of any error
*/
public Object buildBean(Class clazz, Map<String, Object> extraContext) throws Exception {
return clazz.newInstance();
}
/**
- * @param obj
+ * @param obj object to inject internal
+ * @return the object
*/
protected Object injectInternalBeans(Object obj) {
if (obj != null && container != null) {
@@ -162,6 +165,8 @@ public class ObjectFactory implements Serializable {
*
* @param className the type of Object to build
* @param extraContext a Map of extra context which uses the same keys as the {@link com.opensymphony.xwork2.ActionContext}
+ * @return object for the given type
+ * @throws Exception in case of any error
*/
public Object buildBean(String className, Map<String, Object> extraContext) throws Exception {
return buildBean(className, extraContext, true);
@@ -172,6 +177,9 @@ public class ObjectFactory implements Serializable {
*
* @param className the type of Object to build
* @param extraContext a Map of extra context which uses the same keys as the {@link com.opensymphony.xwork2.ActionContext}
+ * @param injectInternal true if inject internal beans
+ * @return object for the given type
+ * @throws Exception in case of any error
*/
public Object buildBean(String className, Map<String, Object> extraContext, boolean injectInternal) throws Exception {
Class clazz = getClassInstance(className);
@@ -185,7 +193,7 @@ public class ObjectFactory implements Serializable {
/**
* Builds an Interceptor from the InterceptorConfig and the Map of
* parameters from the interceptor reference. Implementations of this method
- * should ensure that the Interceptor is parameterized with both the
+ * should ensure that the Interceptor is parametrized with both the
* parameters from the Interceptor config and the interceptor ref Map (the
* interceptor ref params take precedence), and that the Interceptor.init()
* method is called on the Interceptor instance before it is returned.
@@ -193,6 +201,7 @@ public class ObjectFactory implements Serializable {
* @param interceptorConfig the InterceptorConfig from the configuration
* @param interceptorRefParams a Map of params provided in the Interceptor reference in the
* Action mapping or InterceptorStack definition
+ * @return interceptor
*/
public Interceptor buildInterceptor(InterceptorConfig interceptorConfig, Map<String, String> interceptorRefParams) throws ConfigurationException {
return interceptorFactory.buildInterceptor(interceptorConfig, interceptorRefParams);
@@ -203,6 +212,9 @@ public class ObjectFactory implements Serializable {
*
* @param resultConfig the ResultConfig found for the action with the result code returned
* @param extraContext a Map of extra context which uses the same keys as the {@link com.opensymphony.xwork2.ActionContext}
+ *
+ * @return result
+ * @throws Exception in case of any error
*/
public Result buildResult(ResultConfig resultConfig, Map<String, Object> extraContext) throws Exception {
return resultFactory.buildResult(resultConfig, extraContext);
@@ -212,8 +224,11 @@ public class ObjectFactory implements Serializable {
* Build a Validator of the given type and set the parameters on it
*
* @param className the type of Validator to build
- * @param params property name -> value Map to set onto the Validator instance
+ * @param params property name -> value Map to set onto the Validator instance
* @param extraContext a Map of extra context which uses the same keys as the {@link com.opensymphony.xwork2.ActionContext}
+ *
+ * @return validator of the given type
+ * @throws Exception in case of any error
*/
public Validator buildValidator(String className, Map<String, Object> params, Map<String, Object> extraContext) throws Exception {
return validatorFactory.buildValidator(className, params, extraContext);
@@ -225,6 +240,7 @@ public class ObjectFactory implements Serializable {
* @param converterClass to instantiate
* @param extraContext a Map of extra context which uses the same keys as the {@link com.opensymphony.xwork2.ActionContext}
* @return instance of converterClass with inject dependencies
+ * @throws Exception in case of any error
*/
public TypeConverter buildConverter(Class<? extends TypeConverter> converterClass, Map<String, Object> extraContext) throws Exception {
return converterFactory.buildConverter(converterClass, extraContext);
@@ -233,10 +249,10 @@ public class ObjectFactory implements Serializable {
/**
* Builds unknown handler
*
- * @param unknownHandlerName
- * @param extraContext
- * @return
- * @throws Exception
+ * @param unknownHandlerName the unknown handler name
+ * @param extraContext extra context
+ * @return a unknown handler
+ * @throws Exception in case of any error
*/
public UnknownHandler buildUnknownHandler(String unknownHandlerName, Map<String, Object> extraContext) throws Exception {
return unknownHandlerFactory.buildUnknownHandler(unknownHandlerName, extraContext);
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/UnknownHandler.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/UnknownHandler.java b/core/src/main/java/com/opensymphony/xwork2/UnknownHandler.java
index 2b5c7c1..51556d6 100644
--- a/core/src/main/java/com/opensymphony/xwork2/UnknownHandler.java
+++ b/core/src/main/java/com/opensymphony/xwork2/UnknownHandler.java
@@ -33,7 +33,7 @@ public interface UnknownHandler {
* @param namespace The namespace
* @param actionName The action name
* @return An generated ActionConfig, can return <tt>null</tt>
- * @throws XWorkException
+ * @throws XWorkException in case of errors
*/
ActionConfig handleUnknownAction(String namespace, String actionName) throws XWorkException;
@@ -45,7 +45,7 @@ public interface UnknownHandler {
* @param actionConfig The action config
* @param resultCode The returned result code
* @return A result to be executed, can return <tt>null</tt>
- * @throws XWorkException
+ * @throws XWorkException in case of errors
*/
Result handleUnknownResult(ActionContext actionContext, String actionName, ActionConfig actionConfig, String resultCode) throws XWorkException;
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/config/Configuration.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/config/Configuration.java b/core/src/main/java/com/opensymphony/xwork2/config/Configuration.java
index ab6b2ab..9af002f 100644
--- a/core/src/main/java/com/opensymphony/xwork2/config/Configuration.java
+++ b/core/src/main/java/com/opensymphony/xwork2/config/Configuration.java
@@ -65,8 +65,9 @@ public interface Configuration extends Serializable {
/**
* @since 2.1
- * @param containerProviders
- * @throws ConfigurationException
+ * @param containerProviders list of container providers
+ * @return list of package providers
+ * @throws ConfigurationException in case of any configuration errors
*/
List<PackageProvider> reloadContainer(List<ContainerProvider> containerProviders) throws ConfigurationException;
@@ -85,7 +86,7 @@ public interface Configuration extends Serializable {
/**
* @since 2.1
- * @param unknownHandlerStack
+ * @param unknownHandlerStack list of unknown handlers
*/
void setUnknownHandlerStack(List<UnknownHandlerConfig> unknownHandlerStack);
}
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/config/ConfigurationException.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/config/ConfigurationException.java b/core/src/main/java/com/opensymphony/xwork2/config/ConfigurationException.java
index fcbb11b..af505f7 100644
--- a/core/src/main/java/com/opensymphony/xwork2/config/ConfigurationException.java
+++ b/core/src/main/java/com/opensymphony/xwork2/config/ConfigurationException.java
@@ -46,6 +46,7 @@ public class ConfigurationException extends XWorkException {
* detail message.
*
* @param s the detail message.
+ * @param target the target object
*/
public ConfigurationException(String s, Object target) {
super(s, target);
@@ -53,6 +54,8 @@ public class ConfigurationException extends XWorkException {
/**
* Constructs a <code>ConfigurationException</code> with no detail message.
+ *
+ * @param cause the cause of the exception
*/
public ConfigurationException(Throwable cause) {
super(cause);
@@ -60,6 +63,8 @@ public class ConfigurationException extends XWorkException {
/**
* Constructs a <code>ConfigurationException</code> with no detail message.
+ * @param cause the cause of the exception
+ * @param target the target object
*/
public ConfigurationException(Throwable cause, Object target) {
super(cause, target);
@@ -70,6 +75,7 @@ public class ConfigurationException extends XWorkException {
* detail message.
*
* @param s the detail message.
+ * @param cause the cause of the exception
*/
public ConfigurationException(String s, Throwable cause) {
super(s, cause);
@@ -80,6 +86,8 @@ public class ConfigurationException extends XWorkException {
* detail message.
*
* @param s the detail message.
+ * @param cause the cause of the exception
+ * @param target the target object
*/
public ConfigurationException(String s, Throwable cause, Object target) {
super(s, cause, target);
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/config/ConfigurationManager.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/config/ConfigurationManager.java b/core/src/main/java/com/opensymphony/xwork2/config/ConfigurationManager.java
index 63abe87..ea51c63 100644
--- a/core/src/main/java/com/opensymphony/xwork2/config/ConfigurationManager.java
+++ b/core/src/main/java/com/opensymphony/xwork2/config/ConfigurationManager.java
@@ -56,7 +56,7 @@ public class ConfigurationManager {
}
/**
- * Get the current XWork configuration object. By default an instance of DefaultConfiguration will be returned
+ * @return the current XWork configuration object. By default an instance of DefaultConfiguration will be returned
*
* @see com.opensymphony.xwork2.config.impl.DefaultConfiguration
*/
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/config/PackageProvider.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/config/PackageProvider.java b/core/src/main/java/com/opensymphony/xwork2/config/PackageProvider.java
index dd0dfae..9020e3c 100644
--- a/core/src/main/java/com/opensymphony/xwork2/config/PackageProvider.java
+++ b/core/src/main/java/com/opensymphony/xwork2/config/PackageProvider.java
@@ -28,19 +28,19 @@ public interface PackageProvider {
* @param configuration The configuration
* @throws ConfigurationException If anything goes wrong
*/
- public void init(Configuration configuration) throws ConfigurationException;
+ void init(Configuration configuration) throws ConfigurationException;
/**
* Tells whether the PackageProvider should reload its configuration
*
* @return <tt>true</tt>, whether the PackageProvider should reload its configuration, <tt>false</tt>otherwise.
*/
- public boolean needsReload();
+ boolean needsReload();
/**
* Loads the packages for the configuration.
- * @throws ConfigurationException
+ * @throws ConfigurationException in case of configuration errors
*/
- public void loadPackages() throws ConfigurationException;
+ void loadPackages() throws ConfigurationException;
}
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/config/entities/ActionConfig.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/config/entities/ActionConfig.java b/core/src/main/java/com/opensymphony/xwork2/config/entities/ActionConfig.java
index d796c02..b32f2cf 100644
--- a/core/src/main/java/com/opensymphony/xwork2/config/entities/ActionConfig.java
+++ b/core/src/main/java/com/opensymphony/xwork2/config/entities/ActionConfig.java
@@ -30,8 +30,8 @@ import java.util.*;
* Interface and the execute() method called</li>
* <li>clazz - the class name for the action</li>
* <li>params - the params to be set for this action just before execution</li>
- * <li>results - the result map {String -> View class}</li>
- * <li>resultParameters - params for results {String -> Map}</li>
+ * <li>results - the result map {String -> View class}</li>
+ * <li>resultParameters - params for results {String -> Map}</li>
* <li>typeConverter - the Ognl TypeConverter to use when getting/setting properties</li>
* </ul>
*
@@ -68,7 +68,7 @@ public class ActionConfig extends Located implements Serializable {
/**
* Clones an ActionConfig, copying data into new maps and lists
* @param orig The ActionConfig to clone
- * @Since 2.1
+ * @since 2.1
*/
protected ActionConfig(ActionConfig orig) {
this.name = orig.name;
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/config/entities/InterceptorStackConfig.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/config/entities/InterceptorStackConfig.java b/core/src/main/java/com/opensymphony/xwork2/config/entities/InterceptorStackConfig.java
index f17eed6..51632b5 100644
--- a/core/src/main/java/com/opensymphony/xwork2/config/entities/InterceptorStackConfig.java
+++ b/core/src/main/java/com/opensymphony/xwork2/config/entities/InterceptorStackConfig.java
@@ -49,13 +49,13 @@ public class InterceptorStackConfig extends Located implements Serializable {
* Creates an InterceptorStackConfig object.
*/
protected InterceptorStackConfig() {
- this.interceptors = new ArrayList<InterceptorMapping>();
+ this.interceptors = new ArrayList<>();
}
/**
* Creates an InterceptorStackConfig object with a particular <code>name</code>.
*
- * @param name
+ * @param orig interceptor stack configuration
*/
protected InterceptorStackConfig(InterceptorStackConfig orig) {
this.name = orig.name;
@@ -67,7 +67,7 @@ public class InterceptorStackConfig extends Located implements Serializable {
/**
* Returns a <code>Collection</code> of InterceptorMapping objects.
*
- * @return
+ * @return collection of interceptor mappings
*/
public Collection<InterceptorMapping> getInterceptors() {
return interceptors;
@@ -89,6 +89,9 @@ public class InterceptorStackConfig extends Located implements Serializable {
* <li>both names are equals</li>
* <li>all of their <code>InterceptorMapping</code>s are equals</li>
* </ul>
+ *
+ * @param o the given object to check
+ * @return true if object match the rules
*/
@Override
public boolean equals(Object o) {
@@ -114,7 +117,7 @@ public class InterceptorStackConfig extends Located implements Serializable {
}
/**
- * Generate hashcode based on <code>InterceptorStackConfig</code>'s name and its
+ * @return generated hashcode based on <code>InterceptorStackConfig</code>'s name and its
* <code>InterceptorMapping</code>s.
*/
@Override
@@ -151,6 +154,10 @@ public class InterceptorStackConfig extends Located implements Serializable {
/**
* Add an <code>InterceptorMapping</code> object.
+ *
+ * @param interceptor interceptor mapping
+ *
+ * @return this builder
*/
public Builder addInterceptor(InterceptorMapping interceptor) {
target.interceptors.add(interceptor);
@@ -159,6 +166,10 @@ public class InterceptorStackConfig extends Located implements Serializable {
/**
* Add a List of <code>InterceptorMapping</code> objects.
+ *
+ * @param interceptors list of interceptor mappings
+ *
+ * @return this builder
*/
public Builder addInterceptors(List<InterceptorMapping> interceptors) {
target.interceptors.addAll(interceptors);
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/config/entities/PackageConfig.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/config/entities/PackageConfig.java b/core/src/main/java/com/opensymphony/xwork2/config/entities/PackageConfig.java
index 0f803f2..c9ef12d 100644
--- a/core/src/main/java/com/opensymphony/xwork2/config/entities/PackageConfig.java
+++ b/core/src/main/java/com/opensymphony/xwork2/config/entities/PackageConfig.java
@@ -217,14 +217,14 @@ public class PackageConfig extends Located implements Comparable, Serializable,
}
/**
- * Returns the default result type for this package.
+ * @return the default result type for this package.
*/
public String getDefaultResultType() {
return defaultResultType;
}
/**
- * gets the default interceptor-ref name. If this is not set on this PackageConfig, it searches the parent
+ * @return the default interceptor-ref name. If this is not set on this PackageConfig, it searches the parent
* PackageConfigs in order until it finds one.
*/
public String getFullDefaultInterceptorRef() {
@@ -242,7 +242,7 @@ public class PackageConfig extends Located implements Comparable, Serializable,
}
/**
- * gets the default action-ref name. If this is not set on this PackageConfig, it searches the parent
+ * @return the default action-ref name. If this is not set on this PackageConfig, it searches the parent
* PackageConfigs in order until it finds one.
*/
public String getFullDefaultActionRef() {
@@ -267,6 +267,8 @@ public class PackageConfig extends Located implements Comparable, Serializable,
* If there is no default result type, but this package has parents - we will try to
* look up the default result type of a parent.
* </p>
+ *
+ * @return the default result type for this package.
*/
public String getFullDefaultResultType() {
if ((defaultResultType == null) && !parents.isEmpty()) {
@@ -481,7 +483,9 @@ public class PackageConfig extends Located implements Comparable, Serializable,
/**
* sets the default Result type for this package
*
- * @param defaultResultType
+ * @param defaultResultType set the default result type
+ *
+ * @return this builder
*/
public Builder defaultResultType(String defaultResultType) {
target.defaultResultType = defaultResultType;
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/config/impl/AbstractMatcher.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/config/impl/AbstractMatcher.java b/core/src/main/java/com/opensymphony/xwork2/config/impl/AbstractMatcher.java
index 5deb7cb..954657f 100644
--- a/core/src/main/java/com/opensymphony/xwork2/config/impl/AbstractMatcher.java
+++ b/core/src/main/java/com/opensymphony/xwork2/config/impl/AbstractMatcher.java
@@ -142,11 +142,12 @@ public abstract class AbstractMatcher<E> implements Serializable {
protected abstract E convert(String path, E orig, Map<String, String> vars);
/**
- * <p> Replaces parameter values
- * </p>
+ * <p>Replaces parameter values</p>
*
* @param orig The original parameters with placeholder values
* @param vars A Map of wildcard-matched strings
+ *
+ * @return map with replaced parameters
*/
protected Map<String,String> replaceParameters(Map<String, String> orig, Map<String,String> vars) {
Map<String, String> map = new LinkedHashMap<>();
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/config/impl/ActionConfigMatcher.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/config/impl/ActionConfigMatcher.java b/core/src/main/java/com/opensymphony/xwork2/config/impl/ActionConfigMatcher.java
index 2d0a3c5..bb97ce8 100644
--- a/core/src/main/java/com/opensymphony/xwork2/config/impl/ActionConfigMatcher.java
+++ b/core/src/main/java/com/opensymphony/xwork2/config/impl/ActionConfigMatcher.java
@@ -50,6 +50,7 @@ public class ActionConfigMatcher extends AbstractMatcher<ActionConfig> implement
* last two characters didn't exist. The goal is to support the
* legacy "*!*" syntax, where the "!*" is optional.</p>
*
+ * @param patternMatcher pattern matcher
* @param configs An array of ActionConfig's to process
* @param looseMatch To loosely match wildcards or not
*/
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/config/impl/DefaultConfiguration.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/config/impl/DefaultConfiguration.java b/core/src/main/java/com/opensymphony/xwork2/config/impl/DefaultConfiguration.java
index 2bc98ab..1aa45c1 100644
--- a/core/src/main/java/com/opensymphony/xwork2/config/impl/DefaultConfiguration.java
+++ b/core/src/main/java/com/opensymphony/xwork2/config/impl/DefaultConfiguration.java
@@ -143,7 +143,9 @@ public class DefaultConfiguration implements Configuration {
* Calls the ConfigurationProviderFactory.getConfig() to tell it to reload the configuration and then calls
* buildRuntimeConfiguration().
*
- * @throws ConfigurationException
+ * @return list of package providers
+ *
+ * @throws ConfigurationException in case of any configuration errors
*/
public synchronized List<PackageProvider> reloadContainer(List<ContainerProvider> providers) throws ConfigurationException {
packageContexts.clear();
@@ -272,14 +274,20 @@ public class DefaultConfiguration implements Configuration {
}
/**
+ * <p>
* This builds the internal runtime configuration used by Xwork for finding and configuring Actions from the
* programmatic configuration data structures. All of the old runtime configuration will be discarded and rebuilt.
+ * </p>
*
* <p>
* It basically flattens the data structures to make the information easier to access. It will take
* an {@link ActionConfig} and combine its data with all inherited dast. For example, if the {@link ActionConfig}
* is in a package that contains a global result and it also contains a result, the resulting {@link ActionConfig}
* will have two results.
+ * </p>
+ *
+ * @return runtime configuration
+ * @throws ConfigurationException in case of any configuration errors
*/
protected synchronized RuntimeConfiguration buildRuntimeConfiguration() throws ConfigurationException {
Map<String, Map<String, ActionConfig>> namespaceActionConfigs = new LinkedHashMap<>();
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/config/impl/NamespaceMatch.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/config/impl/NamespaceMatch.java b/core/src/main/java/com/opensymphony/xwork2/config/impl/NamespaceMatch.java
index 52a0886..ce2ae70 100644
--- a/core/src/main/java/com/opensymphony/xwork2/config/impl/NamespaceMatch.java
+++ b/core/src/main/java/com/opensymphony/xwork2/config/impl/NamespaceMatch.java
@@ -20,7 +20,7 @@ import java.util.Map;
/**
* Represents a match from a namespace pattern matching.
*
- * @Since 2.1
+ * @since 2.1
*/
public class NamespaceMatch {
private String pattern;
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/config/impl/NamespaceMatcher.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/config/impl/NamespaceMatcher.java b/core/src/main/java/com/opensymphony/xwork2/config/impl/NamespaceMatcher.java
index 3d64c33..6fa9ec3 100644
--- a/core/src/main/java/com/opensymphony/xwork2/config/impl/NamespaceMatcher.java
+++ b/core/src/main/java/com/opensymphony/xwork2/config/impl/NamespaceMatcher.java
@@ -23,7 +23,7 @@ import java.util.Set;
/**
* Matches namespace strings against a wildcard pattern matcher
*
- * @Since 2.1
+ * @since 2.1
*/
public class NamespaceMatcher extends AbstractMatcher<NamespaceMatch> {
public NamespaceMatcher(PatternMatcher<?> patternMatcher,
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/config/providers/InterceptorBuilder.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/config/providers/InterceptorBuilder.java b/core/src/main/java/com/opensymphony/xwork2/config/providers/InterceptorBuilder.java
index 1328205..04439fb 100644
--- a/core/src/main/java/com/opensymphony/xwork2/config/providers/InterceptorBuilder.java
+++ b/core/src/main/java/com/opensymphony/xwork2/config/providers/InterceptorBuilder.java
@@ -38,7 +38,6 @@ import java.util.Map;
* @author Mike
* @author Rainer Hermanns
* @author tmjee
- * @version $Date$ $Id$
*/
public class InterceptorBuilder {
@@ -48,11 +47,13 @@ public class InterceptorBuilder {
/**
* Builds a list of interceptors referenced by the refName in the supplied PackageConfig (InterceptorMapping object).
*
- * @param interceptorLocator
- * @param refName
- * @param refParams
+ * @param interceptorLocator interceptor locator
+ * @param refName reference name
+ * @param refParams reference parameters
+ * @param location location
+ * @param objectFactory object factory
* @return list of interceptors referenced by the refName in the supplied PackageConfig (InterceptorMapping object).
- * @throws ConfigurationException
+ * @throws ConfigurationException in case of any configuration errors
*/
public static List<InterceptorMapping> constructInterceptorReference(InterceptorLocator interceptorLocator,
String refName, Map<String,String> refParams, Location location, ObjectFactory objectFactory) throws ConfigurationException {
@@ -96,9 +97,9 @@ public class InterceptorBuilder {
* Builds a list of interceptors referenced by the refName in the supplied PackageConfig overriding the properties
* of the referenced interceptor with refParams.
*
- * @param interceptorLocator
- * @param stackConfig
- * @param refParams The overridden interceptor properies
+ * @param interceptorLocator interceptor locator
+ * @param stackConfig interceptor stack configuration
+ * @param refParams The overridden interceptor properties
* @return list of interceptors referenced by the refName in the supplied PackageConfig overridden with refParams.
*/
private static List<InterceptorMapping> constructParameterizedInterceptorReferences(
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/config/providers/XmlConfigurationProvider.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/config/providers/XmlConfigurationProvider.java b/core/src/main/java/com/opensymphony/xwork2/config/providers/XmlConfigurationProvider.java
index e8e6548..12a71c7 100644
--- a/core/src/main/java/com/opensymphony/xwork2/config/providers/XmlConfigurationProvider.java
+++ b/core/src/main/java/com/opensymphony/xwork2/config/providers/XmlConfigurationProvider.java
@@ -120,6 +120,8 @@ public class XmlConfigurationProvider implements ConfigurationProvider {
/**
* Returns an unmodifiable map of DTD mappings
+ *
+ * @return map of DTD mappings
*/
public Map<String, String> getDtdMappings() {
return dtdMappings;
@@ -484,6 +486,10 @@ public class XmlConfigurationProvider implements ConfigurationProvider {
/**
* Create a PackageConfig from an XML element representing it.
+ *
+ * @param packageElement the given XML element
+ * @return the package config
+ * @throws ConfigurationException in case of configuration errors
*/
protected PackageConfig addPackage(Element packageElement) throws ConfigurationException {
String packageName = packageElement.getAttribute("name");
@@ -602,9 +608,14 @@ public class XmlConfigurationProvider implements ConfigurationProvider {
* <p>
* This method builds a package context by looking for the parents of this new package.
* </p>
+ *
* <p>
* If no parents are found, it will return a root package.
* </p>
+ *
+ * @param packageElement the package element
+ *
+ * @return the package config builder
*/
protected PackageConfig.Builder buildPackageContext(Element packageElement) {
String parent = packageElement.getAttribute("extends");
@@ -654,6 +665,11 @@ public class XmlConfigurationProvider implements ConfigurationProvider {
/**
* Build a map of ResultConfig objects from below a given XML element.
+ *
+ * @param element the given XML element
+ * @param packageContext the package context
+ *
+ * @return map of result config objects
*/
protected Map<String, ResultConfig> buildResults(Element element, PackageConfig.Builder packageContext) {
NodeList resultEls = element.getElementsByTagName("result");
@@ -769,7 +785,12 @@ public class XmlConfigurationProvider implements ConfigurationProvider {
}
/**
- * Build a map of ResultConfig objects from below a given XML element.
+ * Build a list of exception mapping objects from below a given XML element.
+ *
+ * @param element the given XML element
+ * @param packageContext the package context
+ *
+ * @return list of exception mapping config objects
*/
protected List<ExceptionMappingConfig> buildExceptionMappings(Element element, PackageConfig.Builder packageContext) {
NodeList exceptionMappingEls = element.getElementsByTagName("exception-mapping");
@@ -842,6 +863,9 @@ public class XmlConfigurationProvider implements ConfigurationProvider {
/**
* Load all of the global results for this package from the XML element.
+ *
+ * @param packageContext the package context
+ * @param packageElement the given XML element
*/
protected void loadGlobalResults(PackageConfig.Builder packageContext, Element packageElement) {
NodeList globalResultList = packageElement.getElementsByTagName("global-results");
@@ -863,6 +887,9 @@ public class XmlConfigurationProvider implements ConfigurationProvider {
/**
* Load all of the global results for this package from the XML element.
+ *
+ * @param packageContext the package context
+ * @param packageElement the given XML element
*/
protected void loadGobalExceptionMappings(PackageConfig.Builder packageContext, Element packageElement) {
NodeList globalExceptionMappingList = packageElement.getElementsByTagName("global-exception-mappings");
@@ -922,14 +949,6 @@ public class XmlConfigurationProvider implements ConfigurationProvider {
loadInterceptorStacks(element, context);
}
- // protected void loadPackages(Element rootElement) throws ConfigurationException {
- // NodeList packageList = rootElement.getElementsByTagName("package");
- //
- // for (int i = 0; i < packageList.getLength(); i++) {
- // Element packageElement = (Element) packageList.item(i);
- // addPackage(packageElement);
- // }
- // }
private List<Document> loadConfigurationFiles(String fileName, Element includeElement) {
List<Document> docs = new ArrayList<>();
List<Document> finalDocs = new ArrayList<>();
@@ -1049,9 +1068,10 @@ public class XmlConfigurationProvider implements ConfigurationProvider {
* Looks up the Interceptor Class from the interceptor-ref name and creates an instance, which is added to the
* provided List, or, if this is a ref to a stack, it adds the Interceptor instances from the List to this stack.
*
- * @param interceptorRefElement Element to pull interceptor ref data from
* @param context The PackageConfig to lookup the interceptor from
+ * @param interceptorRefElement Element to pull interceptor ref data from
* @return A list of Interceptor objects
+ * @throws ConfigurationException in case of configuration errors
*/
private List<InterceptorMapping> lookupInterceptorReference(PackageConfig.Builder context, Element interceptorRefElement) throws ConfigurationException {
String refName = interceptorRefElement.getAttribute("name");
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/config/providers/XmlHelper.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/config/providers/XmlHelper.java b/core/src/main/java/com/opensymphony/xwork2/config/providers/XmlHelper.java
index fd85be5..9ab196d 100644
--- a/core/src/main/java/com/opensymphony/xwork2/config/providers/XmlHelper.java
+++ b/core/src/main/java/com/opensymphony/xwork2/config/providers/XmlHelper.java
@@ -34,24 +34,31 @@ public class XmlHelper {
/**
+ * <p>
* This method will find all the parameters under this <code>paramsElement</code> and return them as
- * Map<String, String>. For example,
+ * Map<String, String>. For example,
+ * </p>
+ *
* <pre>
- * <result ... >
- * <param name="param1">value1</param>
- * <param name="param2">value2</param>
- * <param name="param3">value3</param>
- * </result>
+ * <result ... >
+ * <param name="param1">value1</param>
+ * <param name="param2">value2</param>
+ * <param name="param3">value3</param>
+ * </result>
* </pre>
- * will returns a Map<String, String> with the following key, value pairs :-
+ *
+ * <p>
+ * will returns a Map<String, String> with the following key, value pairs:
+ * </p>
+ *
* <ul>
* <li>param1 - value1</li>
* <li>param2 - value2</li>
* <li>param3 - value3</li>
* </ul>
*
- * @param paramsElement
- * @return
+ * @param paramsElement params element
+ * @return a map of key,value pairs
*/
public static Map<String, String> getParams(Element paramsElement) {
LinkedHashMap<String, String> params = new LinkedHashMap<>();
@@ -86,7 +93,7 @@ public class XmlHelper {
* </p>
*
* <pre>
- * <result>something_1</result>
+ * <result>something_1</result>
* </pre>
*
* <p>
@@ -95,7 +102,8 @@ public class XmlHelper {
* namely, <code>something_1</code> in the example above.
* </p>
*
- * @return
+ * @param element the DOM element
+ * @return content as string
*/
public static String getContent(Element element) {
StringBuilder paramValue = new StringBuilder();
@@ -113,7 +121,8 @@ public class XmlHelper {
}
/**
- * Return the value of the "order" attribute from the root element
+ * @param doc document
+ * @return the value of the "order" attribute from the root element
*/
public static Integer getLoadOrder(Document doc) {
Element rootElement = doc.getDocumentElement();
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/conversion/NullHandler.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/conversion/NullHandler.java b/core/src/main/java/com/opensymphony/xwork2/conversion/NullHandler.java
index 86d71f0..9edfda5 100644
--- a/core/src/main/java/com/opensymphony/xwork2/conversion/NullHandler.java
+++ b/core/src/main/java/com/opensymphony/xwork2/conversion/NullHandler.java
@@ -33,22 +33,37 @@ package com.opensymphony.xwork2.conversion;
import java.util.Map;
/**
-* Interface for handling null results from Chains.
-* Object has the opportunity to substitute an object for the
-* null and continue.
-* @author Luke Blanshard (blanshlu@netscape.net)
-* @author Drew Davidson (drew@ognl.org)
-*/
+ * <p>
+ * Interface for handling null results from Chains.
+ * Object has the opportunity to substitute an object for the
+ * null and continue.
+ * </p>
+ *
+ * @author Luke Blanshard (blanshlu@netscape.net)
+ * @author Drew Davidson (drew@ognl.org)
+ */
public interface NullHandler
{
/**
- Method called on target returned null.
+ * Method called on target returned null.
+ * @param context context
+ * @param target target object
+ * @param methodName method name
+ * @param args arguments
+ *
+ * @return object
*/
- public Object nullMethodResult(Map<String, Object> context, Object target, String methodName, Object[] args);
+ Object nullMethodResult(Map<String, Object> context, Object target, String methodName, Object[] args);
/**
- Property in target evaluated to null. Property can be a constant
- String property name or a DynamicSubscript.
+ * Property in target evaluated to null. Property can be a constant
+ * String property name or a DynamicSubscript.
+ *
+ * @param context context
+ * @param target target object
+ * @param property property
+ *
+ * @return object
*/
- public Object nullPropertyValue(Map<String, Object> context, Object target, Object property);
+ Object nullPropertyValue(Map<String, Object> context, Object target, Object property);
}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/conversion/TypeConversionException.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/conversion/TypeConversionException.java b/core/src/main/java/com/opensymphony/xwork2/conversion/TypeConversionException.java
index 033ee73..82e4f34 100644
--- a/core/src/main/java/com/opensymphony/xwork2/conversion/TypeConversionException.java
+++ b/core/src/main/java/com/opensymphony/xwork2/conversion/TypeConversionException.java
@@ -27,7 +27,7 @@ import com.opensymphony.xwork2.XWorkException;
public class TypeConversionException extends XWorkException {
/**
- * Constructs a <code>XWorkException</code> with no detail message.
+ * Constructs a <code>XWorkException</code> with no detail message.
*/
public TypeConversionException() {
}
@@ -44,6 +44,7 @@ public class TypeConversionException extends XWorkException {
/**
* Constructs a <code>XWorkException</code> with no detail message.
+ * @param cause the cause
*/
public TypeConversionException(Throwable cause) {
super(cause);
@@ -54,6 +55,7 @@ public class TypeConversionException extends XWorkException {
* detail message.
*
* @param s the detail message.
+ * @param cause the cause
*/
public TypeConversionException(String s, Throwable cause) {
super(s, cause);
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/conversion/annotations/Conversion.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/conversion/annotations/Conversion.java b/core/src/main/java/com/opensymphony/xwork2/conversion/annotations/Conversion.java
index 45bad80..aa02df7 100644
--- a/core/src/main/java/com/opensymphony/xwork2/conversion/annotations/Conversion.java
+++ b/core/src/main/java/com/opensymphony/xwork2/conversion/annotations/Conversion.java
@@ -36,7 +36,7 @@ import java.lang.annotation.Target;
* <p> <u>Annotation parameters:</u> </p>
*
* <!-- START SNIPPET: parameters -->
- * <table>
+ * <table summary="">
* <thead>
* <tr>
* <th>Parameter</th>
@@ -92,6 +92,8 @@ public @interface Conversion {
/**
* Allow Type Conversions being applied at Type level.
+ *
+ * @return type conversion
*/
TypeConversion[] conversions() default {};
}
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/conversion/annotations/TypeConversion.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/conversion/annotations/TypeConversion.java b/core/src/main/java/com/opensymphony/xwork2/conversion/annotations/TypeConversion.java
index d7037bf..6640659 100644
--- a/core/src/main/java/com/opensymphony/xwork2/conversion/annotations/TypeConversion.java
+++ b/core/src/main/java/com/opensymphony/xwork2/conversion/annotations/TypeConversion.java
@@ -25,29 +25,29 @@ import java.lang.annotation.Target;
* <p>This annotation is used for class and application wide conversion rules.</p>
*
* <p>
- * Class wide conversion:<br/>
+ * Class wide conversion:<br>
* The conversion rules will be assembled in a file called <code>XXXAction-conversion.properties</code>
* within the same package as the related action class.
* Set type to: <code>type = ConversionType.CLASS</code>
* </p>
*
* <p>
- * Application wide conversion:<br/>
+ * Application wide conversion:<br>
* The conversion rules will be assembled within the <code>xwork-conversion.properties</code> file within the classpath root.
* Set type to: <code>type = ConversionType.APPLICATION</code>
* </p>
* <!-- END SNIPPET: description -->
*
- * <p> <u>Annotation usage:</u></p>
+ * <p><u>Annotation usage:</u></p>
*
* <!-- START SNIPPET: usage -->
- * The TypeConversion annotation can be applied at property and method level.
+ * <p>The TypeConversion annotation can be applied at property and method level.</p>
* <!-- END SNIPPET: usage -->
*
- * <p> <u>Annotation parameters:</u></p>
+ * <p><u>Annotation parameters:</u></p>
*
* <!-- START SNIPPET: parameters -->
- * <table>
+ * <table summary="">
* <thead>
* <tr>
* <th>Parameter</th>
@@ -144,6 +144,8 @@ public @interface TypeConversion {
/**
* The optional key name used within TYPE level annotations.
* Defaults to the property name.
+ *
+ * @return key
*/
String key() default "";
@@ -152,6 +154,8 @@ public @interface TypeConversion {
* Defaults to CLASS.
*
* Note: If you use ConversionType.APPLICATION, you can not set a value!
+ *
+ * @return the conversion type
*/
ConversionType type() default ConversionType.CLASS;
@@ -160,13 +164,17 @@ public @interface TypeConversion {
* Note: Collection and Map conversion rules can be determined via com.opensymphony.xwork2.util.DefaultObjectTypeDeterminer.
*
* @see com.opensymphony.xwork2.conversion.impl.DefaultObjectTypeDeterminer
+ *
+ * @return the conversion rule
*/
ConversionRule rule() default ConversionRule.PROPERTY;
/**
* The class of the TypeConverter to be used as converter.
*
- * Note: This can not be used with ConversionRule.KEY_PROPERTY!
+ * Note: This can not be used with ConversionRule.KEY_PROPERTY!
+ *
+ * @return class of the TypeConverter to be used as converter
*/
String converter() default "";
@@ -174,6 +182,8 @@ public @interface TypeConversion {
* If used with ConversionRule.KEY_PROPERTY specify a value here!
*
* Note: If you use ConversionType.APPLICATION, you can not set a value!
+ *
+ * @return value
*/
String value() default "";
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/conversion/impl/DefaultTypeConverter.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/conversion/impl/DefaultTypeConverter.java b/core/src/main/java/com/opensymphony/xwork2/conversion/impl/DefaultTypeConverter.java
index 47bcd1b..8b3a9a6 100644
--- a/core/src/main/java/com/opensymphony/xwork2/conversion/impl/DefaultTypeConverter.java
+++ b/core/src/main/java/com/opensymphony/xwork2/conversion/impl/DefaultTypeConverter.java
@@ -312,6 +312,8 @@ public abstract class DefaultTypeConverter implements TypeConverter {
*
* @param value
* an object to interpret as a String
+ * @param trim
+ * trims the result if true
* @return the String value implied by the given object as returned by the
* toString() method, or "null" if the object is null.
*/
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/conversion/impl/InstantiatingNullHandler.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/conversion/impl/InstantiatingNullHandler.java b/core/src/main/java/com/opensymphony/xwork2/conversion/impl/InstantiatingNullHandler.java
index 308d5e1..e94eb4e 100644
--- a/core/src/main/java/com/opensymphony/xwork2/conversion/impl/InstantiatingNullHandler.java
+++ b/core/src/main/java/com/opensymphony/xwork2/conversion/impl/InstantiatingNullHandler.java
@@ -30,38 +30,35 @@ import java.util.*;
/**
* <!-- START SNIPPET: javadoc -->
- *
+ * <p>
* Provided that the key {@link ReflectionContextState#CREATE_NULL_OBJECTS} is in the action context with a value of true (this key is set
* only during the execution of the {@link com.opensymphony.xwork2.interceptor.ParametersInterceptor}), OGNL expressions
* that have caused a NullPointerException will be temporarily stopped for evaluation while the system automatically
* tries to solve the null references by automatically creating the object.
+ * </p>
*
- * <p> The following rules are used when handling null references:</p>
+ * <p>The following rules are used when handling null references:</p>
*
* <ul>
- *
* <li>If the property is declared <i>exactly</i> as a {@link Collection} or {@link List}, then an ArrayList shall be
* returned and assigned to the null references.</li>
- *
* <li>If the property is declared as a {@link Map}, then a HashMap will be returned and assigned to the null
* references.</li>
- *
* <li>If the null property is a simple bean with a no-arg constructor, it will simply be created using the {@link
* ObjectFactory#buildBean(java.lang.Class, java.util.Map)} method.</li>
- *
* </ul>
*
* <!-- END SNIPPET: javadoc -->
*
* <!-- START SNIPPET: example -->
- *
+ * <p>
* For example, if a form element has a text field named <b>person.name</b> and the expression <i>person</i> evaluates
* to null, then this class will be invoked. Because the <i>person</i> expression evaluates to a <i>Person</i> class, a
* new Person is created and assigned to the null reference. Finally, the name is set on that object and the overall
* effect is that the system automatically created a Person object for you, set it by calling setUsers() and then
* finally called getUsers().setName() as you would typically expect.
- *
- * <!-- END SNIPPET: example>
+ * </p>
+ * <!-- END SNIPPET: example -->
*
* @author Matt Ho
* @author Patrick Lightbody