Class SequenceIter

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.glib.SequenceIter

All Implemented Interfaces:

Proxy

@Generated("org.javagi.JavaGI")
public class SequenceIter
extends ProxyInstance

The GSequenceIter struct is an opaque data type representing an iterator pointing into a GSequence.

Constructor Summary

Constructors

Constructor	Description
SequenceIter(MemorySegment address)	Create a SequenceIter proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
int	compare(SequenceIter b)	Returns a negative number if this SequenceIter comes before b, 0 if they are equal, and a positive number if this SequenceIter comes after b.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
int	getPosition()	Returns the position of this SequenceIter
Sequence	getSequence()	Returns the GSequence that this SequenceIter points into.
boolean	isBegin()	Returns whether this SequenceIter is the begin iterator
boolean	isEnd()	Returns whether this SequenceIter is the end iterator
SequenceIter	move(int delta)	Returns the GSequenceIter which is delta positions away from iter. If this SequenceIter is closer than -delta positions to the beginning of the sequence, the begin iterator is returned.
SequenceIter	next()	Returns an iterator pointing to the next position after iter. If this SequenceIter is the end iterator, the end iterator is returned.
SequenceIter	prev()	Returns an iterator pointing to the previous position before iter. If this SequenceIter is the begin iterator, the begin iterator is returned.

Methods inherited from class ProxyInstance

equals, handle, hashCode

Methods inherited from class Object

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

Constructor Details

SequenceIter

public SequenceIter(MemorySegment address)

Create a SequenceIter proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

compare

public int compare(SequenceIter b)

Returns a negative number if this SequenceIter comes before b, 0 if they are equal, and a positive number if this SequenceIter comes after b.

The this SequenceIter and b iterators must point into the same sequence.

Parameters:

b - a GSequenceIter

Returns:

a negative number if this SequenceIter comes before b, 0 if they are equal, and a positive number if this SequenceIter comes after b

Since:

2.14

getPosition

public int getPosition()

Returns the position of this SequenceIter

Returns:

the position of this SequenceIter

Since:

2.14

getSequence

public Sequence getSequence()

Returns the GSequence that this SequenceIter points into.

Returns:

the GSequence that this SequenceIter points into

Since:

2.14

isBegin

public boolean isBegin()

Returns whether this SequenceIter is the begin iterator

Returns:

whether this SequenceIter is the begin iterator

Since:

2.14

isEnd

public boolean isEnd()

Returns whether this SequenceIter is the end iterator

Returns:

Whether this SequenceIter is the end iterator

Since:

2.14

move

public SequenceIter move(int delta)

Returns the GSequenceIter which is delta positions away from iter. If this SequenceIter is closer than -delta positions to the beginning of the sequence, the begin iterator is returned. If this SequenceIter is closer than delta positions to the end of the sequence, the end iterator is returned.

Parameters:

delta - A positive or negative number indicating how many positions away from this SequenceIter the returned GSequenceIter will be

Returns:

a GSequenceIter which is delta positions away from this SequenceIter

Since:

2.14

next

public SequenceIter next()

Returns an iterator pointing to the next position after iter. If this SequenceIter is the end iterator, the end iterator is returned.

Returns:

a GSequenceIter pointing to the next position after this SequenceIter

Since:

2.14

prev

public SequenceIter prev()

Returns an iterator pointing to the previous position before iter. If this SequenceIter is the begin iterator, the begin iterator is returned.

Returns:

a GSequenceIter pointing to the previous position before this SequenceIter

Since:

2.14