\hypertarget{classorg_1_1libelektra_1_1KeySet}{}\doxysection{org.\+libelektra.\+Key\+Set Class Reference}
\label{classorg_1_1libelektra_1_1KeySet}\index{org.libelektra.KeySet@{org.libelektra.KeySet}}


Java representation of a native \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Elektra}{Elektra}} key set, a container for keys.  




Inherits Iterable$<$ Key $>$.

\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
void \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_aa3851e13c627e32f02275636806e30cc}{release}} ()
\begin{DoxyCompactList}\small\item\em Clean-\/up method to release key set reference by trying to free the native reference~\newline
 ~\newline
 Call this method if you have obtained a \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} via any of its public methods or \mbox{\hyperlink{classorg_1_1libelektra_1_1KDB_a1668a8f1b44e082d577f58b1963141dd}{KDB\#get(\+Key)}} and you do not longer need it. \end{DoxyCompactList}\item 
Iterator$<$ \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} $>$ \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_a1a3b37dff55df600c4fee6bea714a8d9}{iterator}} ()
\item 
String \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_a9c1e2918acce8c7cda5be406989c87af}{to\+String}} ()
\begin{DoxyCompactList}\small\item\em Iterates though all keys in this key set and appends their representation to the output. \end{DoxyCompactList}\item 
\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_af3571c68cd55983c45666cf9f75143a1}{dup}} ()
\begin{DoxyCompactList}\small\item\em Duplicates the key set. \end{DoxyCompactList}\item 
\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_a344a72a98a01a1a1a0e6526ff22eb55e}{copy}} (\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} source)
\begin{DoxyCompactList}\small\item\em Copies key references from. \end{DoxyCompactList}\item 
int \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_a9244d4c9a07e61c5842dcd2fc620e4d6}{size}} ()
\begin{DoxyCompactList}\small\item\em Indicates the key set size. \end{DoxyCompactList}\item 
\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_a0eff916445842bb1e47fe398efc19538}{append}} (\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} key)
\begin{DoxyCompactList}\small\item\em Append key to key set. \end{DoxyCompactList}\item 
\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_a7457ab3aa74323af26c80b05fe5607b5}{append}} (\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} source)
\begin{DoxyCompactList}\small\item\em Appends keys from key set. \end{DoxyCompactList}\item 
\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_acb8551293dbbf6e9fd95c588f7dfa2dd}{cut}} (\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} cutpoint)
\begin{DoxyCompactList}\small\item\em Creates new key set with help of a cut point. \end{DoxyCompactList}\item 
\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_a1302d1a59480851a0de54dcad2a50b6d}{remove}} (int cursor)
\begin{DoxyCompactList}\small\item\em Returns key from key set and also removes it from the set. \end{DoxyCompactList}\item 
\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_a8536b95ff54ef2cc80004d0dbfac736d}{first}} ()
\begin{DoxyCompactList}\small\item\em Gets the key set head key. \end{DoxyCompactList}\item 
\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_ab4d9dcee5031e7b910c14672810bfb7c}{last}} ()
\begin{DoxyCompactList}\small\item\em Gets the key set tail key. \end{DoxyCompactList}\item 
\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_ae6e95674082204841f208f59fcc416cb}{at}} (int cursor)
\begin{DoxyCompactList}\small\item\em Gets the key at the given cursor position. \end{DoxyCompactList}\item 
Optional$<$ \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} $>$ \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_a0d56925d157879f71c0fb68360dcf3bf}{lookup}} (\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} find)
\begin{DoxyCompactList}\small\item\em Search for a key in the key set. \end{DoxyCompactList}\item 
Optional$<$ \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} $>$ \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_a5a75e55a138cc6516a4bf92e74f3bc3a}{lookup}} (\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} find, int options)
\begin{DoxyCompactList}\small\item\em Search for a key in the key set. \end{DoxyCompactList}\item 
Optional$<$ \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} $>$ \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_a50a2c161fdd8d48cddf2c6980822a107}{lookup}} (String find)
\begin{DoxyCompactList}\small\item\em Search for a key in the key set. \end{DoxyCompactList}\item 
Optional$<$ \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} $>$ \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_a805133ecb4d93a999072155ceb1d0240}{lookup}} (String find, int options)
\begin{DoxyCompactList}\small\item\em Search for a key in the key set. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_a97739afd3f44984c424b3b90ee784f70}{create}} (Key... keys)
\begin{DoxyCompactList}\small\item\em Constructs a new \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} containing the specified \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{keys}}~\newline
 ~\newline
 Example\+: \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} key\+Set = \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_a97739afd3f44984c424b3b90ee784f70}{Key\+Set.\+create}}(\mbox{\hyperlink{classorg_1_1libelektra_1_1Key_ae62b6596937d48b5a24af97e6341d37a}{Key.\+create}}(\char`\"{}\+A\char`\"{}), \mbox{\hyperlink{classorg_1_1libelektra_1_1Key_ae62b6596937d48b5a24af97e6341d37a}{Key.\+create}}(\char`\"{}\+B\char`\"{}));. \end{DoxyCompactList}\item 
static \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_ae6858ba2c52f97ccca3cf5d3c3582f0e}{create}} (int allocation\+Hint, Key... keys)
\begin{DoxyCompactList}\small\item\em Constructs a new \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} containing the specified \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{keys}}~\newline
 ~\newline
 Example\+: \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} key\+Set = \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_a97739afd3f44984c424b3b90ee784f70}{Key\+Set.\+create}}(10, \mbox{\hyperlink{classorg_1_1libelektra_1_1Key_ae62b6596937d48b5a24af97e6341d37a}{Key.\+create}}(\char`\"{}\+A\char`\"{}), \mbox{\hyperlink{classorg_1_1libelektra_1_1Key_ae62b6596937d48b5a24af97e6341d37a}{Key.\+create}}(\char`\"{}\+B\char`\"{}));. \end{DoxyCompactList}\item 
static \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_ac0ba4b88bef5e731b586f4ca63b9ab7f}{create}} ()
\begin{DoxyCompactList}\small\item\em Constructs an empty \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} with a default allocation hint of 16. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Protected Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_af3aac3e0a3d9a65981478b114697332a}{Key\+Set}} (long native\+Pointer)
\begin{DoxyCompactList}\small\item\em Constructor associating a new \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} instance with a native pointer in long format. \end{DoxyCompactList}\item 
\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_a9e480cfc208b2f11a1be3045bd7d7ac9}{Key\+Set}} (long native\+Pointer, boolean suppress\+Clean\+Up)
\begin{DoxyCompactList}\small\item\em Constructor associating a new \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} instance with a native pointer in long format~\newline
 ~\newline
 Suppressing clean-\/up has been introduced for usage of this binding as JNI plug-\/in and should normally not be used in any other case. \end{DoxyCompactList}\item 
