Package org.cytoscape.property

Interface CyProperty<P>

Type Parameters:

P - The generic type for the CyProperty. Generally one of two types: Properties or Bookmarks, although it is possible for property objects of other types to be registered in this way as well.

All Known Implementing Classes:

AbstractConfigDirPropsReader, SimpleCyProperty

public interface CyProperty<P>

A general property service interface for providing access to different types of property objects as OSGi services. The type P is generally one of two types: Properties or Bookmarks, although it is possible for property objects of other types to be registered in this way as well.

Cytoscape Backwards Compatibility (SPI Interface): We expect that this interface will be implemented. Therefore to maintain backwards compatibility this interface will only be modified for major version updates.

Module: property-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>property-api</artifactId>
</dependency>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	CyProperty.SavePolicy	SavePolicy specifies how the CyProperty will be saved, or if it will not be saved.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_PROPS_CONFIG_DIR	The name of the default directory where we will look for properties files.

Method Summary

Modifier and Type	Method	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.

Field Details

DEFAULT_PROPS_CONFIG_DIR

static final String DEFAULT_PROPS_CONFIG_DIR

The name of the default directory where we will look for properties files. This will be a subdirectory of the "user.home" directory defined in the default Java system properties (System.getProperties()).

See Also:

• Constant Field Values

Method Details

getName

String getName()

Returns the name of the CyProperty.

Returns:

The name of the CyProperty.

getProperties

P getProperties()

Return a property object.

Returns:

A property object of type P.

getSavePolicy

CyProperty.SavePolicy getSavePolicy()

Returns the CyProperty.SavePolicy of the CyProperty.

Returns:

the CyProperty.SavePolicy of the CyProperty.

getPropertyType

Class<? extends P> getPropertyType()

Returns the type of the property object.

Returns:

the type of the property object.