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
28 import javax.annotation.Nonnull;
29 import java.io.IOException;
30 import java.io.Reader;
31 import java.nio.charset.Charset;
32 import java.nio.charset.StandardCharsets;
33 import java.nio.file.Files;
34 import java.nio.file.Path;
35 import it.tidalwave.role.io.TextReadable;
36
37 /***************************************************************************************************************************************************************
38 *
39 * An implementation of {@link TextReadable} which delegates to a {@link Path}.
40 *
41 * @author Fabrizio Giudici
42 * @since 3.2-ALPHA-12
43 * @it.tidalwave.javadoc.stable
44 *
45 **************************************************************************************************************************************************************/
46 public class PathTextReadable implements TextReadable
47 {
48 @Nonnull
49 private final Path path;
50
51 @Nonnull
52 private final Charset charset;
53
54 /***********************************************************************************************************************************************************
55 * Creates an instance with the given path and options.
56 *
57 * @param path the path to open
58 **********************************************************************************************************************************************************/
59 public PathTextReadable (@Nonnull final Path path)
60 {
61 this(path, StandardCharsets.UTF_8);
62 }
63
64 /***********************************************************************************************************************************************************
65 * Creates an instance with the given path and options.
66 *
67 * @param path the path to open
68 * @param charset the character set
69 **********************************************************************************************************************************************************/
70 public PathTextReadable (@Nonnull final Path path, @Nonnull final Charset charset)
71 {
72 this.path = path;
73 this.charset = charset;
74 }
75
76 /***********************************************************************************************************************************************************
77 * {@inheritDoc}
78 **********************************************************************************************************************************************************/
79 @Override @Nonnull
80 public Reader openReader()
81 throws IOException
82 {
83 return Files.newBufferedReader(path, charset);
84 }
85 }