computer-core/src/main/java/com/baidu/hugegraph/computer/core/store/file/hgkvfile/HgkvFile.java

/*
 * Copyright 2017 HugeGraph Authors
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with this
 * work for additional information regarding copyright ownership. The ASF
 * licenses this file to You 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.baidu.hugegraph.computer.core.store.file.hgkvfile;

import java.io.Closeable;
import java.io.IOException;

import com.baidu.hugegraph.computer.core.io.RandomAccessOutput;

public interface HgkvFile extends Closeable {

    /**
     * The absolute path includes file name.
     */
    String path();

    /**
     * Number of entries in file.
     */
    long numEntries();

    /**
     * Number of sub entries in file.
     */
    long numSubEntries();

    /**
     * File version.
     */
    String version();

    /**
     * Max key in file.
     */
    byte[] max();

    /**
     * Min key in file.
     */
    byte[] min();

    /**
     * File verification string.
     */
    String magic();

    /**
     * Output of hgkv file.
     */
    RandomAccessOutput output() throws IOException;
}