org.projectnessie.model.FetchOption Maven / Gradle / Ivy
/*
* Copyright (C) 2022 Dremio
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.projectnessie.model;
import java.util.Locale;
import javax.annotation.Nullable;
/**
* This enum defines the levels of details that may be represented by model objects. For example,
* {@link Reference} objects may or may not include metadata. The exact meaning of each enum value
* depends on the usage context.
*/
public enum FetchOption {
MINIMAL,
ALL;
/**
* Will return true if the given fetchOption is {@link FetchOption#ALL},
* false otherwise.
*
* @param fetchOption the {@link FetchOption} to evaluate.
* @return true if the given fetchOption is {@link FetchOption#ALL},
* false otherwise.
*/
public static boolean isFetchAll(@Nullable @jakarta.annotation.Nullable FetchOption fetchOption) {
return ALL == fetchOption;
}
/**
* Will return the name from the given fetchOption or {@link FetchOption#MINIMAL} if
* the given fetchOption is null.
*
* @param fetchOption The {@link FetchOption} to evaluate and potentially return.
* @return The name of the given fetchOption or {@link FetchOption#MINIMAL} if the
* given fetchOption is null
*/
public static String getFetchOptionName(
@Nullable @jakarta.annotation.Nullable FetchOption fetchOption) {
return null == fetchOption ? FetchOption.MINIMAL.name() : fetchOption.name();
}
public static FetchOption parse(String fetchOption) {
try {
if (fetchOption != null) {
return FetchOption.valueOf(fetchOption.toUpperCase(Locale.ROOT));
}
return null;
} catch (IllegalArgumentException e) {
return ALL;
}
}
}