\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_a56bdc110d4882fef8be458fe639fab88}{Key\+Set}} (Pointer pointer)
\begin{DoxyCompactList}\small\item\em Constructor associating a new \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} instance with a JNA pointer. \end{DoxyCompactList}\item 
Pointer \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_ae48a42eace65f38a2cb23ba6dd432271}{get\+Pointer}} ()
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Java representation of a native \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Elektra}{Elektra}} key set, a container for keys. 

\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_af3aac3e0a3d9a65981478b114697332a}\label{classorg_1_1libelektra_1_1KeySet_af3aac3e0a3d9a65981478b114697332a}} 
\index{org.libelektra.KeySet@{org.libelektra.KeySet}!KeySet@{KeySet}}
\index{KeySet@{KeySet}!org.libelektra.KeySet@{org.libelektra.KeySet}}
\doxysubsubsection{\texorpdfstring{KeySet()}{KeySet()}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}}
{\footnotesize\ttfamily org.\+libelektra.\+Key\+Set.\+Key\+Set (\begin{DoxyParamCaption}\item[{long}]{native\+Pointer }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [protected]}}



Constructor associating a new \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} instance with a native pointer in long format. 


\begin{DoxyParams}{Parameters}
{\em native\+Pointer} & Native pointer to key set in long format \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a9e480cfc208b2f11a1be3045bd7d7ac9}\label{classorg_1_1libelektra_1_1KeySet_a9e480cfc208b2f11a1be3045bd7d7ac9}} 
\index{org.libelektra.KeySet@{org.libelektra.KeySet}!KeySet@{KeySet}}
\index{KeySet@{KeySet}!org.libelektra.KeySet@{org.libelektra.KeySet}}
\doxysubsubsection{\texorpdfstring{KeySet()}{KeySet()}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}}
{\footnotesize\ttfamily org.\+libelektra.\+Key\+Set.\+Key\+Set (\begin{DoxyParamCaption}\item[{long}]{native\+Pointer,  }\item[{boolean}]{suppress\+Clean\+Up }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [protected]}}



