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


A keyset holds together a set of keys.  




Inherits Iterable$<$ Key $>$.

\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_aa3851e13c627e32f02275636806e30cc}\label{classorg_1_1libelektra_1_1KeySet_aa3851e13c627e32f02275636806e30cc}} 
void \hyperlink{classorg_1_1libelektra_1_1KeySet_aa3851e13c627e32f02275636806e30cc}{release} ()
\begin{DoxyCompactList}\small\item\em Clean-\/up method to release keyset reference. \end{DoxyCompactList}\item 
java.\+util.\+Iterator$<$ \hyperlink{classorg_1_1libelektra_1_1Key}{Key} $>$ \hyperlink{classorg_1_1libelektra_1_1KeySet_ac7ef2aa30918b5790cbba04b4fe70073}{iterator} ()
\begin{DoxyCompactList}\small\item\em Iterable interface function. \end{DoxyCompactList}\item 
String \hyperlink{classorg_1_1libelektra_1_1KeySet_a9c1e2918acce8c7cda5be406989c87af}{to\+String} ()
\begin{DoxyCompactList}\small\item\em Basic java function that represents object as String. \end{DoxyCompactList}\item 
\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set} \hyperlink{classorg_1_1libelektra_1_1KeySet_af3571c68cd55983c45666cf9f75143a1}{dup} ()
\begin{DoxyCompactList}\small\item\em Duplicates the key set. \end{DoxyCompactList}\item 
int \hyperlink{classorg_1_1libelektra_1_1KeySet_a32cba0dbe638373296fb242a698ad1cb}{copy} (final \hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set} other)
\begin{DoxyCompactList}\small\item\em Copies key references from other key set. \end{DoxyCompactList}\item 
int \hyperlink{classorg_1_1libelektra_1_1KeySet_a9a21c729da19bc6fb2e7f33fe06ee15e}{needs\+Sync} ()
\begin{DoxyCompactList}\small\item\em Helper function to check if synchronization is necessary. \end{DoxyCompactList}\item 
int \hyperlink{classorg_1_1libelektra_1_1KeySet_aac3920fa38179de07bcd242207915540}{length} ()
\begin{DoxyCompactList}\small\item\em Helper function that returns key set size. \end{DoxyCompactList}\item 
int \hyperlink{classorg_1_1libelektra_1_1KeySet_a5c1738709f8ccda0929204c9151e773e}{append} (final \hyperlink{classorg_1_1libelektra_1_1Key}{Key} k)
\begin{DoxyCompactList}\small\item\em Helper function to append key to key set. \end{DoxyCompactList}\item 
int \hyperlink{classorg_1_1libelektra_1_1KeySet_a383722346ce590f7bc00aae82c1d035d}{append} (final \hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set} ks)
\begin{DoxyCompactList}\small\item\em Helper function that appends keys of key set. \end{DoxyCompactList}\item 
\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set} \hyperlink{classorg_1_1libelektra_1_1KeySet_a470743c3a6f873427d057c6ce7e3661c}{cut} (final \hyperlink{classorg_1_1libelektra_1_1Key}{Key} cutpoint)
\begin{DoxyCompactList}\small\item\em Helper function that creates new key set with help of a cut point. \end{DoxyCompactList}\item 
\hyperlink{classorg_1_1libelektra_1_1Key}{Key} \hyperlink{classorg_1_1libelektra_1_1KeySet_a6fcb652d72c64772bae40ec801d93ad9}{pop} ()
\begin{DoxyCompactList}\small\item\em Helper function that returns key from key set and also removes it from the set. \end{DoxyCompactList}\item 
\hyperlink{classorg_1_1libelektra_1_1Key}{Key} \hyperlink{classorg_1_1libelektra_1_1KeySet_a684ac5513b51d841cc04bdcdb203c4cf}{current} ()
\begin{DoxyCompactList}\small\item\em Helper function that returns current key from the key set. \end{DoxyCompactList}\item 
\hyperlink{classorg_1_1libelektra_1_1Key}{Key} \hyperlink{classorg_1_1libelektra_1_1KeySet_a92aa593320132e4272602dda29aee2c7}{next} ()
\begin{DoxyCompactList}\small\item\em Helper function that returns the next key in the key set. \end{DoxyCompactList}\item 
int \hyperlink{classorg_1_1libelektra_1_1KeySet_a20533a5e97b16b76b977b95be179d58c}{rewind} ()
\begin{DoxyCompactList}\small\item\em Helper function that rewinds the current key set. \end{DoxyCompactList}\item 
\hyperlink{classorg_1_1libelektra_1_1Key}{Key} \hyperlink{classorg_1_1libelektra_1_1KeySet_a11ba1ef1213a9f1ac5743491bc7154e5}{head} ()
\begin{DoxyCompactList}\small\item\em Helper function that gets the key set head. \end{DoxyCompactList}\item 
\hyperlink{classorg_1_1libelektra_1_1Key}{Key} \hyperlink{classorg_1_1libelektra_1_1KeySet_ab81aff6c88595b3f4c3307d1f996857f}{tail} ()
\begin{DoxyCompactList}\small\item\em Helper function that gets the key set tail. \end{DoxyCompactList}\item 
int \hyperlink{classorg_1_1libelektra_1_1KeySet_a37e6d574b4595021a6cc732e325219e1}{get\+Cursor} ()
\begin{DoxyCompactList}\small\item\em Helper function that gets the current cursor of the key set. \end{DoxyCompactList}\item 
int \hyperlink{classorg_1_1libelektra_1_1KeySet_adb3caad35c8dfcd1934d7cd32ff0ca4a}{set\+Cursor} (final int cursor)
\begin{DoxyCompactList}\small\item\em Helper function that sets the current cursor of the key set. \end{DoxyCompactList}\item 
\hyperlink{classorg_1_1libelektra_1_1Key}{Key} \hyperlink{classorg_1_1libelektra_1_1KeySet_a125d86734bd428c9eb1f937eb1b7ab74}{at} (final int cursor)
\begin{DoxyCompactList}\small\item\em Helper function that gets the \hyperlink{classorg_1_1libelektra_1_1Key}{Key} at the given cursor position. \end{DoxyCompactList}\item 
\hyperlink{classorg_1_1libelektra_1_1Key}{Key} \hyperlink{classorg_1_1libelektra_1_1KeySet_a6fb319a768b1cb43464154a93f9a2e93}{lookup} (final \hyperlink{classorg_1_1libelektra_1_1Key}{Key} find, final int options)
\begin{DoxyCompactList}\small\item\em Helper function to search for a key in the key set. \end{DoxyCompactList}\item 
\hyperlink{classorg_1_1libelektra_1_1Key}{Key} \hyperlink{classorg_1_1libelektra_1_1KeySet_a9ff1d475fd6ae316515c4c1cc173991b}{lookup} (final \hyperlink{classorg_1_1libelektra_1_1Key}{Key} find)
\begin{DoxyCompactList}\small\item\em Helper function to search for a key in the key set. \end{DoxyCompactList}\item 
\hyperlink{classorg_1_1libelektra_1_1Key}{Key} \hyperlink{classorg_1_1libelektra_1_1KeySet_aa17a04907eb8c8d2a9a488788d0039ea}{lookup} (final String find, final int options)
\begin{DoxyCompactList}\small\item\em Helper function to search for a key in the key set. \end{DoxyCompactList}\item 
\hyperlink{classorg_1_1libelektra_1_1Key}{Key} \hyperlink{classorg_1_1libelektra_1_1KeySet_a69921726091c9a775bb8ece1f1e3a858}{lookup} (final String find)
\begin{DoxyCompactList}\small\item\em Helper function to search for a key in the key set. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static \hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set} \hyperlink{classorg_1_1libelektra_1_1KeySet_a441d0e45a150a6fd5f75be00ec42338d}{create} (final int alloc, final Key... args)
\begin{DoxyCompactList}\small\item\em Basic constructor for key set. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Protected Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{classorg_1_1libelektra_1_1KeySet_a72507fbeb96bfb90e44562e0a8e70331}{Key\+Set} (final long p)
\begin{DoxyCompactList}\small\item\em Helper constructor for duplication by pointer in long format. \end{DoxyCompactList}\item 
\hyperlink{classorg_1_1libelektra_1_1KeySet_adf4ea02b31ed468e49c615f61ea57a15}{Key\+Set} (final Pointer p)
\begin{DoxyCompactList}\small\item\em Helper constructor for duplication by pointer. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_ad11eed8c4aeea5b9af381e0185b3a097}\label{classorg_1_1libelektra_1_1KeySet_ad11eed8c4aeea5b9af381e0185b3a097}} 
void \hyperlink{classorg_1_1libelektra_1_1KeySet_ad11eed8c4aeea5b9af381e0185b3a097}{finalize} ()  throws Throwable 
\begin{DoxyCompactList}\small\item\em Clean-\/up method to inform underlying c-\/library about the release of the keyset reference. \end{DoxyCompactList}\item 
Pointer \hyperlink{classorg_1_1libelektra_1_1KeySet_abf3f028c9c3b88a47aa9d67a5c8e95da}{get} ()
\begin{DoxyCompactList}\small\item\em Native pointer used by J\+NA. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Static Protected Member Functions}
\begin{DoxyCompactItemize}
\item 
static \hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set} \hyperlink{classorg_1_1libelektra_1_1KeySet_ae3f1cd9ac1a4fd2ef7d16e6c320bc6a3}{create} (final int alloc, final Object... args)
\begin{DoxyCompactList}\small\item\em Basic constructor for key set. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
A keyset holds together a set of keys. 

