Package: WritableFolder

WritableFolder

name	instruction	branch	complexity	line	method
static {...}	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: * #%L
3: * *********************************************************************************************************************
4: *
5: * NorthernWind - lightweight CMS
6: * http://northernwind.tidalwave.it - git clone git@bitbucket.org:tidalwave/northernwind-rca-src.git
7: * %%
8: * Copyright (C) 2013 - 2021 Tidalwave s.a.s. (http://tidalwave.it)
9: * %%
10: * *********************************************************************************************************************
11: *
12: * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
13: * the License. You may obtain a copy of the License at
14: *
15: * http://www.apache.org/licenses/LICENSE-2.0
16: *
17: * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
18: * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
19: * specific language governing permissions and limitations under the License.
20: *
21: * *********************************************************************************************************************
22: *
23: *
24: * *********************************************************************************************************************
25: * #L%
26: */
27: package it.tidalwave.northernwind.model.admin.role;
28:
29: import javax.annotation.Nonnull;
30: import java.io.IOException;
31: import it.tidalwave.role.io.Marshallable;
32:
33: /***********************************************************************************************************************
34: *
35: * A role for folders that can be written into.
36: *
37: * @stereotype role
38: *
39: * @author Fabrizio Giudici
40: *
41: **********************************************************************************************************************/
42: public interface WritableFolder
43: {
44: public static final Class<WritableFolder> _WritableFolder_ = WritableFolder.class;
45:
46: /*******************************************************************************************************************
47: *
48: * Writes a text into the specified file.
49: *
50: * @param fileName the name of the file inside the folder to write to
51: * @param text the text to write
52: * @throws IOException in case of I/O error
53: *
54: ******************************************************************************************************************/
55: public void write (@Nonnull String fileName, @Nonnull String text)
56: throws IOException;
57:
58: /*******************************************************************************************************************
59: *
60: * Writes a marshallable object into the specified file.
61: *
62: * @param fileName the name of the file inside the folder to write to
63: * @param marshallable the object to write
64: * @throws IOException in case of I/O error
65: *
66: ******************************************************************************************************************/
67: public void write (@Nonnull String fileName, @Nonnull Marshallable marshallable)
68: throws IOException;
69: }