Package: ResourceFileSystem

ResourceFileSystem

Coverage

1: /*
2: * #%L
3: * *********************************************************************************************************************
4: *
5: * NorthernWind - lightweight CMS
6: * http://northernwind.tidalwave.it - git clone https://bitbucket.org/tidalwave/northernwind-src.git
7: * %%
8: * Copyright (C) 2011 - 2023 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.core.model;
28:
29: import javax.annotation.Nonnull;
30: import it.tidalwave.util.As;
31:
32: /***********************************************************************************************************************
33: *
34: * The file system to which a {@link ResourceFile} belongs to.
35: *
36: * @author Fabrizio Giudici
37: *
38: **********************************************************************************************************************/
39: public interface ResourceFileSystem extends As
40: {
41: /*******************************************************************************************************************
42: *
43: * Returns the root of this file system.
44: *
45: * @return the root folder
46: *
47: ******************************************************************************************************************/
48: @Nonnull
49: public ResourceFile getRoot();
50:
51: /*******************************************************************************************************************
52: *
53: * Returns the file with the given path
54: * TODO replace with a Finder
55: *
56: * @param path the file path
57: * @return the file, null if not found
58: *
59: ******************************************************************************************************************/
60: public ResourceFile findFileByPath (@Nonnull String path);
61: }