org.libelektra.KDB Class Reference

Represents session with the Key database. More...

Inherits AutoCloseable.

Public Member Functions
	KDB (final Pointer p)
	Helper constructor for duplication by pointer. More...
void	close () throws KDBException
	Clean-up function initiating closing of the KDB session. More...
void	get (final KeySet ks, final Key parentKey) throws KDBException
	Will fetch at least all keys that are sub-keys or children of sub-keys of the supplied parent key. More...
void	set (final KeySet ks, final Key parentKey) throws KDBException
	Will update changed keys of the given keyset in the backend. More...
void	close (final Key parentKey) throws KDBException
	Clean-up method that closes the KDB session. More...

Static Public Member Functions
static KDB	open (final Key errorKey) throws KDBException
	Basic constructor of KDB class Opens KDB session with the given errorKey to write possible warning and error information to. More...
static KDB	open (final KeySet contract, final Key errorKey) throws KDBException
	Basic constructor of KDB class Opens KDB session with the given errorKey to write possible warning and error information to. More...
static void	goptsContract (final KeySet contract, final String[] args, final String[] env, final Key parentKey, final KeySet goptsConfig)
	Creates a contract for use with KDB#open that mounts and configures the gopts plugin. More...

Protected Member Functions
Pointer	get ()
	Native pointer being used by JNA. More...

Detailed Description

Represents session with the Key database.

Close after usage, or simply use a try-with-resources statement.

Constructor & Destructor Documentation

KDB()

org.libelektra.KDB.KDB ( final Pointer  p )

inline

Helper constructor for duplication by pointer.

Parameters

p	Pointer to another KDB object

Member Function Documentation

close() [1/2]

void org.libelektra.KDB.close ( ) throws KDBException

inline

Clean-up function initiating closing of the KDB session.

Exceptions

KDBException

TODO #3754 detailed exception description (including appropriate subtypes)

close() [2/2]

void org.libelektra.KDB.close ( final Key  parentKey ) throws KDBException

inline

Clean-up method that closes the KDB session.

Parameters

parentKey

Key holding error and warning information

Exceptions

KDBException

TODO #3754 detailed exception description (including appropriate subtypes)

get() [1/2]

void org.libelektra.KDB.get ( final KeySet  ks, final Key  parentKey  ) throws KDBException

inline

Will fetch at least all keys that are sub-keys or children of sub-keys of the supplied parent key.

Parameters

ks	KeySet where the fetched keys will be stored in
parentKey	Root key which name will be used to fetch keys below it

Exceptions

KDBException

In case of an error when loading keys

get() [2/2]

Pointer org.libelektra.KDB.get ( )

inlineprotected

Native pointer being used by JNA.

Returns

Native pointer object

goptsContract()

static void org.libelektra.KDB.goptsContract ( final KeySet  contract, final String []  args, final String []  env, final Key  parentKey, final KeySet  goptsConfig  )

inlinestatic

Creates a contract for use with KDB#open that mounts and configures the gopts plugin.

Parameters

contract	the KeySet into which the contract is written
args	the arguments that will be converted into argc and argv for gopts
env	the environment variables that gopts will use
parentKey	the parent key that gopts will use
goptsConfig	the config KeySet used for mounting gopts

Exceptions

IllegalArgumentException

if any of the arguments are null

open() [1/2]

static KDB org.libelektra.KDB.open ( final Key  errorKey ) throws KDBException

inlinestatic

Basic constructor of KDB class
Opens KDB session with the given errorKey to write possible warning and error information to.

Parameters

errorKey

used to store warning and error information

Returns

New KDB session object

Exceptions

KDBException

TODO #3754 detailed exception description (including appropriate subtypes)

open() [2/2]

static KDB org.libelektra.KDB.open ( final KeySet  contract, final Key  errorKey  ) throws KDBException

inlinestatic

Basic constructor of KDB class
Opens KDB session with the given errorKey to write possible warning and error information to.

Parameters

contract	the contract that will be ensured by kdbOpen()
errorKey	used to store warning and error information

Returns

New KDB session object

Exceptions

KDBException

TODO #3754 detailed exception description (including appropriate subtypes)

set()

void org.libelektra.KDB.set ( final KeySet  ks, final Key  parentKey  ) throws KDBException

inline

Will update changed keys of the given keyset in the backend.

get() has to be called before this function may be executed.

Parameters

ks	KeySet which contains keys to be updated in the backend
parentKey	Is used to add warnings and set an error, if necessary

Exceptions

KDBException

In case of an error when storing keys

---

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

• KDB.java