com.ideanest.attributes.dev
Class AttributesBuilder

java.lang.Object
  com.ideanest.attributes.dev.AttributesBuilder

All Implemented Interfaces:

com.thoughtworks.qdox.parser.Builder

public class AttributesBuilder

extends java.lang.Object

implements com.thoughtworks.qdox.parser.Builder

QDox Builder implementation for creating Properties containing attributes.

An AttributesBuilder can only be used to parse one file at a time. Call the reset() method before reusing an instance.

Based on a similar class written by Joe Walnes.

Version:

$Revision: 1.4 $ ($Date: 2003/08/01 04:52:05 $)

Author:

Piotr Kaminski

Nested Class Summary

static class	AttributesBuilder.MixedMode
static interface	AttributesBuilder.Mode
static class	AttributesBuilder.ObjectMode
static class	AttributesBuilder.StringMode

Field Summary

static java.util.Set

JAVADOC_TAGS

Constructor Summary

AttributesBuilder(AttributesBuilder.Mode mode)

Method Summary

void	addField(com.thoughtworks.qdox.parser.structs.FieldDef def)
void	addImport(java.lang.String importName)
void	addJavaDoc(java.lang.String text)
void	addJavaDocTag(java.lang.String tag, java.lang.String text)
void	addMethod(com.thoughtworks.qdox.parser.structs.MethodDef def)
void	addPackage(java.lang.String packageName)
void	beginClass(com.thoughtworks.qdox.parser.structs.ClassDef def)
void	endClass()
java.util.Map	getPacks()
void	ignore(java.lang.String tag)
void	ignoreAll(java.util.Collection tags)
void	parse(java.io.File file)
void	setMode(AttributesBuilder.Mode mode)

Methods inherited from class java.lang.Object

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

Field Detail

JAVADOC_TAGS

public static final java.util.Set JAVADOC_TAGS

Constructor Detail

AttributesBuilder

public AttributesBuilder(AttributesBuilder.Mode mode)

Method Detail

addField

public void addField(com.thoughtworks.qdox.parser.structs.FieldDef def)

Specified by:

addField in interface com.thoughtworks.qdox.parser.Builder

addImport

public void addImport(java.lang.String importName)

Specified by:

addImport in interface com.thoughtworks.qdox.parser.Builder

addJavaDoc

public void addJavaDoc(java.lang.String text)

Specified by:

addJavaDoc in interface com.thoughtworks.qdox.parser.Builder

addJavaDocTag

public void addJavaDocTag(java.lang.String tag,
                          java.lang.String text)

Specified by:

addJavaDocTag in interface com.thoughtworks.qdox.parser.Builder

addMethod

public void addMethod(com.thoughtworks.qdox.parser.structs.MethodDef def)

Specified by:

addMethod in interface com.thoughtworks.qdox.parser.Builder

addPackage

public void addPackage(java.lang.String packageName)

Specified by:

addPackage in interface com.thoughtworks.qdox.parser.Builder

beginClass

public void beginClass(com.thoughtworks.qdox.parser.structs.ClassDef def)

Specified by:

beginClass in interface com.thoughtworks.qdox.parser.Builder

endClass

public void endClass()

Specified by:

endClass in interface com.thoughtworks.qdox.parser.Builder

getPacks

public java.util.Map getPacks()

ignore

public void ignore(java.lang.String tag)

ignoreAll

public void ignoreAll(java.util.Collection tags)

parse

public void parse(java.io.File file)
           throws java.io.IOException

Throws:

java.io.IOException

setMode

public void setMode(AttributesBuilder.Mode mode)