de.smartics.analysis.javadoc
Class CollectorContextManager

java.lang.Object
  de.smartics.analysis.javadoc.CollectorContextManager

public final class CollectorContextManager
     
     

      
      extends 
      
      Object
     
     

The singleton provides the collector context used to provide information to the collector doclet.

This singleton is thread safe. It is expected that there is only one context per time for any thread.

Author:

Robert Reiner

See Also:

Reading JavaDoc from Code

Method Summary

static CollectorContext	getCollectorContext() Returns the thread-locally stored collector context.
static void	setCollectorContext(CollectorContext context) Sets the thread-locally stored collector context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getCollectorContext

public static CollectorContext getCollectorContext()

Returns the thread-locally stored collector context.

Returns:

the thread-locally stored collector context.

setCollectorContext

public static void setCollectorContext(CollectorContext context)

Sets the thread-locally stored collector context. It is required to set the context prior to its usage since the initial value for the context is null.

It is expected to remove the context as soon as it is no longer needed, by setting it to null.

Parameters:

context - the thread-locally stored collector context.