org.apache.ignite.tools.ant.beautifier

Class GridJavadocAntTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.MatchingTask

org.apache.ignite.tools.ant.beautifier.GridJavadocAntTask

All Implemented Interfaces:

Cloneable, org.apache.tools.ant.types.selectors.SelectorContainer

public class GridJavadocAntTask
extends org.apache.tools.ant.taskdefs.MatchingTask

Ant task fixing known HTML issues for Javadoc.

Field Summary

Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask

fileset

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

Constructors

Constructor and Description
GridJavadocAntTask()

Method Summary

Modifier and Type	Method and Description
void	execute()
static String	readFileToString(String fileName, Charset charset) Reads file to string using specified charset.
void	setCss(String css) Sets CSS file name.
void	setDir(File dir) Sets directory.
void	setVerify(Boolean verify) Sets whether to verify JavaDoc HTML.

Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask

add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems

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

Methods inherited from class java.lang.Object

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

Constructor Detail

GridJavadocAntTask

public GridJavadocAntTask()

Method Detail

setDir

public void setDir(File dir)

Sets directory.

Parameters:

dir - Directory to set.

setCss

public void setCss(String css)

Sets CSS file name.

Parameters:

css - CSS file name to set.

setVerify

public void setVerify(Boolean verify)

Sets whether to verify JavaDoc HTML.

Parameters:

verify - Verify flag.

execute

public void execute()

Overrides:

execute in class org.apache.tools.ant.Task

readFileToString

public static String readFileToString(String fileName,
                                      Charset charset)
                               throws IOException

Reads file to string using specified charset.

Parameters:

fileName - File name.

charset - File charset.

Returns:

File content.

Throws:

IOException - If error occurred.