Commits

Anonymous committed f78ee2a

o resolved most of the javadoc task warnings
o added some more javadocs
Issue number:
Obtained from:
Submitted by:
Reviewed by:

git-svn-id: http://svn.opensymphony.com/svn/xwork/trunk@892e221344d-f017-0410-9bd5-d282ab1896d7

Comments (0)

Files changed (27)

tiger/src/java/com/opensymphony/xwork/conversion/annotations/Conversion.java

  *
  * <pre>
  * <!-- START SNIPPET: example -->
- * @Conversion()
+ * &#64;Conversion()
  * public class ConversionAction implements Action {
  * }
  *

tiger/src/java/com/opensymphony/xwork/conversion/annotations/TypeConversion.java

  *
  * <pre>
  * <!-- START SNIPPET: example -->
- * @Conversion()
+ * &#64;Conversion()
  * public class ConversionAction implements Action {
  *
  *   private String convertInt;
  *
  *   private HashMap keyValues = null;
  *
- *   @TypeConversion(type = ConversionType.APPLICATION, converter = "com.opensymphony.xwork.util.XWorkBasicConverter")
+ *   &#64;TypeConversion(type = ConversionType.APPLICATION, converter = "com.opensymphony.xwork.util.XWorkBasicConverter")
  *   public void setConvertInt( String convertInt ) {
  *       this.convertInt = convertInt;
  *   }
  *
- *   @TypeConversion(converter = "com.opensymphony.xwork.util.XWorkBasicConverter")
+ *   &#64;TypeConversion(converter = "com.opensymphony.xwork.util.XWorkBasicConverter")
  *   public void setConvertDouble( String convertDouble ) {
  *       this.convertDouble = convertDouble;
  *   }
  *
- *   @TypeConversion(rule = ConversionRule.COLLECTION, converter = "java.util.String")
+ *   &#64;TypeConversion(rule = ConversionRule.COLLECTION, converter = "java.util.String")
  *   public void setUsers( List users ) {
  *       this.users = users;
  *   }
  *
- *   @TypeConversion(rule = ConversionRule.MAP, converter = "java.math.BigInteger")
+ *   &#64;TypeConversion(rule = ConversionRule.MAP, converter = "java.math.BigInteger")
  *   public void setKeyValues( HashMap keyValues ) {
  *       this.keyValues = keyValues;
  *   }
  *
- *   @TypeConversion(type = ConversionType.APPLICATION, property = "java.util.Date", converter = "com.opensymphony.xwork.util.XWorkBasicConverter")
+ *   &#64;TypeConversion(type = ConversionType.APPLICATION, property = "java.util.Date", converter = "com.opensymphony.xwork.util.XWorkBasicConverter")
  *   public String execute() throws Exception {
  *       return SUCCESS;
  *   }

tiger/src/java/com/opensymphony/xwork/interceptor/annotations/After.java

  * <!-- START SNIPPET: example -->
  * public class SampleAction extends ActionSupport {
  *
- *  @After
+ *  &#64;After
  *  public void isValid() throws ValidationException {
  *    // validate model object, throw exception if failed
  *  }

tiger/src/java/com/opensymphony/xwork/interceptor/annotations/AnnotationWorkflowInterceptor.java

  *  public class BaseAnnotatedAction {
  *  	protected String log = "";
  *
- *  	@Before
+ *  	&#64;Before
  *  	public String baseBefore() {
  *  		log = log + "baseBefore-";
  *  		return null;
  *  }
  *
  *  public class AnnotatedAction extends BaseAnnotatedAction {
- *  	@Before
+ *  	&#64;Before
  *  	public String before() {
  *  		log = log + "before";
  *  		return null;
  *  		return Action.SUCCESS;
  *  	}
  *
- *  	@BeforeResult
+ *  	&#64;BeforeResult
  *  	public void beforeResult() throws Exception {
  *  		log = log +"-beforeResult";
  *  	}
  *
- *  	@After
+ *  	&#64;After
  *  	public void after() {
  *  		log = log + "-after";
  *  	}

tiger/src/java/com/opensymphony/xwork/interceptor/annotations/Before.java

  * <!-- START SNIPPET: example -->
  * public class SampleAction extends ActionSupport {
  *
- *  @Before
+ *  &#64;Before
  *  public void isAuthorized() throws AuthenticationException {
  *    // authorize request, throw exception if failed
  *  }

tiger/src/java/com/opensymphony/xwork/interceptor/annotations/BeforeResult.java

  * <!-- START SNIPPET: example -->
  * public class SampleAction extends ActionSupport {
  *
- *  @BeforeResult
+ *  &#64;BeforeResult
  *  public void isValid() throws ValidationException {
  *    // validate model object, throw exception if failed
  *  }

tiger/src/java/com/opensymphony/xwork/util/AnnotationXWorkConverter.java

  *
  * @author <a href="mailto:plightbo@gmail.com">Pat Lightbody</a>
  * @author Rainer Hermanns
- * @see XWorkConverter
+ * @see com.opensymphony.xwork.util.XWorkConverter
  */
 public class AnnotationXWorkConverter extends XWorkConverter {
     

tiger/src/java/com/opensymphony/xwork/util/CreateIfNull.java

  * <!-- START SNIPPET: example -->
  * List<User> users = null;
  *
- * @CreateIfNull( value = true )
+ * &#64;CreateIfNull( value = true )
  * public void setUsers(List<User> users) {
  *   this.users = users;
  * }

tiger/src/java/com/opensymphony/xwork/util/Element.java

  * Map<Long, User> userMap = null;
  * List<User> userList = null;
  *
- * @Element( value = com.acme.User )
+ * &#64;Element( value = com.acme.User )
  * public void setUserMap(Map<Long, User> userMap) {
  *   this.userMap = userMap;
  * }
  *
- * @Element( value = com.acme.User )
+ * &#64;Element( value = com.acme.User )
  * public void setUserList(List<User> userList) {
  *   this.userList = userList;
  * }

tiger/src/java/com/opensymphony/xwork/util/GenericsObjectTypeDeterminer.java

      *
      * @param parentClass the Class which contains as a property the Map or Collection we are finding the key for.
      * @param property    the property of the Map or Collection for the given parent class
-     * @see ObjectTypeDeterminer#getKeyClass(Class, String)
+     * @see com.opensymphony.xwork.util.ObjectTypeDeterminer#getKeyClass(Class, String)
      */
     public Class getKeyClass(Class parentClass, String property) {
 
      *
      * @param parentClass the Class which contains as a property the Map or Collection we are finding the key for.
      * @param property    the property of the Map or Collection for the given parent class
-     * @see ObjectTypeDeterminer#getElementClass(Class, String, Object)
+     * @see com.opensymphony.xwork.util.ObjectTypeDeterminer#getElementClass(Class, String, Object)
      */
     public Class getElementClass(Class parentClass, String property, Object key) {
 
      *
      * @param parentClass the Class which contains as a property the Map or Collection we are finding the key for.
      * @param property    the property of the Map or Collection for the given parent class
-     * @see ObjectTypeDeterminer#getKeyProperty(Class, String)
+     * @see com.opensymphony.xwork.util.ObjectTypeDeterminer#getKeyProperty(Class, String)
      */
     public String getKeyProperty(Class parentClass, String property) {
 
      * @param target
      * @param keyProperty
      * @param isIndexAccessed <tt>true</tt>, if the collection or map is accessed via index, <tt>false</tt> otherwise.
-     * @see ObjectTypeDeterminer#getKeyProperty(Class, String)
+     * @see com.opensymphony.xwork.util.ObjectTypeDeterminer#getKeyProperty(Class, String)
      */
     public boolean shouldCreateIfNew(Class parentClass,
                                      String property,

tiger/src/java/com/opensymphony/xwork/util/Key.java

  * // The key property for User objects within the users collection is the <code>userName</code> attribute.
  * Map<Long, User> userMap = null;
  *
- * @Key( value = java.lang.Long.class )
+ * &#64;Key( value = java.lang.Long.class )
  * public void setUserMap(Map<Long, User> userMap) {
  *   this.userMap = userMap;
  * }

tiger/src/java/com/opensymphony/xwork/util/KeyProperty.java

  * // The key property for User objects within the users collection is the <code>userName</code> attribute.
  * List<User> users = null;
  *
- * @KeyProperty( value = "userName" )
+ * &#64;KeyProperty( value = "userName" )
  * public void setUsers(List<User> users) {
  *   this.users = users;
  * }

tiger/src/java/com/opensymphony/xwork/validator/annotations/ConversionErrorFieldValidator.java

  *
  * <pre>
  * <!-- START SNIPPET: example -->
- * @ConversionErrorFieldValidator(message = "Default message", key = "i18n.key", shortCircuit = true)
+ * &#64;ConversionErrorFieldValidator(message = "Default message", key = "i18n.key", shortCircuit = true)
  * <!-- END SNIPPET: example -->
  * </pre>
  *

tiger/src/java/com/opensymphony/xwork/validator/annotations/DateRangeFieldValidator.java

  *
  * <pre>
  * <!-- START SNIPPET: example -->
- * @DateRangeFieldValidator(message = "Default message", key = "i18n.key", shortCircuit = true, min = "2005/01/01", max = "2005/12/31")
+ * &#64;DateRangeFieldValidator(message = "Default message", key = "i18n.key", shortCircuit = true, min = "2005/01/01", max = "2005/12/31")
  * <!-- END SNIPPET: example -->
  * </pre>
  *

tiger/src/java/com/opensymphony/xwork/validator/annotations/DoubleRangeFieldValidator.java

  *
  * <pre>
  * <!-- START SNIPPET: example -->
- * @DoubleRangeFieldValidator(message = "Default message", key = "i18n.key", shortCircuit = true, minInclusive = "0.123", maxInclusive = "99.987")
+ * &#64;DoubleRangeFieldValidator(message = "Default message", key = "i18n.key", shortCircuit = true, minInclusive = "0.123", maxInclusive = "99.987")
  * <!-- END SNIPPET: example -->
  * </pre>
  *

tiger/src/java/com/opensymphony/xwork/validator/annotations/EmailValidator.java

  *
  * <pre>
  * <!-- START SNIPPET: example -->
- * @EmailValidator(message = "Default message", key = "i18n.key", shortCircuit = true)
+ * &#64;EmailValidator(message = "Default message", key = "i18n.key", shortCircuit = true)
  * <!-- END SNIPPET: example -->
  * </pre>
  *

tiger/src/java/com/opensymphony/xwork/validator/annotations/ExpressionValidator.java

  *
  * <pre>
  * <!-- START SNIPPET: example -->
- * @ExpressionValidator(message = "Default message", key = "i18n.key", shortCircuit = true, expression = "an OGNL expression" )
+ * &#64;ExpressionValidator(message = "Default message", key = "i18n.key", shortCircuit = true, expression = "an OGNL expression" )
  * <!-- END SNIPPET: example -->
  * </pre>
  *

tiger/src/java/com/opensymphony/xwork/validator/annotations/FieldExpressionValidator.java

  *
  * <pre>
  * <!-- START SNIPPET: example -->
- * @FieldExpressionValidator(message = "Default message", key = "i18n.key", shortCircuit = true, expression = "an OGNL expression")
+ * &#64;FieldExpressionValidator(message = "Default message", key = "i18n.key", shortCircuit = true, expression = "an OGNL expression")
  * <!-- END SNIPPET: example -->
  * </pre>
  *

tiger/src/java/com/opensymphony/xwork/validator/annotations/IntRangeFieldValidator.java

  *
  * <pre>
  * <!-- START SNIPPET: example -->
- * @IntRangeFieldValidator(message = "Default message", key = "i18n.key", shortCircuit = true, min = "0", max = "42")
+ * &#64;IntRangeFieldValidator(message = "Default message", key = "i18n.key", shortCircuit = true, min = "0", max = "42")
  * <!-- END SNIPPET: example -->
  * </pre>
  *

tiger/src/java/com/opensymphony/xwork/validator/annotations/RequiredFieldValidator.java

  *
  * <pre>
  * <!-- START SNIPPET: example -->
- * @RequiredFieldValidator(message = "Default message", key = "i18n.key", shortCircuit = true)
+ * &#64;RequiredFieldValidator(message = "Default message", key = "i18n.key", shortCircuit = true)
  * <!-- END SNIPPET: example -->
  * </pre>
  *

tiger/src/java/com/opensymphony/xwork/validator/annotations/RequiredStringValidator.java

  *
  * <pre>
  * <!-- START SNIPPET: example -->
- * @RequiredStringValidator(message = "Default message", key = "i18n.key", shortCircuit = true, trim = true)
+ * &#64;RequiredStringValidator(message = "Default message", key = "i18n.key", shortCircuit = true, trim = true)
  * <!-- END SNIPPET: example -->
  * </pre>
  *

tiger/src/java/com/opensymphony/xwork/validator/annotations/StringLengthFieldValidator.java

  *
  * <pre>
  * <!-- START SNIPPET: example -->
- * @StringLengthFieldValidator(message = "Default message", key = "i18n.key", shortCircuit = true, trim = true, minLength = "5",  maxLength = "12")
+ * &#64;StringLengthFieldValidator(message = "Default message", key = "i18n.key", shortCircuit = true, trim = true, minLength = "5",  maxLength = "12")
  * <!-- END SNIPPET: example -->
  * </pre>
  *

tiger/src/java/com/opensymphony/xwork/validator/annotations/StringRegexValidator.java

  *
  * <pre>
  * <!-- START SNIPPET: example -->
- * @StringRegexValidator(message = "Default message", key = "i18n.key", shortCircuit = true, regex = "a regular expression", caseSensitive = true)
+ * &#64;StringRegexValidator(message = "Default message", key = "i18n.key", shortCircuit = true, regex = "a regular expression", caseSensitive = true)
  * <!-- END SNIPPET: example -->
  * </pre>
  *

tiger/src/java/com/opensymphony/xwork/validator/annotations/UrlValidator.java

  *
  * <pre>
  * <!-- START SNIPPET: example -->
- * @UrlValidator(message = "Default message", key = "i18n.key", shortCircuit = true)
+ * &#64;UrlValidator(message = "Default message", key = "i18n.key", shortCircuit = true)
  * <!-- END SNIPPET: example -->
  * </pre>
  *

tiger/src/java/com/opensymphony/xwork/validator/annotations/Validation.java

  * <u>An Annotated Interface</u>
  * <pre>
  * <!-- START SNIPPET: example -->
- * @Validation()
+ * &#64;Validation()
  * public interface AnnotationDataAware {
  *
  *     void setBarObj(Bar b);
  *
  *     Bar getBarObj();
  *
- *     @RequiredFieldValidator(message = "You must enter a value for data.")
- *     @RequiredStringValidator(message = "You must enter a value for data.")
+ *     &#64;RequiredFieldValidator(message = "You must enter a value for data.")
+ *     &#64;RequiredStringValidator(message = "You must enter a value for data.")
  *     void setData(String data);
  *
  *     String getData();
  * <u>An Annotated Class</u>
  * <pre>
  * <!-- START SNIPPET: example2 -->
- * @Validation()
+ * &#64;Validation()
  * public class SimpleAnnotationAction extends ActionSupport {
  *
- *     @RequiredFieldValidator(type = ValidatorType.FIELD, message = "You must enter a value for bar.")
- *     @IntRangeFieldValidator(type = ValidatorType.FIELD, min = "6", max = "10", message = "bar must be between ${min} and ${max}, current value is ${bar}.")
+ *     &#64;RequiredFieldValidator(type = ValidatorType.FIELD, message = "You must enter a value for bar.")
+ *     &#64;IntRangeFieldValidator(type = ValidatorType.FIELD, min = "6", max = "10", message = "bar must be between ${min} and ${max}, current value is ${bar}.")
  *     public void setBar(int bar) {
  *         this.bar = bar;
  *     }
  *         return bar;
  *     }
  *
- *     @Validations(
+ *     &#64;Validations(
  *             requiredFields =
- *                     {@RequiredFieldValidator(type = ValidatorType.SIMPLE, fieldName = "customfield", message = "You must enter a value for field.")},
+ *                     {&#64;RequiredFieldValidator(type = ValidatorType.SIMPLE, fieldName = "customfield", message = "You must enter a value for field.")},
  *             requiredStrings =
- *                     {@RequiredStringValidator(type = ValidatorType.SIMPLE, fieldName = "stringisrequired", message = "You must enter a value for string.")},
+ *                     {&#64;RequiredStringValidator(type = ValidatorType.SIMPLE, fieldName = "stringisrequired", message = "You must enter a value for string.")},
  *             emails =
- *                     { @EmailValidator(type = ValidatorType.SIMPLE, fieldName = "emailaddress", message = "You must enter a value for email.")},
+ *                     { &#64;EmailValidator(type = ValidatorType.SIMPLE, fieldName = "emailaddress", message = "You must enter a value for email.")},
  *             urls =
- *                     { @UrlValidator(type = ValidatorType.SIMPLE, fieldName = "hreflocation", message = "You must enter a value for email.")},
+ *                     { &#64;UrlValidator(type = ValidatorType.SIMPLE, fieldName = "hreflocation", message = "You must enter a value for email.")},
  *             stringLengthFields =
- *                     {@StringLengthFieldValidator(type = ValidatorType.SIMPLE, trim = true, minLength="10" , maxLength = "12", fieldName = "needstringlength", message = "You must enter a stringlength.")},
+ *                     {&#64;StringLengthFieldValidator(type = ValidatorType.SIMPLE, trim = true, minLength="10" , maxLength = "12", fieldName = "needstringlength", message = "You must enter a stringlength.")},
  *             intRangeFields =
  *                     { @IntRangeFieldValidator(type = ValidatorType.SIMPLE, fieldName = "intfield", min = "6", max = "10", message = "bar must be between ${min} and ${max}, current value is ${bar}.")},
  *             dateRangeFields =
- *                     {@DateRangeFieldValidator(type = ValidatorType.SIMPLE, fieldName = "datefield", min = "-1", max = "99", message = "bar must be between ${min} and ${max}, current value is ${bar}.")},
+ *                     {&#64;DateRangeFieldValidator(type = ValidatorType.SIMPLE, fieldName = "datefield", min = "-1", max = "99", message = "bar must be between ${min} and ${max}, current value is ${bar}.")},
  *             expressions = {
- *                 @ExpressionValidator(expression = "foo &gt; 1", message = "Foo must be greater than Bar 1. Foo = ${foo}, Bar = ${bar}."),
- *                 @ExpressionValidator(expression = "foo &gt; 2", message = "Foo must be greater than Bar 2. Foo = ${foo}, Bar = ${bar}."),
- *                 @ExpressionValidator(expression = "foo &gt; 3", message = "Foo must be greater than Bar 3. Foo = ${foo}, Bar = ${bar}."),
- *                 @ExpressionValidator(expression = "foo &gt; 4", message = "Foo must be greater than Bar 4. Foo = ${foo}, Bar = ${bar}."),
- *                 @ExpressionValidator(expression = "foo &gt; 5", message = "Foo must be greater than Bar 5. Foo = ${foo}, Bar = ${bar}.")
+ *                 &#64;ExpressionValidator(expression = "foo &gt; 1", message = "Foo must be greater than Bar 1. Foo = ${foo}, Bar = ${bar}."),
+ *                 &#64;ExpressionValidator(expression = "foo &gt; 2", message = "Foo must be greater than Bar 2. Foo = ${foo}, Bar = ${bar}."),
+ *                 &#64;ExpressionValidator(expression = "foo &gt; 3", message = "Foo must be greater than Bar 3. Foo = ${foo}, Bar = ${bar}."),
+ *                 &#64;ExpressionValidator(expression = "foo &gt; 4", message = "Foo must be greater than Bar 4. Foo = ${foo}, Bar = ${bar}."),
+ *                 &#64;ExpressionValidator(expression = "foo &gt; 5", message = "Foo must be greater than Bar 5. Foo = ${foo}, Bar = ${bar}.")
  *     }
  *     )
  *     public String execute() throws Exception {

tiger/src/java/com/opensymphony/xwork/validator/annotations/Validations.java

  *
  * <pre>
  * <!-- START SNIPPET: example -->
- * @Validations(
+ * &#64;Validations(
  *           requiredFields =
- *                   {@RequiredFieldValidator(type = ValidatorType.SIMPLE, fieldName = "customfield", message = "You must enter a value for field.")},
+ *                   {&#64;RequiredFieldValidator(type = ValidatorType.SIMPLE, fieldName = "customfield", message = "You must enter a value for field.")},
  *           requiredStrings =
- *                   {@RequiredStringValidator(type = ValidatorType.SIMPLE, fieldName = "stringisrequired", message = "You must enter a value for string.")},
+ *                   {&#64;RequiredStringValidator(type = ValidatorType.SIMPLE, fieldName = "stringisrequired", message = "You must enter a value for string.")},
  *           emails =
- *                   { @EmailValidator(type = ValidatorType.SIMPLE, fieldName = "emailaddress", message = "You must enter a value for email.")},
+ *                   { &#64;EmailValidator(type = ValidatorType.SIMPLE, fieldName = "emailaddress", message = "You must enter a value for email.")},
  *           urls =
- *                   { @UrlValidator(type = ValidatorType.SIMPLE, fieldName = "hreflocation", message = "You must enter a value for email.")},
+ *                   { &#64;UrlValidator(type = ValidatorType.SIMPLE, fieldName = "hreflocation", message = "You must enter a value for email.")},
  *           stringLengthFields =
- *                   {@StringLengthFieldValidator(type = ValidatorType.SIMPLE, trim = true, minLength="10" , maxLength = "12", fieldName = "needstringlength", message = "You must enter a stringlength.")},
+ *                   {&#64;StringLengthFieldValidator(type = ValidatorType.SIMPLE, trim = true, minLength="10" , maxLength = "12", fieldName = "needstringlength", message = "You must enter a stringlength.")},
  *           intRangeFields =
- *                   { @IntRangeFieldValidator(type = ValidatorType.SIMPLE, fieldName = "intfield", min = "6", max = "10", message = "bar must be between ${min} and ${max}, current value is ${bar}.")},
+ *                   { &#64;IntRangeFieldValidator(type = ValidatorType.SIMPLE, fieldName = "intfield", min = "6", max = "10", message = "bar must be between ${min} and ${max}, current value is ${bar}.")},
  *           dateRangeFields =
- *                   {@DateRangeFieldValidator(type = ValidatorType.SIMPLE, fieldName = "datefield", min = "-1", max = "99", message = "bar must be between ${min} and ${max}, current value is ${bar}.")},
+ *                   {&#64;DateRangeFieldValidator(type = ValidatorType.SIMPLE, fieldName = "datefield", min = "-1", max = "99", message = "bar must be between ${min} and ${max}, current value is ${bar}.")},
  *           expressions = {
- *               @ExpressionValidator(expression = "foo &gt; 1", message = "Foo must be greater than Bar 1. Foo = ${foo}, Bar = ${bar}."),
- *               @ExpressionValidator(expression = "foo &gt; 2", message = "Foo must be greater than Bar 2. Foo = ${foo}, Bar = ${bar}."),
- *               @ExpressionValidator(expression = "foo &gt; 3", message = "Foo must be greater than Bar 3. Foo = ${foo}, Bar = ${bar}."),
- *               @ExpressionValidator(expression = "foo &gt; 4", message = "Foo must be greater than Bar 4. Foo = ${foo}, Bar = ${bar}."),
- *               @ExpressionValidator(expression = "foo &gt; 5", message = "Foo must be greater than Bar 5. Foo = ${foo}, Bar = ${bar}.")
+ *               &#64;ExpressionValidator(expression = "foo &gt; 1", message = "Foo must be greater than Bar 1. Foo = ${foo}, Bar = ${bar}."),
+ *               &#64;ExpressionValidator(expression = "foo &gt; 2", message = "Foo must be greater than Bar 2. Foo = ${foo}, Bar = ${bar}."),
+ *               &#64;ExpressionValidator(expression = "foo &gt; 3", message = "Foo must be greater than Bar 3. Foo = ${foo}, Bar = ${bar}."),
+ *               &#64;ExpressionValidator(expression = "foo &gt; 4", message = "Foo must be greater than Bar 4. Foo = ${foo}, Bar = ${bar}."),
+ *               &#64;ExpressionValidator(expression = "foo &gt; 5", message = "Foo must be greater than Bar 5. Foo = ${foo}, Bar = ${bar}.")
  *   }
  *   )
  *   public String execute() throws Exception {

tiger/src/java/com/opensymphony/xwork/validator/annotations/VisitorFieldValidator.java

  *
  * <pre>
  * <!-- START SNIPPET: example -->
- * @VisitorFieldValidator(message = "Default message", key = "i18n.key", shortCircuit = true, context = "action alias", appendPrefix = true)
+ * &#64;VisitorFieldValidator(message = "Default message", key = "i18n.key", shortCircuit = true, context = "action alias", appendPrefix = true)
  * <!-- END SNIPPET: example -->
  * </pre>
  *