Package: BinaryReadable

BinaryReadable

name	instruction	branch	complexity	line	method
static {...}	M: 7 C: 0 0%	M: 0 C: 0 100%	M: 1 C: 0 0%	M: 2 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.InputStream;
31:
32: /***************************************************************************************************************************************************************
33: *
34: * The role of an object that can be read as a stream of bytes.
35: *
36: * @stereotype Role
37: *
38: * @author Fabrizio Giudici
39: * @it.tidalwave.javadoc.stable
40: *
41: **************************************************************************************************************************************************************/
42: @FunctionalInterface
43: public interface BinaryReadable
44: {
45: public static final Class<BinaryReadable> _BinaryReadable_ = BinaryReadable.class;
46:
47: /***********************************************************************************************************************************************************
48: * A default implementation which throws {@link IOException} when opening the stream.
49: **********************************************************************************************************************************************************/
50: public static final BinaryReadable DEFAULT = new BinaryReadable()
51: {
52: @Override @Nonnull
53: public InputStream openStream()
54: throws IOException
55: {
56: throw new IOException("Operation not supported");
57: }
58: };
59:
60: /***********************************************************************************************************************************************************
61: * Returns an {@link InputStream} to read from the object.
62: *
63: * @return the {@code InputStream}
64: * @throws IOException if the operation can't be performed
65: **********************************************************************************************************************************************************/
66: @Nonnull
67: public InputStream openStream()
68: throws IOException;
69: }