org.codehaus.groovy.wiki
Class Wiki2Markup

java.lang.Object
  MatchingTask
      org.codehaus.groovy.wiki.Wiki2Markup

Direct Known Subclasses:

Wiki2TestCase

public class Wiki2Markup

extends MatchingTask

Converts the Wiki markup into XML/HTML so that it can be styled by the Maven build

Version:

$Revision: 1.3 $

Author:

James Strachan

See Also:

Serialized Form

Field Summary

protected java.io.File[]	compileList
private org.radeox.api.engine.context.RenderContext	context
private java.io.File	destDir
private org.radeox.api.engine.RenderEngine	engine
protected boolean	failOnError
protected boolean	listFiles
private GlobPatternMapper	m
private Path	src

Constructor Summary

Wiki2Markup()

Method Summary

protected void	checkParameters()
protected void	compile()
protected void	compile(java.io.File file, java.lang.String name)
void	compileFiles(java.lang.String[] args)
protected org.radeox.api.engine.RenderEngine	createRenderEngine()
Path	createSrc() Adds a path for source compilation.
void	execute() Executes the task.
protected java.lang.String	filter(java.lang.String result)
java.io.File	getDestdir() Gets the destination directory into which the java source files should be compiled.
protected java.lang.String	getExtension()
boolean	getFailonerror() Gets the failonerror flag.
java.io.File[]	getFileList() Gets the list of files to be compiled.
boolean	getListfiles() Get the listfiles flag.
Path	getSrcdir() Gets the source dirs to find the source java files.
static void	main(java.lang.String[] args)
protected java.lang.String	readFile(java.io.File file)
protected Path	recreateSrc() Recreate src.
protected void	resetFileLists() Clear the list of files to be compiled and copied..
protected void	scanDir(java.io.File srcDir, java.io.File destDir, java.lang.String[] files) Scans the directory looking for source files to be compiled.
void	setDestdir(java.io.File destDir) Set the destination directory into which the Java source files should be compiled.
void	setFailonerror(boolean fail) Indicates whether the build will continue even if there are compilation errors; defaults to true.
void	setListfiles(boolean list) If true, list the source files being handed off to the compiler.
void	setProceed(boolean proceed)
void	setSrcdir(Path srcDir) Set the source directories to find the source Java files.

Methods inherited from class java.lang.Object

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

Field Detail

src

private Path src

destDir

private java.io.File destDir

failOnError

protected boolean failOnError

listFiles

protected boolean listFiles

compileList

protected java.io.File[] compileList

m

private GlobPatternMapper m

context

private org.radeox.api.engine.context.RenderContext context

engine

private org.radeox.api.engine.RenderEngine engine

Constructor Detail

Wiki2Markup

public Wiki2Markup()

Method Detail

main

public static void main(java.lang.String[] args)

createSrc

public Path createSrc()

Adds a path for source compilation.

Returns:

a nested src element.

recreateSrc

protected Path recreateSrc()

Recreate src.

Returns:

a nested src element.

setSrcdir

public void setSrcdir(Path srcDir)

Set the source directories to find the source Java files.

Parameters:

srcDir - the source directories as a path

getSrcdir

public Path getSrcdir()

Gets the source dirs to find the source java files.

Returns:

the source directorys as a path

setDestdir

public void setDestdir(java.io.File destDir)

Set the destination directory into which the Java source files should be compiled.

Parameters:

destDir - the destination director

getDestdir

public java.io.File getDestdir()

Gets the destination directory into which the java source files should be compiled.

Returns:

the destination directory

setListfiles

public void setListfiles(boolean list)

If true, list the source files being handed off to the compiler.

Parameters:

list - if true list the source files

getListfiles

public boolean getListfiles()

Get the listfiles flag.

Returns:

the listfiles flag

setFailonerror

public void setFailonerror(boolean fail)

Indicates whether the build will continue even if there are compilation errors; defaults to true.

Parameters:

fail - if true halt the build on failure

setProceed

public void setProceed(boolean proceed)

Parameters:

proceed - inverse of failoferror

getFailonerror

public boolean getFailonerror()

Gets the failonerror flag.

Returns:

the failonerror flag

execute

public void execute()
             throws BuildException

Executes the task.

Throws:

BuildException - if an error occurs

resetFileLists

protected void resetFileLists()

Clear the list of files to be compiled and copied..

scanDir

protected void scanDir(java.io.File srcDir,
                       java.io.File destDir,
                       java.lang.String[] files)

Scans the directory looking for source files to be compiled. The results are returned in the class variable compileList

Parameters:

srcDir - The source directory

destDir - The destination directory

files - An array of filenames

getFileList

public java.io.File[] getFileList()

Gets the list of files to be compiled.

Returns:

the list of files as an array

checkParameters

protected void checkParameters()
                        throws BuildException

Throws:

BuildException

compileFiles

public void compileFiles(java.lang.String[] args)
                  throws java.io.IOException

Throws:

java.io.IOException

compile

protected void compile()

compile

protected void compile(java.io.File file,
                       java.lang.String name)
                throws java.io.IOException

Throws:

java.io.IOException

filter

protected java.lang.String filter(java.lang.String result)

readFile

protected java.lang.String readFile(java.io.File file)
                             throws java.io.IOException

Throws:

java.io.IOException

createRenderEngine

protected org.radeox.api.engine.RenderEngine createRenderEngine()

getExtension

protected java.lang.String getExtension()