org.apache.tapestry.spec
Interface IPropertySpecification

All Superinterfaces:

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

All Known Implementing Classes:

PropertySpecification

public interface IPropertySpecification
extends org.apache.hivemind.LocationHolder

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

Author:

glongman@intelligentworks.com

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()
boolean	isGeneric() Checks if the type represented by this property is in a generic declaration.
boolean	isPersistent() Returns true if 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 interface org.apache.hivemind.LocationHolder

setLocation

Methods inherited from interface org.apache.hivemind.Locatable

getLocation

Method Detail

getInitialValue

String getInitialValue()

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().

getName

String getName()

isPersistent

boolean isPersistent()

Returns true if getPersistence()is null.

getType

String getType()

setInitialValue

void setInitialValue(String initialValue)

setName

void setName(String name)

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

setType

void setType(String type)

setGeneric

void setGeneric(boolean isGeneric)

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

Parameters:

isGeneric -

isGeneric

boolean isGeneric()

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

Returns:

True if it is generic, false otherwise.

isProxyChecked

boolean isProxyChecked()

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

Returns:

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

setProxyChecked

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.

Parameters:

checked -

canProxy

boolean canProxy()

Checks if this parameter can be proxied.

Returns:

True if the type can be proxied, false otherwise.

setCanProxy

void setCanProxy(boolean canProxy)

Sets whether or not this property can be proxied.

Parameters:

canProxy -

setPersistence

void setPersistence(String persistence)

A string indicating how the property is persisted.

Since:

4.0

getPersistence

String getPersistence()

If null, then the property is not persistent.

Since:

4.0