Java representation of a native Elektra key set, a container for keys.
More...
Inherits AbstractSet< Key >, and NavigableSet< Key >.
|
| static KeySet | create (Key... keys) |
| | Constructs a new KeySet containing the specified keys
Example: KeySet keySet = KeySet.create(Key.create("A"), Key.create("B"));.
|
| |
| static KeySet | create (int allocationHint, Key... keys) |
| | Constructs a new KeySet containing the specified keys
Example: KeySet keySet = KeySet.create(10, Key.create("A"), Key.create("B"));.
|
| |
| static KeySet | create () |
| | Constructs an empty KeySet with a default allocation hint of 16.
|
| |
|
| | KeySet (long nativePointer) |
| | Constructor associating a new KeySet instance with a native pointer in long format.
|
| |
| | KeySet (long nativePointer, boolean suppressCleanUp) |
| | Constructor associating a new KeySet instance with a native pointer in long format
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.
|
| |
| | KeySet (Pointer pointer) |
| | Constructor associating a new KeySet instance with a JNA pointer.
|
| |
|
void | release () |
| | Clean-up method to release key set reference by trying to free the native reference
key sets, will get cleaned up by garbage collection as soon as they get phantom reachable.
|
| |
| Pointer | getPointer () |
| |
Java representation of a native Elektra key set, a container for keys.
◆ KeySet() [1/3]
| org.libelektra.KeySet.KeySet |
( |
long |
nativePointer | ) |
|
|
inlineprotected |
Constructor associating a new KeySet instance with a native pointer in long format.
- Parameters
-
| nativePointer | Native pointer to key set in long format |
◆ KeySet() [2/3]
| org.libelektra.KeySet.KeySet |
( |
long |
nativePointer, |
|
|
boolean |
suppressCleanUp |
|
) |
| |
|
inlineprotected |
Constructor associating a new KeySet instance with a native pointer in long format
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.
- Parameters
-
| nativePointer | Native pointer to key set in long format |
| suppressCleanUp | True to suppress native reference clean-up as soon as this KeySet instance becomes phantom reachable, false otherwise |
◆ KeySet() [3/3]
| org.libelektra.KeySet.KeySet |
( |
Pointer |
pointer | ) |
|
|
inlineprotected |
Constructor associating a new KeySet instance with a JNA pointer.
- Parameters
-
- Exceptions
-
| IllegalArgumentException | if pointer is null |
◆ add()
| boolean org.libelektra.KeySet.add |
( |
Key |
e | ) |
|
|
inline |
- Exceptions
-
| IllegalStateException | if this KeySet or the specified key has already been released |
| NullPointerException | if key is null |
| KeySetException | if inserting the key failed because of allocation problems |
- See also
- #append(Key)
◆ addAll()
| boolean org.libelektra.KeySet.addAll |
( |
Collection<? extends Key > |
c | ) |
|
|
inline |
- Exceptions
-
| IllegalStateException | if this KeySet or any Key contained in the specified collection c has already been released |
| NullPointerException | if the specified collection is null or contains
null elements |
| KeySetException | if inserting the key failed because of allocation problems |
◆ append() [1/2]
| KeySet org.libelektra.KeySet.append |
( |
Key |
key | ) |
|
|
inline |
Append key to key set.
- Parameters
-
- Returns
- This
KeySet, enabling a fluent interface
- Exceptions
-
| IllegalStateException | if this KeySet or the specified key has already been released |
| IllegalArgumentException | if key is null |
| KeySetException | if appending the key failed because of allocation problems |
- See also
- #add(Key)
◆ append() [2/2]
Appends keys from key set.
- Parameters
-
- Returns
- This
KeySet, enabling a fluent interface
- Exceptions
-
| IllegalStateException | if this KeySet or the specified source has already been released |
| IllegalArgumentException | if source is null |
| KeySetException | if appending the source failed because of allocation problems |
◆ at()
| Key org.libelektra.KeySet.at |
( |
int |
cursor | ) |
|
|
inline |
Gets the key at the given cursor position.
- Parameters
-
| cursor | Cursor position used to fetch key; starting from 0 |
- Returns
- Key found at specified cursor position
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
| IndexOutOfBoundsException | if position is out of bounds |
◆ ceiling()
| Key org.libelektra.KeySet.ceiling |
( |
Key |
key | ) |
|
|
inline |
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
◆ clear()
| void org.libelektra.KeySet.clear |
( |
| ) |
|
|
inline |
Removes all elements form this KeySet.
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
◆ comparator()
| Comparator<? super Key > org.libelektra.KeySet.comparator |
( |
| ) |
|
|
inline |
@implSpec Returns null because natural ordering of keys is used (ReadableKey implements Comparable)
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
◆ contains()
| boolean org.libelektra.KeySet.contains |
( |
@Nullable Object |
o | ) |
|
|
inline |
- Exceptions
-
| IllegalStateException | if this KeySet has already been released or the passed o is a Key that has already been released |
| NullPointerException | if the specified element o is null |
- See also
- #lookup(Key)
◆ containsAll()
| boolean org.libelektra.KeySet.containsAll |
( |
Collection<?> |
c | ) |
|
|
inline |
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
| NullPointerException | if the specified collection is null or contains
null elements |
◆ copy()
Copies key references from source to this KeySet.
- Parameters
-
| source | Key set that is used as source |
- Returns
- This
KeySet, enabling a fluent interface
- Exceptions
-
| IllegalStateException | if this KeySet or the specified source has already been released |
| IllegalArgumentException | if source is null |
◆ create() [1/3]
| static KeySet org.libelektra.KeySet.create |
( |
| ) |
|
|
inlinestatic |
Constructs an empty KeySet with a default allocation hint of 16.
- Returns
- Newly allocated key set
- Exceptions
-
| KeySetException | on allocation problems |
◆ create() [2/3]
| static KeySet org.libelektra.KeySet.create |
( |
int |
allocationHint, |
|
|
Key... |
keys |
|
) |
| |
|
inlinestatic |
Constructs a new KeySet containing the specified keys
Example: KeySet keySet = KeySet.create(10, Key.create("A"), Key.create("B"));.
- Parameters
-
| allocationHint | Hint indicating the expected size of the key set |
| keys | List of initial keys for the key set |
- Returns
- New key set containing the specified initial keys
- Exceptions
-
| KeySetException | on allocation problems |
◆ create() [3/3]
| static KeySet org.libelektra.KeySet.create |
( |
Key... |
keys | ) |
|
|
inlinestatic |
Constructs a new KeySet containing the specified keys
Example: KeySet keySet = KeySet.create(Key.create("A"), Key.create("B"));.
- Parameters
-
| keys | List of initial keys for the key set |
- Returns
- New key set containing the specified initial keys
- Exceptions
-
| KeySetException | on allocation problems |
◆ cut()
| KeySet org.libelektra.KeySet.cut |
( |
Key |
cutpoint | ) |
|
|
inline |
Creates new key set with help of a cut point.
- Parameters
-
| cutpoint | Key that is used as cutting point |
- Returns
- New
KeySet containing all keys until the cutting point
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
| IllegalArgumentException | if cutpoint is null |
| KeySetException | if cutpoint is missing a key name or on allocation problems |
◆ descendingIterator()
| Iterator< Key > org.libelektra.KeySet.descendingIterator |
( |
| ) |
|
|
inline |
◆ descendingSet()
| NavigableSet< Key > org.libelektra.KeySet.descendingSet |
( |
| ) |
|
|
inline |
◆ dup()
| KeySet org.libelektra.KeySet.dup |
( |
| ) |
|
|
inline |
Duplicates the key set.
- Returns
- New
KeySet containing the same key references as this KeySet does
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
◆ first()
| Key org.libelektra.KeySet.first |
( |
| ) |
|
|
inline |
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
| NoSuchElementException | |
◆ floor()
| Key org.libelektra.KeySet.floor |
( |
Key |
key | ) |
|
|
inline |
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
◆ getPointer()
| Pointer org.libelektra.KeySet.getPointer |
( |
| ) |
|
|
inlineprotected |
- Returns
- JNA pointer to the native pointer for this key set
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
◆ headSet() [1/2]
| SortedSet< Key > org.libelektra.KeySet.headSet |
( |
Key |
toElement | ) |
|
|
inline |
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
| NullPointerException | if toElement is null |
| IllegalArgumentException | |
◆ headSet() [2/2]
| NavigableSet< Key > org.libelektra.KeySet.headSet |
( |
Key |
toElement, |
|
|
boolean |
inclusive |
|
) |
| |
|
inline |
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
| NullPointerException | if toElement is null |
| IllegalArgumentException | |
◆ higher()
| Key org.libelektra.KeySet.higher |
( |
Key |
key | ) |
|
|
inline |
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
◆ indexOf()
| int org.libelektra.KeySet.indexOf |
( |
Key |
key | ) |
|
|
inline |
- Parameters
-
- Returns
- Index of the
key in this KeySet
- Exceptions
-
| IllegalStateException | if KeySet or key has already been released |
| IllegalArgumentException | if key was not found in this KeySet |
◆ isEmpty()
| boolean org.libelektra.KeySet.isEmpty |
( |
| ) |
|
|
inline |
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
◆ iterator()
| Iterator< Key > org.libelektra.KeySet.iterator |
( |
| ) |
|
|
inline |
◆ last()
| Key org.libelektra.KeySet.last |
( |
| ) |
|
|
inline |
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
| NoSuchElementException | |
◆ lookup() [1/2]
| Optional< Key > org.libelektra.KeySet.lookup |
( |
Key |
find | ) |
|
|
inline |
Search for a key in the key set.
- Parameters
-
- Returns
- Key if search successful,
Optional#empty() otherwise
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
| IllegalArgumentException | if key is null |
- See also
- #contains(Object)
◆ lookup() [2/2]
| Optional< Key > org.libelektra.KeySet.lookup |
( |
String |
find | ) |
|
|
inline |
Search for a key in the key set.
- Parameters
-
| find | Key name used in search |
- Returns
- Key if search successful,
Optional#empty() otherwise
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
| IllegalArgumentException | if find is blank |
◆ lower()
| Key org.libelektra.KeySet.lower |
( |
Key |
key | ) |
|
|
inline |
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
◆ pollFirst()
| Key org.libelektra.KeySet.pollFirst |
( |
| ) |
|
|
inline |
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
◆ pollLast()
| Key org.libelektra.KeySet.pollLast |
( |
| ) |
|
|
inline |
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
◆ remove() [1/4]
| Key org.libelektra.KeySet.remove |
( |
int |
cursor | ) |
|
|
inline |
Returns key from key set and also removes it from the set.
- Parameters
-
| cursor | Cursor position of the key to remove; starting from 0 |
- Returns
- Key found at given cursor position
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
| IndexOutOfBoundsException | if position is out of bounds |
◆ remove() [2/4]
| boolean org.libelektra.KeySet.remove |
( |
Object |
o | ) |
|
|
inline |
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
- See also
- #remove(ReadableKey)
◆ remove() [3/4]
Removes the specified key from key set.
- Parameters
-
- Returns
- Removed
Key from the key set, matching the specified key's name. May or may not reference the same native key resource. Optional#empty() if the specified key was not found.
- Exceptions
-
| IllegalStateException | if KeySet or key has already been released |
| IllegalArgumentException | if key is null |
- See also
- #remove(Object)
◆ remove() [4/4]
| Optional< Key > org.libelektra.KeySet.remove |
( |
String |
find | ) |
|
|
inline |
Removes the key with the specified name from key set.
- Parameters
-
| find | Name of the key to remove |
- Returns
- Removed
Key from the key set, matching the specified key's name. Optional#empty() if the no key matching the specified name was not found.
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
| IllegalArgumentException | if find is blank |
◆ removeAll()
| boolean org.libelektra.KeySet.removeAll |
( |
Collection<?> |
c | ) |
|
|
inline |
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
| NullPointerException | if the specified collection is null or contains
null elements |
◆ retainAll()
| boolean org.libelektra.KeySet.retainAll |
( |
Collection<?> |
c | ) |
|
|
inline |
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
| NullPointerException | if the specified collection is null or contains
null elements |
◆ size()
| int org.libelektra.KeySet.size |
( |
| ) |
|
|
inline |
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
◆ subSet() [1/2]
| NavigableSet< Key > org.libelektra.KeySet.subSet |
( |
Key |
fromElement, |
|
|
boolean |
fromInclusive, |
|
|
Key |
toElement, |
|
|
boolean |
toInclusive |
|
) |
| |
|
inline |
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
| NullPointerException | if fromElement or toElement is null |
| IllegalArgumentException | |
◆ subSet() [2/2]
| SortedSet< Key > org.libelektra.KeySet.subSet |
( |
Key |
fromElement, |
|
|
Key |
toElement |
|
) |
| |
|
inline |
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
| NullPointerException | if fromElement or toElement is null |
| IllegalArgumentException | |
◆ tailSet() [1/2]
| SortedSet< Key > org.libelektra.KeySet.tailSet |
( |
Key |
fromElement | ) |
|
|
inline |
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
| NullPointerException | if fromElement is null |
| IllegalArgumentException | |
◆ tailSet() [2/2]
| NavigableSet< Key > org.libelektra.KeySet.tailSet |
( |
Key |
fromElement, |
|
|
boolean |
inclusive |
|
) |
| |
|
inline |
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
| NullPointerException | if fromElement is null |
| IllegalArgumentException | |
◆ toArray()
| Object[] org.libelektra.KeySet.toArray |
( |
| ) |
|
|
inline |
- Exceptions
-
| IllegalStateException | if this KeySet has already been released |
◆ toString()
| String org.libelektra.KeySet.toString |
( |
| ) |
|
|
inline |
Iterates though all keys in this key set and appends their representation to the output.
Uses the toString() function of the Key objects.
- Returns
- Represents this
KeySet as string
The documentation for this class was generated from the following file: