PathBinaryReadable.java

  1. /*
  2.  * *********************************************************************************************************************
  3.  *
  4.  * TheseFoolishThings: Miscellaneous utilities
  5.  * http://tidalwave.it/projects/thesefoolishthings
  6.  *
  7.  * Copyright (C) 2009 - 2023 by Tidalwave s.a.s. (http://tidalwave.it)
  8.  *
  9.  * *********************************************************************************************************************
  10.  *
  11.  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  12.  * the License. You may obtain a copy of the License at
  13.  *
  14.  *     http://www.apache.org/licenses/LICENSE-2.0
  15.  *
  16.  * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
  17.  * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the
  18.  * specific language governing permissions and limitations under the License.
  19.  *
  20.  * *********************************************************************************************************************
  21.  *
  22.  * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
  23.  * git clone https://github.com/tidalwave-it/thesefoolishthings-src
  24.  *
  25.  * *********************************************************************************************************************
  26.  */
  27. package it.tidalwave.role.io.spi;

  28. import javax.annotation.Nonnull;
  29. import java.io.IOException;
  30. import java.io.InputStream;
  31. import java.nio.file.Files;
  32. import java.nio.file.OpenOption;
  33. import java.nio.file.Path;
  34. import it.tidalwave.role.io.BinaryReadable;

  35. /***********************************************************************************************************************
  36.  *
  37.  * An implementation of {@link BinaryReadable} which delegates to a {@link Path}.
  38.  *
  39.  * @author  Fabrizio Giudici
  40.  * @since   3.2-ALPHA-12
  41.  * @it.tidalwave.javadoc.stable
  42.  *
  43.  **********************************************************************************************************************/
  44. public class PathBinaryReadable implements BinaryReadable
  45.   {
  46.     @Nonnull
  47.     private final Path path;

  48.     @Nonnull
  49.     private final OpenOption[] openOptions;

  50.     /*******************************************************************************************************************
  51.      *
  52.      * Creates an instance with the given path and options.
  53.      *
  54.      * @param   path          the path to open
  55.      * @param   openOptions   open options
  56.      *
  57.      ******************************************************************************************************************/
  58.     public PathBinaryReadable (@Nonnull final Path path, @Nonnull final OpenOption... openOptions)
  59.       {
  60.         this.path = path;
  61.         this.openOptions = openOptions;
  62.       }

  63.     /*******************************************************************************************************************
  64.      *
  65.      * {@inheritDoc}
  66.      *
  67.      ******************************************************************************************************************/
  68.     @Override @Nonnull
  69.     public InputStream openStream()
  70.       throws IOException
  71.       {
  72.         return Files.newInputStream(path, openOptions);
  73.       }
  74.   }