\hypertarget{classorg_1_1libelektra_1_1KDB}{}\section{org.\+libelektra.\+K\+DB Class Reference}
\label{classorg_1_1libelektra_1_1KDB}\index{org.\+libelektra.\+K\+DB@{org.\+libelektra.\+K\+DB}}


Represents session with the \hyperlink{classorg_1_1libelektra_1_1Key}{Key} database.  




Inherits Auto\+Closeable.

\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{classorg_1_1libelektra_1_1KDB_a256255ad383403a2efe699c4ccc4fe12}{K\+DB} (final Pointer p)
\begin{DoxyCompactList}\small\item\em Helper constructor for duplication by pointer. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KDB_ad3dcc3e348d1c841c7eda0bb00c54167}\label{classorg_1_1libelektra_1_1KDB_ad3dcc3e348d1c841c7eda0bb00c54167}} 
void \hyperlink{classorg_1_1libelektra_1_1KDB_ad3dcc3e348d1c841c7eda0bb00c54167}{close} ()
\begin{DoxyCompactList}\small\item\em Clean-\/up function initiating closing of the \hyperlink{classorg_1_1libelektra_1_1KDB}{K\+DB} session. \end{DoxyCompactList}\item 
void \hyperlink{classorg_1_1libelektra_1_1KDB_ac3b5b3551a9fef5dae1fb468e74272f6}{get} (final \hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set} ks, final \hyperlink{classorg_1_1libelektra_1_1Key}{Key} parent\+Key)  throws K\+D\+B\+Exception 	
\begin{DoxyCompactList}\small\item\em Will fetch at least all keys that are sub-\/keys or children of sub-\/keys of the supplied parent key. \end{DoxyCompactList}\item 
void \hyperlink{classorg_1_1libelektra_1_1KDB_a4e7f86ca77f654bb11a38cdf6db6383f}{set} (final \hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set} ks, final \hyperlink{classorg_1_1libelektra_1_1Key}{Key} parent\+Key)  throws K\+D\+B\+Exception 	
\begin{DoxyCompactList}\small\item\em Will update changed keys of the given keyset in the backend. \end{DoxyCompactList}\item 
void \hyperlink{classorg_1_1libelektra_1_1KDB_af6b472eadf78ba4ed216303b52ddb29e}{close} (final \hyperlink{classorg_1_1libelektra_1_1Key}{Key} parent\+Key)
\begin{DoxyCompactList}\small\item\em Clean-\/up method that closes the \hyperlink{classorg_1_1libelektra_1_1KDB}{K\+DB} session. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static \hyperlink{classorg_1_1libelektra_1_1KDB}{K\+DB} \hyperlink{classorg_1_1libelektra_1_1KDB_ae7e6c1cea2b930a077aec11c3cbdef4b}{open} (final \hyperlink{classorg_1_1libelektra_1_1Key}{Key} parent\+Key)
\begin{DoxyCompactList}\small\item\em Basic constructor of \hyperlink{classorg_1_1libelektra_1_1KDB}{K\+DB} class~\newline
 Opens \hyperlink{classorg_1_1libelektra_1_1KDB}{K\+DB} session with the given parent\+Key to write possible warning and error information to. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Protected Member Functions}
\begin{DoxyCompactItemize}
\item 
Pointer \hyperlink{classorg_1_1libelektra_1_1KDB_a600abc786bde91a3122bd96be991a3d5}{get} ()
\begin{DoxyCompactList}\small\item\em Native pointer being used by J\+NA. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Represents session with the \hyperlink{classorg_1_1libelektra_1_1Key}{Key} database. 

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

\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KDB_a256255ad383403a2efe699c4ccc4fe12}\label{classorg_1_1libelektra_1_1KDB_a256255ad383403a2efe699c4ccc4fe12}} 
\index{org\+::libelektra\+::\+K\+DB@{org\+::libelektra\+::\+K\+DB}!K\+DB@{K\+DB}}
\index{K\+DB@{K\+DB}!org\+::libelektra\+::\+K\+DB@{org\+::libelektra\+::\+K\+DB}}
\subsubsection{\texorpdfstring{K\+D\+B()}{KDB()}}
{\footnotesize\ttfamily org.\+libelektra.\+K\+D\+B.\+K\+DB (\begin{DoxyParamCaption}\item[{final Pointer}]{p }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Helper constructor for duplication by pointer. 


\begin{DoxyParams}{Parameters}
{\em p} & Pointer to another \hyperlink{classorg_1_1libelektra_1_1KDB}{K\+DB} object \\
\hline
\end{DoxyParams}


\subsection{Member Function Documentation}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KDB_af6b472eadf78ba4ed216303b52ddb29e}\label{classorg_1_1libelektra_1_1KDB_af6b472eadf78ba4ed216303b52ddb29e}} 
\index{org\+::libelektra\+::\+K\+DB@{org\+::libelektra\+::\+K\+DB}!close@{close}}
\index{close@{close}!org\+::libelektra\+::\+K\+DB@{org\+::libelektra\+::\+K\+DB}}
\subsubsection{\texorpdfstring{close()}{close()}}
{\footnotesize\ttfamily void org.\+libelektra.\+K\+D\+B.\+close (\begin{DoxyParamCaption}\item[{final \hyperlink{classorg_1_1libelektra_1_1Key}{Key}}]{parent\+Key }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Clean-\/up method that closes the \hyperlink{classorg_1_1libelektra_1_1KDB}{K\+DB} session. 


\begin{DoxyParams}{Parameters}
{\em parent\+Key} & \hyperlink{classorg_1_1libelektra_1_1Key}{Key} holding error and warning information \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KDB_ac3b5b3551a9fef5dae1fb468e74272f6}\label{classorg_1_1libelektra_1_1KDB_ac3b5b3551a9fef5dae1fb468e74272f6}} 
\index{org\+::libelektra\+::\+K\+DB@{org\+::libelektra\+::\+K\+DB}!get@{get}}
\index{get@{get}!org\+::libelektra\+::\+K\+DB@{org\+::libelektra\+::\+K\+DB}}
\subsubsection{\texorpdfstring{get()}{get()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily void org.\+libelektra.\+K\+D\+B.\+get (\begin{DoxyParamCaption}\item[{final \hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}}]{ks,  }\item[{final \hyperlink{classorg_1_1libelektra_1_1Key}{Key}}]{parent\+Key }\end{DoxyParamCaption}) throws \hyperlink{classorg_1_1libelektra_1_1exception_1_1KDBException}{K\+D\+B\+Exception}\hspace{0.3cm}{\ttfamily [inline]}}



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


