org.sonatype.guice.bean.scanners.index
Class AbstractSisuIndex

java.lang.Object
  extended by org.sonatype.guice.bean.scanners.index.AbstractSisuIndex
Direct Known Subclasses:
QualifiedIndexAPT6, QualifiedIndexCmd

public abstract class AbstractSisuIndex
extends java.lang.Object

Skeleton class that can generate META-INF/sisu index files.


Constructor Summary
AbstractSisuIndex()
           
 
Method Summary
protected  void addClassToIndex(java.lang.Object anno, java.lang.Object clazz)
          Adds a new annotated class entry to the index.
protected  void flushIndex()
          Writes the current index as a series of tables.
protected abstract  java.io.Reader getReader(java.lang.String path)
          Creates a new reader for the given input path.
protected abstract  java.io.Writer getWriter(java.lang.String path)
          Creates a new writer for the given output path.
protected abstract  void info(java.lang.String message)
          Reports an informational message.
protected abstract  void warn(java.lang.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

AbstractSisuIndex

public AbstractSisuIndex()
Method Detail

addClassToIndex

protected final void addClassToIndex(java.lang.Object anno,
                                     java.lang.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.


info

protected abstract void info(java.lang.String message)
Reports an informational message.

Parameters:
message - The message

warn

protected abstract void warn(java.lang.String message)
Reports a warning message.

Parameters:
message - The message

getReader

protected abstract java.io.Reader getReader(java.lang.String path)
                                     throws java.io.IOException
Creates a new reader for the given input path.

Parameters:
path - The input path
Returns:
The relevant reader
Throws:
java.io.IOException

getWriter

protected abstract java.io.Writer getWriter(java.lang.String path)
                                     throws java.io.IOException
Creates a new writer for the given output path.

Parameters:
path - The output path
Returns:
The relevant writer
Throws:
java.io.IOException


Copyright © 2010-2011 Sonatype, Inc.. All Rights Reserved.