Package org.eclipse.sisu.space

Class SisuIndex

java.lang.Object

org.eclipse.sisu.space.SisuIndex

All Implemented Interfaces:

ClassVisitor, SpaceVisitor

public class SisuIndex
extends Object
implements SpaceVisitor, ClassVisitor

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

The index consists of qualified class names listed in META-INF/sisu/javax.inject.Named.

See Also:

• sisu-maven-plugin

Field Summary

Fields inherited from interface org.eclipse.sisu.space.ClassVisitor

NON_INSTANTIABLE

Constructor Summary

Constructors

Constructor	Description
SisuIndex(File targetDirectory)

Method Summary

Modifier and Type	Method	Description
protected final void	addClassToIndex(Object anno, Object clazz)	Adds a new annotated class entry to the index.
final void	enterClass(int modifiers, String name, String _extends, String[] _implements)	Enters the class definition.
final void	enterSpace(ClassSpace _space)	Enters the class space.
protected final 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.
final void	index(ClassSpace _space)
protected void	info(String message)	Reports an informational message.
final void	leaveClass()	Leaves the class definition.
final void	leaveSpace()	Leaves the class space.
static void	main(String[] args)
final AnnotationVisitor	visitAnnotation(String desc)	Visits an annotation declared on the class.
final ClassVisitor	visitClass(URL url)	Visits a class resource in the class space.
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 Details

SisuIndex

public SisuIndex(File targetDirectory)

Method Details

main

public static void main(String[] args)

index

public final void index(ClassSpace _space)

enterSpace

public final void enterSpace(ClassSpace _space)

Description copied from interface: SpaceVisitor

Enters the class space.

Specified by:

enterSpace in interface SpaceVisitor

Parameters:

_space - The class space

visitClass

public final ClassVisitor visitClass(URL url)

Description copied from interface: SpaceVisitor

Visits a class resource in the class space.

Specified by:

visitClass in interface SpaceVisitor

Parameters:

url - The class resource URL

Returns:

Class visitor; null if it is not interested in visiting the class

enterClass

public final void enterClass(int modifiers,
 String name,
 String _extends,
 String[] _implements)

Description copied from interface: ClassVisitor

Enters the class definition.

Specified by:

enterClass in interface ClassVisitor

Parameters:

modifiers - The access modifiers

name - The internal name, such as "javax/inject/Provider"

_extends - Extends this superclass

_implements - Implements these interfaces

visitAnnotation

public final AnnotationVisitor visitAnnotation(String desc)

Description copied from interface: ClassVisitor

Visits an annotation declared on the class.

Specified by:

visitAnnotation in interface ClassVisitor

Parameters:

desc - The JVM descriptor for the annotation class, such as "Ljavax/inject/Qualifier;"

Returns:

Annotation visitor; null if it is not interested in visiting the annotation

See Also:

• SpaceScanner.jvmDescriptor(Class)

leaveClass

public final void leaveClass()

Description copied from interface: ClassVisitor

Leaves the class definition.

Specified by:

leaveClass in interface ClassVisitor

leaveSpace

public final void leaveSpace()

Description copied from interface: SpaceVisitor

Leaves the class space.

Specified by:

leaveSpace in interface SpaceVisitor

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.