rainerh  committed 292cc52

Javadoc fixes
o added package.html files
o updated overview.html
o fixed doc comments


  • Participants
  • Parent commits ab1ba74

Comments (0)

Files changed (33)

File src/java/com/opensymphony/xwork2/

  * To add lifecycle hook into an <code>ObjectFactory</code>, either or both of the following interfaces
  * could be implemented by the <code>ObjectFactory</code> itself.
  * <ul>
- * 		<li>{@link ObjectFactoryInitializable}</li>
- *      <li>{@link ObjectFactoryDestroyable}</li>
+ * 		<li>{@link org.apache.struts2.util.ObjectFactoryInitializable}</li>
+ *      <li>{@link org.apache.struts2.util.ObjectFactoryDestroyable}</li>
  * </ul>
- * Both will be invoked during the startup and showdown of {@link FilterDispatcher} through {@link Dispatcher}.
+ * Both will be invoked during the startup and showdown of {@link org.apache.struts2.dispatcher.FilterDispatcher} through {@link org.apache.struts2.dispatcher.Dispatcher}.
  * @author Jason Carreira

File src/java/com/opensymphony/xwork2/config/entities/package.html

+<body>Configuration entity classes.</body>

File src/java/com/opensymphony/xwork2/config/impl/

      * </p>
      * @param orig  The original parameters with placehold values
