Package jetbrains.mps.extapi.persistence

Class DataSourceBase

java.lang.Object

jetbrains.mps.extapi.persistence.DataSourceBase

All Implemented Interfaces:

DataSource

Direct Known Subclasses:

FileDataSource, FolderDataSource, FolderSetDataSource, SingleStreamSource

public abstract class DataSourceBase
extends Object
implements DataSource

A base convenience class for data sources with empty implementations for all methods.

Constructor Summary

Constructors

Constructor	Description
DataSourceBase()

Method Summary

Modifier and Type	Method	Description
void	addListener(DataSourceListener listener)	Registers listeners who need to be notified about changes in the underlying data source.
String	getLocation()	Yields a string representation for the location of the data source (if applicable)
long	getTimestamp()	Retrieves the last modification timestamp.
DataSourceType	getType()	Defines a data source type for this kind of data sources.
boolean	isReadOnly()	TODO Makes sense only with API which introduce changes to the DataSource.
void	refresh()
void	removeListener(DataSourceListener listener)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSourceBase

public DataSourceBase()

Method Detail

addListener

public void addListener(@NotNull
                        DataSourceListener listener)

Description copied from interface: DataSource

Registers listeners who need to be notified about changes in the underlying data source. It is the responsibility of the DataSource to detect such updates and notify the listeners.

Specified by:

addListener in interface DataSource

removeListener

public void removeListener(@NotNull
                           DataSourceListener listener)

Specified by:

removeListener in interface DataSource

getType

@Nullable
public DataSourceType getType()

Description copied from interface: DataSource

Defines a data source type for this kind of data sources. The data source type notion is strongly associated with the possibility to provide DataSourceFactory and ModelFactory custom mappings. See DataSourceFactoryRuleService and ModelFactoryService for the implementation details.

Specified by:

getType in interface DataSource

Returns:

the unique data source type for this instance of data source if the developer wants others to be able to change the default behavior of this data source (register with the same key) or if he desires to associate this data source with some specific model factory.

getTimestamp

public long getTimestamp()

Description copied from interface: DataSource

Retrieves the last modification timestamp. The timestamp should reliably reflect all external changes to the data source.

Specified by:

getTimestamp in interface DataSource

Returns:

0 if timestamp is not supported for the source, or -1 if the source is dead (like when file is deleted)

refresh

public void refresh()

getLocation

@NotNull
public String getLocation()

Description copied from interface: DataSource

Yields a string representation for the location of the data source (if applicable)

Specified by:

getLocation in interface DataSource

isReadOnly

public boolean isReadOnly()

Description copied from interface: DataSource

TODO Makes sense only with API which introduce changes to the DataSource. Currently it is incomplete. Usually there is a possibility to edit DataSource. For examples please see StreamDataSource.

Specified by:

isReadOnly in interface DataSource

Returns:

whether this data source can be changed.

toString

public String toString()

Overrides:

toString in class Object