Coverage Report

Coverage Report - org.jtheque.core.managers.core.application.Application

Classes in this File

 package org.jtheque.core.managers.core.application;
 
 import org.jtheque.core.managers.resource.ImageType;
 import org.jtheque.utils.bean.Version;
 
 /*
  * 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/>.
  */
 
 /**
  * A JTheque Core application specification.
  *
  * @author Baptiste Wicht
  */
 public interface Application {
     /**
      * Return the path to the logo.
      *
      * @return The path to the logo.
      */
     String getLogo();
 
     /**
      * Return the image type of the logo.
      *
      * @return The image type of the logo.
      */
     ImageType getLogoType();
 
     /**
      * Return the path to the window icon.
      *
      * @return The path to the window icon.
      */
     String getWindowIcon();
 
     /**
      * Return the image type of the window icon.
      *
      * @return The image type of the window icon.
      */
     ImageType getWindowIconType();
 
     /**
      * Return the path to the licence.
      *
      * @return The path to the licence of the application.
      */
     String getLicenceFilePath();
 
     /**
      * Return the application version.
      *
      * @return The version of the application.
      */
     Version getVersion();
 
     /**
      * The path to the folder of the installation.
      *
      * @return The path to the application folder.
      */
     String getFolderPath();
 
     /**
      * Indicate if we must display the licence.
      *
      * @return true if we must display the licence else false.
      */
     boolean isDisplayLicence();
 
     /**
      * Return the url of the application repository.
      *
      * @return The URL to the application repository.
      */
     String getRepository();
 
     /**
      * Return the messages file url for the application.
      *
      * @return The URL to the messages files of the application.
      */
     String getMessageFileURL();
 
     /**
      * Return the name of the application.
      *
      * @return The name of the application.
      */
     String getName();
 
     /**
      * Return the author of the application.
      *
      * @return The author of the application.
      */
     String getAuthor();
 
     /**
      * Return the email of the author of the application.
      *
      * @return The email of the author of the application.
      */
     String getEmail();
 
     /**
      * Return the site of the application.
      *
      * @return The site of the application.
      */
     String getSite();
 
     /**
      * Return the copyright of the application.
      *
      * @return The copyright of the application.
      */
     String getCopyright();
 
     /**
      * Return all the supported languages of the application.
      *
      * @return An array containing the languages than the application support.
      */
     String[] getSupportedLanguages();
 
     /**
      * Return the application property.
      *
      * @param key The key of the property.
      *
      * @return The value of the property or empty string if there is no property with this key.
      */
     String getProperty(String key);
 }

1		package org.jtheque.core.managers.core.application;
2
3		import org.jtheque.core.managers.resource.ImageType;
4		import org.jtheque.utils.bean.Version;
5
6		/*
7		* This file is part of JTheque.
8		*
9		* JTheque is free software: you can redistribute it and/or modify
10		* it under the terms of the GNU General Public License as published by
11		* the Free Software Foundation, either version 3 of the License.
12		*
13		* JTheque is distributed in the hope that it will be useful,
14		* but WITHOUT ANY WARRANTY; without even the implied warranty of
15		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16		* GNU General Public License for more details.
17		*
18		* You should have received a copy of the GNU General Public License
19		* along with JTheque. If not, see <http://www.gnu.org/licenses/>.
20		*/
21
22		/**
23		* A JTheque Core application specification.
24		*
25		* @author Baptiste Wicht
26		*/
27		public interface Application {
28		/**
29		* Return the path to the logo.
30		*
31		* @return The path to the logo.
32		*/
33		String getLogo();
34
35		/**
36		* Return the image type of the logo.
37		*
38		* @return The image type of the logo.
39		*/
40		ImageType getLogoType();
41
42		/**
43		* Return the path to the window icon.
44		*
45		* @return The path to the window icon.
46		*/
47		String getWindowIcon();
48
49		/**
50		* Return the image type of the window icon.
51		*
52		* @return The image type of the window icon.
53		*/
54		ImageType getWindowIconType();
55
56		/**
57		* Return the path to the licence.
58		*
59		* @return The path to the licence of the application.
60		*/
61		String getLicenceFilePath();
62
63		/**
64		* Return the application version.
65		*
66		* @return The version of the application.
67		*/
68		Version getVersion();
69
70		/**
71		* The path to the folder of the installation.
72		*
73		* @return The path to the application folder.
74		*/
75		String getFolderPath();
76
77		/**
78		* Indicate if we must display the licence.
79		*
80		* @return true if we must display the licence else false.
81		*/
82		boolean isDisplayLicence();
83
84		/**
85		* Return the url of the application repository.
86		*
87		* @return The URL to the application repository.
88		*/
89		String getRepository();
90
91		/**
92		* Return the messages file url for the application.
93		*
94		* @return The URL to the messages files of the application.
95		*/
96		String getMessageFileURL();
97
98		/**
99		* Return the name of the application.
100		*
101		* @return The name of the application.
102		*/
103		String getName();
104
105		/**
106		* Return the author of the application.
107		*
108		* @return The author of the application.
109		*/
110		String getAuthor();
111
112		/**
113		* Return the email of the author of the application.
114		*
115		* @return The email of the author of the application.
116		*/
117		String getEmail();
118
119		/**
120		* Return the site of the application.
121		*
122		* @return The site of the application.
123		*/
124		String getSite();
125
126		/**
127		* Return the copyright of the application.
128		*
129		* @return The copyright of the application.
130		*/
131		String getCopyright();
132
133		/**
134		* Return all the supported languages of the application.
135		*
136		* @return An array containing the languages than the application support.
137		*/
138		String[] getSupportedLanguages();
139
140		/**
141		* Return the application property.
142		*
143		* @param key The key of the property.
144		*
145		* @return The value of the property or empty string if there is no property with this key.
146		*/
147		String getProperty(String key);
148		}