$darkmode
Elektra 0.11.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
org.libelektra.KeySet Class Reference

Java representation of a native Elektra key set, a container for keys. More...

Inherits AbstractSet< Key >, and NavigableSet< Key >.

Public Member Functions

KeySet dup ()
 Duplicates the key set. More...
 
KeySet copy (KeySet source)
 Copies key references from. More...
 
KeySet append (Key key)
 Append key to key set. More...
 
KeySet append (KeySet source)
 Appends keys from key set. More...
 
KeySet cut (Key cutpoint)
 Creates new key set with help of a cut point. More...
 
Optional< Keyremove (ReadableKey key)
 Removes the specified key from key set. More...
 
Optional< Keyremove (String find)
 Removes the key with the specified name from key set. More...
 
Key remove (int cursor)
 Returns key from key set and also removes it from the set. More...
 
Key at (int cursor)
 Gets the key at the given cursor position. More...
 
int indexOf (Key key)
 
Optional< Keylookup (Key find)
 Search for a key in the key set. More...
 
Optional< Keylookup (String find)
 Search for a key in the key set. More...
 
String toString ()
 Iterates though all keys in this key set and appends their representation to the output. More...
 
int size ()
 
boolean isEmpty ()
 
boolean contains (@Nullable Object o)
 
Key lower (Key key)
 
Key floor (Key key)
 
Key ceiling (Key key)
 
Key higher (Key key)
 
Key pollFirst ()
 
Key pollLast ()
 
Iterator< Keyiterator ()
 
NavigableSet< KeydescendingSet ()
 
Iterator< KeydescendingIterator ()
 
NavigableSet< KeysubSet (Key fromElement, boolean fromInclusive, Key toElement, boolean toInclusive)
 
NavigableSet< KeyheadSet (Key toElement, boolean inclusive)
 
NavigableSet< KeytailSet (Key fromElement, boolean inclusive)
 
Object[] toArray ()
 
boolean add (Key e)
 
boolean remove (Object o)
 
boolean containsAll (Collection<?> c)
 
boolean addAll (Collection<? extends Key > c)
 
boolean retainAll (Collection<?> c)
 
boolean removeAll (Collection<?> c)
 
void clear ()
 Removes all elements form this KeySet. More...
 
Comparator<? super Keycomparator ()
 
SortedSet< KeysubSet (Key fromElement, Key toElement)
 
SortedSet< KeyheadSet (Key toElement)
 
SortedSet< KeytailSet (Key fromElement)
 
Key first ()
 
Key last ()
 

Static Public Member Functions

static KeySet create (Key... keys)
 Constructs a new KeySet containing the specified keys

Example: KeySet keySet = KeySet.create(Key.create("A"), Key.create("B"));. More...
 
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"));. More...
 
static KeySet create ()
 Constructs an empty KeySet with a default allocation hint of 16. More...
 

Protected Member Functions

 KeySet (long nativePointer)
 Constructor associating a new KeySet instance with a native pointer in long format. More...
 
 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. More...
 
 KeySet (Pointer pointer)
 Constructor associating a new KeySet instance with a JNA pointer. More...
 
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 ()
 

Detailed Description

Java representation of a native Elektra key set, a container for keys.

Constructor & Destructor Documentation

◆ KeySet() [1/3]

org.libelektra.KeySet.KeySet ( long  nativePointer)
inlineprotected

Constructor associating a new KeySet instance with a native pointer in long format.

Parameters
nativePointerNative 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
nativePointerNative pointer to key set in long format
suppressCleanUpTrue to suppress native reference clean-up as soon as this {} 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
pointerJNA Pointer to key set
Exceptions
IllegalArgumentExceptionif
pointer
is
null

Member Function Documentation

◆ add()

boolean org.libelektra.KeySet.add ( Key  e)
inline

Exceptions
IllegalStateExceptionif this KeySet or the specified
key
has already been released
NullPointerExceptionif
key
is
null
KeySetExceptionif inserting the
key
failed because of allocation problems
See also
append(Key)

◆ addAll()

boolean org.libelektra.KeySet.addAll ( Collection<? extends Key c)
inline

Exceptions
IllegalStateExceptionif this KeySet or any Key contained in the specified collection
c
has already been released
NullPointerExceptionif the specified collection is
null
or contains
null
elements
KeySetExceptionif 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
keyKey to append
Returns
This KeySet, enabling a fluent interface
Exceptions
IllegalStateExceptionif this KeySet or the specified
key
has already been released
IllegalArgumentExceptionif
key
is
null
KeySetExceptionif appending the
key
failed because of allocation problems
See also
add(Key)

