org.cytoscape.io.read
Interface CyPropertyReader

All Superinterfaces:

Task

public interface CyPropertyReader
extends Task

An extension of the Task interface that returns a property object. The type of the object returned can be be anything, but will in practice be Properties, Bookmarks, org.cytoscape.property.session.Cysession. The system determines the specific object type based on the CyFileFilter associated with the InputStreamTaskFactory service that produces this reader. Instances of this interface are created by InputStreamTaskFactory objects registered as OSGi services, which are in turn processed by associated reader manager objects that distinguish InputStreamTaskFactories based on the DataCategory associated with the CyFileFilter.

Module: io-api

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

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

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.

Method Summary

Object

getProperty() Return a property object.

Methods inherited from interface org.cytoscape.work.Task

cancel, run

Method Detail

getProperty

Object getProperty()

Return a property object.

Returns:

A property object. The type can be be anything, but in practice will be Properties, Bookmarks, and org.cytoscape.property.session.Cysession.