org.cytoscape.property

Class SimpleCyProperty<P>

java.lang.Object

org.cytoscape.property.SimpleCyProperty<P>

Type Parameters:

P -

All Implemented Interfaces:

CyProperty<P>

public final class SimpleCyProperty<P>
extends Object
implements CyProperty<P>

A simple implementation of CyProperty suitable for general purpose use.

Cytoscape Backwards Compatibility (Final Class): This class is final and therefore can't be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.

Nested Class Summary

Nested classes/interfaces inherited from interface org.cytoscape.property.CyProperty

CyProperty.SavePolicy

Field Summary

Fields

Modifier and Type	Field and Description
static String	CORE_PROPRERTY_NAME Core Cytoscape Property (Cytoscape System Property)

Fields inherited from interface org.cytoscape.property.CyProperty

DEFAULT_PROPS_CONFIG_DIR

Constructor Summary

Constructors

Constructor and Description
SimpleCyProperty(String name, P properties, Class<? extends P> propertyType, CyProperty.SavePolicy savePolicy) Properties is a non-null Properties object that this CyProperty object should encapsulate.

Method Summary

Modifier and Type	Method and Description
String	getName() Returns the name of the CyProperty.
P	getProperties() Return a property object.
Class<? extends P>	getPropertyType() Returns the type of the property object.
CyProperty.SavePolicy	getSavePolicy() Returns the CyProperty.SavePolicy of the CyProperty.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CORE_PROPRERTY_NAME

public static final String CORE_PROPRERTY_NAME

Core Cytoscape Property (Cytoscape System Property)

See Also:

Constant Field Values

Constructor Detail

SimpleCyProperty

public SimpleCyProperty(String name,
                        P properties,
                        Class<? extends P> propertyType,
                        CyProperty.SavePolicy savePolicy)

Properties is a non-null Properties object that this CyProperty object should encapsulate.

Parameters:

properties - The non-null Properties object this CyProperty object should encapsulate. Throws NullPointerException if Properties is null.

savePolicy - the CyProperty.SavePolicy of this CyProperty object.

Method Detail

getName

public String getName()

Returns the name of the CyProperty.

Specified by:

getName in interface CyProperty<P>

Returns:

The name of the CyProperty.

getProperties

public P getProperties()

Return a property object.

Specified by:

getProperties in interface CyProperty<P>

Returns:

A property object of type P.

getSavePolicy

public CyProperty.SavePolicy getSavePolicy()

Returns the CyProperty.SavePolicy of the CyProperty.

Specified by:

getSavePolicy in interface CyProperty<P>

Returns:

the CyProperty.SavePolicy of the CyProperty.

getPropertyType

public Class<? extends P> getPropertyType()

Returns the type of the property object.

Specified by:

getPropertyType in interface CyProperty<P>

Returns:

the type of the property object.

toString

public String toString()

Overrides:

toString in class Object