org.apache.hadoop.fs.impl.FileRangeImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hadoop-common Show documentation
Apache Hadoop Common
The newest version!
/*
 * 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 org.apache.hadoop.fs.impl;

import java.nio.ByteBuffer;
import java.util.concurrent.CompletableFuture;

import org.apache.hadoop.classification.InterfaceAudience;
import org.apache.hadoop.fs.FileRange;

/**
 * A range of bytes from a file with an optional buffer to read those bytes
 * for zero copy. This shouldn't be created directly via constructor rather
 * factory defined in {@code FileRange#createFileRange} should be used.
 */
@InterfaceAudience.Private
public class FileRangeImpl implements FileRange {
  private long offset;
  private int length;
  private CompletableFuture reader;

  /**
   * nullable reference to store in the range.
   */
  private final Object reference;

  /**
   * Create.
   * @param offset offset in file
   * @param length length of data to read.
   * @param reference nullable reference to store in the range.
   */
  public FileRangeImpl(long offset, int length, Object reference) {
    this.offset = offset;
    this.length = length;
    this.reference = reference;
  }

  @Override
  public String toString() {
    return String.format("range [%d-%d], length=%,d, reference=%s",
        getOffset(), getOffset() + getLength(), getLength(), getReference());
  }

  @Override
  public long getOffset() {
    return offset;
  }

  @Override
  public int getLength() {
    return length;
  }

  public void setOffset(long offset) {
    this.offset = offset;
  }

  public void setLength(int length) {
    this.length = length;
  }

  @Override
  public void setData(CompletableFuture pReader) {
    this.reader = pReader;
  }

  @Override
  public CompletableFuture getData() {
    return reader;
  }

  @Override
  public Object getReference() {
    return reference;
  }
}