Method: openReader()

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