Constructor associating a new \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} instance with a native pointer in long format~\newline
 ~\newline
 Suppressing clean-\/up has been introduced for usage of this binding as JNI plug-\/in and should normally not be used in any other case. 


\begin{DoxyParams}{Parameters}
{\em native\+Pointer} & Native pointer to key set in long format \\
\hline
{\em suppress\+Clean\+Up} & True to suppress native reference clean-\/up as soon as this \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} instance becomes phantom reachable, false otherwise \\
\hline
\end{DoxyParams}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_aa3851e13c627e32f02275636806e30cc}{release()}} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a56bdc110d4882fef8be458fe639fab88}\label{classorg_1_1libelektra_1_1KeySet_a56bdc110d4882fef8be458fe639fab88}} 
\index{org.libelektra.KeySet@{org.libelektra.KeySet}!KeySet@{KeySet}}
\index{KeySet@{KeySet}!org.libelektra.KeySet@{org.libelektra.KeySet}}
\doxysubsubsection{\texorpdfstring{KeySet()}{KeySet()}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}}
{\footnotesize\ttfamily org.\+libelektra.\+Key\+Set.\+Key\+Set (\begin{DoxyParamCaption}\item[{Pointer}]{pointer }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [protected]}}



Constructor associating a new \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} instance with a JNA pointer. 


\begin{DoxyParams}{Parameters}
{\em pointer} & JNA \mbox{\hyperlink{}{Pointer}} to key set \\
\hline
\end{DoxyParams}

\begin{DoxyExceptions}{Exceptions}
{\em Illegal\+Argument\+Exception} & if
\begin{DoxyCode}{1}
\DoxyCodeLine{pointer }

\end{DoxyCode}
 is
\begin{DoxyCode}{1}
\DoxyCodeLine{\textcolor{keyword}{null} }

\end{DoxyCode}
 \\
\hline
\end{DoxyExceptions}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_aa3851e13c627e32f02275636806e30cc}{release()}} 
\end{DoxySeeAlso}


\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a0eff916445842bb1e47fe398efc19538}\label{classorg_1_1libelektra_1_1KeySet_a0eff916445842bb1e47fe398efc19538}} 
\index{org.libelektra.KeySet@{org.libelektra.KeySet}!append@{append}}
\index{append@{append}!org.libelektra.KeySet@{org.libelektra.KeySet}}
\doxysubsubsection{\texorpdfstring{append()}{append()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} org.\+libelektra.\+Key\+Set.\+append (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}}}]{key }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Append key to key set. 


\begin{DoxyParams}{Parameters}
{\em key} & \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} to append \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
This \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}}, enabling a fluent interface 
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em Illegal\+Argument\+Exception} & if
\begin{DoxyCode}{1}
\DoxyCodeLine{key }

\end{DoxyCode}
 is
\begin{DoxyCode}{1}
\DoxyCodeLine{\textcolor{keyword}{null} }

\end{DoxyCode}
 \\
\hline
{\em Key\+Set\+Released\+Exception} & if this \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} has already been released \\
\hline
\end{DoxyExceptions}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a7457ab3aa74323af26c80b05fe5607b5}\label{classorg_1_1libelektra_1_1KeySet_a7457ab3aa74323af26c80b05fe5607b5}} 
\index{org.libelektra.KeySet@{org.libelektra.KeySet}!append@{append}}
\index{append@{append}!org.libelektra.KeySet@{org.libelektra.KeySet}}
\doxysubsubsection{\texorpdfstring{append()}{append()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} org.\+libelektra.\+Key\+Set.\+append (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}}}]{source }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Appends keys from key set. 


\begin{DoxyParams}{Parameters}
{\em source} & Source \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} to append all of its \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{keys}} \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
This \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}}, enabling a fluent interface 
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em Key\+Set\+Released\+Exception} & if this \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} or the specified 
\begin{DoxyCode}{1}
\DoxyCodeLine{source }

\end{DoxyCode}
 has already been released \\
\hline
{\em Illegal\+Argument\+Exception} & if
\begin{DoxyCode}{1}
\DoxyCodeLine{source }

\end{DoxyCode}
 is
\begin{DoxyCode}{1}
\DoxyCodeLine{\textcolor{keyword}{null} }

\end{DoxyCode}
 \\
