org.apache.tools.ant.module.api

Interface AntProjectCookie

All Superinterfaces:

Node.Cookie

All Known Subinterfaces:

AntProjectCookie.ParseStatus

public interface AntProjectCookie
extends Node.Cookie

Cookie containing the state of an Ant Project. Note that there is a document, and also a parse exception. At least one must be non-null; it is possible for both to be non-null in case there was a valid parse before, and some changes are now invalid.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AntProjectCookie.ParseStatus Extended cookie permitting queries of parse status.

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ChangeListener l) Add a listener to changes in the document.
Document	getDocument() Get the DOM document for the build script.
File	getFile() Get the disk file for the build script.
FileObject	getFileObject() Get the file object for the build script.
Throwable	getParseException() Get the last parse-related exception, if there was one.
Element	getProjectElement() Get the DOM root element (<project>) for the build script.
void	removeChangeListener(ChangeListener l) Remove a listener to changes in the document.

Method Detail

getFile

File getFile()

Get the disk file for the build script.

Returns:

the disk file, or null if none (but must be a file object)

getFileObject

FileObject getFileObject()

Get the file object for the build script.

Returns:

the file object, or null if none (but must be a disk file)

getDocument

Document getDocument()

Get the DOM document for the build script.

Returns:

the document, or null if it could not be parsed

getProjectElement

Element getProjectElement()

Get the DOM root element (<project>) for the build script.

Returns:

the root element, or null if it could not be parsed

getParseException

Throwable getParseException()

Get the last parse-related exception, if there was one.

Returns:

the parse exception, or null if it is valid

addChangeListener

void addChangeListener(ChangeListener l)

Add a listener to changes in the document.

Parameters:

l - the listener to add

removeChangeListener

void removeChangeListener(ChangeListener l)

Remove a listener to changes in the document.

Parameters:

l - the listener to remove