com.sun.tools.xjc.api
Interface Property

All Known Implementing Classes:
PropertyImpl

public interface Property

Represents a property of a wrapper-style element.

Carrys information about one property of a wrapper-style element. This interface is solely intended for the use by the JAX-RPC and otherwise the use is discouraged.

REVISIT: use CodeModel.

See Also:
Mapping

Method Summary
 javax.xml.namespace.QName elementName()
          Name of the XML element that corresponds to the property.
 java.lang.String getValue(java.lang.String $bean, java.lang.String $var, java.lang.String uniqueName)
          Deprecated. this method is provided for now to allow gradual migration for JAX-RPC.
 java.lang.String name()
          The name of the property.
 java.lang.String setValue(java.lang.String $bean, java.lang.String $var, java.lang.String uniqueName)
          Deprecated. this method is provided for now to allow gradual migration for JAX-RPC.
 com.sun.codemodel.JType type()
          The Java type of the property.
 

Method Detail

name

java.lang.String name()
The name of the property.

This method returns a valid identifier suitable for the use as a variable name.

Returns:
always non-null. Camel-style name like "foo" or "barAndZot". Note that it may contain non-ASCII characters (CJK, etc.) The caller is responsible for proper escaping if it wants to print this as a variable name.

type

com.sun.codemodel.JType type()
The Java type of the property.

Returns:
always non-null. JType is a representation of a Java type in a codeModel. If you just need the fully-qualified class name, call JType.fullName().

elementName

javax.xml.namespace.QName elementName()
Name of the XML element that corresponds to the property.

Each child of a wrapper style element corresponds with an element, and this method returns that name.

Returns:
always non-null valid QName.

setValue

java.lang.String setValue(java.lang.String $bean,
                          java.lang.String $var,
                          java.lang.String uniqueName)
Deprecated. this method is provided for now to allow gradual migration for JAX-RPC.

Generates the code that sets values to this property.

Parameters:
$bean - A variable name that evaluates to the "type representation" of the bean that receives new values.
$var - A variable name that evaluates to the values to be set. The type of this variable must be the one returned by type()
uniqueName - Sometimes this method needs to generate additional local variables to get the job done. This parameter specifies what names can be used in such occasion. This parameter must not be null. For example, when you pass "abc", you are guaranteeing that any identifier "abc.*" (in regexp) is usable unused identifier names in the context where this code is used.
Returns:
A statement that sets the values to the bean. At the end of the evaluation of this generated statement the bean will have new values, and the contents of the variables are intact.

getValue

java.lang.String getValue(java.lang.String $bean,
                          java.lang.String $var,
                          java.lang.String uniqueName)
Deprecated. this method is provided for now to allow gradual migration for JAX-RPC.

Generates the code that gets values to this property.

Parameters:
$bean - A variable name that evaluates to the "type representation" of the bean whose values will be retrieved.
$var - A variable name that evaluates to the values to be set. The type of this variable must be the one returned by type().
uniqueName - Sometimes this method needs to generate additional local variables to get the job done. This parameter specifies what names can be used in such occasion. This parameter must not be null. For example, when you pass "abc", you are guaranteeing that any identifier "abc.*" (in regexp) is usable unused identifier names in the context where this code is used.
Returns:
A statement that gets the values to the bean. At the end of the evaluation, the specified variable will carry the values obtained from the bean. The specified variable can have unitialized value before the evaluation of this statement.