org.eclipse.mylyn.wikitext.core.util.anttask
Class MarkupToDocbookTask

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by org.eclipse.mylyn.wikitext.core.util.anttask.MarkupTask
              extended by org.eclipse.mylyn.wikitext.core.util.anttask.MarkupToDocbookTask
All Implemented Interfaces:
Cloneable

public class MarkupToDocbookTask
extends MarkupTask

An Ant task for converting markup to docbook format.

Since:
1.0
Author:
David Green

Field Summary
protected  File file
           
 
Fields inherited from class org.apache.tools.ant.Task
target, taskName, taskType, wrapper
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project
 
Constructor Summary
MarkupToDocbookTask()
           
 
Method Summary
 void addFileset(org.apache.tools.ant.types.FileSet set)
          Adds a set of files to process.
 void execute()
           
 String getBookTitle()
          Get the book title.
 String getDocbookFilenameFormat()
          The format of the DocBook output file.
 String getDoctype()
          The XML doctype of the docbook.
 File getFile()
           
 boolean isOverwrite()
           
 void setBookTitle(String bookTitle)
          The book title.
 void setDocbookFilenameFormat(String docbookFilenameFormat)
          The format of the DocBook output file.
 void setDoctype(String doctype)
          Set the XML doctype of the docbook.
 void setFile(File file)
           
 void setOverwrite(boolean overwrite)
           
 
Methods inherited from class org.eclipse.mylyn.wikitext.core.util.anttask.MarkupTask
addConfiguredMarkupLanguageConfiguration, createMarkupLanguage, getInternalLinkPattern, getMarkupLanguage, getMarkupLanguageConfiguration, getSourceEncoding, isFailOnValidationError, isFailOnValidationWarning, isValidate, performValidation, readFully, setFailOnValidationError, setFailOnValidationWarning, setInternalLinkPattern, setMarkupLanguage, setMarkupLanguageConfiguration, setSourceEncoding, setValidate
 
Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

file

protected File file
Constructor Detail

MarkupToDocbookTask

public MarkupToDocbookTask()
Method Detail

addFileset

public void addFileset(org.apache.tools.ant.types.FileSet set)
Adds a set of files to process.


execute

public void execute()
             throws org.apache.tools.ant.BuildException
Overrides:
execute in class org.apache.tools.ant.Task
Throws:
org.apache.tools.ant.BuildException

getDocbookFilenameFormat

public String getDocbookFilenameFormat()
The format of the DocBook output file. Consists of a pattern where the '$1' is replaced with the filename of the input file. Default value is $1.xml

See Also:
setDocbookFilenameFormat(String)

setDocbookFilenameFormat

public void setDocbookFilenameFormat(String docbookFilenameFormat)
The format of the DocBook output file. Consists of a pattern where the '$1' is replaced with the filename of the input file. Default value is $1.xml

Parameters:
docbookFilenameFormat -

getBookTitle

public String getBookTitle()
Get the book title.

Returns:
the title, or null if the source filename is to be used as the title.

setBookTitle

public void setBookTitle(String bookTitle)
The book title.

Parameters:
bookTitle - the title, or null if the source filename is to be used as the title.

setDoctype

public void setDoctype(String doctype)
Set the XML doctype of the docbook. The doctype should look something like this: <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">


getDoctype

public String getDoctype()
The XML doctype of the docbook.


isOverwrite

public boolean isOverwrite()

setOverwrite

public void setOverwrite(boolean overwrite)

getFile

public File getFile()

setFile

public void setFile(File file)


Copyright © 2011 FuseSource, Corp.. All Rights Reserved.