ca.nengo.config.impl

Class AbstractProperty

java.lang.Object

ca.nengo.config.impl.AbstractProperty

All Implemented Interfaces:

Property

Direct Known Subclasses:

ListPropertyImpl, NamedValuePropertyImpl, SingleValuedPropertyImpl, TemplateArrayProperty, TemplateProperty

public abstract class AbstractProperty
extends java.lang.Object
implements Property

Base implementation of Property.

Constructor Summary

Constructors

Constructor and Description
AbstractProperty(Configuration configuration, java.lang.String name, java.lang.Class<?> c, boolean mutable)

Method Summary

Methods

Modifier and Type	Method and Description
protected Configuration	getConfiguration()
protected java.lang.String	getDefaultDocumentation(java.lang.reflect.Method[] methods)
java.lang.String	getDocumentation()
java.lang.String	getName()
java.lang.Class<?>	getType()
boolean	isMutable()
void	setDocumentation(java.lang.String text)
void	setName(java.lang.String name)

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.nengo.config.Property

isFixedCardinality

Constructor Detail

AbstractProperty

public AbstractProperty(Configuration configuration,
                java.lang.String name,
                java.lang.Class<?> c,
                boolean mutable)

Parameters:

configuration - Configuration to which the Property belongs

name - Name of the Property

c - Type of the Property

mutable - Whether the Property value(s) can be modified

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface Property

Returns:

Property name

See Also:

Property.getName()

setName

public void setName(java.lang.String name)

Specified by:

setName in interface Property

Parameters:

name - New Property name

See Also:

Property.setName(java.lang.String)

getType

public java.lang.Class<?> getType()

Specified by:

getType in interface Property

Returns:

Class to which values belong

See Also:

Property.getType()

isMutable

public boolean isMutable()

Specified by:

isMutable in interface Property

Returns:

True if values can be changed after construction of the Configurable

See Also:

Property.isMutable()

getConfiguration

protected Configuration getConfiguration()

getDocumentation

public java.lang.String getDocumentation()

Specified by:

getDocumentation in interface Property

Returns:

Text describing the property semantics (plain text or HTML)

See Also:

Property.getDocumentation()

setDocumentation

public void setDocumentation(java.lang.String text)

Parameters:

text - New documentation text (can be plain text or HTML)

getDefaultDocumentation

protected java.lang.String getDefaultDocumentation(java.lang.reflect.Method[] methods)

Parameters:

methods - The methods that underlie this property

Returns:

A default documentation string composed of javadocs for these methods