TopicProvider


1   /*====================================================================
2   
3   OpenCCM: The Open CORBA Component Model Platform
4   Copyright (C) 2000-2003 USTL - LIFL - GOAL
5   Contact: openccm-team@objectweb.org
6   
7   This library is free software; you can redistribute it and/or
8   modify it under the terms of the GNU Lesser General Public
9   License as published by the Free Software Foundation; either
10  version 2.1 of the License, or any later version.
11  
12  This library 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 GNU
15  Lesser General Public License for more details.
16  
17  You should have received a copy of the GNU Lesser General Public
18  License along with this library; if not, write to the Free Software
19  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
20  USA
21  
22  Initial developer(s): Jerome Offroy.
23  Contributor(s): ______________________________________.
24  
25  ====================================================================*/
26  
27  package org.objectweb.util.monolog.provider.api;
28  
29  import java.util.HashMap  ;
30  
31  /**
32   * @author Jerome Offroy
33   *
34   */
35  public interface TopicProvider {
36      /**
37       * Method createTopic used to create a new topic with its description and its Class caller reference.
38       * @param name of the new Topic
39       * @param ref reference of the caller Class
40       * @param description of the new Topic
41       */
42      public String   createTopic(String   name, Class   ref, String   description[]);
43      
44      /**
45       * Method getTopic return the Topic associated to a Class reference.
46       * @param ref Class 
47       * @return String Topic
48       */
49      public String   getTopic(Class   ref);
50      
51      /**
52       * Method getTopics lists all the created Topic.
53       * @return String[] list of Topics
54       */
55      public String   [] getTopics();
56      
57      /**
58       * Method getTopicDescription gets description for a Topic.
59       * @param name of the Topic
60       * @return String[] description
61       */
62      public String  [] getTopicDescription(String   name);
63      
64      /**
65       * get Topics used by reference class
66       * @return HashMap
67       */
68      public HashMap   getTopicsByRef() ;
69      
70  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags