http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/org/apache/struts2/views/velocity/components/AbstractDirective.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/views/velocity/components/AbstractDirective.java b/core/src/main/java/org/apache/struts2/views/velocity/components/AbstractDirective.java index 88e3c53..acabef0 100644 --- a/core/src/main/java/org/apache/struts2/views/velocity/components/AbstractDirective.java +++ b/core/src/main/java/org/apache/struts2/views/velocity/components/AbstractDirective.java @@ -50,7 +50,8 @@ public abstract class AbstractDirective extends Directive { public abstract String getBeanName(); /** - * All components, unless otherwise stated, are LINE-level directives. + * @return All components, unless otherwise stated, are LINE-level directives. + * */ public int getType() { return LINE; @@ -82,12 +83,18 @@ public abstract class AbstractDirective extends Directive { } /** - * create a Map of properties that the user has passed in. for example, + * <p> + * Create a Map of properties that the user has passed in. For example: + * </p> + * * <pre> * #xxx("name=hello" "value=world" "template=foo") * </pre> - * would yield a params that contains {["name", "hello"], ["value", "world"], ["template", "foo"]} * + * <p> + * would yield a params that contains {["name", "hello"], ["value", "world"], ["template", "foo"]} + * </p> + * @param contextAdapter the context adapter * @param node the Node passed in to the render method * @return a Map of the user specified properties * @throws org.apache.velocity.exception.ParseErrorException @@ -132,7 +139,11 @@ public abstract class AbstractDirective extends Directive { * then the key, rows, would be added to the propertyMap with the String value, 20. * * @param propertyMap a params containing all the properties that we wish to set + * @param contextAdapter the context adapter * @param node the parameter to set expressed in "name=value" format + * + * @throws ParseErrorException in case of parsing errors + * @throws MethodInvocationException in case of method invocation errors */ protected void putProperty(Map propertyMap, InternalContextAdapter contextAdapter, Node node) throws ParseErrorException, MethodInvocationException { // node.value uses the StrutsValueStack to evaluate the directive's value parameter
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/org/apache/struts2/views/xslt/AbstractAdapterNode.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/views/xslt/AbstractAdapterNode.java b/core/src/main/java/org/apache/struts2/views/xslt/AbstractAdapterNode.java index d110d2d..78fea2d 100644 --- a/core/src/main/java/org/apache/struts2/views/xslt/AbstractAdapterNode.java +++ b/core/src/main/java/org/apache/struts2/views/xslt/AbstractAdapterNode.java @@ -93,10 +93,10 @@ public abstract class AbstractAdapterNode implements AdapterNode { /** * - * @param adapterFactory - * @param parent - * @param propertyName - * @param value + * @param adapterFactory the adapter factory + * @param parent the parent adapter node + * @param propertyName the property name + * @param value value */ protected void setContext(AdapterFactory adapterFactory, AdapterNode parent, String propertyName, Object value) { setAdapterFactory(adapterFactory); @@ -116,6 +116,8 @@ public abstract class AbstractAdapterNode implements AdapterNode { /** * Lazily initialize child childAdapters + * + * @return node list */ protected List<Node> getChildAdapters() { if (childAdapters == null) { http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/org/apache/struts2/views/xslt/AdapterFactory.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/views/xslt/AdapterFactory.java b/core/src/main/java/org/apache/struts2/views/xslt/AdapterFactory.java index 67202fc..159ccf4 100644 --- a/core/src/main/java/org/apache/struts2/views/xslt/AdapterFactory.java +++ b/core/src/main/java/org/apache/struts2/views/xslt/AdapterFactory.java @@ -29,60 +29,77 @@ import java.util.HashMap; import java.util.Map; /** + * <p> * AdapterFactory produces Node adapters for Java object types. * Adapter classes are generally instantiated dynamically via a no-args constructor * and populated with their context information via the AdapterNode interface. + * </p> * + * <p> * This factory supports proxying of generic DOM Node trees, allowing arbitrary * Node types to be mixed together. You may simply return a Document or Node * type as an object property and it will appear as a sub-tree in the XML as * you'd expect. See #proxyNode(). + * </p> * + * <p> * Customization of the result XML can be accomplished by providing * alternate adapters for Java types. Adapters are associated with Java * types through the registerAdapterType() method. + * </p> * + * <p> * For example, since there is no default Date adapter, Date objects will be * rendered with the generic Bean introspecting adapter, producing output * like: + * </p> + * * <pre> - <date> - <date>19</date> - <day>1</day> - <hours>0</hours> - <minutes>7</minutes> - <month>8</month> - <seconds>4</seconds> - <time>1127106424531</time> - <timezoneOffset>300</timezoneOffset> - <year>105</year> - </date> + * <date> + * <date>19</date> + * <day>1</day> + * <hours>0</hours> + * <minutes>7</minutes> + * <month>8</month> + * <seconds>4</seconds> + * <time>1127106424531</time> + * <timezoneOffset>300</timezoneOffset> + * <year>105</year> + * </date> * </pre> * + * <p> * By extending the StringAdapter and overriding its normal behavior we can * create a custom Date formatter: + * </p> * * <pre> - public static class CustomDateAdapter extends StringAdapter { - protected String getStringValue() { - Date date = (Date)getPropertyValue(); - return DateFormat.getTimeInstance( DateFormat.FULL ).format( date ); - } - } + * public static class CustomDateAdapter extends StringAdapter { + * protected String getStringValue() { + * Date date = (Date)getPropertyValue(); + * return DateFormat.getTimeInstance( DateFormat.FULL ).format( date ); + * } + * } * </pre> * + * <p> * Producing output like: + * </p> * -<pre> - <date>12:02:54 AM CDT</date> - </pre> + * <pre> + * <date>12:02:54 AM CDT</date> + * </pre> * + * <p> * The StringAdapter (which is normally invoked only to adapt String values) * is a useful base for these kinds of customizations and can produce * structured XML output as well as plain text by setting its parseStringAsXML() * property to true. + * </p> * + * <p> * See provided examples. + * </p> */ public class AdapterFactory { @@ -103,10 +120,13 @@ public class AdapterFactory { * The document will have a root element with the specified property name * and contain the specified Java object content. * - * @param propertyName The name of the root document element - * @return - * @throws IllegalAccessException - * @throws InstantiationException + * @param propertyName the name of the root document element + * @param propertyValue the property value + * + * @return the document object + * + * @throws IllegalAccessException in case of illegal access + * @throws InstantiationException in case of instantiation errors */ public Document adaptDocument(String propertyName, Object propertyValue) throws IllegalAccessException, InstantiationException { @@ -120,6 +140,12 @@ public class AdapterFactory { * the child node itself may be any type of Node. * * @see #adaptDocument( String, Object ) + * + * @param parent the parent adapter node + * @param propertyName the name of th property + * @param value the value + * + * @return a node */ public Node adaptNode(AdapterNode parent, String propertyName, Object value) { Class adapterClass = getAdapterForValue(value); @@ -172,6 +198,11 @@ public class AdapterFactory { * <p> * This method is primarily for use by the adapter node classes. * </p> + * + * @param parent parent adapter node + * @param node node + * + * @return proxy node */ public Node proxyNode(AdapterNode parent, Node node) { // If the property is a Document, "unwrap" it to the root element @@ -202,6 +233,13 @@ public class AdapterFactory { /** * Create an instance of an adapter dynamically and set its context via * the AdapterNode interface. + * + * @param adapterClass adapter class + * @param parent parent adapter node + * @param propertyName the property name + * @param propertyValue the property value + * + * @return the new node */ private Node constructAdapterInstance(Class adapterClass, AdapterNode parent, String propertyName, Object propertyValue) { // Check to see if the class has a no-args constructor @@ -228,8 +266,10 @@ public class AdapterFactory { /** * Create an appropriate adapter for a null value. * - * @param parent - * @param propertyName + * @param parent parent adapter node + * @param propertyName the property name + * + * @return the new node */ public Node adaptNullValue(AdapterNode parent, String propertyName) { return new StringAdapter(this, parent, propertyName, "null"); http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/org/apache/struts2/views/xslt/AdapterNode.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/views/xslt/AdapterNode.java b/core/src/main/java/org/apache/struts2/views/xslt/AdapterNode.java index c5063e2..4b76cb6 100644 --- a/core/src/main/java/org/apache/struts2/views/xslt/AdapterNode.java +++ b/core/src/main/java/org/apache/struts2/views/xslt/AdapterNode.java @@ -29,51 +29,68 @@ public interface AdapterNode extends Node { /** * The adapter factory that created this node. + * + * @return the adapter factory */ AdapterFactory getAdapterFactory(); /** - * The adapter factory that created this node. + * @param factory the adapter factory that created this node. + * */ void setAdapterFactory(AdapterFactory factory); /** * The parent adapter node of this node. Note that our parent must be another adapter node, but our children may be any * kind of Node. + * + * @return the parent adapter node */ AdapterNode getParent(); /** - * The parent adapter node of this node. Note that our parent must be another adapter node, but our children may be any + * @param parent the parent adapter node of this node. Note that our parent must be another adapter node, but our children may be any * kind of Node. */ void setParent(AdapterNode parent); /** * The child node before the specified sibling + * + * @param thisNode this node + * @return the child node before */ Node getChildBefore(Node thisNode); /** * The child node after the specified sibling + * + * @param thisNode this node + * @return the child node after */ Node getChildAfter(Node thisNode); /** * The name of the Java object (property) that we are adapting + * + * @return the property name */ String getPropertyName(); /** - * The name of the Java object (property) that we are adapting + * @param name the name of the Java object (property) that we are adapting */ void setPropertyName(String name); /** * The Java object (property) that we are adapting + * + * @return the property object */ Object getPropertyValue(); - /** The Java object (property) that we are adapting */ + /** + * @param prop the Java object (property) that we are adapting + */ void setPropertyValue(Object prop ); } http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/org/apache/struts2/views/xslt/BeanAdapter.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/views/xslt/BeanAdapter.java b/core/src/main/java/org/apache/struts2/views/xslt/BeanAdapter.java index e9b8413..41c940a 100644 --- a/core/src/main/java/org/apache/struts2/views/xslt/BeanAdapter.java +++ b/core/src/main/java/org/apache/struts2/views/xslt/BeanAdapter.java @@ -51,7 +51,7 @@ import java.util.Map; * } * </pre> * - * would be rendered as: <myPerson> <firstName>...</firstName> <lastName>...</lastName> </myPerson> + * would be rendered as: <myPerson> <firstName>...</firstName> <lastName>...</lastName> </myPerson> */ public class BeanAdapter extends AbstractAdapterElement { //Static fields/initializer http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/org/apache/struts2/views/xslt/MapAdapter.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/views/xslt/MapAdapter.java b/core/src/main/java/org/apache/struts2/views/xslt/MapAdapter.java index 8566637..4050e38 100644 --- a/core/src/main/java/org/apache/struts2/views/xslt/MapAdapter.java +++ b/core/src/main/java/org/apache/struts2/views/xslt/MapAdapter.java @@ -31,13 +31,13 @@ import java.util.Map; * MapAdapter adapters a java.util.Map type to an XML DOM with the following * structure: * <pre> - * <myMap> - * <entry> - * <key>...</key> - * <value>...</value> - * </entry> + * <myMap> + * <entry> + * <key>...</key> + * <value>...</value> + * </entry> * ... - * </myMap> + * </myMap> * </pre> */ public class MapAdapter extends AbstractAdapterElement { http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/org/apache/struts2/views/xslt/ProxyElementAdapter.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/views/xslt/ProxyElementAdapter.java b/core/src/main/java/org/apache/struts2/views/xslt/ProxyElementAdapter.java index 31dca8b..36fc570 100644 --- a/core/src/main/java/org/apache/struts2/views/xslt/ProxyElementAdapter.java +++ b/core/src/main/java/org/apache/struts2/views/xslt/ProxyElementAdapter.java @@ -29,13 +29,17 @@ import java.util.ArrayList; import java.util.List; /** + * <p> * ProxyElementAdapter is a pass-through adapter for objects which already * implement the Element interface. All methods are proxied to the underlying * Node except getParent(), getNextSibling() and getPreviousSibling(), which * are implemented by the abstract adapter node to work with the parent adapter. + * </p> * + * <p> * Note: this class wants to be (extend) both an AbstractElementAdapter * and ProxyElementAdapter, but its proxy-ness is winning right now. + * </p> */ public class ProxyElementAdapter extends ProxyNodeAdapter implements Element { @@ -46,7 +50,7 @@ public class ProxyElementAdapter extends ProxyNodeAdapter implements Element { } /** - * Get the proxied Element + * @return the proxied Element */ protected Element element() { return (Element) getPropertyValue(); http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/org/apache/struts2/views/xslt/ProxyNodeAdapter.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/views/xslt/ProxyNodeAdapter.java b/core/src/main/java/org/apache/struts2/views/xslt/ProxyNodeAdapter.java index f7ce1bb..3ccdc61 100644 --- a/core/src/main/java/org/apache/struts2/views/xslt/ProxyNodeAdapter.java +++ b/core/src/main/java/org/apache/struts2/views/xslt/ProxyNodeAdapter.java @@ -46,16 +46,15 @@ public abstract class ProxyNodeAdapter extends AbstractAdapterNode { } /** - * Get the proxied Node value + * @return the proxied Node value */ protected Node node() { return (Node) getPropertyValue(); } /** - * Get and adapter to wrap the proxied node. - * - * @param node + * @param node the node + * @return adapter to wrap the proxied node. */ protected Node wrap(Node node) { return getAdapterFactory().proxyNode(this, node); http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/org/apache/struts2/views/xslt/StringAdapter.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/views/xslt/StringAdapter.java b/core/src/main/java/org/apache/struts2/views/xslt/StringAdapter.java index 194d52b..93daf41 100644 --- a/core/src/main/java/org/apache/struts2/views/xslt/StringAdapter.java +++ b/core/src/main/java/org/apache/struts2/views/xslt/StringAdapter.java @@ -32,17 +32,20 @@ import java.util.ArrayList; import java.util.List; /** + * <p> * StringAdapter adapts a Java String value to a DOM Element with the specified * property name containing the String's text. - * e.g. a property <pre>String getFoo() { return "My Text!"; }</pre> + * e.g. a property <code>String getFoo() { return "My Text!"; }</code> * will appear in the result DOM as: - * <foo>MyText!</foo> + * <foo>MyText!</foo> + * </p> * + * <p> * Subclasses may override the getStringValue() method in order to use StringAdapter * as a simplified custom XML adapter for Java types. A subclass can enable XML * parsing of the value string via the setParseStringAsXML() method and then * override getStringValue() to return a String containing the custom formatted XML. - * + * </p> */ public class StringAdapter extends AbstractAdapterElement { @@ -68,6 +71,8 @@ public class StringAdapter extends AbstractAdapterElement { * setParseStringAsXML() method and then override getStringValue() to return a * String containing the custom formatted XML. * </p> + * + * @return the string value */ protected String getStringValue() { return getPropertyValue().toString(); @@ -92,7 +97,7 @@ public class StringAdapter extends AbstractAdapterElement { } /** - * Is this StringAdapter to interpret its string values as containing + * @return is this StringAdapter to interpret its string values as containing * XML Text? * * @see #setParseStringAsXML(boolean) @@ -107,7 +112,7 @@ public class StringAdapter extends AbstractAdapterElement { * Element will be a child of this String element. (i.e. wrapped in an * element of the property name specified for this StringAdapter). * - * @param parseStringAsXML + * @param parseStringAsXML when set to true the StringAdapter will interpret its String value as containing XML text * @see #getParseStringAsXML() */ public void setParseStringAsXML(boolean parseStringAsXML) { http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/org/apache/struts2/views/xslt/XSLTResult.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/views/xslt/XSLTResult.java b/core/src/main/java/org/apache/struts2/views/xslt/XSLTResult.java index 68b92ae..5ebbf67 100644 --- a/core/src/main/java/org/apache/struts2/views/xslt/XSLTResult.java +++ b/core/src/main/java/org/apache/struts2/views/xslt/XSLTResult.java @@ -115,7 +115,7 @@ import java.util.Map; * * <p> * <b>Note:</b> In your .xsl file the root match must be named <tt>result</tt>. - * <br/>This example will output the username by using <tt>getUsername</tt> on your + * <br>This example will output the username by using <tt>getUsername</tt> on your * action class: * <pre> * <xsl:template match="result"> @@ -191,12 +191,15 @@ import java.util.Map; * </ul> * * <!-- END SNIPPET: params --> - * + * <p> * <b>Example:</b> + * </p> * - * <pre><!-- START SNIPPET: example --> + * <pre> + * <!-- START SNIPPET: example --> * <result name="success" type="xslt">foo.xslt</result> - * <!-- END SNIPPET: example --></pre> + * <!-- END SNIPPET: example --> + * </pre> * */ public class XSLTResult implements Result { @@ -295,9 +298,7 @@ public class XSLTResult implements Result { } /** - * If true, parse the stylesheet location for OGNL expressions. - * - * @param parse + * @param parse if true, parse the stylesheet location for OGNL expressions. */ public void setParse(boolean parse) { this.parse = parse; @@ -395,7 +396,7 @@ public class XSLTResult implements Result { } /** - * Get the URI Resolver to be called by the processor when it encounters an xsl:include, xsl:import, or document() + * @return the URI Resolver to be called by the processor when it encounters an xsl:include, xsl:import, or document() * function. The default is an instance of ServletURIResolver, which operates relative to the servlet context. */ protected URIResolver getURIResolver() { http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/plugins/bean-validation/src/main/java/org/apache/struts/beanvalidation/constraints/FieldMatch.java ---------------------------------------------------------------------- diff --git a/plugins/bean-validation/src/main/java/org/apache/struts/beanvalidation/constraints/FieldMatch.java b/plugins/bean-validation/src/main/java/org/apache/struts/beanvalidation/constraints/FieldMatch.java index 1c765fb..f478344 100644 --- a/plugins/bean-validation/src/main/java/org/apache/struts/beanvalidation/constraints/FieldMatch.java +++ b/plugins/bean-validation/src/main/java/org/apache/struts/beanvalidation/constraints/FieldMatch.java @@ -41,16 +41,16 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME; * </p> * <pre> * - * @FieldMatch(first = "password", second = "confirmPassword", message = "The password fields must match") + * {@literal @}FieldMatch(first = "password", second = "confirmPassword", message = "The password fields must match") * </pre> * * <p> * Example, compare more than 1 pair of fields: * </p> * <pre> - * @FieldMatch.List({ - * @FieldMatch(first = "password", second = "confirmPassword", message = "The password fields must match"), - * @FieldMatch(first = "email", second = "confirmEmail", message = "The email fields must match") + * {@literal @}FieldMatch.List({ + * {@literal @}FieldMatch(first = "password", second = "confirmPassword", message = "The password fields must match"), + * {@literal @}FieldMatch(first = "email", second = "confirmEmail", message = "The email fields must match") * }) * </pre> */ http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/plugins/bean-validation/src/main/java/org/apache/struts/beanvalidation/validation/interceptor/BeanValidationInterceptor.java ---------------------------------------------------------------------- diff --git a/plugins/bean-validation/src/main/java/org/apache/struts/beanvalidation/validation/interceptor/BeanValidationInterceptor.java b/plugins/bean-validation/src/main/java/org/apache/struts/beanvalidation/validation/interceptor/BeanValidationInterceptor.java index aaed47d..3cd56e9 100644 --- a/plugins/bean-validation/src/main/java/org/apache/struts/beanvalidation/validation/interceptor/BeanValidationInterceptor.java +++ b/plugins/bean-validation/src/main/java/org/apache/struts/beanvalidation/validation/interceptor/BeanValidationInterceptor.java @@ -166,6 +166,10 @@ public class BeanValidationInterceptor extends MethodFilterInterceptor { /** * Decide if a violation should be added to the fieldErrors or actionErrors + * + * @param violation the violation + * + * @return true if violation should be added to the fieldErrors or actionErrors */ protected boolean isActionError(ConstraintViolation<Object> violation) { return violation.getLeafBean() == violation.getInvalidValue(); @@ -173,6 +177,13 @@ public class BeanValidationInterceptor extends MethodFilterInterceptor { /** * This is copied from DefaultActionInvocation + * + * @param actionClass the action class + * @param methodName the method name + * + * @return Method + * + * @throws NoSuchMethodException if no method with this name was found */ protected Method getActionMethod(Class<?> actionClass, String methodName) throws NoSuchMethodException { Method method; http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/plugins/bean-validation/src/main/java/org/apache/struts/beanvalidation/validation/interceptor/DefaultBeanValidationManager.java ---------------------------------------------------------------------- diff --git a/plugins/bean-validation/src/main/java/org/apache/struts/beanvalidation/validation/interceptor/DefaultBeanValidationManager.java b/plugins/bean-validation/src/main/java/org/apache/struts/beanvalidation/validation/interceptor/DefaultBeanValidationManager.java index 69707bf..9bae97a 100644 --- a/plugins/bean-validation/src/main/java/org/apache/struts/beanvalidation/validation/interceptor/DefaultBeanValidationManager.java +++ b/plugins/bean-validation/src/main/java/org/apache/struts/beanvalidation/validation/interceptor/DefaultBeanValidationManager.java @@ -44,11 +44,13 @@ import javax.validation.ValidatorFactory; * almost always use the default Validator anyway. You need to pass provider class in order for this plugin to hook * itself to underlying validation Factory. Any of following Validation provider can be provided using * <code>struts.beanValidation.providerClass</code> + * </p> + * * <ul> * <li>Hibernate Validator - <code>org.hibernate.validator.HibernateValidator</code></li> * <li>Apache Bval - <code>org.apache.bval.jsr303.ApacheValidationProvider</code></li> * </ul> - * </p> + * */ public class DefaultBeanValidationManager implements BeanValidationManager { @@ -107,10 +109,14 @@ public class DefaultBeanValidationManager implements BeanValidationManager { * <p> * In this case, the default validation provider resolver will be used to locate available providers. The chosen * provider is defined as followed: + * </p> + * <ul> * <li>if the XML configuration defines a provider, this provider is used</li> * <li>if the XML configuration does not define a provider or if no XML configuration is present the first provider * returned by the ValidationProviderResolver instance is used.</li> - * </p> + * </ul> + * + * @return validator instance */ public Validator getValidator() { return this.validationFactory.getValidator(); http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/plugins/convention/src/main/java/org/apache/struts2/convention/ClasspathConfigurationProvider.java ---------------------------------------------------------------------- diff --git a/plugins/convention/src/main/java/org/apache/struts2/convention/ClasspathConfigurationProvider.java b/plugins/convention/src/main/java/org/apache/struts2/convention/ClasspathConfigurationProvider.java index f5e7973..32aec96 100644 --- a/plugins/convention/src/main/java/org/apache/struts2/convention/ClasspathConfigurationProvider.java +++ b/plugins/convention/src/main/java/org/apache/struts2/convention/ClasspathConfigurationProvider.java @@ -70,6 +70,8 @@ public class ClasspathConfigurationProvider implements ConfigurationProvider, Di /** * Not used. + * + * @param configuration configuration */ public void init(Configuration configuration) { if (devMode && reload && !listeningToDispatcher) { @@ -82,6 +84,11 @@ public class ClasspathConfigurationProvider implements ConfigurationProvider, Di /** * Does nothing. + * + * @param containerBuilder container builder + * @param locatableProperties locatable properties + * + * @throws ConfigurationException in case of configuration errors */ public void register(ContainerBuilder containerBuilder, LocatableProperties locatableProperties) throws ConfigurationException { @@ -90,14 +97,13 @@ public class ClasspathConfigurationProvider implements ConfigurationProvider, Di /** * Loads the packages using the {@link ActionConfigBuilder}. * - * @throws ConfigurationException + * @throws ConfigurationException in case of configuration errors */ public void loadPackages() throws ConfigurationException { } /** - * Depends on devMode, relead and actionConfigBuilder.needsReload() - * @return Always false. + * @return true if devMode, reload and actionConfigBuilder.needsReload() */ public boolean needsReload() { return devMode && reload && actionConfigBuilder.needsReload(); http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/plugins/convention/src/main/java/org/apache/struts2/convention/DefaultResultMapBuilder.java ---------------------------------------------------------------------- diff --git a/plugins/convention/src/main/java/org/apache/struts2/convention/DefaultResultMapBuilder.java b/plugins/convention/src/main/java/org/apache/struts2/convention/DefaultResultMapBuilder.java index 767b534..87fb970 100644 --- a/plugins/convention/src/main/java/org/apache/struts2/convention/DefaultResultMapBuilder.java +++ b/plugins/convention/src/main/java/org/apache/struts2/convention/DefaultResultMapBuilder.java @@ -32,6 +32,7 @@ import com.opensymphony.xwork2.util.finder.ClassLoaderInterface; import com.opensymphony.xwork2.util.finder.ClassLoaderInterfaceDelegate; import com.opensymphony.xwork2.util.finder.ResourceFinder; import com.opensymphony.xwork2.util.finder.Test; +import org.apache.commons.lang3.BooleanUtils; import org.apache.commons.lang3.ObjectUtils; import org.apache.commons.lang3.StringUtils; import org.apache.logging.log4j.LogManager; @@ -53,7 +54,7 @@ import java.util.*; * </p> * * <pre> - * /resultPath/namespace/action-<result>.jsp + * /resultPath/namespace/action-<result>.jsp * </pre> * * <p> @@ -102,14 +103,14 @@ import java.util.*; * table below: * </p> * - * <table> + * <table summary=""> * <tr><th>Extension</th><th>Type</th></tr> - * <tr><td>.jsp</td><td>dispatcher</td</tr> - * <tr><td>.jspx</td><td>dispatcher</td</tr> - * <tr><td>.html</td><td>dispatcher</td</tr> - * <tr><td>.htm</td><td>dispatcher</td</tr> - * <tr><td>.vm</td><td>velocity</td</tr> - * <tr><td>.ftl</td><td>freemarker</td</tr> + * <tr><td>.jsp</td><td>dispatcher</td></tr> + * <tr><td>.jspx</td><td>dispatcher</td></tr> + * <tr><td>.html</td><td>dispatcher</td></tr> + * <tr><td>.htm</td><td>dispatcher</td></tr> + * <tr><td>.vm</td><td>velocity</td></tr> + * <tr><td>.ftl</td><td>freemarker</td></tr> * </table> */ public class DefaultResultMapBuilder implements ResultMapBuilder { @@ -142,7 +143,7 @@ public class DefaultResultMapBuilder implements ResultMapBuilder { */ @Inject("struts.convention.result.flatLayout") public void setFlatResultLayout(String flatResultLayout) { - this.flatResultLayout = "true".equals(flatResultLayout); + this.flatResultLayout = BooleanUtils.toBoolean(flatResultLayout); } /** http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/plugins/convention/src/main/java/org/apache/struts2/convention/PackageBasedActionConfigBuilder.java ---------------------------------------------------------------------- diff --git a/plugins/convention/src/main/java/org/apache/struts2/convention/PackageBasedActionConfigBuilder.java b/plugins/convention/src/main/java/org/apache/struts2/convention/PackageBasedActionConfigBuilder.java index cac3566..b4a8be9 100644 --- a/plugins/convention/src/main/java/org/apache/struts2/convention/PackageBasedActionConfigBuilder.java +++ b/plugins/convention/src/main/java/org/apache/struts2/convention/PackageBasedActionConfigBuilder.java @@ -131,7 +131,7 @@ public class PackageBasedActionConfigBuilder implements ActionConfigBuilder { } /** - * Reload configuration when classes change. Defaults to "false" and should not be used + * @param reload Reload configuration when classes change. Defaults to "false" and should not be used * in production. */ @Inject("struts.convention.classes.reload") @@ -146,7 +146,7 @@ public class PackageBasedActionConfigBuilder implements ActionConfigBuilder { } /** - * Exclude URLs found by the parent class loader. Defaults to "true", set to true for JBoss + * @param exclude Exclude URLs found by the parent class loader. Defaults to "true", set to true for JBoss */ @Inject("struts.convention.exclude.parentClassLoader") public void setExcludeParentClassLoader(String exclude) { @@ -154,7 +154,7 @@ public class PackageBasedActionConfigBuilder implements ActionConfigBuilder { } /** - * If this constant is true, and there is an "execute" method(not annotated), a mapping will be added + * @param alwaysMapExecute If this constant is true, and there is an "execute" method(not annotated), a mapping will be added * pointing to it, even if there are other mapping in the class */ @Inject("struts.convention.action.alwaysMapExecute") @@ -186,8 +186,9 @@ public class PackageBasedActionConfigBuilder implements ActionConfigBuilder { */ @Inject(value = "struts.convention.action.includeJars", required = false) public void setIncludeJars(String includeJars) { - if (StringUtils.isNotEmpty(includeJars)) + if (StringUtils.isNotEmpty(includeJars)) { this.includeJars = includeJars.split("\\s*[,]\\s*"); + } } /** @@ -1031,7 +1032,7 @@ public class PackageBasedActionConfigBuilder implements ActionConfigBuilder { * 1. Loop over all the namespaces such as /foo and see if it has an action named index * 2. If an action doesn't exists in the parent namespace of the same name, create an action * in the parent namespace of the same name as the namespace that points to the index - * action in the namespace. e.g. /foo -> /foo/index + * action in the namespace. e.g. /foo -> /foo/index * 3. Create the action in the namespace for empty string if it doesn't exist. e.g. /foo/ * the action is "" and the namespace is /foo * http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/plugins/convention/src/main/java/org/apache/struts2/convention/ReflectionTools.java ---------------------------------------------------------------------- diff --git a/plugins/convention/src/main/java/org/apache/struts2/convention/ReflectionTools.java b/plugins/convention/src/main/java/org/apache/struts2/convention/ReflectionTools.java index 7140fe9..3db5327 100644 --- a/plugins/convention/src/main/java/org/apache/struts2/convention/ReflectionTools.java +++ b/plugins/convention/src/main/java/org/apache/struts2/convention/ReflectionTools.java @@ -51,6 +51,7 @@ public class ReflectionTools { /** * Retrieves the annotation from the given method in the given class. * + * @param <T> type of annotated class * @param clazz The class. * @param methodName The method. * @param annotationClass The annotation to get. http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/plugins/convention/src/main/java/org/apache/struts2/convention/annotation/Namespace.java ---------------------------------------------------------------------- diff --git a/plugins/convention/src/main/java/org/apache/struts2/convention/annotation/Namespace.java b/plugins/convention/src/main/java/org/apache/struts2/convention/annotation/Namespace.java index a0c4739..9e60df5 100644 --- a/plugins/convention/src/main/java/org/apache/struts2/convention/annotation/Namespace.java +++ b/plugins/convention/src/main/java/org/apache/struts2/convention/annotation/Namespace.java @@ -46,7 +46,7 @@ import java.lang.annotation.ElementType; * </p> * * <pre> - * <java-package>#<parent-xwork-package>#<namespace> + * <java-package>#<parent-xwork-package>#<namespace> * </pre> * * <p> http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/plugins/convention/src/main/java/org/apache/struts2/convention/annotation/ParentPackage.java ---------------------------------------------------------------------- diff --git a/plugins/convention/src/main/java/org/apache/struts2/convention/annotation/ParentPackage.java b/plugins/convention/src/main/java/org/apache/struts2/convention/annotation/ParentPackage.java index 7a2c6f8..2e0b1f9 100644 --- a/plugins/convention/src/main/java/org/apache/struts2/convention/annotation/ParentPackage.java +++ b/plugins/convention/src/main/java/org/apache/struts2/convention/annotation/ParentPackage.java @@ -44,7 +44,7 @@ import java.lang.annotation.Target; * </p> * * <pre> - * <java-package>#<parent-xwork-package>#<namespace> + * <java-package>#<parent-xwork-package>#<namespace> * </pre> * * <p> http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/plugins/convention/src/main/java/org/apache/struts2/convention/annotation/ResultPath.java ---------------------------------------------------------------------- diff --git a/plugins/convention/src/main/java/org/apache/struts2/convention/annotation/ResultPath.java b/plugins/convention/src/main/java/org/apache/struts2/convention/annotation/ResultPath.java index 320fdc7..4e06e7c 100644 --- a/plugins/convention/src/main/java/org/apache/struts2/convention/annotation/ResultPath.java +++ b/plugins/convention/src/main/java/org/apache/struts2/convention/annotation/ResultPath.java @@ -54,7 +54,7 @@ import java.lang.annotation.Target; * </p> * * <pre> - * /WEB-INF/jsps/foo/do-something-<resultCode>.ext + * /WEB-INF/jsps/foo/do-something-<resultCode>.ext * </pre> * <!-- END SNIPPET: javadoc --> */ http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/plugins/embeddedjsp/src/main/java/org/apache/struts2/JSPRuntime.java ---------------------------------------------------------------------- diff --git a/plugins/embeddedjsp/src/main/java/org/apache/struts2/JSPRuntime.java b/plugins/embeddedjsp/src/main/java/org/apache/struts2/JSPRuntime.java index 71c008b..182fda4 100644 --- a/plugins/embeddedjsp/src/main/java/org/apache/struts2/JSPRuntime.java +++ b/plugins/embeddedjsp/src/main/java/org/apache/struts2/JSPRuntime.java @@ -30,7 +30,7 @@ import javax.servlet.jsp.HttpJspPage; import java.util.Map; /** - * Maintains a cache of jsp locations -> servlet instances for those jsps. When a jsp is requested + * Maintains a cache of jsp locations -> servlet instances for those jsps. When a jsp is requested * from the cache, the cache will block if the jsp was not compiled already, and wait for the compilation */ public abstract class JSPRuntime { http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/plugins/embeddedjsp/src/main/java/org/apache/struts2/compiler/MemoryClassLoader.java ---------------------------------------------------------------------- diff --git a/plugins/embeddedjsp/src/main/java/org/apache/struts2/compiler/MemoryClassLoader.java b/plugins/embeddedjsp/src/main/java/org/apache/struts2/compiler/MemoryClassLoader.java index 7a20ed8..a6cc61b 100644 --- a/plugins/embeddedjsp/src/main/java/org/apache/struts2/compiler/MemoryClassLoader.java +++ b/plugins/embeddedjsp/src/main/java/org/apache/struts2/compiler/MemoryClassLoader.java @@ -24,11 +24,11 @@ import java.util.Map; import java.util.concurrent.ConcurrentHashMap; /** - * Keeps a cache of class name -> MemoryJavaFileObject. If the requested class name is in the cache + * Keeps a cache of class name -> MemoryJavaFileObject. If the requested class name is in the cache * a new class is defined for it, otherwise findClass delegates to the parent class loader */ public class MemoryClassLoader extends ClassLoader { - private Map<String, MemoryJavaFileObject> cachedObjects = new ConcurrentHashMap<String, MemoryJavaFileObject>(); + private Map<String, MemoryJavaFileObject> cachedObjects = new ConcurrentHashMap<>(); public MemoryClassLoader() { //without this, the tests will not run, because the tests are loaded by a custom classloader http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/MethodExpressionImpl.java ---------------------------------------------------------------------- diff --git a/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/MethodExpressionImpl.java b/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/MethodExpressionImpl.java index 4a1815d..60f6314 100644 --- a/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/MethodExpressionImpl.java +++ b/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/MethodExpressionImpl.java @@ -44,7 +44,7 @@ import org.apache.struts2.el.util.ReflectionUtil; * An <code>Expression</code> that refers to a method on an object. * * <p> - * <code>The {@link ExpressionFactory#createMethodExpression} method + * The {@link ExpressionFactory#createMethodExpression} method * can be used to parse an expression string and return a concrete instance * of <code>MethodExpression</code> that encapsulates the parsed expression. * The {@link FunctionMapper} is used at parse time, not evaluation time, @@ -100,11 +100,12 @@ public final class MethodExpressionImpl extends MethodExpression implements } /** - * @param expr - * @param node - * @param fnMapper - * @param expectedType - * @param paramTypes + * @param expr expression + * @param node node + * @param fnMapper function mapper + * @param varMapper variable mapper + * @param expectedType expected type + * @param paramTypes parameter types array */ public MethodExpressionImpl(String expr, Node node, FunctionMapper fnMapper, VariableMapper varMapper, http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/ValueExpressionImpl.java ---------------------------------------------------------------------- diff --git a/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/ValueExpressionImpl.java b/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/ValueExpressionImpl.java index 57e1b5b..7dc16de 100644 --- a/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/ValueExpressionImpl.java +++ b/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/ValueExpressionImpl.java @@ -57,7 +57,7 @@ import org.apache.struts2.el.util.ReflectionUtil; * </p> * * <p> - * <code>The {@link ExpressionFactory#createValueExpression} method + * The {@link ExpressionFactory#createValueExpression} method * can be used to parse an expression string and return a concrete instance * of <code>ValueExpression</code> that encapsulates the parsed expression. * The {@link FunctionMapper} is used at parse time, not evaluation time, @@ -107,7 +107,11 @@ public final class ValueExpressionImpl extends ValueExpression implements } /** - * + * @param expr expression + * @param node node + * @param fnMapper function mapper + * @param varMapper variable mapper + * @param expectedType expected type */ public ValueExpressionImpl(String expr, Node node, FunctionMapper fnMapper, VariableMapper varMapper, Class expectedType) { http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/lang/ELSupport.java ---------------------------------------------------------------------- diff --git a/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/lang/ELSupport.java b/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/lang/ELSupport.java index 2c349a2..7ed5e71 100644 --- a/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/lang/ELSupport.java +++ b/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/lang/ELSupport.java @@ -50,10 +50,10 @@ public class ELSupport { } /** - * @param obj0 - * @param obj1 - * @return - * @throws EvaluationException + * @param obj0 first object + * @param obj1 second object + * @return 0 if objects are equals + * @throws ELException in case of errors */ public final static int compare(final Object obj0, final Object obj1) throws ELException { @@ -93,10 +93,10 @@ public class ELSupport { } /** - * @param obj0 - * @param obj1 - * @return - * @throws EvaluationException + * @param obj0 first object + * @param obj1 second object + * @return true if objects are equals + * @throws ELException in case of errors */ public final static boolean equals(final Object obj0, final Object obj1) throws ELException { @@ -139,9 +139,9 @@ public class ELSupport { } /** - * @param obj - * @param type - * @return + * @param obj object + * @param type class ytpe + * @return enum */ public final static Enum coerceToEnum(final Object obj, Class type) { if (obj == null || "".equals(obj)) { @@ -154,8 +154,8 @@ public class ELSupport { } /** - * @param obj - * @return + * @param obj object + * @return boolean */ public final static Boolean coerceToBoolean(final Object obj) throws IllegalArgumentException { @@ -304,8 +304,8 @@ public class ELSupport { } /** - * @param obj - * @return + * @param obj object + * @return String */ public final static String coerceToString(final Object obj) { if (obj == null) { @@ -377,8 +377,8 @@ public class ELSupport { } /** - * @param obj - * @return + * @param obj object array + * @return true if object array contains null values */ public final static boolean containsNulls(final Object[] obj) { for (int i = 0; i < obj.length; i++) { @@ -466,9 +466,6 @@ public class ELSupport { } } - /** - * - */ public ELSupport() { super(); } http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/lang/ExpressionBuilder.java ---------------------------------------------------------------------- diff --git a/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/lang/ExpressionBuilder.java b/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/lang/ExpressionBuilder.java index b1d38d0..a60b89d 100644 --- a/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/lang/ExpressionBuilder.java +++ b/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/lang/ExpressionBuilder.java @@ -58,9 +58,6 @@ public final class ExpressionBuilder implements NodeVisitor { private String expression; - /** - * - */ public ExpressionBuilder(String expression, ELContext ctx) throws ELException { this.expression = expression; http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/lang/FunctionMapperImpl.java ---------------------------------------------------------------------- diff --git a/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/lang/FunctionMapperImpl.java b/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/lang/FunctionMapperImpl.java index d0f7a16..7bebefb 100644 --- a/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/lang/FunctionMapperImpl.java +++ b/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/lang/FunctionMapperImpl.java @@ -93,9 +93,6 @@ public class FunctionMapperImpl extends FunctionMapper implements protected String prefix; protected String localName; - /** - * - */ public Function(String prefix, String localName, Method m) { if (localName == null) { throw new NullPointerException("LocalName cannot be null"); http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/parser/ArithmeticNode.java ---------------------------------------------------------------------- diff --git a/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/parser/ArithmeticNode.java b/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/parser/ArithmeticNode.java index 230ed16..1dd5fca 100644 --- a/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/parser/ArithmeticNode.java +++ b/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/parser/ArithmeticNode.java @@ -29,7 +29,7 @@ import org.apache.struts2.el.lang.EvaluationContext; public class ArithmeticNode extends SimpleNode { /** - * @param i + * @param i i */ public ArithmeticNode(int i) { super(i); http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/parser/BooleanNode.java ---------------------------------------------------------------------- diff --git a/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/parser/BooleanNode.java b/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/parser/BooleanNode.java index e3d65e8..e82a741 100644 --- a/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/parser/BooleanNode.java +++ b/plugins/embeddedjsp/src/main/java/org/apache/struts2/el/parser/BooleanNode.java @@ -27,7 +27,7 @@ import org.apache.struts2.el.lang.EvaluationContext; */ public class BooleanNode extends SimpleNode { /** - * @param i + * @param i i */ public BooleanNode(int i) { super(i);
