com.ben12.reta.plugin

Interface SourceProviderPlugin

public interface SourceProviderPlugin

Plug-in interface to implement.

Author:

Benoît Moreau (ben.12)

Method Summary

Modifier and Type	Method and Description
SourceConfiguration	createNewSourceConfiguration() Creation of an empty or default SourceConfiguration for this plug-in.
RETAParser	createParser(SourceConfiguration configuration) Create a new parser for the requirement source configuration.
javafx.scene.Node	createSourceConfigurationEditor(SourceConfiguration sourceConfiguration, BufferingManager bufferingManager) Create a new JavaFX GUI for the edition of the SourceConfiguration of this plug-in.
String	getSourceName()
SourceConfiguration	loadSourceConfiguration(org.ini4j.Profile.Section iniSection) Load the SourceConfiguration of this plug-in from the dedicated INI section.
void	saveSourceConfiguration(SourceConfiguration sourceConfiguration, org.ini4j.Profile.Section iniSection) Save the SourceConfiguration of this plug-in in the dedicated INI section.

Method Detail

getSourceName

String getSourceName()

Returns:

source name exposed to users

saveSourceConfiguration

void saveSourceConfiguration(SourceConfiguration sourceConfiguration,
                             org.ini4j.Profile.Section iniSection)

Save the SourceConfiguration of this plug-in in the dedicated INI section.

Parameters:

sourceConfiguration - source configuration to save

iniSection - INI section where source configuration must be saved

loadSourceConfiguration

SourceConfiguration loadSourceConfiguration(org.ini4j.Profile.Section iniSection)

Load the SourceConfiguration of this plug-in from the dedicated INI section.

Parameters:

iniSection - INI section where source configuration must be read

Returns:

source configuration read

createNewSourceConfiguration

SourceConfiguration createNewSourceConfiguration()

Creation of an empty or default SourceConfiguration for this plug-in.

Returns:

new source configuration

createSourceConfigurationEditor

javafx.scene.Node createSourceConfigurationEditor(SourceConfiguration sourceConfiguration,
                                                  BufferingManager bufferingManager)

Create a new JavaFX GUI for the edition of the SourceConfiguration of this plug-in.

Parameters:

sourceConfiguration - source configuration to edit

bufferingManager - buffering manager to use

Returns:

JavaFX GUI for source configuration edition

createParser

RETAParser createParser(SourceConfiguration configuration)

Create a new parser for the requirement source configuration.

Parameters:

configuration - source configuration to use

Returns:

the parser to use for the requirement source configuration