net.dpml.tools.tasks
Class DocTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          net.dpml.tools.tasks.GenericTask
              net.dpml.tools.tasks.DocTask

public class DocTask
extends GenericTask

Site generation.

Version:

1.2.0

Author:

Digital Product Meta Library

Nested Class Summary

class

DocTask.RegexpFilter Utility regualar expression filter.

Field Summary

static String	DOC_ANCHOR_URL_KEY Constant docs anchor url key.
static String	DOC_BRAND_NAME_KEY Constant docs brand key.
static String	DOC_DATE_FORMAT_KEY Constant docs date format key.
static String	DOC_ENTRY_KEY Constant docs entry-point key.
static String	DOC_FORMAT_KEY Constant docs output format key.
static String	DOC_HOME_PATH_KEY Constant docs home page path.
static String	DOC_LOGO_LEFT_FILE_KEY Constant docs logo-left file key.
static String	DOC_LOGO_LEFT_URL_KEY Constant docs logo-left url key.
static String	DOC_LOGO_MIDDLE_FILE_KEY Constant docs logo-middle file key.
static String	DOC_LOGO_MIDDLE_URL_KEY Constant docs logo-middle url key.
static String	DOC_LOGO_RIGHT_FILE_KEY Constant docs logo-right-file key.
static String	DOC_LOGO_RIGHT_URL_KEY Constant docs logo-right url key.
static String	DOC_RESOURCES_KEY Constant docs resources key.
static String	DOC_SRC_KEY Constant docs src key.
static String	DOC_STYLE_KEY Constant docs output style key.
static String	DOC_TEMP_KEY Constant temp docs key.
static String	DOC_THEME_KEY Constant docs theme key.
static String	ORG_NAME_KEY Constant organization key.

Fields inherited from class net.dpml.tools.tasks.GenericTask

ASC_EXT, GPG_EXE_KEY, MD5_EXT

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

DocTask()

Method Summary

void	execute() Execute the task.
String	getTheme() Return the assigned theme.
void	init() Initialize the task.
void	setDest(File dir) Set a directory for ultimate replication of the generated documentation.
void	setTheme(String theme) Set the doc theme.

Methods inherited from class net.dpml.tools.tasks.GenericTask

asc, checksum, copy, deleteDir, getContext, getLibrary, getResource, isInitialized, mkDir

Methods inherited from class org.apache.tools.ant.Task

getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, setProject

Methods inherited from class java.lang.Object

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

Field Detail

ORG_NAME_KEY

public static final String ORG_NAME_KEY

Constant organization key.

See Also:

Constant Field Values

DOC_TEMP_KEY

public static final String DOC_TEMP_KEY

Constant temp docs key.

See Also:

Constant Field Values

DOC_SRC_KEY

public static final String DOC_SRC_KEY

Constant docs src key.

See Also:

Constant Field Values

DOC_RESOURCES_KEY

public static final String DOC_RESOURCES_KEY

Constant docs resources key.

See Also:

Constant Field Values

DOC_THEME_KEY

public static final String DOC_THEME_KEY

Constant docs theme key.

See Also:

Constant Field Values

DOC_FORMAT_KEY

public static final String DOC_FORMAT_KEY

Constant docs output format key.

See Also:

Constant Field Values

DOC_DATE_FORMAT_KEY

public static final String DOC_DATE_FORMAT_KEY

Constant docs date format key.

See Also:

Constant Field Values

DOC_STYLE_KEY

public static final String DOC_STYLE_KEY

Constant docs output style key.

See Also:

Constant Field Values

DOC_ENTRY_KEY

public static final String DOC_ENTRY_KEY

Constant docs entry-point key.

See Also:

Constant Field Values

DOC_LOGO_RIGHT_FILE_KEY

public static final String DOC_LOGO_RIGHT_FILE_KEY

Constant docs logo-right-file key.

See Also:

Constant Field Values

DOC_LOGO_RIGHT_URL_KEY

public static final String DOC_LOGO_RIGHT_URL_KEY

Constant docs logo-right url key.

See Also:

Constant Field Values

DOC_LOGO_LEFT_FILE_KEY

public static final String DOC_LOGO_LEFT_FILE_KEY

Constant docs logo-left file key.

See Also:

Constant Field Values

DOC_LOGO_LEFT_URL_KEY

public static final String DOC_LOGO_LEFT_URL_KEY

Constant docs logo-left url key.

See Also:

Constant Field Values

DOC_LOGO_MIDDLE_FILE_KEY

public static final String DOC_LOGO_MIDDLE_FILE_KEY

Constant docs logo-middle file key.

See Also:

Constant Field Values

DOC_LOGO_MIDDLE_URL_KEY

public static final String DOC_LOGO_MIDDLE_URL_KEY

Constant docs logo-middle url key.

See Also:

Constant Field Values

DOC_BRAND_NAME_KEY

public static final String DOC_BRAND_NAME_KEY

Constant docs brand key.

See Also:

Constant Field Values

DOC_ANCHOR_URL_KEY

public static final String DOC_ANCHOR_URL_KEY

Constant docs anchor url key.

See Also:

Constant Field Values

DOC_HOME_PATH_KEY

public static final String DOC_HOME_PATH_KEY

Constant docs home page path.

See Also:

Constant Field Values

Constructor Detail

DocTask

public DocTask()

Method Detail

getTheme

public String getTheme()

Return the assigned theme.

Returns:

the theme

setDest

public void setDest(File dir)

Set a directory for ultimate replication of the generated documentation.

Parameters:

dir - the utilimate destination directory

setTheme

public void setTheme(String theme)

Set the doc theme.

Parameters:

theme - the theme name

init

public void init()
          throws BuildException

Initialize the task.

Overrides:

init in class GenericTask

Throws:

BuildException - if a build error occurs

execute

public void execute()

Execute the task.

Overrides:

execute in class Task