com.microsoft.azure.storage.file.FileRange Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of azure-storage Show documentation

SDK for Microsoft Azure Storage Clients

There is a newer version: 8.6.6

/**
 * Copyright Microsoft Corporation
 * 
 * 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.microsoft.azure.storage.file;

/**
 * Represents a range of bytes in a file.
 */
public final class FileRange {
    /**
     * Represents the ending offset of the file range.
     */
    private long endOffset;

    /**
     * Represents the starting offset of the file range.
     */
    private long startOffset;

    /**
     * Creates an instance of the {@link FileRange} class.
     * 
     * @param start
     *            A long which represents the starting offset.
     * @param end
     *            A long which represents the ending offset.
     */
    public FileRange(final long start, final long end) {
        this.setStartOffset(start);
        this.setEndOffset(end);
    }

    /**
     * Gets the ending offset.
     * 
     * @return A long which represents the ending offset.
     */
    public long getEndOffset() {
        return this.endOffset;
    }

    /**
     * Gets the starting offset.
     * 
     * @return A long which represents the starting offset.
     */
    public long getStartOffset() {
        return this.startOffset;
    }

    /**
     * Sets the ending offset.
     * 
     * @param endOffset
     *            A long which specifies the ending offset.
     */
    public void setEndOffset(final long endOffset) {
        this.endOffset = endOffset;
    }

    /**
     * Sets the starting offset.
     * 
     * @param startOffset
     *            A long which specifies the starting offset.
     */
    public void setStartOffset(final long startOffset) {
        this.startOffset = startOffset;
    }

    /**
     * Returns the content of the file range as a string.
     * 
     * @return A String which represents the contents of the file range.
     */
    @Override
    public String toString() {
        return String.format("bytes=%d-%d", this.getStartOffset(), this.getEndOffset());
    }
}