run.halo.app.extension.MetadataOperator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
API of halo project, connecting by other projects.
The newest version!
package run.halo.app.extension;

import static io.swagger.v3.oas.annotations.media.Schema.RequiredMode.REQUIRED;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import io.swagger.v3.oas.annotations.media.Schema;
import java.time.Instant;
import java.util.Map;
import java.util.Objects;
import java.util.Set;

/**
 * MetadataOperator contains some getters and setters for required fields of metadata.
 *
 * @author johnniang
 */
@JsonDeserialize(as = Metadata.class)
@Schema(implementation = Metadata.class)
public interface MetadataOperator {

    @Schema(name = "name", description = "Metadata name", requiredMode = REQUIRED)
    @JsonProperty("name")
    String getName();

    @Schema(name = "generateName", description = "The name field will be generated automatically "
        + "according to the given generateName field")
    String getGenerateName();

    @Schema(name = "labels")
    @JsonProperty("labels")
    Map getLabels();

    @Schema(name = "annotations")
    @JsonProperty("annotations")
    Map getAnnotations();

    @Schema(name = "version", nullable = true)
    @JsonProperty("version")
    Long getVersion();

    @Schema(name = "creationTimestamp", nullable = true)
    @JsonProperty("creationTimestamp")
    Instant getCreationTimestamp();

    @Schema(name = "deletionTimestamp", nullable = true)
    @JsonProperty("deletionTimestamp")
    Instant getDeletionTimestamp();

    @Schema(name = "finalizers", nullable = true)
    Set getFinalizers();

    void setName(String name);

    void setGenerateName(String generateName);

    void setLabels(Map labels);

    void setAnnotations(Map annotations);

    void setVersion(Long version);

    void setCreationTimestamp(Instant creationTimestamp);

    void setDeletionTimestamp(Instant deletionTimestamp);

    void setFinalizers(Set finalizers);

    static boolean metadataDeepEquals(MetadataOperator left, MetadataOperator right) {
        if (left == null && right == null) {
            return true;
        }
        if (left == null || right == null) {
            return false;
        }
        if (!Objects.equals(left.getName(), right.getName())) {
            return false;
        }
        if (!Objects.equals(left.getLabels(), right.getLabels())) {
            return false;
        }
        if (!Objects.equals(left.getAnnotations(), right.getAnnotations())) {
            return false;
        }
        if (!Objects.equals(left.getCreationTimestamp(), right.getCreationTimestamp())) {
            return false;
        }
        if (!Objects.equals(left.getDeletionTimestamp(), right.getDeletionTimestamp())) {
            return false;
        }
        if (!Objects.equals(left.getVersion(), right.getVersion())) {
            return false;
        }
        if (!Objects.equals(left.getFinalizers(), right.getFinalizers())) {
            return false;
        }
        return true;
    }
}