\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a72507fbeb96bfb90e44562e0a8e70331}\label{classorg_1_1libelektra_1_1KeySet_a72507fbeb96bfb90e44562e0a8e70331}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!Key\+Set@{Key\+Set}}
\index{Key\+Set@{Key\+Set}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{Key\+Set()}{KeySet()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily org.\+libelektra.\+Key\+Set.\+Key\+Set (\begin{DoxyParamCaption}\item[{final long}]{p }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [protected]}}



Helper constructor for duplication by pointer in long format. 


\begin{DoxyParams}{Parameters}
{\em p} & Pointer to another \hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set} in long format \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_adf4ea02b31ed468e49c615f61ea57a15}\label{classorg_1_1libelektra_1_1KeySet_adf4ea02b31ed468e49c615f61ea57a15}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!Key\+Set@{Key\+Set}}
\index{Key\+Set@{Key\+Set}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{Key\+Set()}{KeySet()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily org.\+libelektra.\+Key\+Set.\+Key\+Set (\begin{DoxyParamCaption}\item[{final Pointer}]{p }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [protected]}}



Helper constructor for duplication by pointer. 


\begin{DoxyParams}{Parameters}
{\em p} & Pointer to another \hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set} \\
\hline
\end{DoxyParams}


\subsection{Member Function Documentation}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a5c1738709f8ccda0929204c9151e773e}\label{classorg_1_1libelektra_1_1KeySet_a5c1738709f8ccda0929204c9151e773e}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!append@{append}}
\index{append@{append}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{append()}{append()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily int org.\+libelektra.\+Key\+Set.\+append (\begin{DoxyParamCaption}\item[{final \hyperlink{classorg_1_1libelektra_1_1Key}{Key}}]{k }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Helper function to append key to key set. 

Does nothing if null is provided.


\begin{DoxyParams}{Parameters}
{\em k} & \hyperlink{classorg_1_1libelektra_1_1Key}{Key} to append \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Index of key in key set; starting from 1, -\/1 if null was provided 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a383722346ce590f7bc00aae82c1d035d}\label{classorg_1_1libelektra_1_1KeySet_a383722346ce590f7bc00aae82c1d035d}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!append@{append}}
\index{append@{append}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{append()}{append()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily int org.\+libelektra.\+Key\+Set.\+append (\begin{DoxyParamCaption}\item[{final \hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}}]{ks }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Helper function that appends keys of key set. 


\begin{DoxyParams}{Parameters}
{\em ks} & \hyperlink{classorg_1_1libelektra_1_1Key}{Key} set to append \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Highest new index of key in key set; starting from 1, -\/1 if null was provided 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a125d86734bd428c9eb1f937eb1b7ab74}\label{classorg_1_1libelektra_1_1KeySet_a125d86734bd428c9eb1f937eb1b7ab74}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!at@{at}}
\index{at@{at}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{at()}{at()}}
{\footnotesize\ttfamily \hyperlink{classorg_1_1libelektra_1_1Key}{Key} org.\+libelektra.\+Key\+Set.\+at (\begin{DoxyParamCaption}\item[{final int}]{cursor }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Helper function that gets the \hyperlink{classorg_1_1libelektra_1_1Key}{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}
\hyperlink{classorg_1_1libelektra_1_1Key}{Key} at given cursor position 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a32cba0dbe638373296fb242a698ad1cb}\label{classorg_1_1libelektra_1_1KeySet_a32cba0dbe638373296fb242a698ad1cb}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!copy@{copy}}
\index{copy@{copy}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{copy()}{copy()}}
{\footnotesize\ttfamily int org.\+libelektra.\+Key\+Set.\+copy (\begin{DoxyParamCaption}\item[{final \hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}}]{other }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Copies key references from other key set. 


\begin{DoxyParams}{Parameters}
{\em other} & \hyperlink{classorg_1_1libelektra_1_1Key}{Key} set that is used as source \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
1 in case of success, 0 if source was N\+U\+LL and dest (this) was cleared successfully, -\/1 in case of an error (null pointer) 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_ae3f1cd9ac1a4fd2ef7d16e6c320bc6a3}\label{classorg_1_1libelektra_1_1KeySet_ae3f1cd9ac1a4fd2ef7d16e6c320bc6a3}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!create@{create}}
\index{create@{create}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{create()}{create()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily static \hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set} org.\+libelektra.\+Key\+Set.\+create (\begin{DoxyParamCaption}\item[{final int}]{alloc,  }\item[{final Object...}]{args }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [static]}, {\ttfamily [protected]}}



