org.projectnessie.model.ContentResponse Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nessie-model-quarkus Show documentation

nessie-model-jakarta is effectively the same as nessie-model, but it is _not_ a multi-release jar and retains the jakarta annotations in the canonical classes. Please note that this artifact will go away, once Nessie no longer support Java 8 for clients. Therefore, do _not_ refer to this artifact - it is only meant for consumption by Nessie-Quarkus.

The newest version!

/*
 * Copyright (C) 2020 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 com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonView;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import javax.annotation.Nullable;
import javax.validation.constraints.NotNull;
import org.immutables.value.Value;
import org.projectnessie.model.ser.Views;

@Value.Immutable
@JsonSerialize(as = ImmutableContentResponse.class)
@JsonDeserialize(as = ImmutableContentResponse.class)
public interface ContentResponse {

  static ImmutableContentResponse.Builder builder() {
    return ImmutableContentResponse.builder();
  }

  @NotNull
  @jakarta.validation.constraints.NotNull
  @Value.Parameter(order = 1)
  Content getContent();

  /**
   * The effective reference (for example a branch or tag) including the commit ID from which the
   * entries were fetched. Never null.
   */
  @NotNull
  @jakarta.validation.constraints.NotNull
  @Value.Parameter(order = 2)
  Reference getEffectiveReference();

  @Nullable
  @jakarta.annotation.Nullable
  @JsonView(Views.V2.class)
  @JsonInclude(JsonInclude.Include.NON_NULL)
  @Value.Parameter(order = 3)
  Documentation getDocumentation();

  static ContentResponse of(Content content, Reference effectiveReference) {
    return of(content, effectiveReference, null);
  }

  static ContentResponse of(
      Content content, Reference effectiveReference, Documentation documentation) {
    return ImmutableContentResponse.of(content, effectiveReference, documentation);
  }
}