PathBinaryReadable.java

/*
 * *************************************************************************************************************************************************************
 *
 * TheseFoolishThings: Miscellaneous utilities
 * http://tidalwave.it/projects/thesefoolishthings
 *
 * Copyright (C) 2009 - 2024 by Tidalwave s.a.s. (http://tidalwave.it)
 *
 * *************************************************************************************************************************************************************
 *
 * 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.
 *
 * *************************************************************************************************************************************************************
 *
 * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
 * git clone https://github.com/tidalwave-it/thesefoolishthings-src
 *
 * *************************************************************************************************************************************************************
 */
package it.tidalwave.role.io.spi;

import javax.annotation.Nonnull;
import java.io.IOException;
import java.io.InputStream;
import java.nio.file.Files;
import java.nio.file.OpenOption;
import java.nio.file.Path;
import it.tidalwave.role.io.BinaryReadable;

/***************************************************************************************************************************************************************
 *
 * An implementation of {@link BinaryReadable} which delegates to a {@link Path}.
 *
 * @author  Fabrizio Giudici
 * @since   3.2-ALPHA-12
 * @it.tidalwave.javadoc.stable
 *
 **************************************************************************************************************************************************************/
public class PathBinaryReadable implements BinaryReadable
  {
    @Nonnull
    private final Path path;

    @Nonnull
    private final OpenOption[] openOptions;

    /***********************************************************************************************************************************************************
     * Creates an instance with the given path and options.
     *
     * @param   path          the path to open
     * @param   openOptions   open options
     **********************************************************************************************************************************************************/
    public PathBinaryReadable (@Nonnull final Path path, @Nonnull final OpenOption... openOptions)
      {
        this.path = path;
        this.openOptions = openOptions;
      }

    /***********************************************************************************************************************************************************
     * {@inheritDoc}
     **********************************************************************************************************************************************************/
    @Override @Nonnull
    public InputStream openStream()
      throws IOException
      {
        return Files.newInputStream(path, openOptions);
      }
  }