com.lf.commons.ant

Class AntMessage

java.lang.Object

com.lf.commons.web.msg.XMLMessage

com.lf.commons.ant.AntMessage

All Implemented Interfaces:

AbstractMessage

public class AntMessage
extends XMLMessage

Represents an XML fragment used for Ant build scripts (no DTD).

Since:

1.6

Version:

$Revision: 1.5 $, $Date: 2012/12/28 11:44:24 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANT_MESSAGE_DTD The underlying DTD (dummy).

Fields inherited from class com.lf.commons.web.msg.XMLMessage

docname, document, dtd, encoding, format

Constructor Summary

Constructors

Constructor and Description
AntMessage() Constructor method for i18n purposes only.
AntMessage(java.lang.String docname, java.lang.String[] cliargs, java.io.File[] targetfiles, org.apache.commons.vfs2.FileObject[] targeturls, java.util.Vector<org.jdom.Element> custom) Constructs a message instance.

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.Vector<org.jdom.Element>	createFileDirSets(java.io.File[] targets) Constructs a series of FileSet or DirSet XML elements for use with Ant.
static java.util.Vector<org.jdom.Element>	createURLs(org.apache.commons.vfs2.FileObject[] targets) Constructs a series of URL XML elements for use with Ant.

Methods inherited from class com.lf.commons.web.msg.XMLMessage

canProcess, getAttribute, getAttributeValue, getContents, getDocument, getDTD, getElement, getElements, getElementValue, getEncoding, getIntFunctionResult, isArmed, isValid, printDocument, read, read, setEncoding, setFormat, write, write

Methods inherited from class java.lang.Object

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

Field Detail

ANT_MESSAGE_DTD

public static final java.lang.String ANT_MESSAGE_DTD

The underlying DTD (dummy).

See Also:

Constant Field Values

Constructor Detail

AntMessage

public AntMessage()
           throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

AntMessage

public AntMessage(java.lang.String docname,
          java.lang.String[] cliargs,
          java.io.File[] targetfiles,
          org.apache.commons.vfs2.FileObject[] targeturls,
          java.util.Vector<org.jdom.Element> custom)

Constructs a message instance.

The given command line arguments is mapped as XML document.

Parameters:

docname - The top-level element name

cliargs - The options used for the CLI app

targetfiles - The files/directories to be processed

targeturls - The URLs/directories to be processed

custom - The custom elements (optional)

Method Detail

createFileDirSets

public static java.util.Vector<org.jdom.Element> createFileDirSets(java.io.File[] targets)

Constructs a series of FileSet or DirSet XML elements for use with Ant.

Files are specified using a Fileset task for each file, directories are specified with the Dirset task. We use the more complex version with dir and include pattern since this works for any operating system. Root directories needs to be specially handled (e.g. Windows drives).

Parameters:

targets - The files/directories to be processed

Returns:

Container with FileSet/DirSet elements, may be empty

Throws:

java.lang.NullPointerException - If a parameter is null

createURLs

public static java.util.Vector<org.jdom.Element> createURLs(org.apache.commons.vfs2.FileObject[] targets)

Constructs a series of URL XML elements for use with Ant.

Parameters:

targets - The URLs/directories to be processed

Returns:

Container with UrlFileSet/UrlDirSet elements, may be empty

Throws:

java.lang.NullPointerException - If a parameter is null