Module overrungl.nfd

Package overrungl.nfd

Class NFDEnumerator

java.lang.Object

overrungl.Pointer

overrungl.Struct

overrungl.nfd.NFDEnumerator

All Implemented Interfaces:

AutoCloseable, Iterable<String>, Addressable

public final class NFDEnumerator
extends Struct
implements Iterable<String>, AutoCloseable

NFDEnumerator relies on preview features of the Java platform:

• NFDEnumerator refers to one or more preview APIs: MemorySegment, SegmentAllocator, StructLayout.

Programs can only use NFDEnumerator when preview features are enabled.

Preview features may be removed in a future release, or upgraded to permanent features of the Java platform.

A wrapper of NFD path set enumerator.

Since:

0.1.0

Author:

squid233

See Also:

• NFD.pathSetGetEnum(MemorySegment, MemorySegment)^PREVIEW

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	NFDEnumerator.Kind	The kind of the enumerator.

Field Summary

Fields

Modifier and Type	Field	Description
static final StructLayoutPREVIEW	LAYOUT	The struct layout.

Fields inherited from class overrungl.Struct

layout

Fields inherited from class overrungl.Pointer

address, allocator, managedSegment

Method Summary

Modifier and Type	Method	Description
void	close()
static Tuple2<NFDResult,NFDEnumerator>	fromPathSetN(SegmentAllocatorPREVIEW allocator, MemorySegmentPREVIEW pathSet)	Creates an enumerator from the given path set that is created with NFD.openDialogMultipleN(java.lang.foreign.MemorySegment, overrungl.nfd.NFDNFilterItem.Buffer, java.lang.String)PREVIEW.
static Tuple2<NFDResult,NFDEnumerator>	fromPathSetU8(SegmentAllocatorPREVIEW allocator, MemorySegmentPREVIEW pathSet)	Creates an enumerator from the given path set that is created with NFD.openDialogMultipleU8(java.lang.foreign.MemorySegment, overrungl.nfd.NFDU8FilterItem.Buffer, java.lang.String)PREVIEW.
@NotNull Iterator<String>	iterator()

Methods inherited from class overrungl.Struct

layout, segment, sizeof

Methods inherited from class overrungl.Pointer

address, allocator, segment, segment

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

LAYOUT

public static final StructLayoutPREVIEW LAYOUT

The struct layout.

Method Details

fromPathSetN

public static Tuple2<NFDResult,NFDEnumerator> fromPathSetN(SegmentAllocatorPREVIEW allocator,
 MemorySegmentPREVIEW pathSet)

Creates an enumerator from the given path set that is created with NFD.openDialogMultipleN(java.lang.foreign.MemorySegment, overrungl.nfd.NFDNFilterItem.Buffer, java.lang.String)^PREVIEW.

Parameters:

allocator - the allocator of the enumerator.

pathSet - the path set.

Returns:

the result and the enumerator.

fromPathSetU8

public static Tuple2<NFDResult,NFDEnumerator> fromPathSetU8(SegmentAllocatorPREVIEW allocator,
 MemorySegmentPREVIEW pathSet)

Creates an enumerator from the given path set that is created with NFD.openDialogMultipleU8(java.lang.foreign.MemorySegment, overrungl.nfd.NFDU8FilterItem.Buffer, java.lang.String)^PREVIEW.

Parameters:

allocator - the allocator of the enumerator.

pathSet - the path set.

Returns:

the result and the enumerator.

iterator

@NotNull
public @NotNull Iterator<String> iterator()

Specified by:

iterator in interface Iterable<String>

close

public void close()

Specified by:

close in interface AutoCloseable