$darkmode
Elektra 0.11.0
|
Read only key representing a native Elektra key providing read access to its name and value. More...
Public Member Functions | |
String | toString () |
Iterator< String > | keyNameIterator () |
boolean | getBoolean () |
byte | getByte () |
short | getShort () |
int | getInt () |
long | getLong () |
float | getFloat () |
double | getDouble () |
String | getString () |
Key | dup () |
Duplicates this ReadableKey as Key. More... | |
Key | dup (int flags) |
Duplicates this ReadableKey as Key. More... | |
int | compareTo (ReadableKey other) |
Compares this key with the. More... | |
boolean | isBelow (ReadableKey other) |
Checks whether this key is sub-key of the. More... | |
boolean | isBelowOrSame (ReadableKey other) |
Checks whether this key is the same as the. More... | |
boolean | isDirectlyBelow (ReadableKey other) |
Checks whether this key is direct sub-key of the. More... | |
boolean | isBinary () |
boolean | isString () |
String | getName () |
int | getNameSize () |
String | getBaseName () |
int | getBaseNameSize () |
int | getValueSize () |
boolean | isNull () |
Static Public Attributes | |
static final int | KEY_CP_NAME = 1 << 0 |
Flag for use with Key#copy(Key, int) and dup(int) for copying the key name. | |
static final int | KEY_CP_STRING = 1 << 1 |
Flag for use with Key#copy(Key, int) and dup(int) for copying the key value, if it is a string. More... | |
static final int | KEY_CP_VALUE = 1 << 2 |
Flag for use with Key#copy(Key, int) and dup(int) for copying the key value. More... | |
static final int | KEY_CP_META = 1 << 3 |
Flag for use with Key#copy(Key, int) and dup(int) for copying the key metadata. | |
static final int | KEY_CP_ALL = KEY_CP_NAME | KEY_CP_VALUE | KEY_CP_META |
Flag for use with Key#copy(Key, int) and dup(int) for copying the key name, value and metadata. | |
Protected Member Functions | |
ReadableKey (Pointer pointer) | |
Constructor associating a new ReadableKey instance with a JNA pointer. More... | |
ReadableKey (Pointer pointer, boolean suppressCleanUp) | |
Constructor associating a new ReadableKey instance with a JNA pointer 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. More... | |
void | release () |
Clean-up method to release key reference by first decrementing its reference counter and then trying to free the native reference keys, will get cleaned up by garbage collection as soon as they get phantom reachable. | |
Pointer | getPointer () |
Static Protected Member Functions | |
static Optional< ReadableKey > | createReadOnly (@Nullable Pointer pointer) |
Constructs a new ReadableKey instance associated with a JNA pointer. More... | |
Read only key representing a native Elektra key providing read access to its name and value.
@apiNote This abstraction is used to represent meta keys being read only by definition and cannot contain binary data
|
inlineprotected |
Constructor associating a new ReadableKey instance with a JNA pointer.
pointer | JNA Pointer to key |
|
inlineprotected |
Constructor associating a new ReadableKey instance with a JNA pointer
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.
|
inline |
Compares this key with the.
key by comparing the key name with string comparison
other | Other key to compare this key to |
IllegalStateException | if this or the other
|
IllegalArgumentException | if other
null
|
|
inlinestaticprotected |
Constructs a new ReadableKey instance associated with a JNA pointer.
pointer | Optional JNA Pointer to key |
|
inline |
Duplicates this ReadableKey as Key.
KeyException | if copying failed |
IllegalStateException | if this ReadableKey has already been released |
|
inline |
Duplicates this ReadableKey as Key.
flags | Flags indicating which parts of the key to copy Example: KEY_CP_NAME | KEY_CP_VALUE |
KeyException | if copying failed |
IllegalStateException | if this ReadableKey has already been released |
|
inline |
IllegalStateException | if this ReadableKey has already been released |
|
inline |
IllegalStateException | if this ReadableKey has already been released |
|
inline |
KeyStringValueException | if the underlying native key is not of type string |
IllegalStateException | if this ReadableKey has already been released |
|
inline |
NumberFormatException | if the getString() does not return a parsable byte
|
KeyStringValueException | if the underlying native key is not of type string |
IllegalStateException | if this ReadableKey has already been released |
|
inline |
NumberFormatException | if the getString() does not return a parsable double
|
KeyStringValueException | if the underlying native key is not of type string |
IllegalStateException | if this ReadableKey has already been released |
|
inline |
NumberFormatException | if the getString() does not return a parsable float
|
KeyStringValueException | if the underlying native key is not of type string |
IllegalStateException | if this ReadableKey has already been released |
|
inline |
NumberFormatException | if the getString() does not return a parsable integer |
KeyStringValueException | if the underlying native key is not of type string |
IllegalStateException | if this ReadableKey has already been released |
|
inline |
NumberFormatException | if the getString() does not return a parsable long
|
KeyStringValueException | if the underlying native key is not of type string |
IllegalStateException | if this ReadableKey has already been released |
|
inline |
IllegalStateException | if this ReadableKey has already been released |
|
inline |
IllegalStateException | if this ReadableKey has already been released |
|
inlineprotected |
IllegalStateException | if this ReadableKey has already been released |
|
inline |
NumberFormatException | if the getString() does not return a parsable short
|
KeyStringValueException | if the underlying native key is not of type string |
IllegalStateException | if this ReadableKey has already been released |
|
inline |
KeyStringValueException | if the underlying native key is not of type string |
IllegalStateException | if this ReadableKey has already been released |
|
inline |
IllegalStateException | if this ReadableKey has already been released |
|
inline |
Checks whether this key is sub-key of the.
key
other | Key that is used in check as parent key |
IllegalStateException | if this or the other
|
IllegalArgumentException | if other
null
|
|
inline |
Checks whether this key is the same as the.
key or a sub-key of the
key
other | Key that is used in check as parent key |
IllegalStateException | if this or the other
|
IllegalArgumentException | if other
null
|
|
inline |
IllegalStateException | if this ReadableKey has already been released |
|
inline |
Checks whether this key is direct sub-key of the.
key
other | Key that is used in check as parent key |
IllegalStateException | if this or the other
|
IllegalArgumentException | if other
null
|
|
inline |
IllegalStateException | if this ReadableKey has already been released |
|
inline |
IllegalStateException | if this ReadableKey has already been released |
|
inline |
IllegalStateException | if this ReadableKey has already been released |
|
inline |
|
static |
Flag for use with Key#copy(Key, int) and dup(int) for copying the key value, if it is a string.
@apiNote Do not use together with KEY_CP_VALUE
|
static |
Flag for use with Key#copy(Key, int) and dup(int) for copying the key value.
@apiNote Do not use together with KEY_CP_STRING