de.smartics.analysis.javadoc
Class CollectorContext

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

public class CollectorContext
     
     

      
      extends 
      
      Object
     
     

The context of a collector execution. Since arguments cannot be passed to the Javadoc tool, communication happens over static context. This context instance is expected to be places in a static context (i.e. singleton). It is not the singleton, but an instance to be managed by a static context.

This implementation is not thread-safe.

Author:

Robert Reiner

Constructor Summary

CollectorContext(Filter filter)
Convenience constructor if no class loader needs to be specified.

CollectorContext(Filter filter, ClassLoader projectClassLoader)
Default constructor.

Method Summary

Filter	getFilter() Returns the filter used by the doclet to remove found Javadoc information.
ClassLoader	getProjectClassLoader() Returns the class loader to use for the Javadoc tool if not null.
List<com.sun.javadoc.Doc>	getResult() Returns the result of the collection of Javadoc information collected by the doclet.
void	setResult(List<com.sun.javadoc.Doc> result) Sets the result of the collection of Javadoc information collected by the doclet.

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectorContext

public CollectorContext(Filter filter,
                        ClassLoader projectClassLoader)
                 throws NullPointerException

Default constructor.

Parameters:

filter - the filter used by the doclet to remove found Javadoc information.

projectClassLoader - the class loader to use for the Javadoc tool if not null.

Throws:

NullPointerException - if the filter is null.

CollectorContext

public CollectorContext(Filter filter)
                 throws NullPointerException

Convenience constructor if no class loader needs to be specified.

Parameters:

filter - the filter used by the doclet to remove found Javadoc information.

Throws:

NullPointerException - if the filter is null.

Method Detail

getFilter

public Filter getFilter()

Returns the filter used by the doclet to remove found Javadoc information. Only information that passes the filter will be part of the result.

Returns:

the filter used by the doclet to remove found Javadoc information.

getProjectClassLoader

public ClassLoader getProjectClassLoader()

Returns the class loader to use for the Javadoc tool if not null.

Returns:

the class loader to use for the Javadoc tool if not null.

getResult

public List<com.sun.javadoc.Doc> getResult()

Returns the result of the collection of Javadoc information collected by the doclet.

Returns:

the result of the collection of Javadoc information collected by the doclet.

setResult

public void setResult(List<com.sun.javadoc.Doc> result)

Sets the result of the collection of Javadoc information collected by the doclet.

Parameters:

result - the result of the collection of Javadoc information collected by the doclet.