alluxio.client.file.options

Class FreeOptions

java.lang.Object

alluxio.client.file.options.FreeOptions

@PublicApi
 @NotThreadSafe
public final class FreeOptions
extends Object

Method options for freeing space.

Method Summary

Modifier and Type	Method and Description
static FreeOptions	defaults()
boolean	equals(Object o)
CommonOptions	getCommonOptions()
int	hashCode()
boolean	isForced()
boolean	isRecursive()
FreeOptions	setCommonOptions(CommonOptions options)
FreeOptions	setForced(boolean forced) Sets the forced flag.
FreeOptions	setRecursive(boolean recursive) Sets the recursive flag.
String	toString()
FreeTOptions	toThrift()

Methods inherited from class java.lang.Object

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

Method Detail

defaults

public static FreeOptions defaults()

Returns:

the default FreeOptions

getCommonOptions

public CommonOptions getCommonOptions()

Returns:

the common options

isForced

public boolean isForced()

Returns:

the forced flag value; if the object to be freed is pinned, the flag specifies whether this object should still be freed

isRecursive

public boolean isRecursive()

Returns:

the recursive flag value; if the object to be freed is a directory, the flag specifies whether the directory content should be recursively freed as well

setCommonOptions

public FreeOptions setCommonOptions(CommonOptions options)

Parameters:

options - the common options

Returns:

the updated options object

setForced

public FreeOptions setForced(boolean forced)

Sets the forced flag.

Parameters:

forced - the forced flag value; if the object to be freed is pinned, the flag specifies whether this object should still be freed

Returns:

the updated options object

setRecursive

public FreeOptions setRecursive(boolean recursive)

Sets the recursive flag.

Parameters:

recursive - the recursive flag value to use; if the object to be freed is a directory, the flag specifies whether the directory content should be recursively freed as well

Returns:

the updated options object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toThrift

public FreeTOptions toThrift()

Returns:

Thrift representation of the options