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

java.lang.Object
  Task
      org.eclipse.mylyn.wikitext.core.util.anttask.MarkupTask

Direct Known Subclasses:

MarkupToDitaTask, MarkupToDocbookTask, MarkupToHtmlTask

public abstract class MarkupTask
extends Task

An abstract class for Ant tasks that use a configurable MarkupLanguage.

Author:

David Green

Constructor Summary

MarkupTask()

Method Summary

protected MarkupLanguage	createMarkupLanguage() Create a markup language parser for the specified markup language.
String	getInternalLinkPattern()
String	getMarkupLanguage() The markup language to use.
boolean	isFailOnValidationError() Indicate if WikiText validation errors should cause the Ant build to fail.
boolean	isFailOnValidationWarning() Indicate if WikiText validation warnings should cause the Ant build to fail.
boolean	isValidate() Indicate if WikiText markup should be validated.
protected void	performValidation(File source, String markupContent)
void	setFailOnValidationError(boolean failOnValidationError) Indicate if WikiText validation errors should cause the Ant build to fail.
void	setFailOnValidationWarning(boolean failOnValidationWarning) Indicate if WikiText validation warnings should cause the Ant build to fail.
void	setInternalLinkPattern(String internalLinkPattern)
void	setMarkupLanguage(String markupLanguage) The markup language to use.
void	setValidate(boolean validate) Indicate if WikiText markup should be validated.

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkupTask

public MarkupTask()

Method Detail

getMarkupLanguage

public String getMarkupLanguage()

The markup language to use. Should correspond to a markup language name.

setMarkupLanguage

public void setMarkupLanguage(String markupLanguage)

The markup language to use. Should correspond to a markup language name.

createMarkupLanguage

protected MarkupLanguage createMarkupLanguage()
                                       throws BuildException

Create a markup language parser for the specified markup language.

Returns:

the markup language

Throws:

BuildException - if the markup language is not specified or if it is unknown.

setInternalLinkPattern

public void setInternalLinkPattern(String internalLinkPattern)

See Also:

MarkupLanguage.setInternalLinkPattern(String)

getInternalLinkPattern

public String getInternalLinkPattern()

See Also:

MarkupLanguage.getInternalLinkPattern()

isValidate

public boolean isValidate()

Indicate if WikiText markup should be validated. The default is true.

setValidate

public void setValidate(boolean validate)

Indicate if WikiText markup should be validated. The default is true.

isFailOnValidationError

public boolean isFailOnValidationError()

Indicate if WikiText validation errors should cause the Ant build to fail. The default is true.

setFailOnValidationError

public void setFailOnValidationError(boolean failOnValidationError)

Indicate if WikiText validation errors should cause the Ant build to fail. The default is true.

isFailOnValidationWarning

public boolean isFailOnValidationWarning()

Indicate if WikiText validation warnings should cause the Ant build to fail. The default is false.

setFailOnValidationWarning

public void setFailOnValidationWarning(boolean failOnValidationWarning)

Indicate if WikiText validation warnings should cause the Ant build to fail. The default is false.

performValidation

protected void performValidation(File source,
                                 String markupContent)