Package: Marshallable

Marshallable

name	instruction	branch	complexity	line	method
static {...}	M: 0 C: 3 100%	M: 0 C: 0 100%	M: 0 C: 1 100%	M: 0 C: 1 100%	M: 0 C: 1 100%

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.OutputStream;
31:
32: /***************************************************************************************************************************************************************
33: *
34: * The role of an object that can be marshalled to an {@link OutputStream}.
35: *
36: * @stereotype Role
37: *
38: * @author Fabrizio Giudici
39: *
40: **************************************************************************************************************************************************************/
41: @FunctionalInterface
42: public interface Marshallable
43: {
44: public static final Class<Marshallable> _Marshallable_ = Marshallable.class;
45:
46: /***********************************************************************************************************************************************************
47: * Marshals this object to an {@link OutputStream}.
48: *
49: * @param os the {@code OutputStream}
50: * @throws IOException in case of errors
51: **********************************************************************************************************************************************************/
52: @SuppressWarnings("RedundantThrows")
53: public void marshal (@Nonnull OutputStream os)
54: throws IOException;
55: }