Modifier and Type	Class and Description
private static class	AntStructure.DTDPrinter
public static interface	AntStructure.StructurePrinter Writes the actual structure information.

Modifier and Type	Field and Description
private File	output
private AntStructure.StructurePrinter	printer

Access	Constructor and Description
public	AntStructure()

Modifier and Type	Method and Description
public void	add(final AntStructure.StructurePrinter the printer to use. p) The StructurePrinter to use.
protected boolean	Returns: true if all the strings in the array math XML-NMTOKEN areNmtokens(final String[] the array of string to test s) Do the Strings all match the XML-NMTOKEN production?
public void	execute() Overrides org.apache.tools.ant.Task.execute. Build the antstructure DTD.
protected boolean	Returns: true if the string matches the XML-NMTOKEN isNmtoken(final String the string to test s) Does this String match the XML-NMTOKEN production?
public void	setOutput(final File the output file output) The output file.

output	back to summary
private File output

printer	back to summary
private AntStructure.StructurePrinter printer

AntStructure	back to summary
public AntStructure()

Method Detail

add	back to summary
public void add(final AntStructure.StructurePrinter p) The StructurePrinter to use. Parameters p:AntStructure.StructurePrinter the printer to use. Since Ant 1.7

add

back to summary

public void add(final AntStructure.StructurePrinter p)

The StructurePrinter to use.

Parameters

p:AntStructure.StructurePrinter: the printer to use.

Since

Ant 1.7

areNmtokens	back to summary
protected boolean areNmtokens(final String[] s) Do the Strings all match the XML-NMTOKEN production? Otherwise they are not suitable as an enumerated attribute, for example. Parameters s:String[] the array of string to test Returns:boolean true if all the strings in the array math XML-NMTOKEN

areNmtokens

back to summary

protected boolean areNmtokens(final String[] s)

Do the Strings all match the XML-NMTOKEN production?

Otherwise they are not suitable as an enumerated attribute, for example.

Parameters

s:String[]: the array of string to test

Returns:boolean

true if all the strings in the array math XML-NMTOKEN

execute	back to summary
public void execute() throws BuildException Overrides org.apache.tools.ant.Task.execute. Build the antstructure DTD. Annotations @Override Exceptions BuildException: if the DTD cannot be written.

execute

back to summary

public void execute() throws BuildException

Overrides org.apache.tools.ant.Task.execute.

Build the antstructure DTD.

Annotations

@Override

Exceptions

BuildException:: if the DTD cannot be written.

isNmtoken	back to summary
protected boolean isNmtoken(final String s) Does this String match the XML-NMTOKEN production? Parameters s:String the string to test Returns:boolean true if the string matches the XML-NMTOKEN

isNmtoken

back to summary

protected boolean isNmtoken(final String s)

Does this String match the XML-NMTOKEN production?

Parameters

s:String: the string to test

Returns:boolean

true if the string matches the XML-NMTOKEN

setOutput	back to summary
public void setOutput(final File output) The output file. Parameters output:File the output file

setOutput

back to summary

public void setOutput(final File output)

The output file.

Parameters

output:File: the output file

org.apache.tools.ant.taskdefs back to summary

private Class AntStructure.DTDPrinter

Class Inheritance

extends Object
implements StructurePrinter

java.lang.Object
org.apache.tools.ant.taskdefs.AntStructure.DTDPrinter

All Implemented Interfaces

org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter

Field Summary

Modifier and Type	Field and Description
private static final String	BOOLEAN
private static final String	TASKS
private static final String	TYPES
private final Hashtable<String, String>	visited

Constructor Summary

Access	Constructor and Description
private	DTDPrinter()

Method Summary

Modifier and Type	Method and Description
public static final boolean	Returns: true if all the strings in the array math XML-NMTOKEN areNmtokens(final String[] the array of string to test s) Do the Strings all match the XML-NMTOKEN production?
public static final boolean	Returns: true if the string matches the XML-NMTOKEN isNmtoken(final String the string to test s) Does this String match the XML-NMTOKEN production?
public void	printElementDecl(final PrintWriter PrintWriter to write to. out, final Project Project instance for the current task p, final String element name. name, final Class<?> class of the defined element. element) Implements org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter.printElementDecl. Print the definition for a given element.
public void	printHead(final PrintWriter PrintWriter to write to. out, final Project Project instance for the current task p, final Hashtable<String, Class<?>> map (name to implementing class) tasks, final Hashtable<String, Class<?>> map (name to implementing class) data types. types) Implements org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter.printHead. Prints the header of the generated output.
private void	printHead(final PrintWriter out, final Set<String> tasks, final Set<String> types) Prints the header of the generated output.
public void	printTail(final PrintWriter PrintWriter to write to. out) Implements org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter.printTail. Prints the trailer.
private void	printTargetAttrs(final PrintWriter out, final String tag) Prints the definition for the target element.
public void	printTargetDecl(final PrintWriter PrintWriter to write to. out) Implements org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter.printTargetDecl. Prints the definition for the target element.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

