Jive Forums API (5.5.20.2-oracle) Core Javadocs

com.jivesoftware.base
Class GroupManagerFactory

java.lang.Object
  extended by com.jivesoftware.base.GroupManagerFactory
All Implemented Interfaces:
com.jivesoftware.base.JiveManager

public class GroupManagerFactory
extends java.lang.Object
implements com.jivesoftware.base.JiveManager

A factory that returns a concrete instance of a group manager.


Field Summary
static com.jivesoftware.util.Cache groupCache
          A cache for group objects.
static com.jivesoftware.util.Cache groupIDCache
          A cache that maps group names to ID's.
static com.jivesoftware.util.Cache groupMemberCache
          A cache for the list members of in each group.This cache is not instantiated until after this factory is initialized.
 
Method Summary
static void addListener(GroupListener listener)
          Method used internally by Jive.
 void destroy()
           
static void dispatchEvent(JiveEvent event)
          Method used internally by Jive.
static void doInitialize()
           
static GroupManager getInstance()
          Returns a concrete instance of the group manager interface.
 void initialize()
           
static void removeListener(GroupListener listener)
          Method used internally by Jive.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

groupCache

public static com.jivesoftware.util.Cache groupCache
A cache for group objects. This cache is not instantiated until after this factory is initialized.


groupIDCache

public static com.jivesoftware.util.Cache groupIDCache
A cache that maps group names to ID's. This cache is not instantiated until after this factory is initialized.


groupMemberCache

public static com.jivesoftware.util.Cache groupMemberCache
A cache for the list members of in each group.This cache is not instantiated until after this factory is initialized.

Method Detail

getInstance

public static GroupManager getInstance()
Returns a concrete instance of the group manager interface. This method will return null until this class has been initialized.

Note: in general, this method is not intended to be called by outside users of the API. Doing so is dangerous since the GroupManager implementation returned will not be secured by a protection proxy.

Returns:
a concrete implementation of a group manager.

initialize

public void initialize()
Specified by:
initialize in interface com.jivesoftware.base.JiveManager

destroy

public void destroy()
Specified by:
destroy in interface com.jivesoftware.base.JiveManager

doInitialize

public static void doInitialize()

addListener

public static void addListener(GroupListener listener)
Method used internally by Jive. Do NOT use this method to register a listener for group events - use the GroupEventDispatcher to do that.


removeListener

public static void removeListener(GroupListener listener)
Method used internally by Jive. Do NOT use this method to unregister a listener for group events - use the GroupEventDispatcher to do that.


dispatchEvent

public static void dispatchEvent(JiveEvent event)
Method used internally by Jive.


Jive Forums Project Page

Copyright © 1999-2006 Jive Software.