PathBinaryReadable.java

  1. /*
  2.  * *************************************************************************************************************************************************************
  3.  *
  4.  * TheseFoolishThings: Miscellaneous utilities
  5.  * http://tidalwave.it/projects/thesefoolishthings
  6.  *
  7.  * Copyright (C) 2009 - 2024 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 the License.
  12.  * 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 an "AS IS" BASIS, WITHOUT WARRANTIES OR
  17.  * CONDITIONS OF ANY KIND, either express or implied.  See the License for the specific language governing permissions and limitations under the License.
  18.  *
  19.  * *************************************************************************************************************************************************************
  20.  *
  21.  * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
  22.  * git clone https://github.com/tidalwave-it/thesefoolishthings-src
  23.  *
  24.  * *************************************************************************************************************************************************************
  25.  */
  26. package it.tidalwave.role.io.spi;

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

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

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

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

  60.     /***********************************************************************************************************************************************************
  61.      * {@inheritDoc}
  62.      **********************************************************************************************************************************************************/
  63.     @Override @Nonnull
  64.     public InputStream openStream()
  65.       throws IOException
  66.       {
  67.         return Files.newInputStream(path, openOptions);
  68.       }
  69.   }