◆ append() [2/2]

KeySet org.libelektra.KeySet.append ( KeySet  source)
inline

Appends keys from key set.

Parameters
sourceSource KeySet to append all of its keys
Returns
This KeySet, enabling a fluent interface
Exceptions
IllegalStateExceptionif this KeySet or the specified
source
has already been released
IllegalArgumentExceptionif
source
is
null
KeySetExceptionif 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
cursorCursor position used to fetch key; starting from 0
Returns
Key found at specified cursor position
Exceptions
IllegalStateExceptionif this KeySet has already been released
IndexOutOfBoundsExceptionif position is out of bounds

◆ ceiling()

Key org.libelektra.KeySet.ceiling ( Key  key)
inline

Exceptions
IllegalStateExceptionif this KeySet has already been released

◆ clear()

void org.libelektra.KeySet.clear ( )
inline

Removes all elements form this KeySet.

Exceptions
IllegalStateExceptionif 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
IllegalStateExceptionif this KeySet has already been released

◆ contains()

boolean org.libelektra.KeySet.contains ( @Nullable Object  o)
inline

Exceptions
IllegalStateExceptionif this KeySet has already been released or the passed o is a Key that has already been released
NullPointerExceptionif the specified element
o
is
null
See also
lookup(Key)

◆ containsAll()

boolean org.libelektra.KeySet.containsAll ( Collection<?>  c)
inline

Exceptions
IllegalStateExceptionif this KeySet has already been released
NullPointerExceptionif the specified collection is
null
or contains
null
elements

◆ copy()

KeySet org.libelektra.KeySet.copy ( KeySet  source)
inline

Copies key references from.

source

to this KeySet

Parameters
sourceKey set that is used as source
Returns
This KeySet, enabling a fluent interface
Exceptions
IllegalStateExceptionif this KeySet or the specified
source
has already been released
IllegalArgumentExceptionif
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
KeySetExceptionon 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
allocationHintHint indicating the expected size of the key set
keysList of initial keys for the key set
Returns
New key set containing the specified initial keys
Exceptions
KeySetExceptionon 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
keysList of initial keys for the key set
Returns
New key set containing the specified initial keys
Exceptions
KeySetExceptionon allocation problems

◆ cut()

KeySet org.libelektra.KeySet.cut ( Key  cutpoint)
inline

Creates new key set with help of a cut point.

Parameters
cutpointKey that is used as cutting point
Returns
New KeySet containing all keys until the cutting point
Exceptions
IllegalStateExceptionif this KeySet has already been released
IllegalArgumentExceptionif
cutpoint
is
null
KeySetExceptionif
cutpoint
is missing a key name or on allocation problems

◆ descendingIterator()

Iterator<Key> org.libelektra.KeySet.descendingIterator ( )
inline

Returns
New DescendingKeySetIterator backed by this KeySet

◆ descendingSet()

NavigableSet<Key> org.libelektra.KeySet.descendingSet ( )
inline

Returns
New DescendingKeySetView backed by this KeySet

◆ dup()

KeySet org.libelektra.KeySet.dup ( )
inline

Duplicates the key set.

Returns
New KeySet containing the same key references as this KeySet does
Exceptions
IllegalStateExceptionif this KeySet has already been released

◆ first()

Key org.libelektra.KeySet.first ( )
inline

Exceptions
IllegalStateExceptionif this KeySet has already been released
NoSuchElementException

◆ floor()

Key org.libelektra.KeySet.floor ( Key  key)
inline

Exceptions
IllegalStateExceptionif 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
IllegalStateExceptionif this KeySet has already been released

◆ headSet() [1/2]

SortedSet<Key> org.libelektra.KeySet.headSet ( Key  toElement)
inline

Exceptions
IllegalStateExceptionif this KeySet has already been released
NullPointerExceptionif
toElement
is
null
IllegalArgumentException

◆ headSet() [2/2]

NavigableSet<Key> org.libelektra.KeySet.headSet ( Key  toElement,
boolean  inclusive 
)
inline

Exceptions
IllegalStateExceptionif this KeySet has already been released
NullPointerExceptionif
toElement
is
null
IllegalArgumentException

◆ higher()