\hline
{\em Key\+Set\+Append\+Exception} & if appending the
\begin{DoxyCode}{1}
\DoxyCodeLine{source }

\end{DoxyCode}
 failed \\
\hline
\end{DoxyExceptions}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_ae6e95674082204841f208f59fcc416cb}\label{classorg_1_1libelektra_1_1KeySet_ae6e95674082204841f208f59fcc416cb}} 
\index{org.libelektra.KeySet@{org.libelektra.KeySet}!at@{at}}
\index{at@{at}!org.libelektra.KeySet@{org.libelektra.KeySet}}
\doxysubsubsection{\texorpdfstring{at()}{at()}}
{\footnotesize\ttfamily \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} org.\+libelektra.\+Key\+Set.\+at (\begin{DoxyParamCaption}\item[{int}]{cursor }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Gets the key at the given cursor position. 


\begin{DoxyParams}{Parameters}
{\em cursor} & Cursor position used to fetch key; starting from 0 \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} found at specified cursor position 
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em Key\+Set\+Released\+Exception} & if this \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} has already been released \\
\hline
{\em Index\+Out\+Of\+Bounds\+Exception} & if position is out of bounds \\
\hline
\end{DoxyExceptions}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{classorg_1_1libelektra_1_1Key_a8e93661372c9a6d5d23a056265a6f5a5}{Key\+::release()}} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a344a72a98a01a1a1a0e6526ff22eb55e}\label{classorg_1_1libelektra_1_1KeySet_a344a72a98a01a1a1a0e6526ff22eb55e}} 
\index{org.libelektra.KeySet@{org.libelektra.KeySet}!copy@{copy}}
\index{copy@{copy}!org.libelektra.KeySet@{org.libelektra.KeySet}}
\doxysubsubsection{\texorpdfstring{copy()}{copy()}}
{\footnotesize\ttfamily \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} org.\+libelektra.\+Key\+Set.\+copy (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}}}]{source }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Copies key references from. 


\begin{DoxyCode}{0}
\DoxyCodeLine{source }

\end{DoxyCode}
 to {\bfseries{this}} \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}}


\begin{DoxyParams}{Parameters}
{\em source} & \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} set that is used as source \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
This \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}}, enabling a fluent interface 
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em Key\+Set\+Released\+Exception} & if this \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} or the specified 
\begin{DoxyCode}{1}
\DoxyCodeLine{source }

\end{DoxyCode}
 has already been released \\
\hline
{\em Illegal\+Argument\+Exception} & if
\begin{DoxyCode}{1}
\DoxyCodeLine{source }

\end{DoxyCode}
 is
\begin{DoxyCode}{1}
\DoxyCodeLine{\textcolor{keyword}{null} }

\end{DoxyCode}
 \\
\hline
\end{DoxyExceptions}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_ac0ba4b88bef5e731b586f4ca63b9ab7f}\label{classorg_1_1libelektra_1_1KeySet_ac0ba4b88bef5e731b586f4ca63b9ab7f}} 
\index{org.libelektra.KeySet@{org.libelektra.KeySet}!create@{create}}
\index{create@{create}!org.libelektra.KeySet@{org.libelektra.KeySet}}
\doxysubsubsection{\texorpdfstring{create()}{create()}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}}
{\footnotesize\ttfamily static \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} org.\+libelektra.\+Key\+Set.\+create (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [static]}}



Constructs an empty \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} with a default allocation hint of 16. 

\begin{DoxyReturn}{Returns}
Newly allocated key set 
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_aa3851e13c627e32f02275636806e30cc}{release()}} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_ae6858ba2c52f97ccca3cf5d3c3582f0e}\label{classorg_1_1libelektra_1_1KeySet_ae6858ba2c52f97ccca3cf5d3c3582f0e}} 
\index{org.libelektra.KeySet@{org.libelektra.KeySet}!create@{create}}
\index{create@{create}!org.libelektra.KeySet@{org.libelektra.KeySet}}
\doxysubsubsection{\texorpdfstring{create()}{create()}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}}
{\footnotesize\ttfamily static \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} org.\+libelektra.\+Key\+Set.\+create (\begin{DoxyParamCaption}\item[{int}]{allocation\+Hint,  }\item[{Key...}]{keys }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [static]}}



