Coverage Report

Coverage Report - org.argouml.application.api.InitSubsystem

Classes in this File

 /* $Id: InitSubsystem.java 17753 2010-01-11 19:49:55Z linus $
  *******************************************************************************
  * Copyright (c) 2009 Contributors - see below
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-v10.html
  *
  * Contributors:
  *    mvw
  *******************************************************************************
  *
  * Some portions of this file was previously release using the BSD License:
  */
 
 // Copyright (c) 2007-2008 The Regents of the University of California. All
 // Rights Reserved. Permission to use, copy, modify, and distribute this
 // software and its documentation without fee, and without a written
 // agreement is hereby granted, provided that the above copyright notice
 // and this paragraph appear in all copies. This software program and
 // documentation are copyrighted by The Regents of the University of
 // California. The software program and documentation are supplied "AS
 // IS", without any accompanying services from The Regents. The Regents
 // does not warrant that the operation of the program will be
 // uninterrupted or error-free. The end-user understands that the program
 // was developed for research purposes and is advised not to rely
 // exclusively on the program for any reason. IN NO EVENT SHALL THE
 // UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
 // SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
 // ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
 // THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
 // SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
 // WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
 // PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
 // CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
 // UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 
 package org.argouml.application.api;
 
 import java.util.List;
 
 
 /**
  * Any subsystem that needs to initialise itself, 
  * could implement this interface.
  * The Main class (or any other top-level class 
  * that knows about the subsystem) then takes care 
  * of the initialisation,
  * without causing dependency cycles.
  *
  * @author Michiel
  */
 public interface InitSubsystem {
 
     /**
      * ArgoUML shall call this at initialisation time, 
      * before the other operations in this interface are called.
      * <p>
      * Use it at will.
      */
     public void init();
     
     /**
      * This method shall not return null.
      * 
      * @return an ordered list of tab panels 
      * to be added to the settings dialog
      */
     public List<GUISettingsTabInterface> getSettingsTabs();
 
     /**
      * This method shall not return null.
      * 
      * @return an ordered list of tab panels 
      * to be added to the project-settings dialog
      */
     public List<GUISettingsTabInterface> getProjectSettingsTabs();
 
     /**
      * This method shall not return null.
      * 
      * @return an ordered list of Tabs
      * to be added to the DetailsPanel
      */
     public List<AbstractArgoJPanel> getDetailsTabs();
 }

1		/* $Id: InitSubsystem.java 17753 2010-01-11 19:49:55Z linus $
2		*******************************************************************************
3		* Copyright (c) 2009 Contributors - see below
4		* All rights reserved. This program and the accompanying materials
5		* are made available under the terms of the Eclipse Public License v1.0
6		* which accompanies this distribution, and is available at
7		* http://www.eclipse.org/legal/epl-v10.html
8		*
9		* Contributors:
10		* mvw
11		*******************************************************************************
12		*
13		* Some portions of this file was previously release using the BSD License:
14		*/
15
16		// Copyright (c) 2007-2008 The Regents of the University of California. All
17		// Rights Reserved. Permission to use, copy, modify, and distribute this
18		// software and its documentation without fee, and without a written
19		// agreement is hereby granted, provided that the above copyright notice
20		// and this paragraph appear in all copies. This software program and
21		// documentation are copyrighted by The Regents of the University of
22		// California. The software program and documentation are supplied "AS
23		// IS", without any accompanying services from The Regents. The Regents
24		// does not warrant that the operation of the program will be
25		// uninterrupted or error-free. The end-user understands that the program
26		// was developed for research purposes and is advised not to rely
27		// exclusively on the program for any reason. IN NO EVENT SHALL THE
28		// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
29		// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
30		// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
31		// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
32		// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
33		// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
34		// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
35		// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
36		// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
37		// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
38
39		package org.argouml.application.api;
40
41		import java.util.List;
42
43
44		/**
45		* Any subsystem that needs to initialise itself,
46		* could implement this interface.
47		* The Main class (or any other top-level class
48		* that knows about the subsystem) then takes care
49		* of the initialisation,
50		* without causing dependency cycles.
51		*
52		* @author Michiel
53		*/
54		public interface InitSubsystem {
55
56		/**
57		* ArgoUML shall call this at initialisation time,
58		* before the other operations in this interface are called.
59		* <p>
60		* Use it at will.
61		*/
62		public void init();
63
64		/**
65		* This method shall not return null.
66		*
67		* @return an ordered list of tab panels
68		* to be added to the settings dialog
69		*/
70		public List<GUISettingsTabInterface> getSettingsTabs();
71
72		/**
73		* This method shall not return null.
74		*
75		* @return an ordered list of tab panels
76		* to be added to the project-settings dialog
77		*/
78		public List<GUISettingsTabInterface> getProjectSettingsTabs();
79
80		/**
81		* This method shall not return null.
82		*
83		* @return an ordered list of Tabs
84		* to be added to the DetailsPanel
85		*/
86		public List<AbstractArgoJPanel> getDetailsTabs();
87		}