Basic constructor for key set. 


\begin{DoxyParams}{Parameters}
{\em alloc} & Length of key set (key count) to be allocated \\
\hline
{\em args} & List of initial arguments for the key set. Example\+:~\newline
 new \hyperlink{classorg_1_1libelektra_1_1Key}{Key}(...), new \hyperlink{classorg_1_1libelektra_1_1Key}{Key}(...), existing\+\_\+key\+\_\+reference, Key\+Set.\+K\+S\+\_\+\+E\+ND \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
New key set with the given initial data 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a441d0e45a150a6fd5f75be00ec42338d}\label{classorg_1_1libelektra_1_1KeySet_a441d0e45a150a6fd5f75be00ec42338d}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!create@{create}}
\index{create@{create}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{create()}{create()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily static \hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set} org.\+libelektra.\+Key\+Set.\+create (\begin{DoxyParamCaption}\item[{final int}]{alloc,  }\item[{final Key...}]{args }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [static]}}



Basic constructor for key set. 


\begin{DoxyParams}{Parameters}
{\em alloc} & Length of key set (key count) to be allocated \\
\hline
{\em args} & List of initial keys for the key set. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
New key set with the given initial data 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a684ac5513b51d841cc04bdcdb203c4cf}\label{classorg_1_1libelektra_1_1KeySet_a684ac5513b51d841cc04bdcdb203c4cf}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!current@{current}}
\index{current@{current}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{current()}{current()}}
{\footnotesize\ttfamily \hyperlink{classorg_1_1libelektra_1_1Key}{Key} org.\+libelektra.\+Key\+Set.\+current (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Helper function that returns current key from the key set. 

\begin{DoxyReturn}{Returns}
Current \hyperlink{classorg_1_1libelektra_1_1Key}{Key} in iteration 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a470743c3a6f873427d057c6ce7e3661c}\label{classorg_1_1libelektra_1_1KeySet_a470743c3a6f873427d057c6ce7e3661c}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!cut@{cut}}
\index{cut@{cut}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{cut()}{cut()}}
{\footnotesize\ttfamily \hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set} org.\+libelektra.\+Key\+Set.\+cut (\begin{DoxyParamCaption}\item[{final \hyperlink{classorg_1_1libelektra_1_1Key}{Key}}]{cutpoint }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Helper function that creates new key set with help of a cut point. 


\begin{DoxyParams}{Parameters}
{\em cutpoint} & \hyperlink{classorg_1_1libelektra_1_1Key}{Key} that is used as cutting point \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
New \hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set} containing all keys until the cutting point, this if null was provided 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_af3571c68cd55983c45666cf9f75143a1}\label{classorg_1_1libelektra_1_1KeySet_af3571c68cd55983c45666cf9f75143a1}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!dup@{dup}}
\index{dup@{dup}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{dup()}{dup()}}
{\footnotesize\ttfamily \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 \hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set} containing the same key references as this object does 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_abf3f028c9c3b88a47aa9d67a5c8e95da}\label{classorg_1_1libelektra_1_1KeySet_abf3f028c9c3b88a47aa9d67a5c8e95da}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!get@{get}}
\index{get@{get}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{get()}{get()}}
{\footnotesize\ttfamily Pointer org.\+libelektra.\+Key\+Set.\+get (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [protected]}}