\begin{DoxyParams}{Parameters}
{\em ks} & \hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set} where the fetched keys will be stored in \\
\hline
{\em parent\+Key} & Root key which name will be used to fetch keys below it \\
\hline
\end{DoxyParams}

\begin{DoxyExceptions}{Exceptions}
{\em K\+D\+B\+Exception} & In case of an error when loading keys \\
\hline
\end{DoxyExceptions}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KDB_a600abc786bde91a3122bd96be991a3d5}\label{classorg_1_1libelektra_1_1KDB_a600abc786bde91a3122bd96be991a3d5}} 
\index{org\+::libelektra\+::\+K\+DB@{org\+::libelektra\+::\+K\+DB}!get@{get}}
\index{get@{get}!org\+::libelektra\+::\+K\+DB@{org\+::libelektra\+::\+K\+DB}}
\subsubsection{\texorpdfstring{get()}{get()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily Pointer org.\+libelektra.\+K\+D\+B.\+get (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [protected]}}



Native pointer being used by J\+NA. 

\begin{DoxyReturn}{Returns}
Native pointer object 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KDB_ae7e6c1cea2b930a077aec11c3cbdef4b}\label{classorg_1_1libelektra_1_1KDB_ae7e6c1cea2b930a077aec11c3cbdef4b}} 
\index{org\+::libelektra\+::\+K\+DB@{org\+::libelektra\+::\+K\+DB}!open@{open}}
\index{open@{open}!org\+::libelektra\+::\+K\+DB@{org\+::libelektra\+::\+K\+DB}}
\subsubsection{\texorpdfstring{open()}{open()}}
{\footnotesize\ttfamily static \hyperlink{classorg_1_1libelektra_1_1KDB}{K\+DB} org.\+libelektra.\+K\+D\+B.\+open (\begin{DoxyParamCaption}\item[{final \hyperlink{classorg_1_1libelektra_1_1Key}{Key}}]{parent\+Key }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [static]}}



Basic constructor of \hyperlink{classorg_1_1libelektra_1_1KDB}{K\+DB} class~\newline
 Opens \hyperlink{classorg_1_1libelektra_1_1KDB}{K\+DB} session with the given parent\+Key to write possible warning and error information to. 


\begin{DoxyParams}{Parameters}
{\em parent\+Key} & Parent key being used for this \hyperlink{classorg_1_1libelektra_1_1KDB}{K\+DB} session; it is used to store warning and error information \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
New \hyperlink{classorg_1_1libelektra_1_1KDB}{K\+DB} session object 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KDB_a4e7f86ca77f654bb11a38cdf6db6383f}\label{classorg_1_1libelektra_1_1KDB_a4e7f86ca77f654bb11a38cdf6db6383f}} 
\index{org\+::libelektra\+::\+K\+DB@{org\+::libelektra\+::\+K\+DB}!set@{set}}
\index{set@{set}!org\+::libelektra\+::\+K\+DB@{org\+::libelektra\+::\+K\+DB}}
\subsubsection{\texorpdfstring{set()}{set()}}
{\footnotesize\ttfamily void org.\+libelektra.\+K\+D\+B.\+set (\begin{DoxyParamCaption}\item[{final \hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}}]{ks,  }\item[{final \hyperlink{classorg_1_1libelektra_1_1Key}{Key}}]{parent\+Key }\end{DoxyParamCaption}) throws \hyperlink{classorg_1_1libelektra_1_1exception_1_1KDBException}{K\+D\+B\+Exception}\hspace{0.3cm}{\ttfamily [inline]}}



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

\hyperlink{classorg_1_1libelektra_1_1KDB_a600abc786bde91a3122bd96be991a3d5}{get()} has to be called before this function may be executed.


\begin{DoxyParams}{Parameters}
{\em ks} & \hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set} which contains keys to be updated in the backend \\
\hline
{\em parent\+Key} & Is used to add warnings and set an error, if necessary \\
\hline
\end{DoxyParams}

\begin{DoxyExceptions}{Exceptions}
{\em K\+D\+B\+Exception} & In case of an error when storing keys \\
\hline
\end{DoxyExceptions}


The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
K\+D\+B.\+java\end{DoxyCompactItemize}