Constructs a new \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} containing the specified \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{keys}}~\newline
 ~\newline
 Example\+: \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} key\+Set = \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_a97739afd3f44984c424b3b90ee784f70}{Key\+Set.\+create}}(10, \mbox{\hyperlink{classorg_1_1libelektra_1_1Key_ae62b6596937d48b5a24af97e6341d37a}{Key.\+create}}(\char`\"{}\+A\char`\"{}), \mbox{\hyperlink{classorg_1_1libelektra_1_1Key_ae62b6596937d48b5a24af97e6341d37a}{Key.\+create}}(\char`\"{}\+B\char`\"{}));. 


\begin{DoxyParams}{Parameters}
{\em allocation\+Hint} & Hint indicating the expected size of the key set \\
\hline
{\em keys} & List of initial keys for the key set \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
New key set containing the specified initial keys 
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_aa3851e13c627e32f02275636806e30cc}{release()}} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a97739afd3f44984c424b3b90ee784f70}\label{classorg_1_1libelektra_1_1KeySet_a97739afd3f44984c424b3b90ee784f70}} 
\index{org.libelektra.KeySet@{org.libelektra.KeySet}!create@{create}}
\index{create@{create}!org.libelektra.KeySet@{org.libelektra.KeySet}}
\doxysubsubsection{\texorpdfstring{create()}{create()}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}}
{\footnotesize\ttfamily static \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} org.\+libelektra.\+Key\+Set.\+create (\begin{DoxyParamCaption}\item[{Key...}]{keys }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [static]}}



Constructs a new \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} containing the specified \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{keys}}~\newline
 ~\newline
 Example\+: \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} key\+Set = \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_a97739afd3f44984c424b3b90ee784f70}{Key\+Set.\+create}}(\mbox{\hyperlink{classorg_1_1libelektra_1_1Key_ae62b6596937d48b5a24af97e6341d37a}{Key.\+create}}(\char`\"{}\+A\char`\"{}), \mbox{\hyperlink{classorg_1_1libelektra_1_1Key_ae62b6596937d48b5a24af97e6341d37a}{Key.\+create}}(\char`\"{}\+B\char`\"{}));. 


\begin{DoxyParams}{Parameters}
{\em keys} & List of initial keys for the key set \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
New key set containing the specified initial keys 
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_aa3851e13c627e32f02275636806e30cc}{release()}} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_acb8551293dbbf6e9fd95c588f7dfa2dd}\label{classorg_1_1libelektra_1_1KeySet_acb8551293dbbf6e9fd95c588f7dfa2dd}} 
\index{org.libelektra.KeySet@{org.libelektra.KeySet}!cut@{cut}}
\index{cut@{cut}!org.libelektra.KeySet@{org.libelektra.KeySet}}
\doxysubsubsection{\texorpdfstring{cut()}{cut()}}
{\footnotesize\ttfamily \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} org.\+libelektra.\+Key\+Set.\+cut (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}}}]{cutpoint }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Creates new key set with help of a cut point. 


\begin{DoxyParams}{Parameters}
{\em cutpoint} & \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} that is used as cutting point \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
New \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} containing all keys until the cutting point, this if null was provided 
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em Key\+Set\+Released\+Exception} & if this \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} has already been released \\
\hline
{\em Illegal\+Argument\+Exception} & if
\begin{DoxyCode}{1}
\DoxyCodeLine{cutpoint }

\end{DoxyCode}
 is
\begin{DoxyCode}{1}
\DoxyCodeLine{\textcolor{keyword}{null} }

\end{DoxyCode}
 \\
