JavaServer Pages(TM) v1.2 Syntax Reference

<jsp:setProperty>

Sets a property value or values in a bean.

JSP Syntax

<jsp:setProperty name="beanInstanceName"	
{ 	
   property="*" |	
   property="propertyName" [ param="parameterName" ] |	
   property="propertyName" value="{stringLiteral| <%= expression %>}"	
}	
/>

XML Syntax

<jsp:setProperty name="beanInstanceName"	
{ 	
   property="*" |	
   property="propertyName" [ param="parameterName" ] |	
   property="propertyName" value="{stringLiteral | %= expression %}" 	
}	
/>

Examples

<jsp:setProperty name="mybean" property="*" />	
<jsp:setProperty name="mybean" property="username" />	
<jsp:setProperty name="mybean" property="username" value="Steve" />

Description

The <jsp:setProperty> element sets the value of one or more properties in a bean, using the bean's setter methods. You must declare the bean with <jsp:useBean> before you set a property value with <jsp:setProperty>. Because <jsp:useBean> and <jsp:setProperty> work together, the bean instance names they use must match (that is, the value of name in <jsp:setProperty> and the value of id in <jsp:useBean> must be the same).

You can use <jsp:setProperty> to set property values in several ways:

By passing all of the values the user enters (stored as parameters in the request object) to matching properties in the bean
By passing a specific value the user enters to a specific property in the bean
By setting a bean property to a value you specify as either a String or an expression that is evaluated at runtime

Each method of setting property values has its own syntax, as described in the next section.

Attributes and Usage

name="beanInstanceName"

The name of an instance of a bean that has already been created or located with a <jsp:useBean> element. The value of name must match the value of id in <jsp:useBean>. The <jsp:useBean> element must appear before <jsp:setProperty> in the JSP page.
property="*"

Stores all of the values of request parameters in bean properties. The names of the bean properties must match the names of the request parameters. A bean property is usually defined by a variable declaration with matching getter and setter methods (for more information, see http://java.sun.com/products/javabeans/docs/).

The values of the request parameters sent from the client to the server are always of type String. The String values are converted to other data types when stored in bean properties. If a property has a PropertyEditor class as indicated in the JavaBeans specification, the setAsText(String) method is used. A conversion failure arises if the method throws an IllegalArgumentException. The allowed bean property types and their conversion methods are shown in TABLE 1.

**TABLE 1**
Property Type	String Is Converted Using
Bean Property	Use setAsText(stringLiteral)
boolean or Boolean	java.lang.Boolean.valueOf(String)
byte or Byte	java.lang.Byte.valueOf(String)
char or Character	java.lang.String.charAt(0)
double or Double	java.lang.Double.valueOf(String)
integer or Integer	java.lang.Integer.valueOf(String)
float or Float	java.lang.Float.valueOf(String)
long or Long	java.lang.Long.valueOf(String)
short or Short	java.lang.Short.valueOf(String)
Object	new String(string-literal)

You can also use <jsp:setProperty> to set the value of an indexed property in a bean. The indexed property must be an array of one of the data types shown in TABLE 1. The array elements are converted using the conversion methods shown in the table.

If a request parameter has an empty or null value, the corresponding bean property is not set. Likewise, if the bean has a property that does not have a matching request parameter, the property value is not set.

property="propertyName" [ param="parameterName" ]

Sets one bean property to the value of one request parameter. In the syntax, property specifies the name of the bean property and param specifies the name of the request parameter by which data is being sent from the client to the server.

If the bean property and the request parameter have different names, you must specify both property and param. If they have the same name, you can specify property and omit param.

If a parameter has an empty or null value, the corresponding bean property is not set.
property="propertyName" value="{string | <%= expression %>}"

Sets one bean property to a specific value. The value can be a String or an expression that is evaluated at runtime. If the value is a String, it is converted to the bean property's data type according to the conversion rules shown above in TABLE 1. If it is an expression, its value must have a data type that matches the the data type of the value of the expression must match the data type of the bean property.

If the parameter has an empty or null value, the corresponding bean property is not set. You cannot use both the param and value attributes in a <jsp:setProperty> element.

Tip

When you use property="*", the bean properties are not necessarily set in the order in which they appear in the HTML form or the bean. If the order in which the properties are set is important to how your bean works, use the syntax form property="propertyName" [ param="parameterName" ]. Better yet, rewrite your bean so that the order of setting properties is not important.

Contents | Prev | Next