Package: TextReadable$1

TextReadable$1

name	instruction	branch	complexity	line	method
openReader()	M: 5 C: 0 0%	M: 0 C: 0 100%	M: 1 C: 0 0%	M: 1 C: 0 0%	M: 1 C: 0 0%
{...}	M: 3 C: 0 0%	M: 0 C: 0 100%	M: 1 C: 0 0%	M: 1 C: 0 0%	M: 1 C: 0 0%

Coverage

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