\hline
\end{DoxyExceptions}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_aa3851e13c627e32f02275636806e30cc}{release()}} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_af3571c68cd55983c45666cf9f75143a1}\label{classorg_1_1libelektra_1_1KeySet_af3571c68cd55983c45666cf9f75143a1}} 
\index{org.libelektra.KeySet@{org.libelektra.KeySet}!dup@{dup}}
\index{dup@{dup}!org.libelektra.KeySet@{org.libelektra.KeySet}}
\doxysubsubsection{\texorpdfstring{dup()}{dup()}}
{\footnotesize\ttfamily \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} org.\+libelektra.\+Key\+Set.\+dup (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Duplicates the key set. 

\begin{DoxyReturn}{Returns}
New \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} containing the same key references as this \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} does 
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em Key\+Set\+Released\+Exception} & if this \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} has already been released \\
\hline
\end{DoxyExceptions}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_aa3851e13c627e32f02275636806e30cc}{release()}} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a8536b95ff54ef2cc80004d0dbfac736d}\label{classorg_1_1libelektra_1_1KeySet_a8536b95ff54ef2cc80004d0dbfac736d}} 
\index{org.libelektra.KeySet@{org.libelektra.KeySet}!first@{first}}
\index{first@{first}!org.libelektra.KeySet@{org.libelektra.KeySet}}
\doxysubsubsection{\texorpdfstring{first()}{first()}}
{\footnotesize\ttfamily \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} org.\+libelektra.\+Key\+Set.\+first (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Gets the key set head key. 

\begin{DoxyReturn}{Returns}
First element of the key set 
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em Key\+Set\+Released\+Exception} & if this \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} has already been released \\
\hline
{\em No\+Such\+Element\+Exception} & if key set is empty \\
\hline
\end{DoxyExceptions}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{classorg_1_1libelektra_1_1Key_a8e93661372c9a6d5d23a056265a6f5a5}{Key\+::release()}} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_ae48a42eace65f38a2cb23ba6dd432271}\label{classorg_1_1libelektra_1_1KeySet_ae48a42eace65f38a2cb23ba6dd432271}} 
\index{org.libelektra.KeySet@{org.libelektra.KeySet}!getPointer@{getPointer}}
\index{getPointer@{getPointer}!org.libelektra.KeySet@{org.libelektra.KeySet}}
\doxysubsubsection{\texorpdfstring{getPointer()}{getPointer()}}
{\footnotesize\ttfamily Pointer org.\+libelektra.\+Key\+Set.\+get\+Pointer (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [protected]}}

\begin{DoxyReturn}{Returns}
JNA pointer to the native pointer for this key set 
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em Key\+Set\+Released\+Exception} & if this \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} has already been released \\
\hline
\end{DoxyExceptions}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a1a3b37dff55df600c4fee6bea714a8d9}\label{classorg_1_1libelektra_1_1KeySet_a1a3b37dff55df600c4fee6bea714a8d9}} 
\index{org.libelektra.KeySet@{org.libelektra.KeySet}!iterator@{iterator}}
\index{iterator@{iterator}!org.libelektra.KeySet@{org.libelektra.KeySet}}
\doxysubsubsection{\texorpdfstring{iterator()}{iterator()}}
{\footnotesize\ttfamily Iterator$<$\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}}$>$ org.\+libelektra.\+Key\+Set.\+iterator (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}

\begin{DoxyReturn}{Returns}
New \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySetIterator}{Key\+Set\+Iterator}} backed by this \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_ab4d9dcee5031e7b910c14672810bfb7c}\label{classorg_1_1libelektra_1_1KeySet_ab4d9dcee5031e7b910c14672810bfb7c}} 
\index{org.libelektra.KeySet@{org.libelektra.KeySet}!last@{last}}
\index{last@{last}!org.libelektra.KeySet@{org.libelektra.KeySet}}
\doxysubsubsection{\texorpdfstring{last()}{last()}}
{\footnotesize\ttfamily \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} org.\+libelektra.\+Key\+Set.\+last (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Gets the key set tail key. 

\begin{DoxyReturn}{Returns}
Last element of the key set 
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em Key\+Set\+Released\+Exception} & if this \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} has already been released \\
\hline
{\em No\+Such\+Element\+Exception} & if key set is empty \\
\hline
\end{DoxyExceptions}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{classorg_1_1libelektra_1_1Key_a8e93661372c9a6d5d23a056265a6f5a5}{Key\+::release()}} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a0d56925d157879f71c0fb68360dcf3bf}\label{classorg_1_1libelektra_1_1KeySet_a0d56925d157879f71c0fb68360dcf3bf}} 
\index{org.libelektra.KeySet@{org.libelektra.KeySet}!lookup@{lookup}}
\index{lookup@{lookup}!org.libelektra.KeySet@{org.libelektra.KeySet}}
\doxysubsubsection{\texorpdfstring{lookup()}{lookup()}\hspace{0.1cm}{\footnotesize\ttfamily [1/4]}}
{\footnotesize\ttfamily Optional$<$\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}}$>$ org.\+libelektra.\+Key\+Set.\+lookup (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}}}]{find }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Search for a key in the key set. 


\begin{DoxyParams}{Parameters}
{\em find} & \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} used in search \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} if search successful, \mbox{\hyperlink{}{Optional\#empty()}} otherwise 
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em Key\+Set\+Released\+Exception} & if this \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} has already been released \\
\hline
{\em Illegal\+Argument\+Exception} & if
\begin{DoxyCode}{1}
\DoxyCodeLine{key }

