KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > opensubsystems > core > util > ProductInfo


1 /*
2  * Copyright (c) 2003 - 2007 OpenSubsystems s.r.o. Slovak Republic. All rights reserved.
3  *
4  * Project: OpenSubsystems
5  *
6  * $Id: ProductInfo.java,v 1.3 2007/01/07 06:14:00 bastafidli Exp $
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; version 2 of the License.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20  */

21
22 package org.opensubsystems.core.util;
23
24 /**
25  * Every product has set of attributes such as name, version, creator. These
26  * are published through this interface.
27  *
28  * Every product must provide class implementing this interface to provide
29  * information about itself.
30  *
31  * @version $Id: ProductInfo.java,v 1.3 2007/01/07 06:14:00 bastafidli Exp $
32  * @author Miro Halas
33  * @code.reviewer Miro Halas
34  * @code.reviewed Initial revision
35  */

36 public interface ProductInfo
37 {
38    /**
39     * @return String - full name of the product to display to the user
40     */

41    String JavaDoc getProductName(
42    );
43    
44    /**
45     * @return String - full version of the product to display to the user, this
46     * should include major version, minor version as well as
47     * other information
48     */

49    String JavaDoc getProductVersion(
50    );
51    
52    /**
53     * @return String - full name of the entity which created this product.
54     */

55    String JavaDoc getProductCreator(
56    );
57
58    /**
59     * @return String - full copyright information for this product.
60     */

61    String JavaDoc getCopyright(
62    );
63 }
64
Popular Tags