org.apache.tools.ant.taskdefs.optional
Class NetRexxC
public
class
NetRexxC
extends MatchingTask
Compiles NetRexx source files.
This task can take the following
arguments:
- binary
- classpath
- comments
- compile
- console
- crossref
- decimal
- destdir
- diag
- explicit
- format
- keep
- logo
- replace
- savelog
- srcdir
- sourcedir
- strictargs
- strictassign
- strictcase
- strictimport
- symbols
- time
- trace
- utf8
- verbose
- suppressMethodArgumentNotUsed
- suppressPrivatePropertyNotUsed
- suppressVariableNotUsed
- suppressExceptionNotSignalled
- suppressDeprecation
- removeKeepExtension
Of these arguments, the
srcdir argument is required.
When this task executes, it will recursively scan the srcdir
looking for NetRexx source files to compile. This task makes its
compile decision based on timestamp.
Before files are compiled they and any other file in the
srcdir will be copied to the destdir allowing support files to be
located properly in the classpath. The reason for copying the source files
before the compile is that NetRexxC has only two destinations for classfiles:
- The current directory, and,
- The directory the source is in (see sourcedir option)
Method Summary |
void | execute()
Executes the task - performs the actual compiler call. |
void | init()
init-Method sets defaults from Properties. |
void | setBinary(boolean binary)
Set whether literals are treated as binary, rather than NetRexx types.
|
void | setClasspath(String classpath)
Set the classpath used for NetRexx compilation. |
void | setComments(boolean comments)
Set whether comments are passed through to the generated java source.
|
void | setCompact(boolean compact)
Set whether error messages come out in compact or verbose format.
|
void | setCompile(boolean compile)
Set whether the NetRexx compiler should compile the generated java code.
|
void | setConsole(boolean console)
Set whether or not compiler messages should be displayed on the 'console'.
|
void | setCrossref(boolean crossref)
Whether variable cross references are generated.
|
void | setDecimal(boolean decimal)
Set whether decimal arithmetic should be used for the netrexx code.
|
void | setDestDir(File destDirName)
Set the destination directory into which the NetRexx source files
should be copied and then compiled. |
void | setDiag(boolean diag)
Whether diagnostic information about the compile is generated |
void | setExplicit(boolean explicit)
Sets whether variables must be declared explicitly before use.
|
void | setFormat(boolean format)
Whether the generated java code is formatted nicely or left to match
NetRexx line numbers for call stack debugging.
|
void | setJava(boolean java)
Whether the generated java code is produced.
|
void | setKeep(boolean keep)
Sets whether the generated java source file should be kept after
compilation. |
void | setLogo(boolean logo)
Whether the compiler text logo is displayed when compiling.
|
void | setRemoveKeepExtension(boolean removeKeepExtension)
Tells wether the trailing .keep in nocompile-mode should be removed
so that the resulting java source really ends on .java.
|
void | setReplace(boolean replace)
Whether the generated .java file should be replaced when compiling.
|
void | setSavelog(boolean savelog)
Sets whether the compiler messages will be written to NetRexxC.log as
well as to the console.
|
void | setSourcedir(boolean sourcedir)
Tells the NetRexx compiler to store the class files in the same
directory as the source files. |
void | setSrcDir(File srcDirName)
Set the source dir to find the source Java files. |
void | setStrictargs(boolean strictargs)
Tells the NetRexx compiler that method calls always need parentheses,
even if no arguments are needed, e.g. |
void | setStrictassign(boolean strictassign)
Tells the NetRexx compile that assignments must match exactly on type.
|
void | setStrictcase(boolean strictcase)
Specifies whether the NetRexx compiler should be case sensitive or not.
|
void | setStrictimport(boolean strictimport)
Sets whether classes need to be imported explicitly using an import
statement. |
void | setStrictprops(boolean strictprops)
Sets whether local properties need to be qualified explicitly using
this .
|
void | setStrictsignal(boolean strictsignal)
Whether the compiler should force catching of exceptions by explicitly
named types.
|
void | setSuppressDeprecation(boolean suppressDeprecation)
Tells whether we should filter out any deprecation-messages
of the compiler out. |
void | setSuppressExceptionNotSignalled(boolean suppressExceptionNotSignalled)
Whether the task should suppress the "FooException is in SIGNALS list
but is not signalled within the method", which is sometimes rather
useless. |
void | setSuppressMethodArgumentNotUsed(boolean suppressMethodArgumentNotUsed)
Whether the task should suppress the "Method argument is not used" in
strictargs-Mode, which can not be suppressed by the compiler itself.
|
void | setSuppressPrivatePropertyNotUsed(boolean suppressPrivatePropertyNotUsed)
Whether the task should suppress the "Private property is defined but
not used" in strictargs-Mode, which can be quite annoying while
developing. |
void | setSuppressVariableNotUsed(boolean suppressVariableNotUsed)
Whether the task should suppress the "Variable is set but not used" in
strictargs-Mode. |
void | setSymbols(boolean symbols)
Sets whether debug symbols should be generated into the class file.
|
void | setTime(boolean time)
Asks the NetRexx compiler to print compilation times to the console
Valid true values are "yes", "on" or "true". |
void | setTrace(NetRexxC.TraceAttr trace)
Turns on or off tracing and directs the resultant trace output Valid
values are: "trace", "trace1", "trace2" and "notrace". |
void | setTrace(String trace)
Turns on or off tracing and directs the resultant trace output Valid
values are: "trace", "trace1", "trace2" and "notrace". |
void | setUtf8(boolean utf8)
Tells the NetRexx compiler that the source is in UTF8.
|
void | setVerbose(NetRexxC.VerboseAttr verbose)
Whether lots of warnings and error messages should be generated |
void | setVerbose(String verbose)
Whether lots of warnings and error messages should be generated |
public void execute()
Executes the task - performs the actual compiler call.
Throws: BuildException on error.
public void init()
init-Method sets defaults from Properties. That way, when ant is called
with arguments like -Dant.netrexxc.verbose=verbose5 one can easily take
control of all netrexxc-tasks.
public void setBinary(boolean binary)
Set whether literals are treated as binary, rather than NetRexx types.
Valid true values are "yes", "on" or "true". Anything else sets the flag to false.
The default is false.
Parameters: binary a boolean
value.
public void setClasspath(String classpath)
Set the classpath used for NetRexx compilation.
Parameters: classpath the classpath to use.
public void setComments(boolean comments)
Set whether comments are passed through to the generated java source.
Valid true values are "yes", "on" or "true". Anything else sets the flag to false.
The default value is false.
Parameters: comments a boolean
value.
public void setCompact(boolean compact)
Set whether error messages come out in compact or verbose format.
Valid true values are "yes", "on" or "true". Anything else sets the flag to false.
The default value is true.
Parameters: compact a boolean
value.
public void setCompile(boolean compile)
Set whether the NetRexx compiler should compile the generated java code.
Valid true values are "yes", "on" or "true". Anything else sets the flag to false.
The default value is true.
Setting this flag to false, will automatically set the keep flag to true.
Parameters: compile a boolean
value.
public void setConsole(boolean console)
Set whether or not compiler messages should be displayed on the 'console'.
Note that this task will rely on the default value for filtering compile messages.
Valid true values are "yes", "on" or "true". Anything else sets the flag to false.
The default value is false.
Parameters: console a boolean
value.
public void setCrossref(boolean crossref)
Whether variable cross references are generated.
Valid true values are "yes", "on" or "true". Anything else sets the flag to false.
The default value is false.
Parameters: crossref a boolean
value.
public void setDecimal(boolean decimal)
Set whether decimal arithmetic should be used for the netrexx code.
Setting this to off will report decimal arithmetic as an error, for
performance critical applications.
Valid true values are "yes", "on" or "true". Anything else sets the flag to false.
The default value is true.
Parameters: decimal a boolean
value.
public void setDestDir(File destDirName)
Set the destination directory into which the NetRexx source files
should be copied and then compiled.
Parameters: destDirName the destination directory.
public void setDiag(boolean diag)
Whether diagnostic information about the compile is generated
Parameters: diag a boolean
value.
public void setExplicit(boolean explicit)
Sets whether variables must be declared explicitly before use.
Valid true values are "yes", "on" or "true". Anything else sets the flag to false.
The default value is false.
Parameters: explicit a boolean
value.
public void setFormat(boolean format)
Whether the generated java code is formatted nicely or left to match
NetRexx line numbers for call stack debugging.
Valid true values are "yes", "on" or "true". Anything else sets the flag to false.
The default value false.
Parameters: format a boolean
value.
public void setJava(boolean java)
Whether the generated java code is produced.
This is not implemented yet.
Parameters: java a boolean
value.
public void setKeep(boolean keep)
Sets whether the generated java source file should be kept after
compilation. The generated files will have an extension of .java.keep,
not .java. See setRemoveKeepExtension
Valid true values are "yes", "on" or "true". Anything else sets the flag to false.
The default value is false.
Parameters: keep a boolean
value.
See Also: NetRexxC
public void setLogo(boolean logo)
Whether the compiler text logo is displayed when compiling.
Valid true values are "yes", "on" or "true". Anything else sets the flag to false.
The default value is false.
Parameters: logo a boolean
value.
public void setRemoveKeepExtension(boolean removeKeepExtension)
Tells wether the trailing .keep in nocompile-mode should be removed
so that the resulting java source really ends on .java.
This facilitates the use of the javadoc tool lateron.
public void setReplace(boolean replace)
Whether the generated .java file should be replaced when compiling.
Valid true values are "yes", "on" or "true". Anything else sets the flag to false.
The default value is false.
Parameters: replace a boolean
value.
public void setSavelog(boolean savelog)
Sets whether the compiler messages will be written to NetRexxC.log as
well as to the console.
Valid true values are "yes", "on" or "true". Anything else sets the flag to false.
The default value is false.
Parameters: savelog a boolean
value.
public void setSourcedir(boolean sourcedir)
Tells the NetRexx compiler to store the class files in the same
directory as the source files. The alternative is the working directory.
Valid true values are "yes", "on" or "true". Anything else sets the flag to false.
The default value is true.
Parameters: sourcedir a boolean
value.
public void setSrcDir(File srcDirName)
Set the source dir to find the source Java files.
Parameters: srcDirName the source directory.
public void setStrictargs(boolean strictargs)
Tells the NetRexx compiler that method calls always need parentheses,
even if no arguments are needed, e.g.
aStringVar.getBytes
vs.
aStringVar.getBytes()
.
Valid true values are "yes", "on" or "true". Anything else sets the flag to false.
The default value is false.
Parameters: strictargs a boolean
value.
public void setStrictassign(boolean strictassign)
Tells the NetRexx compile that assignments must match exactly on type.
Valid true values are "yes", "on" or "true". Anything else sets the flag to false.
The default value is false.
Parameters: strictassign a boolean
value.
public void setStrictcase(boolean strictcase)
Specifies whether the NetRexx compiler should be case sensitive or not.
Valid true values are "yes", "on" or "true". Anything else sets the flag to false.
The default value is false.
Parameters: strictcase a boolean
value.
public void setStrictimport(boolean strictimport)
Sets whether classes need to be imported explicitly using an
import
statement. By default the NetRexx compiler will import certain packages
automatically.
Valid true values are "yes", "on" or "true". Anything else sets the flag to false.
The default value is false.
Parameters: strictimport a boolean
value.
public void setStrictprops(boolean strictprops)
Sets whether local properties need to be qualified explicitly using
this
.
Valid true values are "yes", "on" or "true". Anything else sets the flag to false.
The default value is false.
Parameters: strictprops a boolean
value.
public void setStrictsignal(boolean strictsignal)
Whether the compiler should force catching of exceptions by explicitly
named types.
Valid true values are "yes", "on" or "true". Anything else sets the flag to false.
The default value is false
Parameters: strictsignal a boolean
value.
public void setSuppressDeprecation(boolean suppressDeprecation)
Tells whether we should filter out any deprecation-messages
of the compiler out.
Parameters: suppressDeprecation a boolean
value.
public void setSuppressExceptionNotSignalled(boolean suppressExceptionNotSignalled)
Whether the task should suppress the "FooException is in SIGNALS list
but is not signalled within the method", which is sometimes rather
useless. The warning is logged as verbose message, though.
Parameters: suppressExceptionNotSignalled a boolean
value.
public void setSuppressMethodArgumentNotUsed(boolean suppressMethodArgumentNotUsed)
Whether the task should suppress the "Method argument is not used" in
strictargs-Mode, which can not be suppressed by the compiler itself.
The warning is logged as verbose message, though.
Parameters: suppressMethodArgumentNotUsed a boolean
value.
public void setSuppressPrivatePropertyNotUsed(boolean suppressPrivatePropertyNotUsed)
Whether the task should suppress the "Private property is defined but
not used" in strictargs-Mode, which can be quite annoying while
developing. The warning is logged as verbose message, though.
Parameters: suppressPrivatePropertyNotUsed a boolean
value.
public void setSuppressVariableNotUsed(boolean suppressVariableNotUsed)
Whether the task should suppress the "Variable is set but not used" in
strictargs-Mode. Be careful with this one! The warning is logged as
verbose message, though.
Parameters: suppressVariableNotUsed a boolean
value.
public void setSymbols(boolean symbols)
Sets whether debug symbols should be generated into the class file.
Valid true values are "yes", "on" or "true". Anything else sets the flag to false.
The default value is false.
Parameters: symbols a boolean
value.
public void setTime(boolean time)
Asks the NetRexx compiler to print compilation times to the console
Valid true values are "yes", "on" or "true". Anything else sets the flag to false.
The default value is false.
Parameters: time a boolean
value.
Turns on or off tracing and directs the resultant trace output Valid
values are: "trace", "trace1", "trace2" and "notrace". "trace" and
"trace2".
Parameters: trace the value to set.
public void setTrace(String trace)
Turns on or off tracing and directs the resultant trace output Valid
values are: "trace", "trace1", "trace2" and "notrace". "trace" and
"trace2".
Parameters: trace the value to set.
public void setUtf8(boolean utf8)
Tells the NetRexx compiler that the source is in UTF8.
Valid true values are "yes", "on" or "true". Anything else sets the flag to false.
The default value is false.
Parameters: utf8 a boolean
value.
Whether lots of warnings and error messages should be generated
Parameters: verbose the value to set - verbose<level> or noverbose.
public void setVerbose(String verbose)
Whether lots of warnings and error messages should be generated
Parameters: verbose the value to set - verbose<level> or noverbose.