Package org.apache.struts.config

Class FormPropertyConfig

java.lang.Object
org.apache.struts.config.BaseConfig
org.apache.struts.config.FormPropertyConfig
All Implemented Interfaces:
Serializable
public class FormPropertyConfig extends BaseConfig

A JavaBean representing the configuration information of a <form-property> element in a Struts configuration file.

Since:
Struts 1.1
Version:
$Rev$ $Date: 2005-11-12 11:52:08 -0500 (Sat, 12 Nov 2005)$
See Also:

  • Field Details

    • initial

      protected String initial
      String representation of the initial value for this property.

    • name

      protected String name
      The JavaBean property name of the property described by this element.

    • reset

      protected String reset

      The conditions under which the property described by this element should be reset to its initial value when the form's reset method is called.

      This may be set to true (to always reset the property) or a comma-separated list of HTTP request methods.

      Since:
      Struts 1.3

    • size

      protected int size

      The size of the array to be created if this property is an array type and there is no specified initial value. This value must be non-negative.

      Since:
      Struts 1.1

    • type

      protected String type
      The fully qualified Java class name of the implementation class of this bean property, optionally followed by [] to indicate that the property is indexed.

  • Constructor Details

    • FormPropertyConfig

      public FormPropertyConfig()
      Standard no-arguments constructor for dynamic instantiation.

    • FormPropertyConfig

      public FormPropertyConfig(String name, String type, String initial)
      Constructor that preconfigures the relevant properties.
      Parameters:
      name - Name of this property
      type - Fully qualified class name of this property
      initial - Initial value of this property (if any)

    • FormPropertyConfig

      public FormPropertyConfig(String name, String type, String initial, String reset)
      Constructor that preconfigures the relevant properties.
      Parameters:
      name - Name of this property
      type - Fully qualified class name of this property
      initial - Initial value of this property (if any)
      reset - The conditions under which this property will be reset to its initial value.

    • FormPropertyConfig

      public FormPropertyConfig(String name, String type, String initial, int size)
      Constructor that preconfigures the relevant properties.
      Parameters:
      name - Name of this property
      type - Fully qualified class name of this property
      initial - Initial value of this property (if any)
      size - Size of the array to be created if this property is an array with no defined initial value

    • FormPropertyConfig

      public FormPropertyConfig(String name, String type, String initial, String reset, int size)
      Constructor that preconfigures the relevant properties.
      Parameters:
      name - Name of this property
      type - Fully qualified class name of this property
      initial - Initial value of this property (if any)
      reset - The conditions under which this property will be reset to its initial value.
      size - Size of the array to be created if this property is an array with no defined initial value

  • Method Details

    • getInitial

      public String getInitial()

    • setInitial

      public void setInitial(String initial)

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • getReset

      public String getReset()

    • setReset

      public void setReset(String reset)

    • getSize

      public int getSize()

    • setSize

      public void setSize(int size)

    • getType

      public String getType()

    • setType

      public void setType(String type)

    • getTypeClass

      public Class<?> getTypeClass()
      Return a Class corresponds to the value specified for the type property, taking into account the trailing "[]" for arrays (as well as the ability to specify primitive Java types).

    • initial

      public Object initial()

      Return an object representing the initial value of this property. This is calculated according to the following algorithm:

      • If the value you have specified for the type property represents an array (i.e. it ends with "[]"):
        • If you have specified a value for the initial property, ConvertUtils.convert will be called to convert it into an instance of the specified array type.
        • If you have not specified a value for the initial property, an array of the length specified by the size property will be created. Each element of the array will be instantiated via the zero-args constructor on the specified class (if any). Otherwise, null will be returned.
      • If the value you have specified for the type property does not represent an array:
        • If you have specified a value for the initial property, ConvertUtils.convert will be called to convert it into an object instance.
        • If you have not specified a value for the initial attribute, Struts will instantiate an instance via the zero-args constructor on the specified class (if any). Otherwise, null will be returned.

    • inheritFrom

      public void inheritFrom(FormPropertyConfig config) throws IllegalAccessException, InvocationTargetException, InstantiationException, ClassNotFoundException

      Inherit values that have not been overridden from the provided config object. Subclasses overriding this method should verify that the given parameter is of a class that contains a property it is trying to inherit:

       if (config instanceof MyCustomFormPropertyConfig) {
     MyCustomFormPropertyConfig myConfig =
         (MyCustomFormPropertyConfig) config;

     if (getMyCustomProp() == null) {
         setMyCustomProp(myConfig.getMyCustomProp());
     }
 }
      Parameters:
      config - The object that this instance will be inheriting its values from.
      Throws:
      IllegalAccessException
      InvocationTargetException
      InstantiationException
      ClassNotFoundException

    • toString

      public String toString()
      Return a String representation of this object.
      Overrides:
      toString in class Object