View Javadoc
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.Writer;
31  import java.nio.charset.Charset;
32  import java.nio.charset.StandardCharsets;
33  import java.nio.file.Files;
34  import java.nio.file.OpenOption;
35  import java.nio.file.Path;
36  import it.tidalwave.role.io.TextWritable;
37  
38  /***************************************************************************************************************************************************************
39   *
40   * An implementation of {@link TextWritable} 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 PathTextWritable implements TextWritable
48    {
49      @Nonnull
50      private final Path path;
51  
52      @Nonnull
53      private final Charset charset;
54  
55      @Nonnull
56      private final OpenOption[] openOptions;
57  
58      /***********************************************************************************************************************************************************
59       * Creates an instance with the given path and options.
60       *
61       * @param   path          the path to open
62       **********************************************************************************************************************************************************/
63      public PathTextWritable (@Nonnull final Path path)
64        {
65          this(path, StandardCharsets.UTF_8);
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       * @param   openOptions   open options
74       **********************************************************************************************************************************************************/
75      public PathTextWritable (@Nonnull final Path path,
76                               @Nonnull final Charset charset,
77                               @Nonnull final OpenOption... openOptions)
78        {
79          this.path = path;
80          this.charset = charset;
81          this.openOptions = openOptions;
82        }
83  
84      /***********************************************************************************************************************************************************
85       * {@inheritDoc}
86       **********************************************************************************************************************************************************/
87      @Override @Nonnull
88      public Writer openWriter()
89        throws IOException
90        {
91          return Files.newBufferedWriter(path, charset, openOptions);
92        }
93    }