org.jvnet.hk2.component.classmodel
Class InhabitantsParsingContextGenerator

java.lang.Object
  org.jvnet.hk2.component.classmodel.InhabitantsParsingContextGenerator

All Implemented Interfaces:

Closeable

public abstract class InhabitantsParsingContextGenerator
extends Object
implements Closeable

Responsible for generating the collection of inhabitants, decoupling from implementation detail for the caller.

The caller is expected to continually build up the InhabitantsGenerator context by calling add*(), followed by calling getModelInhabitants() to obtain the progenitors of the inhabitants.

There are two ways to close this instance, either through getContext() or through calling close() directly.

Author:

Jerome Dochez, Jeff Trent

Constructor Summary

protected

InhabitantsParsingContextGenerator(ExecutorService es, ClassPath inhabitantsClassPath, FileFilter inhabitantsClassPathFilter)

Method Summary

protected void	addInhabitantsScanner(String name, InhabitantsScanner is)
void	close()
static InhabitantsParsingContextGenerator	create(Habitat h, ExecutorService es, ClassPath inhabitantsClassPath, FileFilter inhabitantsClassPathFilter) Factory for the InhabitantsParsingContextGenerator
ParsingContext	getContext() Retrieves the parsing context that can be used for model generation elsewhere.
Collection<InhabitantsScanner>	getInhabitantsScanners()
void	parse(Collection<File> files) Add the collection of files to the current InhabitantsGenerator context.
void	parse(File f) Eventually we can perform optimizations here instead of a pass-thru to parseAlways.
protected void	parseAlways(Parser parser, File f)

Methods inherited from class java.lang.Object

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

Constructor Detail

InhabitantsParsingContextGenerator

protected InhabitantsParsingContextGenerator(ExecutorService es,
                                             ClassPath inhabitantsClassPath,
                                             FileFilter inhabitantsClassPathFilter)

Method Detail

create

public static InhabitantsParsingContextGenerator create(Habitat h,
                                                        ExecutorService es,
                                                        ClassPath inhabitantsClassPath,
                                                        FileFilter inhabitantsClassPathFilter)

Factory for the InhabitantsParsingContextGenerator

Parameters:

h - habitat not currently used; reserved for future use

es - the executor to use for any async processing (e.g., parsing)

inhabitantsClassPath - the fully qualified classpath in order to resolve the class-model

inhabitantsClassPathFilter - the filter used for pruning the classpath (may also be a ClassPathAdvisor)

Returns:

an empty context InhabitantsGenerator

parse

public void parse(Collection<File> files)
           throws IOException

Add the collection of files to the current InhabitantsGenerator context.

Parameters:

files - the files to parse.

Throws:

IOException

getContext

public ParsingContext getContext()

Retrieves the parsing context that can be used for model generation elsewhere. Note that this can be called at most once and then this instance is implicitly closed.

Returns:

the parsing context given the code sources provided

getInhabitantsScanners

public Collection<InhabitantsScanner> getInhabitantsScanners()

Returns:

the collection of InhabitantsScanners being maintained

addInhabitantsScanner

protected void addInhabitantsScanner(String name,
                                     InhabitantsScanner is)

parse

public void parse(File f)
           throws IOException

Eventually we can perform optimizations here instead of a pass-thru to parseAlways.

Throws:

IOException

parseAlways

protected void parseAlways(Parser parser,
                           File f)
                    throws IOException

Throws:

IOException

close

public void close()

Specified by:

close in interface Closeable