Method: {...}

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;
28:
29: import javax.annotation.Nonnull;
30: import java.io.IOException;
31: import java.io.Writer;
32:
33: /***********************************************************************************************************************
34: *
35: * The role of an object that can be written as a stream of characters.
36: *
37: * @author Fabrizio Giudici
38: * @it.tidalwave.javadoc.stable
39: *
40: **********************************************************************************************************************/
41: @FunctionalInterface
42: public interface TextWritable
43: {
44: public static final Class<TextWritable> _TextWritable_ = TextWritable.class;
45:
46: /*******************************************************************************************************************
47: *
48: * A default implementation which throws {@link IOException} when opening the stream.
49: *
50: ******************************************************************************************************************/
51: public static final TextWritable DEFAULT = new TextWritable()
52: {
53: @Override @Nonnull
54: public Writer openWriter()
55: throws IOException
56: {
57: throw new IOException("Operation not supported");
58: }
59: };
60:
61: /*******************************************************************************************************************
62: *
63: * Returns a {@link Writer} to write into the object.
64: *
65: * @return the {@code Writer}
66: * @throws IOException if the operation can't be performed
67: *
68: ******************************************************************************************************************/
69: @Nonnull
70: public Writer openWriter()
71: throws IOException;
72: }