-     * @param map The target parameters to store the processed values
      * @param vars  A Map of wildcard-matched strings
     protected Map<String,Object> replaceParameters(Map<String, Object> orig, Map vars) {

File src/java/com/opensymphony/xwork2/config/impl/package.html

+<body>Configuration implementation classes.</body>

File src/java/com/opensymphony/xwork2/config/package.html

+<body>Configuration core classes.</body>

File src/java/com/opensymphony/xwork2/config/providers/package.html

+<body>Configuration provider classes.</body>

File src/java/com/opensymphony/xwork2/conversion/annotations/package.html

+<body>Type conversion annotations.</body>

File src/java/com/opensymphony/xwork2/conversion/metadata/package.html

+<body>Type conversion meta data classes.</body>

File src/java/com/opensymphony/xwork2/inject/util/package.html

+<body>Guice util classes.</body>

File src/java/com/opensymphony/xwork2/interceptor/

  * Utility class contains common methods used by 
- * {@link com.opensymphony.xwork2.interceptor.MethodFilterInterceptorterceptor}
- * and {@link org.apache.struts.action2.components.Form}.
+ * {@link com.opensymphony.xwork2.interceptor.MethodFilterInterceptor}.
  * @author tm_jee
  * @version $Date$ $Id$
-     * Same as {@link #isMethodFiltered(Set, Set, String)}, except that <code>excludeMethods</code>
+     * Same as {@link #applyMethod(Set, Set, String)}, except that <code>excludeMethods</code>
      * and <code>includeMethods</code> are supplied as comma separated string.
      * @param excludeMethods
      * @param includeMethods
      * @param method
-     * @return
+     * @return boolean
     public static boolean applyMethod(String excludeMethods, String includeMethods, String method) {
     	Set includeMethodsSet = TextParseUtil.commaDelimitedStringToSet(includeMethods == null? "" : includeMethods);

File src/java/com/opensymphony/xwork2/interceptor/

 	 * will return "SomeMethod".
 	 * @param methodName
-	 * @return
+	 * @return String
 	public static String capitalizeMethodName(String methodName) {
 		assert(methodName != null);

File src/java/com/opensymphony/xwork2/interceptor/

  * <p/><b>Update</b>: Added logic to execute a prepare{MethodName} and conditionally
  * the a general prepare() Method, depending on the 'alwaysInvokePrepare' parameter/property
  * which is by default true. This allows us to run some logic based on the method 
- * name we specify in the {@link ActionProxy}. For example, you can specify a 
+ * name we specify in the {@link com.opensymphony.xwork2.ActionProxy}. For example, you can specify a
  * prepareInput() method that will be run before the invocation of the input method.
  * <!-- END SNIPPET: description -->

File src/java/com/opensymphony/xwork2/interceptor/annotations/package.html

+<body>Interceptor annotations.</body>

File src/java/com/opensymphony/xwork2/interceptor/package.html

+<body>Interceptor classes.</body>

File src/java/com/opensymphony/xwork2/mock/package.html

+<body>XWork specific mock classes.</body>

File src/java/com/opensymphony/xwork2/package.html

+<body>Main Xwork interfaces and classes.</body>

File src/java/com/opensymphony/xwork2/spring/interceptor/package.html

+<body>Spring specific interceptor classes.</body>

File src/java/com/opensymphony/xwork2/spring/package.html

+<body>Spring ObjectFactory classes.</body>

File src/java/com/opensymphony/xwork2/util/

      * Loads opens the named file and returns the InputStream
-     * @param fileName - the name of the file to open
+     * @param fileUrl - the URL of the file to open
      * @return an InputStream of the file contents or null
      * @throws IllegalArgumentException if there is no file with the given file name

File src/java/com/opensymphony/xwork2/util/

      * Get's the java bean info for the given source.
-     * @param source  the source object.
+     * @param from  the source object.
      * @return  java bean info.
      * @throws IntrospectionException is thrown if an exception occurs during introspection.

File src/java/com/opensymphony/xwork2/util/

  * methods.</p>
  * <p>General searches are initiated by calling the
- * {@link #find(com.opensymphony.xwork2.util.ResolverUtil.Test, String)} ()} method and supplying
+ * {@link #find(com.opensymphony.xwork2.util.ResolverUtil.Test, String...)} ()} method and supplying
  * a package name and a Test instance. This will cause the named package <b>and all sub-packages</b>
  * to be scanned for classes that meet the test. There are also utility methods for the common
  * use cases of scanning multiple packages for extensions of particular classes, or classes

File src/java/com/opensymphony/xwork2/util/

      * A typical use-case would be when we need to URL Encode the parsed value. To do so 
      * we could just supply a URLEncodingEvaluator for example. 
-     * @see {@link TextParseUtil.ParsedValueEvaluator}
      * @param expression
      * @param stack
      * @param evaluator The parsed Value evaluator (could be null).

File src/java/com/opensymphony/xwork2/util/location/

      * @return the description (can be <code>null</code>)
-    public String getDescription();
+    String getDescription();
      * Get the URI of this location
      * @return the URI (<code>null</code> if unknown).
-    public String getURI();
+    String getURI();
      * Get the line number of this location
      * @return the line number (<code>-1</code> if unknown)
-    public int getLineNumber();
+    int getLineNumber();
      * Get the column number of this location
      * @return the column number (<code>-1</code> if unknown)
-    public int getColumnNumber();
+    int getColumnNumber();
      * Gets a source code snippet with the default padding
      * @param padding The amount of lines before and after the error to include
      * @return A list of source lines
-    public List getSnippet(int padding);
+    List getSnippet(int padding);

File src/java/com/opensymphony/xwork2/util/location/

      * @param locator the <code>Locator</code> (can be null)
      * @param attrs the <code>Attributes</code> where locator information should be added
-     * @return
+     * @return Location enabled Attributes.
     public static Attributes addLocationAttributes(Locator locator, Attributes attrs) {
         if (locator == null || attrs.getIndex(URI, SRC_ATTR) != -1) {
      * Returns the location of an element (SAX flavor). If the location is to be kept
-     * into an object built from this element, consider using {@link #getLocation(Attributes)}
+     * into an object built from this element, consider using {@link #getLocation(Attributes, String)}
      * and the {@link Locatable} interface.
      * @param attrs the element's attributes that hold the location information
-     * @return a location string as defined by {@link Location#toString()}.
+     * @return a location string as defined by {@link Location}.
     public static String getLocationString(Attributes attrs) {
         String src = attrs.getValue(URI, SRC_ATTR);
      * Returns the {@link Location} of an element (DOM flavor).
-     * @param attrs the element that holds the location information
+     * @param elem the element that holds the location information
      * @param description a description for the location (if <code>null</code>, the element's name is used)
      * @return a {@link Location} object
      * {@link #getLocation(Element)} and the {@link Locatable} interface.
      * @param elem the element that holds the location information
-     * @return a location string as defined by {@link Location#toString()}.
+     * @return a location string as defined by {@link Location}.
     public static String getLocationString(Element elem) {
         Attr srcAttr = elem.getAttributeNodeNS(URI, SRC_ATTR);

File src/java/com/opensymphony/xwork2/util/package.html

+<body>XWork util classes.</body>

File src/java/com/opensymphony/xwork2/util/profiling/

-     * A profiled call {@link Method#invoke(java.lang.Object, java.lang.Object[]). If {@link UtilTimerStack#isActive() }
+     * A profiled call {@link Method#invoke(java.lang.Object, java.lang.Object[])}. If {@link UtilTimerStack#isActive() }
      * returns false, then no profiling is performed.
     public static Object profiledInvoke(Method target, Object value, Object[] args) throws IllegalAccessException, InvocationTargetException

File src/java/com/opensymphony/xwork2/util/profiling/

      * Determine if profiling is being activated, by searching for a system property
      * 'xwork.profile.activate', default to false (profiling is off).
-     * @return
+     * @return <tt>true</tt>, if active, <tt>false</tt> otherwise.
     public static boolean isActive()
     	 * Method that execute the code subjected to profiling.
-    	 * @return
+    	 * @return  profiles Type
     	 * @throws Exception
     	T doProfiling() throws Exception;

File src/java/com/opensymphony/xwork2/util/profiling/package.html

+<body>Classes to enable profiling of action execution.</body>

File src/java/com/opensymphony/xwork2/validator/annotations/package.html

+<body>Validator annotations.</body>

File src/java/com/opensymphony/xwork2/validator/metadata/package.html

+<body>Validator meta data classes.</body>

File src/java/com/opensymphony/xwork2/validator/package.html

+<body>XWork validation subsystem.</body>

File src/java/com/opensymphony/xwork2/validator/validators/package.html

+<body>XWork default validator classes.</body>

File src/java/overview.html

-This document is the API specification for <a href="" target="_blank">XWork 1.1.1</a>.
+This document is the API specification for <a href="" target="_blank">XWork 2.0</a>.