org.apache.tapestry.spec
Class PropertySpecification

java.lang.Object
  org.apache.hivemind.impl.BaseLocatable
      org.apache.tapestry.spec.PropertySpecification

All Implemented Interfaces:

org.apache.hivemind.Locatable, org.apache.hivemind.LocationHolder, IPropertySpecification

public class PropertySpecification
extends org.apache.hivemind.impl.BaseLocatable
implements IPropertySpecification

Defines a transient or persistant property of a component or page.

Since:

3.0

Author:

Howard Lewis Ship

Constructor Summary

PropertySpecification()

Method Summary

boolean	canProxy() Checks if this parameter can be proxied.
String	getInitialValue() Returns the initial value for this property, as a binding reference.
String	getName()
String	getPersistence() If null, then the property is not persistent.
String	getType() The type of property to create, or null if no type was specified.
boolean	isGeneric() Checks if the type represented by this property is in a generic declaration.
boolean	isPersistent() Returns true if IPropertySpecification.getPersistence()is null.
boolean	isProxyChecked() Checks if this property has previously had it's type information examined to determine if it is elligable for proxying.
void	setCanProxy(boolean canProxy) Sets whether or not this property can be proxied.
void	setGeneric(boolean isGeneric) Sets whether or not this property represents a concrete generic type.
void	setInitialValue(String initialValue)
void	setName(String name) Sets the name of the property.
void	setPersistence(String persistence) A string indicating how the property is persisted.
void	setProxyChecked(boolean checked) Sets the state of this property so that it is known whether or not the type it represents has been checked as being compatible with proxying or not.
void	setType(String type)

Methods inherited from class org.apache.hivemind.impl.BaseLocatable

getLocation, setLocation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.hivemind.LocationHolder

setLocation

Methods inherited from interface org.apache.hivemind.Locatable

getLocation

Constructor Detail

PropertySpecification

public PropertySpecification()

Method Detail

getInitialValue

public String getInitialValue()

Description copied from interface: IPropertySpecification

Returns the initial value for this property, as a binding reference. May return null if the property has no initial value. The initial value is from finishLoad() and re-applied in pageDetached().

Specified by:

getInitialValue in interface IPropertySpecification

getName

public String getName()

Specified by:

getName in interface IPropertySpecification

isPersistent

public boolean isPersistent()

Description copied from interface: IPropertySpecification

Returns true if IPropertySpecification.getPersistence()is null.

Specified by:

isPersistent in interface IPropertySpecification

getType

public String getType()

The type of property to create, or null if no type was specified. The value is the name of a primitive type, a fully qualified class name, or an array name for either. Type is only specified for 3.0 DTDs, in 4.0 the only behavior is for the new property to match the type defined by an abstract accessor, or to be java.lang.Object.

Specified by:

getType in interface IPropertySpecification

setInitialValue

public void setInitialValue(String initialValue)

Specified by:

setInitialValue in interface IPropertySpecification

setName

public void setName(String name)

Sets the name of the property. This should not be changed once this IPropertySpecification is added to a ComponentSpecification.

Specified by:

setName in interface IPropertySpecification

setType

public void setType(String type)

Specified by:

setType in interface IPropertySpecification

setGeneric

public void setGeneric(boolean isGeneric)

Description copied from interface: IPropertySpecification

Sets whether or not this property represents a concrete generic type.

Specified by:

setGeneric in interface IPropertySpecification

isGeneric

public boolean isGeneric()

Description copied from interface: IPropertySpecification

Checks if the type represented by this property is in a generic declaration.

Specified by:

isGeneric in interface IPropertySpecification

Returns:

True if it is generic, false otherwise.

getPersistence

public String getPersistence()

Description copied from interface: IPropertySpecification

If null, then the property is not persistent.

Specified by:

getPersistence in interface IPropertySpecification

Since:

4.0

setPersistence

public void setPersistence(String persistence)

Description copied from interface: IPropertySpecification

A string indicating how the property is persisted.

Specified by:

setPersistence in interface IPropertySpecification

Since:

4.0

canProxy

public boolean canProxy()

Checks if this parameter can be proxied.

Specified by:

canProxy in interface IPropertySpecification

Returns:

True if the type can be proxied, false otherwise.

isProxyChecked

public boolean isProxyChecked()

Checks if this property has previously had it's type information examined to determine if it is elligable for proxying. Meaning IPropertySpecification.canProxy() should be a real value.

Specified by:

isProxyChecked in interface IPropertySpecification

Returns:

True if the proxy type has been checked, false otherwise.

setCanProxy

public void setCanProxy(boolean canProxy)

Sets whether or not this property can be proxied.

Specified by:

setCanProxy in interface IPropertySpecification

setProxyChecked

public void setProxyChecked(boolean checked)

Sets the state of this property so that it is known whether or not the type it represents has been checked as being compatible with proxying or not.

Specified by:

setProxyChecked in interface IPropertySpecification