bt.data.BlockSet Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bt-core Show documentation
BitTorrent Client Library (Core)
The newest version!
/*
 * Copyright (c) 2016—2021 Andrei Tomashpolskiy and individual contributors.
 *
 * 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 bt.data;

/**
 * @since 1.2
 */
public interface BlockSet {

    /**
     * Get the total number of blocks in this block set.
     *
     * @return Total number of blocks in this block set.
     * @since 1.2
     */
    int blockCount();

    /**
     * Get the total length of this block set
     *
     * @return Total length of this block set
     * @since 1.2
     */
    long length();

    /**
     * Get the size of a block in this set.
     *
     * Note that the last block might be smaller due to truncation
     * (i.e. when the chunk's size is not a factor of the size of a block).
     *
     * @return Block size
     * @see #lastBlockSize()
     * @since 1.2
     */
    long blockSize();

    /**
     * Get the size of the last block in this set
     *
     * @return Size of the last block
     * @see #blockSize()
     * @since 1.2
     */
    long lastBlockSize();

    /**
     * Check if block is present.
     *
     * @param blockIndex Index of a block in this set
     *                   (0-based, maximum value is {@link #blockCount()} - 1)
     * @return true if block is present
     * @since 1.2
     */
    boolean isPresent(int blockIndex);

    /**
     * Shortcut method to determine if all blocks are present
     *
     * @return true if all blocks are present
     * @since 1.2
     */
    boolean isComplete();

    /**
     * Shortcut method to determine if no blocks are present
     *
     * @return true if no blocks are present
     * @since 1.2
     */
    boolean isEmpty();

    /**
     * Reset block presence information (may not perform actual deletion of data)
     *
     * @since 1.9
     */
    void clear();
}