org.libelektra.Plugin Interface Reference

This is a Java representation of a plugin. More...

Inheritance diagram for org.libelektra.Plugin:

Public Member Functions
KeySet	getConfig ()
	Gets the config which was used to configure the plugin. More...
int	open (KeySet conf, Key errorKey)
	Calls the open function of the plugin. More...
int	get (KeySet ks, Key parentKey) throws KDBException
	Calls the get function of the plugin. More...
int	set (KeySet ks, Key parentKey) throws KDBException
	Calls the set function of the plugin. More...
int	error (KeySet ks, Key parentKey)
	Calls the error function of the plugin. More...
int	close (Key parentKey)
	Calls the close function of the plugin. More...
String	getName ()
	Returns the plugin name. More...

Detailed Description

This is a Java representation of a plugin.

Member Function Documentation

close()

int org.libelektra.Plugin.close

(

Key

parentKey

)

Calls the close function of the plugin.

Parameters

parentKey

a key

Returns

the plugin's return value for close

Implemented in org.libelektra.plugin.NativePlugin.

error()

int org.libelektra.Plugin.error	(	KeySet	ks,
		Key	parentKey
	)

Calls the error function of the plugin.

Parameters

ks	a keyset
parentKey	a key

Returns

the plugin's return value for error

Implemented in org.libelektra.plugin.NativePlugin.

get()

int org.libelektra.Plugin.get	(	KeySet	ks,
		Key	parentKey
	)		throws KDBException

Calls the get function of the plugin.

Parameters

ks	a keyset
parentKey	a key

Exceptions

KDBException

when Elektra could not set the keyset

Returns

the plugin's return value for get

Implemented in org.libelektra.plugin.NativePlugin.

getConfig()

KeySet org.libelektra.Plugin.getConfig

(

)

Gets the config which was used to configure the plugin.

Returns

A KeySet containing the configuration of the plugin

Implemented in org.libelektra.plugin.NativePlugin.

getName()

String org.libelektra.Plugin.getName

(

)

Returns the plugin name.

Returns

plugin name

Implemented in org.libelektra.plugin.NativePlugin.

open()

int org.libelektra.Plugin.open	(	KeySet	conf,
		Key	errorKey
	)

Calls the open function of the plugin.

Parameters

conf	a configuration keyset
errorKey	a key

Returns

the plugin's return value for open

Implemented in org.libelektra.plugin.NativePlugin.

set()

int org.libelektra.Plugin.set	(	KeySet	ks,
		Key	parentKey
	)		throws KDBException

Calls the set function of the plugin.

Parameters

ks	a keyset
parentKey	a key

Exceptions

KDBException

when Elektra could not set the keyset

Returns

the plugin's return value for set

Implemented in org.libelektra.plugin.NativePlugin.

---

The documentation for this interface was generated from the following file:

• Plugin.java