Package org.projectnessie.model

Enum Class FetchOption

java.lang.Object

java.lang.Enum<FetchOption>

org.projectnessie.model.FetchOption

All Implemented Interfaces:

Serializable, Comparable<FetchOption>, Constable

public enum FetchOption
extends Enum<FetchOption>

This enum defines the levels of details that may be represented by model objects. For example, Reference objects may or may not include metadata. The exact meaning of each enum value depends on the usage context.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

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	parse(String fetchOption)
static FetchOption	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FetchOption[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MINIMAL

public static final FetchOption MINIMAL

ALL

public static final FetchOption ALL

Method Details

values

public static FetchOption[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static FetchOption valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

isFetchAll

public static boolean isFetchAll(@Nullable @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 @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

parse

public static FetchOption parse(String fetchOption)