Scroll to navigation

org.libelektra.KDB(3elektra) Elektra org.libelektra.KDB(3elektra)

NAME

org.libelektra.KDB - Represents session with the Key database.

SYNOPSIS

Inherits AutoCloseable.

Public Member Functions


KDB (final Pointer p)
Helper constructor for duplication by pointer. void close ()
Clean-up function initiating closing of the KDB session. 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. void set (final KeySet ks, final Key parentKey) throws KDBException
Will update changed keys of the given keyset in the backend. void close (final Key parentKey)
Clean-up method that closes the KDB session.

Static Public Member Functions


static KDB open (final Key parentKey)
Basic constructor of KDB class
Opens KDB session with the given parentKey to write possible warning and error information to. "

Protected Member Functions


Pointer get ()
Native pointer being used by JNA.

Detailed Description

Represents session with the Key database.

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

Constructor & Destructor Documentation

org.libelektra.KDB.KDB (final Pointer p) [inline]

Helper constructor for duplication by pointer.

Parameters:

p Pointer to another KDB object

Member Function Documentation

void org.libelektra.KDB.close (final Key parentKey) [inline]

Clean-up method that closes the KDB session.

Parameters:

parentKey Key holding error and warning information

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

Pointer org.libelektra.KDB.get () [inline], [protected]

Native pointer being used by JNA.

Returns:

Native pointer object

static KDB org.libelektra.KDB.open (final Key parentKey) [inline], [static]

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

Parameters:

parentKey Parent key being used for this KDB session; it is used to store warning and error information

Returns:

New KDB session object

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

Author

Generated automatically by Doxygen for Elektra from the source code.

Mon Jan 15 2018 Version 0.8.20