Package: SiteProvider

SiteProvider

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 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:
31: /***********************************************************************************************************************
32: *
33: * A provider for a {@link Site}. It handles the initial configuration and boot, in background. It also exposes a
34: * {@link #reload()} method to reload the contents.
35: *
36: * @author Fabrizio Giudici
37: *
38: **********************************************************************************************************************/
39: public interface SiteProvider
40: {
41: @SuppressWarnings("squid:S1700")
42: public static final Class<SiteProvider> _SiteProvider_ = SiteProvider.class;
43:
44: /*******************************************************************************************************************
45: *
46: * Returns the {@link Site}. It always returns an object, even though it might be not initialized yet (in this case
47: * {@link #isSiteAvailable()} returns {@code false}.
48: *
49: * @return the site
50: *
51: ******************************************************************************************************************/
52: @Nonnull
53: public Site getSite();
54:
55: /*******************************************************************************************************************
56: *
57: * Reloads the {@link Site}.
58: *
59: ******************************************************************************************************************/
60: public void reload();
61:
62: /*******************************************************************************************************************
63: *
64: * Returns {@code true} if the {@link Site} is available.
65: *
66: ******************************************************************************************************************/
67: public boolean isSiteAvailable();
68:
69: /*******************************************************************************************************************
70: *
71: * Returns the version string of NorthernWind.
72: *
73: * @return the version
74: *
75: ******************************************************************************************************************/
76: @Nonnull
77: public String getVersionString();
78: }