BOOLEAN	back to summary
private static final String BOOLEAN

TASKS	back to summary
private static final String TASKS

TYPES	back to summary
private static final String TYPES

visited	back to summary
private final Hashtable<String, String> visited

Constructor Detail

DTDPrinter	back to summary
private DTDPrinter()

Method Detail

areNmtokens	back to summary
public static final boolean areNmtokens(final String[] s) Do the Strings all match the XML-NMTOKEN production? Otherwise they are not suitable as an enumerated attribute, for example. Parameters s:String[] the array of string to test Returns:boolean true if all the strings in the array math XML-NMTOKEN

areNmtokens

back to summary

public static final boolean areNmtokens(final String[] s)

Do the Strings all match the XML-NMTOKEN production?

Otherwise they are not suitable as an enumerated attribute, for example.

Parameters

s:String[]: the array of string to test

Returns:boolean

true if all the strings in the array math XML-NMTOKEN

isNmtoken	back to summary
public static final boolean isNmtoken(final String s) Does this String match the XML-NMTOKEN production? Parameters s:String the string to test Returns:boolean true if the string matches the XML-NMTOKEN

isNmtoken

back to summary

public static final boolean isNmtoken(final String s)

Does this String match the XML-NMTOKEN production?

Parameters

s:String: the string to test

Returns:boolean

true if the string matches the XML-NMTOKEN

printElementDecl	back to summary
public void printElementDecl(final PrintWriter out, final Project p, final String name, final Class<?> element) Implements org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter.printElementDecl. Print the definition for a given element. Parameters out:PrintWriter Doc from org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter.printElementDecl. PrintWriter to write to. p:Project Doc from org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter.printElementDecl. Project instance for the current task name:String Doc from org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter.printElementDecl. element name. element:Class<?> Doc from org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter.printElementDecl. class of the defined element. Annotations @Override

printElementDecl

back to summary

public void printElementDecl(final PrintWriter out, final Project p, final String name, final Class<?> element)

Implements org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter.printElementDecl.

Print the definition for a given element.

Parameters

out:PrintWriter

Doc from org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter.printElementDecl.

PrintWriter to write to.

p:Project

Doc from org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter.printElementDecl.

Project instance for the current task

name:String

Doc from org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter.printElementDecl.

element name.

element:Class<?>

Doc from org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter.printElementDecl.

class of the defined element.

Annotations

@Override

printHead	back to summary
public void printHead(final PrintWriter out, final Project p, final Hashtable<String, Class<?>> tasks, final Hashtable<String, Class<?>> types) Implements org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter.printHead. Doc from org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter.printHead. Prints the header of the generated output. Parameters out:PrintWriter PrintWriter to write to. p:Project Project instance for the current task tasks:Hashtable<String, Class<?>> map (name to implementing class) types:Hashtable<String, Class<?>> map (name to implementing class) data types. Annotations @Override

printHead

back to summary

public void printHead(final PrintWriter out, final Project p, final Hashtable<String, Class<?>> tasks, final Hashtable<String, Class<?>> types)

Implements org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter.printHead.

Doc from org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter.printHead.

Prints the header of the generated output.

Parameters

out:PrintWriter: PrintWriter to write to.
p:Project: Project instance for the current task
tasks:Hashtable<String, Class<?>>: map (name to implementing class)
types:Hashtable<String, Class<?>>: map (name to implementing class) data types.

Annotations

@Override

printHead	back to summary
private void printHead(final PrintWriter out, final Set<String> tasks, final Set<String> types) Prints the header of the generated output. Basically this prints the XML declaration, defines some entities and the project element.

printHead

back to summary

private void printHead(final PrintWriter out, final Set<String> tasks, final Set<String> types)

Prints the header of the generated output.

