Package org.projectnessie.api.params

Enum FetchOption

java.lang.Object

java.lang.Enum<FetchOption>

org.projectnessie.api.params.FetchOption

All Implemented Interfaces:

Serializable, Comparable<FetchOption>

public enum FetchOption
extends Enum<FetchOption>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL
MINIMAL

Method Summary

Modifier and Type	Method	Description
static String	getFetchOptionName(FetchOption fetchOption)	Will return the name from the given fetchOption or MINIMAL if the given fetchOption is null.
static boolean	isFetchAll(FetchOption fetchOption)	Will return true if the given fetchOption is ALL, false otherwise.
static FetchOption	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FetchOption[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MINIMAL

public static final FetchOption MINIMAL

ALL

public static final FetchOption ALL

Method Detail

values

public static FetchOption[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FetchOption c : FetchOption.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FetchOption valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isFetchAll

public static boolean isFetchAll(@Nullable
                                 FetchOption fetchOption)

Will return true if the given fetchOption is ALL, false otherwise.

Parameters:

fetchOption - the FetchOption to evaluate.

Returns:

true if the given fetchOption is ALL, false otherwise.

getFetchOptionName

public static String getFetchOptionName(@Nullable
                                        FetchOption fetchOption)

Will return the name from the given fetchOption or MINIMAL if the given fetchOption is null.

Parameters:

fetchOption - The FetchOption to evaluate and potentially return.

Returns:

The name of the given fetchOption or MINIMAL if the given fetchOption is null