\end{DoxyCode}
 is
\begin{DoxyCode}{1}
\DoxyCodeLine{\textcolor{keyword}{null} }

\end{DoxyCode}
 \\
\hline
\end{DoxyExceptions}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{classorg_1_1libelektra_1_1Key_a8e93661372c9a6d5d23a056265a6f5a5}{Key\+::release()}} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a5a75e55a138cc6516a4bf92e74f3bc3a}\label{classorg_1_1libelektra_1_1KeySet_a5a75e55a138cc6516a4bf92e74f3bc3a}} 
\index{org.libelektra.KeySet@{org.libelektra.KeySet}!lookup@{lookup}}
\index{lookup@{lookup}!org.libelektra.KeySet@{org.libelektra.KeySet}}
\doxysubsubsection{\texorpdfstring{lookup()}{lookup()}\hspace{0.1cm}{\footnotesize\ttfamily [2/4]}}
{\footnotesize\ttfamily Optional$<$\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}}$>$ org.\+libelektra.\+Key\+Set.\+lookup (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}}}]{find,  }\item[{int}]{options }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Search for a key in the key set. 


\begin{DoxyParams}{Parameters}
{\em find} & \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} used in search \\
\hline
{\em options} & Custom search options; concatenation of flags \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} if search successful, \mbox{\hyperlink{}{Optional\#empty()}} otherwise 
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em Key\+Set\+Released\+Exception} & if this \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} has already been released \\
\hline
{\em Illegal\+Argument\+Exception} & if
\begin{DoxyCode}{1}
\DoxyCodeLine{find }

\end{DoxyCode}
 is
\begin{DoxyCode}{1}
\DoxyCodeLine{\textcolor{keyword}{null} }

\end{DoxyCode}
 \\
\hline
\end{DoxyExceptions}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{classorg_1_1libelektra_1_1Key_a8e93661372c9a6d5d23a056265a6f5a5}{Key\+::release()}} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a50a2c161fdd8d48cddf2c6980822a107}\label{classorg_1_1libelektra_1_1KeySet_a50a2c161fdd8d48cddf2c6980822a107}} 
\index{org.libelektra.KeySet@{org.libelektra.KeySet}!lookup@{lookup}}
\index{lookup@{lookup}!org.libelektra.KeySet@{org.libelektra.KeySet}}
\doxysubsubsection{\texorpdfstring{lookup()}{lookup()}\hspace{0.1cm}{\footnotesize\ttfamily [3/4]}}
{\footnotesize\ttfamily Optional$<$\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}}$>$ org.\+libelektra.\+Key\+Set.\+lookup (\begin{DoxyParamCaption}\item[{String}]{find }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Search for a key in the key set. 


\begin{DoxyParams}{Parameters}
{\em find} & \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} name used in search \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} if search successful, \mbox{\hyperlink{}{Optional\#empty()}} otherwise 
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em Key\+Set\+Released\+Exception} & if this \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} has already been released \\
\hline
{\em Illegal\+Argument\+Exception} & if
\begin{DoxyCode}{1}
\DoxyCodeLine{find }

\end{DoxyCode}
 is \mbox{\hyperlink{}{blank}} \\
\hline
\end{DoxyExceptions}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{classorg_1_1libelektra_1_1Key_a8e93661372c9a6d5d23a056265a6f5a5}{Key\+::release()}} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a805133ecb4d93a999072155ceb1d0240}\label{classorg_1_1libelektra_1_1KeySet_a805133ecb4d93a999072155ceb1d0240}} 
\index{org.libelektra.KeySet@{org.libelektra.KeySet}!lookup@{lookup}}
\index{lookup@{lookup}!org.libelektra.KeySet@{org.libelektra.KeySet}}
\doxysubsubsection{\texorpdfstring{lookup()}{lookup()}\hspace{0.1cm}{\footnotesize\ttfamily [4/4]}}
{\footnotesize\ttfamily Optional$<$\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}}$>$ org.\+libelektra.\+Key\+Set.\+lookup (\begin{DoxyParamCaption}\item[{String}]{find,  }\item[{int}]{options }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Search for a key in the key set. 


\begin{DoxyParams}{Parameters}
{\em find} & \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} name used in search \\
\hline
{\em options} & Custom search options; concatenation of flags \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} if search successful, \mbox{\hyperlink{}{Optional\#empty()}} otherwise 
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em Key\+Set\+Released\+Exception} & if this \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} has already been released \\
\hline
{\em Illegal\+Argument\+Exception} & if
\begin{DoxyCode}{1}
\DoxyCodeLine{find }