Basically this prints the XML declaration, defines some entities and the project element.

printTail	back to summary
public void printTail(final PrintWriter out) Implements org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter.printTail. Doc from org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter.printTail. Prints the trailer. Parameters out:PrintWriter PrintWriter to write to. Annotations @Override

printTail

back to summary

public void printTail(final PrintWriter out)

Implements org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter.printTail.

Doc from org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter.printTail.

Prints the trailer.

Parameters

out:PrintWriter: PrintWriter to write to.

Annotations

@Override

printTargetAttrs	back to summary
private void printTargetAttrs(final PrintWriter out, final String tag) Prints the definition for the target element.

printTargetDecl	back to summary
public void printTargetDecl(final PrintWriter out) Implements org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter.printTargetDecl. Prints the definition for the target element. Parameters out:PrintWriter Doc from org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter.printTargetDecl. PrintWriter to write to. Annotations @Override

printTargetDecl

back to summary

public void printTargetDecl(final PrintWriter out)

Implements org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter.printTargetDecl.

Prints the definition for the target element.

Parameters

out:PrintWriter

Doc from org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter.printTargetDecl.

PrintWriter to write to.

Annotations

@Override

org.apache.tools.ant.taskdefs back to summary

public Interface AntStructure.StructurePrinter

Known Direct Implementers: org.apache.tools.ant.taskdefs.AntStructure.DTDPrinter

Writes the actual structure information.

printHead, printTargetDecl and printTail are called exactly once, printElementDecl once for each declared task and type.

Method Summary

Modifier and Type	Method and Description
public void	printElementDecl(PrintWriter PrintWriter to write to. out, Project Project instance for the current task p, String element name. name, Class<?> class of the defined element. element) Print the definition for a given element.
public void	printHead(PrintWriter PrintWriter to write to. out, Project Project instance for the current task p, Hashtable<String, Class<?>> map (name to implementing class) tasks, Hashtable<String, Class<?>> map (name to implementing class) data types. types) Prints the header of the generated output.
public void	printTail(PrintWriter PrintWriter to write to. out) Prints the trailer.
public void	printTargetDecl(PrintWriter PrintWriter to write to. out) Prints the definition for the target element.

Method Detail

printElementDecl	back to summary
public void printElementDecl(PrintWriter out, Project p, String name, Class<?> element) Print the definition for a given element. Parameters out:PrintWriter PrintWriter to write to. p:Project Project instance for the current task name:String element name. element:Class<?> class of the defined element.

printElementDecl

back to summary

public void printElementDecl(PrintWriter out, Project p, String name, Class<?> element)

Print the definition for a given element.

Parameters

out:PrintWriter: PrintWriter to write to.
p:Project: Project instance for the current task
name:String: element name.
element:Class<?>: class of the defined element.

printHead	back to summary
public void printHead(PrintWriter out, Project p, Hashtable<String, Class<?>> tasks, Hashtable<String, Class<?>> types) Prints the header of the generated output. Parameters out:PrintWriter PrintWriter to write to. p:Project Project instance for the current task tasks:Hashtable<String, Class<?>> map (name to implementing class) types:Hashtable<String, Class<?>> map (name to implementing class) data types.

printHead

back to summary

public void printHead(PrintWriter out, Project p, Hashtable<String, Class<?>> tasks, Hashtable<String, Class<?>> types)

Prints the header of the generated output.

Parameters

out:PrintWriter: PrintWriter to write to.
p:Project: Project instance for the current task
tasks:Hashtable<String, Class<?>>: map (name to implementing class)
types:Hashtable<String, Class<?>>: map (name to implementing class) data types.

printTail	back to summary
public void printTail(PrintWriter out) Prints the trailer. Parameters out:PrintWriter PrintWriter to write to.

printTail

back to summary

public void printTail(PrintWriter out)

Prints the trailer.

Parameters

out:PrintWriter: PrintWriter to write to.

printTargetDecl	back to summary
public void printTargetDecl(PrintWriter out) Prints the definition for the target element. Parameters out:PrintWriter PrintWriter to write to.

printTargetDecl

back to summary

public void printTargetDecl(PrintWriter out)

Prints the definition for the target element.

Parameters

out:PrintWriter: PrintWriter to write to.

public Class AntStructure

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class AntStructure.DTDPrinter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface AntStructure.StructurePrinter

Method Summary

Method Detail