com.helger.diver.repo.IRepoStorageReadItem Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2023-2024 Philip Helger & ecosio
 * philip[at]helger[dot]com
 *
 * 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 com.helger.diver.repo;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.commons.annotation.ReturnsMutableCopy;

/**
 * Base interface for the data of an item in a repository as retrieved by
 * reading.
 *
 * @author Philip Helger
 */
public interface IRepoStorageReadItem
{
  /**
   * @return The main content of the item. Never null.
   */
  @Nonnull
  IRepoStorageContent getContent ();

  /**
   * @return true if this repo item has an expected hash value
   *         assigned with it.
   */
  boolean hasExpectedDigest ();

  /**
   * @return The stored hash bytes of this repo item or null.
   * @see #hasExpectedDigest()
   */
  @Nullable
  @ReturnsMutableCopy
  byte [] getExpectedDigest ();

  /**
   * @return true if a hash value was calculated during reading,
   *         false if not.
   */
  boolean hasCalculatedDigest ();

  /**
   * @return The calculated hash bytes of this repo item or null.
   * @see #hasCalculatedDigest()
   */
  @Nullable
  @ReturnsMutableCopy
  byte [] getCalculatedDigest ();

  /**
   * @return The verification state of this item. Never null.
   */
  @Nonnull
  ERepoHashState getHashState ();
}