alluxio.master.file.contexts

Class ListStatusContext

java.lang.Object

alluxio.master.file.contexts.OperationContext<ListStatusPOptions.Builder,ListStatusContext>

alluxio.master.file.contexts.ListStatusContext

public class ListStatusContext
extends OperationContext<ListStatusPOptions.Builder,ListStatusContext>

Used to merge and wrap ListStatusPOptions.

Method Summary

Modifier and Type	Method and Description
static ListStatusContext	create(ListStatusPartialPOptions.Builder optionsBuilder)
static ListStatusContext	create(ListStatusPOptions.Builder optionsBuilder)
static ListStatusContext	defaults()
boolean	donePartialListing()
Optional<ListStatusPartialPOptions.Builder>	getPartialOptions()
long	getTotalListings() Get the value set by setTotalListing.
boolean	isDoneListing()
boolean	isPartialListing()
boolean	isTruncated()
boolean	listedItem() Called each time an item is listed.
static ListStatusContext	mergeFrom(ListStatusPartialPOptions.Builder optionsBuilder) Merges and embeds the given ListStatusPartialPOptions with the corresponding master options.
static ListStatusContext	mergeFrom(ListStatusPOptions.Builder optionsBuilder) Merges and embeds the given ListStatusPOptions with the corresponding master options.
void	setTotalListings(long count) Set the total number of listings in this call, this should be -1 if a recursive listing.
String	toString()

Methods inherited from class alluxio.master.file.contexts.OperationContext

getCancelledTrackers, getOperationId, getOptions, withTracker

Methods inherited from class java.lang.Object

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

Method Detail

getPartialOptions

public Optional<ListStatusPartialPOptions.Builder> getPartialOptions()

Returns:

the partial listing options

setTotalListings

public void setTotalListings(long count)

Set the total number of listings in this call, this should be -1 if a recursive listing.

Parameters:

count - the number of listings

getTotalListings

public long getTotalListings()

Get the value set by setTotalListing.

Returns:

the number of listings

create

public static ListStatusContext create(ListStatusPOptions.Builder optionsBuilder)

Parameters:

optionsBuilder - Builder for proto ListStatusPOptions

Returns:

the instance of ListStatusContext with the given options

create

public static ListStatusContext create(ListStatusPartialPOptions.Builder optionsBuilder)

Parameters:

optionsBuilder - Builder for proto ListStatusPOptions

Returns:

the instance of ListStatusContext with the given options

mergeFrom

public static ListStatusContext mergeFrom(ListStatusPOptions.Builder optionsBuilder)

Merges and embeds the given ListStatusPOptions with the corresponding master options.

Parameters:

optionsBuilder - Builder for proto ListStatusPOptions to merge with defaults

Returns:

the instance of ListStatusContext with default values for master

mergeFrom

public static ListStatusContext mergeFrom(ListStatusPartialPOptions.Builder optionsBuilder)

Merges and embeds the given ListStatusPartialPOptions with the corresponding master options.

Parameters:

optionsBuilder - Builder for proto ListStatusPartialPOptions to merge with defaults

Returns:

the instance of ListStatusContext with default values for master

defaults

public static ListStatusContext defaults()

Returns:

the instance of ListStatusContext with default values for master

listedItem

public boolean listedItem()

Called each time an item is listed.

Returns:

true if the item should be listed, false otherwise

isDoneListing

public boolean isDoneListing()

Returns:

true if the listing has completed and no new items need to be processed

isPartialListing

public boolean isPartialListing()

Returns:

true if this call is a partial listing of files (either has StartAfter set, has an offset set, or has a batch size set).

donePartialListing

public boolean donePartialListing()

Returns:

true if this is a partial listing and at least the batch size elements have been listed, false otherwise

isTruncated

public boolean isTruncated()

Returns:

true if a partial listing and the result was truncated

toString

public String toString()

Overrides:

toString in class Object