Native pointer used by J\+NA. 

\begin{DoxyReturn}{Returns}
Native pointer object used for this key set 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a37e6d574b4595021a6cc732e325219e1}\label{classorg_1_1libelektra_1_1KeySet_a37e6d574b4595021a6cc732e325219e1}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!get\+Cursor@{get\+Cursor}}
\index{get\+Cursor@{get\+Cursor}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{get\+Cursor()}{getCursor()}}
{\footnotesize\ttfamily int org.\+libelektra.\+Key\+Set.\+get\+Cursor (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Helper function that gets the current cursor of the key set. 

\begin{DoxyReturn}{Returns}
Cursor position as integer; initially -\/1, incremented by \hyperlink{classorg_1_1libelektra_1_1KeySet_a92aa593320132e4272602dda29aee2c7}{next()} 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a11ba1ef1213a9f1ac5743491bc7154e5}\label{classorg_1_1libelektra_1_1KeySet_a11ba1ef1213a9f1ac5743491bc7154e5}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!head@{head}}
\index{head@{head}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{head()}{head()}}
{\footnotesize\ttfamily \hyperlink{classorg_1_1libelektra_1_1Key}{Key} org.\+libelektra.\+Key\+Set.\+head (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Helper function that gets the key set head. 

\begin{DoxyReturn}{Returns}
First element of the key set 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_ac7ef2aa30918b5790cbba04b4fe70073}\label{classorg_1_1libelektra_1_1KeySet_ac7ef2aa30918b5790cbba04b4fe70073}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!iterator@{iterator}}
\index{iterator@{iterator}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{iterator()}{iterator()}}
{\footnotesize\ttfamily java.\+util.\+Iterator$<$\hyperlink{classorg_1_1libelektra_1_1Key}{Key}$>$ org.\+libelektra.\+Key\+Set.\+iterator (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Iterable interface function. 

\begin{DoxyReturn}{Returns}
Custom \hyperlink{classorg_1_1libelektra_1_1KeySetIterator}{Key\+Set\+Iterator} 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_aac3920fa38179de07bcd242207915540}\label{classorg_1_1libelektra_1_1KeySet_aac3920fa38179de07bcd242207915540}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!length@{length}}
\index{length@{length}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{length()}{length()}}
{\footnotesize\ttfamily int org.\+libelektra.\+Key\+Set.\+length (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Helper function that returns key set size. 

\begin{DoxyReturn}{Returns}
Size of key set (number of possible keys) 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a6fb319a768b1cb43464154a93f9a2e93}\label{classorg_1_1libelektra_1_1KeySet_a6fb319a768b1cb43464154a93f9a2e93}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!lookup@{lookup}}
\index{lookup@{lookup}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{lookup()}{lookup()}\hspace{0.1cm}{\footnotesize\ttfamily [1/4]}}
{\footnotesize\ttfamily \hyperlink{classorg_1_1libelektra_1_1Key}{Key} org.\+libelektra.\+Key\+Set.\+lookup (\begin{DoxyParamCaption}\item[{final \hyperlink{classorg_1_1libelektra_1_1Key}{Key}}]{find,  }\item[{final int}]{options }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Helper function to search for a key in the key set. 


\begin{DoxyParams}{Parameters}
{\em find} & \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}
\hyperlink{classorg_1_1libelektra_1_1Key}{Key} if search successful, null otherwise 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a9ff1d475fd6ae316515c4c1cc173991b}\label{classorg_1_1libelektra_1_1KeySet_a9ff1d475fd6ae316515c4c1cc173991b}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!lookup@{lookup}}
\index{lookup@{lookup}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{lookup()}{lookup()}\hspace{0.1cm}{\footnotesize\ttfamily [2/4]}}
{\footnotesize\ttfamily \hyperlink{classorg_1_1libelektra_1_1Key}{Key} org.\+libelektra.\+Key\+Set.\+lookup (\begin{DoxyParamCaption}\item[{final \hyperlink{classorg_1_1libelektra_1_1Key}{Key}}]{find }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Helper function to search for a key in the key set. 


\begin{DoxyParams}{Parameters}
{\em find} & \hyperlink{classorg_1_1libelektra_1_1Key}{Key} used in search \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
\hyperlink{classorg_1_1libelektra_1_1Key}{Key} if search successful, null otherwise 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_aa17a04907eb8c8d2a9a488788d0039ea}\label{classorg_1_1libelektra_1_1KeySet_aa17a04907eb8c8d2a9a488788d0039ea}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!lookup@{lookup}}
\index{lookup@{lookup}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{lookup()}{lookup()}\hspace{0.1cm}{\footnotesize\ttfamily [3/4]}}
{\footnotesize\ttfamily \hyperlink{classorg_1_1libelektra_1_1Key}{Key} org.\+libelektra.\+Key\+Set.\+lookup (\begin{DoxyParamCaption}\item[{final String}]{find,  }\item[{final int}]{options }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Helper function to search for a key in the key set. 


\begin{DoxyParams}{Parameters}
{\em find} & \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}
\hyperlink{classorg_1_1libelektra_1_1Key}{Key} if search successful, null otherwise 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a69921726091c9a775bb8ece1f1e3a858}\label{classorg_1_1libelektra_1_1KeySet_a69921726091c9a775bb8ece1f1e3a858}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!lookup@{lookup}}
\index{lookup@{lookup}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{lookup()}{lookup()}\hspace{0.1cm}{\footnotesize\ttfamily [4/4]}}
{\footnotesize\ttfamily \hyperlink{classorg_1_1libelektra_1_1Key}{Key} org.\+libelektra.\+Key\+Set.\+lookup (\begin{DoxyParamCaption}\item[{final String}]{find }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Helper function to search for a key in the key set. 


\begin{DoxyParams}{Parameters}
{\em find} & \hyperlink{classorg_1_1libelektra_1_1Key}{Key} name used in search \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
\hyperlink{classorg_1_1libelektra_1_1Key}{Key} if search successful, null otherwise 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a9a21c729da19bc6fb2e7f33fe06ee15e}\label{classorg_1_1libelektra_1_1KeySet_a9a21c729da19bc6fb2e7f33fe06ee15e}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!needs\+Sync@{needs\+Sync}}
\index{needs\+Sync@{needs\+Sync}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{needs\+Sync()}{needsSync()}}
{\footnotesize\ttfamily int org.\+libelektra.\+Key\+Set.\+needs\+Sync (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Helper function to check if synchronization is necessary. 

\begin{DoxyReturn}{Returns}
1 if sync is necessary, 0 if no sync is necessary, -\/1 in case of an error (null key) 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a92aa593320132e4272602dda29aee2c7}\label{classorg_1_1libelektra_1_1KeySet_a92aa593320132e4272602dda29aee2c7}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!next@{next}}
\index{next@{next}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{next()}{next()}}
{\footnotesize\ttfamily \hyperlink{classorg_1_1libelektra_1_1Key}{Key} org.\+libelektra.\+Key\+Set.\+next (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Helper function that returns the next key in the key set. 

\begin{DoxyReturn}{Returns}
Next \hyperlink{classorg_1_1libelektra_1_1Key}{Key} in key set 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a6fcb652d72c64772bae40ec801d93ad9}\label{classorg_1_1libelektra_1_1KeySet_a6fcb652d72c64772bae40ec801d93ad9}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!pop@{pop}}
\index{pop@{pop}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{pop()}{pop()}}
{\footnotesize\ttfamily \hyperlink{classorg_1_1libelektra_1_1Key}{Key} org.\+libelektra.\+Key\+Set.\+pop (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Helper function that returns key from key set and also removes it from the set. 

\begin{DoxyReturn}{Returns}
First \hyperlink{classorg_1_1libelektra_1_1Key}{Key} in the set 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a20533a5e97b16b76b977b95be179d58c}\label{classorg_1_1libelektra_1_1KeySet_a20533a5e97b16b76b977b95be179d58c}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!rewind@{rewind}}
\index{rewind@{rewind}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{rewind()}{rewind()}}
{\footnotesize\ttfamily int org.\+libelektra.\+Key\+Set.\+rewind (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Helper function that rewinds the current key set. 

\begin{DoxyReturn}{Returns}

\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_adb3caad35c8dfcd1934d7cd32ff0ca4a}\label{classorg_1_1libelektra_1_1KeySet_adb3caad35c8dfcd1934d7cd32ff0ca4a}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!set\+Cursor@{set\+Cursor}}
\index{set\+Cursor@{set\+Cursor}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{set\+Cursor()}{setCursor()}}
{\footnotesize\ttfamily int org.\+libelektra.\+Key\+Set.\+set\+Cursor (\begin{DoxyParamCaption}\item[{final int}]{cursor }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Helper function that sets the current cursor of the key set. 


\begin{DoxyParams}{Parameters}
{\em cursor} & Cursor position as integer \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
1 in case of success 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_ab81aff6c88595b3f4c3307d1f996857f}\label{classorg_1_1libelektra_1_1KeySet_ab81aff6c88595b3f4c3307d1f996857f}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!tail@{tail}}
\index{tail@{tail}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{tail()}{tail()}}
{\footnotesize\ttfamily \hyperlink{classorg_1_1libelektra_1_1Key}{Key} org.\+libelektra.\+Key\+Set.\+tail (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Helper function that gets the key set tail. 

\begin{DoxyReturn}{Returns}
Last element of the key set 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1KeySet_a9c1e2918acce8c7cda5be406989c87af}\label{classorg_1_1libelektra_1_1KeySet_a9c1e2918acce8c7cda5be406989c87af}} 
\index{org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}!to\+String@{to\+String}}
\index{to\+String@{to\+String}!org\+::libelektra\+::\+Key\+Set@{org\+::libelektra\+::\+Key\+Set}}
\subsubsection{\texorpdfstring{to\+String()}{toString()}}
{\footnotesize\ttfamily String org.\+libelektra.\+Key\+Set.\+to\+String (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Basic java function that represents object as String. 

~\newline
 Iterates though all keys in this key set and appends their representation to the output. Uses the \hyperlink{classorg_1_1libelektra_1_1KeySet_a9c1e2918acce8c7cda5be406989c87af}{to\+String()} function of the \hyperlink{classorg_1_1libelektra_1_1Key}{Key} objects.

\begin{DoxyReturn}{Returns}
List of key-\/value pairs contained in this key set 
\end{DoxyReturn}


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