com.metamx.common.MappedByteBufferHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-util Show documentation

Java and jvm utilities

There is a newer version: 1.3.8

/*
 * Copyright 2016 Metamarkets Group Inc.
 *
 * 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.metamx.common;

import java.io.File;
import java.nio.MappedByteBuffer;

/**
 * Facilitates using try-with-resources with {@link MappedByteBuffer}s which don't implement {@link AutoCloseable}.
 *
 * This interface is a specialization of {@code io.druid.collections.ResourceHandler}.
 * @see FileUtils#map(File)
 */
public final class MappedByteBufferHandler implements AutoCloseable
{
  private final MappedByteBuffer mappedByteBuffer;

  MappedByteBufferHandler(MappedByteBuffer mappedByteBuffer)
  {
    this.mappedByteBuffer = mappedByteBuffer;
  }

  /**
   * Returns the wrapped buffer.
   */
  public MappedByteBuffer get()
  {
    return mappedByteBuffer;
  }

  /**
   * Unmaps the wrapped buffer.
   */
  @Override
  public void close()
  {
    ByteBufferUtils.unmap(mappedByteBuffer);
  }
}