org.apache.tuscany.model.assembly
Interface Property

All Superinterfaces:

AssemblyObject, Extensible

All Known Implementing Classes:

PropertyImpl

public interface Property
extends Extensible

A description of a property that can be used to configure a component.

Method Summary

java.lang.Object	getDefaultValue() Returns the default value of the property.
java.lang.String	getName() Returns the property name.
java.lang.Class<?>	getType() Returns the type of this property as used by the runtime.
boolean	isMany() Returns true if the property allows multiple values.
boolean	isRequired() Returns true if a value must be supplied for the property.
void	setDefaultValue(java.lang.Object value) Sets the default value of the property.
void	setMany(boolean value) Sets whether or not the property allows multiple values.
void	setName(java.lang.String name) Sets the property name.
void	setRequired(boolean value) Sets whether a value must be supplied for the property.
void	setType(java.lang.Class<?> value) Sets the type of this property as used by the runtime

Methods inherited from interface org.apache.tuscany.model.assembly.Extensible

getExtensibilityAttributes, getExtensibilityElements

Methods inherited from interface org.apache.tuscany.model.assembly.AssemblyObject

accept, freeze, initialize

Method Detail

getName

java.lang.String getName()

Returns the property name.

Returns:

the property name

setName

void setName(java.lang.String name)

Sets the property name.

Parameters:

name - the property name

getDefaultValue

java.lang.Object getDefaultValue()

Returns the default value of the property.

Returns:

the default value of ths property

setDefaultValue

void setDefaultValue(java.lang.Object value)

Sets the default value of the property.

Parameters:

value - the default value of ths property

isMany

boolean isMany()

Returns true if the property allows multiple values.

Returns:

true if the property allows multiple values

setMany

void setMany(boolean value)

Sets whether or not the property allows multiple values.

Parameters:

value - true if the property should allow multiple values

isRequired

boolean isRequired()

Returns true if a value must be supplied for the property.

Returns:

true is a value must be supplied for the property

setRequired

void setRequired(boolean value)

Sets whether a value must be supplied for the property. For ease of use, it is recommended that a meaningful default value should be supplied for all properties; users should only be required to specify a value if there is no reasonable default.

Parameters:

value - set to true to require that a value be supplied for uses of this property

getType

java.lang.Class<?> getType()

Returns the type of this property as used by the runtime.

Returns:

the type of this property as used by the runtime

setType

void setType(java.lang.Class<?> value)

Sets the type of this property as used by the runtime

Parameters:

value - the type of this property as used by the runtime