\end{DoxyCode}
 is \mbox{\hyperlink{}{blank}} \\
\hline
\end{DoxyExceptions}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{classorg_1_1libelektra_1_1Key_a8e93661372c9a6d5d23a056265a6f5a5}{Key\+::release()}} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_aa3851e13c627e32f02275636806e30cc}\label{classorg_1_1libelektra_1_1KeySet_aa3851e13c627e32f02275636806e30cc}} 
\index{org.libelektra.KeySet@{org.libelektra.KeySet}!release@{release}}
\index{release@{release}!org.libelektra.KeySet@{org.libelektra.KeySet}}
\doxysubsubsection{\texorpdfstring{release()}{release()}}
{\footnotesize\ttfamily void org.\+libelektra.\+Key\+Set.\+release (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Clean-\/up method to release key set reference by trying to free the native reference~\newline
 ~\newline
 Call this method if you have obtained a \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} via any of its public methods or \mbox{\hyperlink{classorg_1_1libelektra_1_1KDB_a1668a8f1b44e082d577f58b1963141dd}{KDB\#get(\+Key)}} and you do not longer need it. 

If you do not manually release such \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{key sets}}, they will get cleaned up by garbage collection as soon as they get phantom reachable. Therefore its encouraged to release \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{key set instances}} as soon as you do not use them anymore. \mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a1302d1a59480851a0de54dcad2a50b6d}\label{classorg_1_1libelektra_1_1KeySet_a1302d1a59480851a0de54dcad2a50b6d}} 
\index{org.libelektra.KeySet@{org.libelektra.KeySet}!remove@{remove}}
\index{remove@{remove}!org.libelektra.KeySet@{org.libelektra.KeySet}}
\doxysubsubsection{\texorpdfstring{remove()}{remove()}}
{\footnotesize\ttfamily \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} org.\+libelektra.\+Key\+Set.\+remove (\begin{DoxyParamCaption}\item[{int}]{cursor }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Returns key from key set and also removes it from the set. 


\begin{DoxyParams}{Parameters}
{\em cursor} & Cursor position of the key to remove; starting from 0 \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} found at given cursor position 
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em Key\+Set\+Released\+Exception} & if this \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} has already been released \\
\hline
{\em Index\+Out\+Of\+Bounds\+Exception} & if position is out of bounds \\
\hline
\end{DoxyExceptions}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{classorg_1_1libelektra_1_1Key_a8e93661372c9a6d5d23a056265a6f5a5}{Key\+::release()}} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a9244d4c9a07e61c5842dcd2fc620e4d6}\label{classorg_1_1libelektra_1_1KeySet_a9244d4c9a07e61c5842dcd2fc620e4d6}} 
\index{org.libelektra.KeySet@{org.libelektra.KeySet}!size@{size}}
\index{size@{size}!org.libelektra.KeySet@{org.libelektra.KeySet}}
\doxysubsubsection{\texorpdfstring{size()}{size()}}
{\footnotesize\ttfamily int org.\+libelektra.\+Key\+Set.\+size (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Indicates the key set size. 

\begin{DoxyReturn}{Returns}
Number of keys contained by this key set 
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em Key\+Set\+Released\+Exception} & if this \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} has already been released \\
\hline
\end{DoxyExceptions}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a9c1e2918acce8c7cda5be406989c87af}\label{classorg_1_1libelektra_1_1KeySet_a9c1e2918acce8c7cda5be406989c87af}} 
\index{org.libelektra.KeySet@{org.libelektra.KeySet}!toString@{toString}}
\index{toString@{toString}!org.libelektra.KeySet@{org.libelektra.KeySet}}
\doxysubsubsection{\texorpdfstring{toString()}{toString()}}
{\footnotesize\ttfamily String org.\+libelektra.\+Key\+Set.\+to\+String (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Iterates though all keys in this key set and appends their representation to the output. 

Uses the \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet_a9c1e2918acce8c7cda5be406989c87af}{to\+String()}} function of the \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} objects.

\begin{DoxyReturn}{Returns}
Represents this \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} as string 
\end{DoxyReturn}


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