Package org.gnome.glib

Class List<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.AbstractSequentialList<E>

org.gnome.glib.List<E>

Type Parameters:

E - The element type must be a MemorySegment, a String, a primitive value, or implement the Proxy interface.

All Implemented Interfaces:

Proxy, Iterable<E>, Collection<E>, List<E>, SequencedCollection<E>

public class List<E>
extends AbstractSequentialList<E>
implements Proxy

Java wrapper for GLib.List that implements List.

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
List(MemorySegment address, Function<MemorySegment,E> make, boolean fullOwnership)	Create a new GLib.List wrapper.
List(MemorySegment address, Function<MemorySegment,E> make, Consumer<E> free, boolean fullOwnership)	Create a new GLib.List wrapper.
List(Function<MemorySegment,E> make, Consumer<E> free, boolean fullOwnership)	Create a wrapper for a new, empty GLib.List.

Method Summary

Modifier and Type	Method	Description
MemorySegment	handle()	Returns the memory address of the head of the list.
boolean	isEmpty()	Checks if the list has no elements (the head of the list is null).
@NotNull ListIterator<E>	listIterator(int index)	Returns a list iterator over the elements in this GLib.List (in proper sequence).
int	size()	Retrieve the size of the list.

Methods inherited from class java.util.AbstractSequentialList

add, addAll, get, iterator, remove, set

Methods inherited from class java.util.AbstractList

add, clear, equals, hashCode, indexOf, lastIndexOf, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addAll, addFirst, addLast, contains, containsAll, getFirst, getLast, remove, removeAll, removeFirst, removeLast, replaceAll, retainAll, reversed, sort, spliterator, toArray, toArray

Constructor Details

List

public List(MemorySegment address,
 Function<MemorySegment,E> make,
 Consumer<E> free,
 boolean fullOwnership)

Create a new GLib.List wrapper.

Parameters:

address - the memory address of the head element of the List

make - a function to construct element instances

free - a function to free element instances. If fullOwnership is false, this can safely be set to null.

fullOwnership - whether to free element instances automatically

List

public List(Function<MemorySegment,E> make,
 Consumer<E> free,
 boolean fullOwnership)

Create a wrapper for a new, empty GLib.List.

Parameters:

make - a function to construct element instances

free - a function to free element instances. If fullOwnership is false, this can safely be set to null.

fullOwnership - whether to free element instances automatically

List

public List(MemorySegment address,
 Function<MemorySegment,E> make,
 boolean fullOwnership)

Create a new GLib.List wrapper.

Parameters:

address - the memory address of the head element of the List

make - a function to construct element instances

fullOwnership - whether to free element instances automatically with GLib.free(java.lang.foreign.MemorySegment)

Method Details

listIterator

@NotNull
public @NotNull ListIterator<E> listIterator(int index)

Returns a list iterator over the elements in this GLib.List (in proper sequence).

Specified by:

listIterator in interface List<E>

Specified by:

listIterator in class AbstractSequentialList<E>

Parameters:

index - index of first element to be returned from the list iterator (by a call to the next method)

Returns:

a list iterator over the elements in this list (in proper sequence).

size

public int size()

Retrieve the size of the list. This is an expensive operation for long lists, because the entire length must be traversed.

Specified by:

size in interface Collection<E>

Specified by:

size in interface List<E>

Specified by:

size in class AbstractCollection<E>

Returns:

the length of the list

isEmpty

public boolean isEmpty()

Checks if the list has no elements (the head of the list is null).

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface List<E>

Overrides:

isEmpty in class AbstractCollection<E>

Returns:

whether the list is empty

handle

public MemorySegment handle()

Returns the memory address of the head of the list. This address can change if the list is modified.

Specified by:

handle in interface Proxy

Returns:

the memory address of the current GLib.List head, or MemorySegment.NULL if the head is null.