org.tigris.scarab.util.build
Class AntL10AnalysisTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.tigris.scarab.util.build.AntL10AnalysisTask

public class AntL10AnalysisTask

extends org.apache.tools.ant.Task

Ant task to check for localisation problems.

Ant parameters:

• FileSet: Files to check
• messageSet: Set the severity for a particular message. This is done by setting the attributes error to the issue that has to be used (e.g. error="CantParseIssue") and severity to one of the defined severity levels:
  • ERROR: This issue will be marked as error
  • WARNING: This issue will be marked as error
  • INFORMATION: This issue will be marked as error
  • IGNORED: This issue will be marked to be ignored. By default all issues are marked as "IGNORED".
• reffile: Reference file
• verbose: Verbosity:
  • 0: Errors only
  • 1: Errors and warnings
  • 2: Errors, warnings and information.
• outfile: IF given, all output is written to this file
• failonerr: Stop after first checked file in case of errors.

In case the output is redirected to a file, summary information is displayed on the ant output.

Author:

sreindl

Nested Class Summary

class

AntL10AnalysisTask.Message sub Class that represents a severity setting message

Field Summary

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

AntL10AnalysisTask()

Method Summary

org.apache.tools.ant.types.FileSet	createFileset() Files to load
AntL10AnalysisTask.Message	createMessageSet() ant handler for the messageSet token
void	execute()
void	setFailonerr(boolean failonerr) Handle the attribute fileonerr
void	setOutfile(java.lang.String filename) Set the output file
void	setRefFile(java.lang.String aFile) Handle the attribute "refFile"
void	setVerbose(int verbose) Handle the attribute "verbose".

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

getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, 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

Constructor Detail

AntL10AnalysisTask

public AntL10AnalysisTask()

Method Detail

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Throws:

org.apache.tools.ant.BuildException

setOutfile

public void setOutfile(java.lang.String filename)

Set the output file

Parameters:

filename - the file to write

setRefFile

public void setRefFile(java.lang.String aFile)

Handle the attribute "refFile"

Parameters:

aFile - The reference file to be used

setVerbose

public void setVerbose(int verbose)

Handle the attribute "verbose".

Parameters:

verbose - The verbosity to be set

setFailonerr

public void setFailonerr(boolean failonerr)

Handle the attribute fileonerr

Parameters:

failonerr - The failonerr to set.

createFileset

public org.apache.tools.ant.types.FileSet createFileset()

Files to load

Returns:

A new FileSet that represents a list of files to be read.

createMessageSet

public AntL10AnalysisTask.Message createMessageSet()

ant handler for the messageSet token

Returns:

a new allocated message