Record Class DirectoryPage

java.lang.Object

java.lang.Record

net.bluemind.node.shared.DirectoryPage

Record Components:

files - regular files of this page

cursor - name of the last scanned entry, to pass as after to get the next page, null when the page is empty

truncated - true when entries were left out because the page was full

public record DirectoryPage(List<FileEntry> files, String cursor, boolean truncated)
extends Record

A page of DirectoryScan, ordered by file name.

Constructor Summary

Constructors

Constructor	Description
DirectoryPage(List<FileEntry> files, String cursor, boolean truncated)	Creates an instance of a DirectoryPage record class.

Method Summary

Modifier and Type	Method	Description
String	cursor()	Returns the value of the cursor record component.
static DirectoryPage	empty()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<FileEntry>	files()	Returns the value of the files record component.
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.
boolean	truncated()	Returns the value of the truncated record component.

Methods inherited from class Object

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

Constructor Details

DirectoryPage

public DirectoryPage(List<FileEntry> files,
 String cursor,
 boolean truncated)

Creates an instance of a DirectoryPage record class.

Parameters:

files - the value for the files record component

cursor - the value for the cursor record component

truncated - the value for the truncated record component

Method Details

empty

public static DirectoryPage empty()

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

files

public List<FileEntry> files()

Returns the value of the files record component.

Returns:

the value of the files record component

cursor

public String cursor()

Returns the value of the cursor record component.

Returns:

the value of the cursor record component

truncated

public boolean truncated()

Returns the value of the truncated record component.

Returns:

the value of the truncated record component