Key org.libelektra.KeySet.higher ( Key  key)
inline

Exceptions
IllegalStateExceptionif this KeySet has already been released

◆ indexOf()

int org.libelektra.KeySet.indexOf ( Key  key)
inline
Parameters
keyKey to look for
Returns
Index of the
key
in this KeySet
Exceptions
IllegalStateExceptionif KeySet or
key
has already been released
IllegalArgumentExceptionif
key
was not found in this KeySet

◆ isEmpty()

boolean org.libelektra.KeySet.isEmpty ( )
inline

Exceptions
IllegalStateExceptionif this KeySet has already been released

◆ iterator()

Iterator<Key> org.libelektra.KeySet.iterator ( )
inline

Returns
New KeySetIterator backed by this KeySet

◆ last()

Key org.libelektra.KeySet.last ( )
inline

Exceptions
IllegalStateExceptionif 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
findKey used in search
Returns
Key if search successful, Optional#empty() otherwise
Exceptions
IllegalStateExceptionif this KeySet has already been released
IllegalArgumentExceptionif
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
findKey name used in search
Returns
Key if search successful, Optional#empty() otherwise
Exceptions
IllegalStateExceptionif this KeySet has already been released
IllegalArgumentExceptionif
find
is blank

◆ lower()

Key org.libelektra.KeySet.lower ( Key  key)
inline

Exceptions
IllegalStateExceptionif this KeySet has already been released

◆ pollFirst()

Key org.libelektra.KeySet.pollFirst ( )
inline

Exceptions
IllegalStateExceptionif this KeySet has already been released

◆ pollLast()

Key org.libelektra.KeySet.pollLast ( )
inline

Exceptions
IllegalStateExceptionif 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
cursorCursor position of the key to remove; starting from 0
Returns
Key found at given cursor position
Exceptions
IllegalStateExceptionif this KeySet has already been released
IndexOutOfBoundsExceptionif position is out of bounds

◆ remove() [2/4]

boolean org.libelektra.KeySet.remove ( Object  o)
inline

Exceptions
IllegalStateExceptionif this KeySet has already been released
See also
remove(ReadableKey)

◆ remove() [3/4]

Optional<Key> org.libelektra.KeySet.remove ( ReadableKey  key)
inline

Removes the specified key from key set.

Parameters
keyKey to remove
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
IllegalStateExceptionif KeySet or
key
has already been released
IllegalArgumentExceptionif
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
findName of the key to remove
Returns
Removed Key from the key set, matching the specified
key
's name. {} if the no key matching the specified name was not found. IllegalStateException if this KeySet} has already been released IllegalArgumentException if find is String#isBlank() blank}

◆ removeAll()

boolean org.libelektra.KeySet.removeAll ( Collection<?>  c)
inline

Exceptions
IllegalStateExceptionif this KeySet has already been released
NullPointerExceptionif the specified collection is
null
or contains
null
elements

◆ retainAll()

boolean org.libelektra.KeySet.retainAll ( Collection<?>  c)
inline

Exceptions
IllegalStateExceptionif this KeySet has already been released
NullPointerExceptionif the specified collection is
null
or contains
null
elements

◆ size()

int org.libelektra.KeySet.size ( )
inline

Exceptions
IllegalStateExceptionif 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
IllegalStateExceptionif this KeySet has already been released
NullPointerExceptionif
fromElement
or
toElement
is
null
IllegalArgumentException

◆ subSet() [2/2]

SortedSet<Key> org.libelektra.KeySet.subSet ( Key  fromElement,
Key  toElement 
)
inline

Exceptions
IllegalStateExceptionif this KeySet has already been released
NullPointerExceptionif
fromElement
or
toElement
is
null
IllegalArgumentException

◆ tailSet() [1/2]

SortedSet<Key> org.libelektra.KeySet.tailSet ( Key  fromElement)
inline

Exceptions
IllegalStateExceptionif this KeySet has already been released
NullPointerExceptionif
fromElement
is
null
IllegalArgumentException

◆ tailSet() [2/2]

NavigableSet<Key> org.libelektra.KeySet.tailSet ( Key  fromElement,
boolean  inclusive 
)
inline

Exceptions
IllegalStateExceptionif this KeySet has already been released
NullPointerExceptionif
fromElement
is
null
IllegalArgumentException

◆ toArray()

Object [] org.libelektra.KeySet.toArray ( )
inline

Exceptions
IllegalStateExceptionif 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: