org.projectnessie.model.metadata.GenericContentMetadata Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nessie-model Show documentation
The newest version!
/*
 * Copyright (C) 2023 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.metadata;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.annotation.JsonUnwrapped;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import java.util.Map;
import javax.annotation.Nullable;
import org.eclipse.microprofile.openapi.annotations.enums.SchemaType;
import org.eclipse.microprofile.openapi.annotations.media.Schema;
import org.immutables.value.Value;
import org.projectnessie.model.ContentMetadata;
import org.projectnessie.model.metadata.GenericContentMetadataSerialization.GenericContentMetadataDeserializer;
import org.projectnessie.model.metadata.GenericContentMetadataSerialization.GenericContentMetadataSerializer;

/** Default/fallback representation of unknown content-metadata variants. */
@Value.Immutable
@JsonSerialize(using = GenericContentMetadataSerializer.class)
@JsonDeserialize(using = GenericContentMetadataDeserializer.class)
public interface GenericContentMetadata extends ContentMetadata {

  @Override
  @Value.Parameter(order = 1)
  String getVariant();

  @Nullable
  @jakarta.annotation.Nullable
  @Schema(type = SchemaType.OBJECT)
  @Value.Parameter(order = 2)
  @JsonInclude(Include.NON_NULL)
  @JsonUnwrapped
  Map getAttributes();

  static GenericContentMetadata genericContentMetadata(
      String variant, Map attributes) {
    return ImmutableGenericContentMetadata.of(variant, attributes);
  }
}