io.sirix.access.ResourceStore Maven / Gradle / Ivy

Go to download
package io.sirix.access;

import io.sirix.cache.BufferManager;
import org.checkerframework.checker.nullness.qual.NonNull;
import io.sirix.api.NodeReadOnlyTrx;
import io.sirix.api.NodeTrx;
import io.sirix.api.ResourceSession;

import java.nio.file.Path;

public interface ResourceStore>
    extends AutoCloseable {

  /**
   * Open a resource, that is get an instance of a {@link ResourceSession} in order to read/write from
   * the resource.
   *
   * @param resourceConfig The resource configuration.
   * @param bufferManager  The buffer manager.
   * @param resourcePath   The resource to open.
   * @return A resource manager.
   * @throws NullPointerException if one if the arguments is {@code null}
   */
  R beginResourceSession(@NonNull ResourceConfiguration resourceConfig, @NonNull BufferManager bufferManager,
      @NonNull Path resourcePath);

  boolean hasOpenResourceSession(Path resourcePath);

  R getOpenResourceSession(Path resourcePath);

  @Override
  void close();

  boolean closeResourceSession(Path resourceFile);

}