org.eclipse.sisu.space

Class SisuIndex

java.lang.Object

org.eclipse.sisu.space.SisuIndex

All Implemented Interfaces:

QualifiedTypeListener

public final class SisuIndex
extends Object
implements QualifiedTypeListener

Command-line utility that generates a qualified class index for a space-separated list of JARs.

Constructor Summary

Constructors

Constructor and Description
SisuIndex(File targetDirectory)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addClassToIndex(Object anno, Object clazz) Adds a new annotated class entry to the index.
protected void	flushIndex() Writes the current index as a series of tables.
protected Reader	getReader(String path) Creates a new reader for the given input path.
protected Writer	getWriter(String path) Creates a new writer for the given output path.
void	hear(Class<?> qualifiedType, Object source) Invoked when the QualifiedTypeVisitor finds a qualified type.
void	index(ClassSpace space)
protected void	info(String message) Reports an informational message.
static void	main(String[] args)
protected void	warn(String message) Reports a warning message.

Methods inherited from class java.lang.Object

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

Constructor Detail

SisuIndex

public SisuIndex(File targetDirectory)

Method Detail

main

public static void main(String[] args)

index

public void index(ClassSpace space)

hear

public void hear(Class<?> qualifiedType,
        Object source)

Description copied from interface: QualifiedTypeListener

Invoked when the QualifiedTypeVisitor finds a qualified type.

Specified by:

hear in interface QualifiedTypeListener

Parameters:

qualifiedType - The qualified type

source - The source of this type

See Also:

Binder.withSource(Object)

info

protected void info(String message)

Reports an informational message.

Parameters:

message - The message

warn

protected void warn(String message)

Reports a warning message.

Parameters:

message - The message

getReader

protected Reader getReader(String path)
                    throws IOException

Creates a new reader for the given input path.

Parameters:

path - The input path

Returns:

The relevant reader

Throws:

IOException

getWriter

protected Writer getWriter(String path)
                    throws IOException

Creates a new writer for the given output path.

Parameters:

path - The output path

Returns:

The relevant writer

Throws:

IOException

addClassToIndex

protected final void addClassToIndex(Object anno,
                   Object clazz)

Adds a new annotated class entry to the index.

Parameters:

anno - The annotation name

clazz - The class name

flushIndex

protected final void flushIndex()

Writes the current index as a series of tables.