Coverage Report

Coverage Report - org.jtheque.core.managers.core.ICore

Classes in this File

 package org.jtheque.core.managers.core;
 
 /*
  * This file is part of JTheque.
  *
  * JTheque is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 3 of the License.
  *
  * JTheque is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with JTheque.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 import org.jtheque.core.managers.core.application.Application;
 import org.jtheque.core.managers.core.io.IFilesContainer;
 import org.jtheque.core.managers.core.io.IFoldersContainer;
 import org.jtheque.core.managers.lifecycle.ILifeCycleManager;
 import org.jtheque.utils.bean.Version;
 
 import java.util.Collection;
 
 /**
  * A core specification.
  *
  * @author Baptiste Wicht
  */
 public interface ICore {
     String IMAGES_BASE_NAME = "org/jtheque/core/images";
 
     /**
      * Return the version of the core.
      *
      * @return The version of the core.
      */
     Version getCoreCurrentVersion();
 
     /**
      * Launch the JTheque Core.
      *
      * @param application The application to launch.
      */
     void launchJThequeCore(Application application);
 
     /**
      * Return the messages file url for the core.
      *
      * @return The URL to the messages files of the core.
      */
     String getCoreMessageFileURL();
 
     /**
      * Return the folders of the application.
      *
      * @return The folders of the application.
      */
     IFoldersContainer getFolders();
 
     /**
      * Return the files of the application.
      *
      * @return The files of the application.
      */
     IFilesContainer getFiles();
 
     /**
      * Add an internationalized credits message.
      *
      * @param key The internationalized key.
      */
     void addCreditsMessage(String key);
 
     /**
      * Return all the credits message.
      *
      * @return A List containing all the credits message.
      */
     Collection<String> getCreditsMessage();
 
     /**
      * Indicate if the current version of the core is compatible with an other version.
      *
      * @param version The version to test the compatibility with.
      * @return true if the current version is compatible with the other version.
      */
     boolean isNotCompatibleWith(Version version);
 
     /**
      * Return the current application.
      *
      * @return The current application.
      */
     Application getApplication();
 
     /**
      * Return the manager of the life cycle.
      *
      * @return The manager of the life cycle.
      */
     ILifeCycleManager getLifeCycleManager();
 
     /**
      * Return the configuration of the core.
      *
      * @return The configuration of the core.
      */
     CoreConfiguration getConfiguration();
 }

1		package org.jtheque.core.managers.core;
2
3		/*
4		* This file is part of JTheque.
5		*
6		* JTheque is free software: you can redistribute it and/or modify
7		* it under the terms of the GNU General Public License as published by
8		* the Free Software Foundation, either version 3 of the License.
9		*
10		* JTheque is distributed in the hope that it will be useful,
11		* but WITHOUT ANY WARRANTY; without even the implied warranty of
12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13		* GNU General Public License for more details.
14		*
15		* You should have received a copy of the GNU General Public License
16		* along with JTheque. If not, see <http://www.gnu.org/licenses/>.
17		*/
18
19		import org.jtheque.core.managers.core.application.Application;
20		import org.jtheque.core.managers.core.io.IFilesContainer;
21		import org.jtheque.core.managers.core.io.IFoldersContainer;
22		import org.jtheque.core.managers.lifecycle.ILifeCycleManager;
23		import org.jtheque.utils.bean.Version;
24
25		import java.util.Collection;
26
27		/**
28		* A core specification.
29		*
30		* @author Baptiste Wicht
31		*/
32		public interface ICore {
33		String IMAGES_BASE_NAME = "org/jtheque/core/images";
34
35		/**
36		* Return the version of the core.
37		*
38		* @return The version of the core.
39		*/
40		Version getCoreCurrentVersion();
41
42		/**
43		* Launch the JTheque Core.
44		*
45		* @param application The application to launch.
46		*/
47		void launchJThequeCore(Application application);
48
49		/**
50		* Return the messages file url for the core.
51		*
52		* @return The URL to the messages files of the core.
53		*/
54		String getCoreMessageFileURL();
55
56		/**
57		* Return the folders of the application.
58		*
59		* @return The folders of the application.
60		*/
61		IFoldersContainer getFolders();
62
63		/**
64		* Return the files of the application.
65		*
66		* @return The files of the application.
67		*/
68		IFilesContainer getFiles();
69
70		/**
71		* Add an internationalized credits message.
72		*
73		* @param key The internationalized key.
74		*/
75		void addCreditsMessage(String key);
76
77		/**
78		* Return all the credits message.
79		*
80		* @return A List containing all the credits message.
81		*/
82		Collection<String> getCreditsMessage();
83
84		/**
85		* Indicate if the current version of the core is compatible with an other version.
86		*
87		* @param version The version to test the compatibility with.
88		* @return true if the current version is compatible with the other version.
89		*/
90		boolean isNotCompatibleWith(Version version);
91
92		/**
93		* Return the current application.
94		*
95		* @return The current application.
96		*/
97		Application getApplication();
98
99		/**
100		* Return the manager of the life cycle.
101		*
102		* @return The manager of the life cycle.
103		*/
104		ILifeCycleManager getLifeCycleManager();
105
106		/**
107		* Return the configuration of the core.
108		*
109		* @return The configuration of the core.
110		*/
111		CoreConfiguration getConfiguration();
112		}