class ScalaTool extends ScalaMatchingTask
An Ant task that generates a shell or batch script to execute a Scala program.
This task can take the following parameters as attributes:
file
(mandatory),class
(mandatory),platforms
,classpath
,properties
,javaflags
,toolflags
.
- Source
- ScalaTool.scala
- Version
1.1
- Alphabetic
- By Inheritance
- ScalaTool
- ScalaMatchingTask
- ScalaTask
- MatchingTask
- SelectorContainer
- Task
- ProjectComponent
- Cloneable
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new ScalaTool()
Type Members
- abstract class PermissibleValue extends AnyRef
Value Members
-
final
def
!=(arg0: Any): Boolean
Test two objects for inequality.
Test two objects for inequality.
- returns
true
if !(this == that), false otherwise.
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
Equivalent to
x.hashCode
except for boxed numeric types andnull
.Equivalent to
x.hashCode
except for boxed numeric types andnull
. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. Fornull
returns a hashcode wherenull.hashCode
throws aNullPointerException
.- returns
a hash value consistent with ==
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (ScalaTool, B)
-
final
def
==(arg0: Any): Boolean
The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
.The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
.- returns
true
if the receiver object is equivalent to the argument;false
otherwise.
- Definition Classes
- AnyRef → Any
-
def
XsetIgnore(arg0: String): Unit
- Definition Classes
- MatchingTask
-
def
XsetItems(arg0: String): Unit
- Definition Classes
- MatchingTask
-
def
add(arg0: FileSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addAnd(arg0: AndSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addContains(arg0: ContainsSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addContainsRegexp(arg0: ContainsRegexpSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addCustom(arg0: ExtendSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addDate(arg0: DateSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addDepend(arg0: DependSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addDepth(arg0: DepthSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addDifferent(arg0: DifferentSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addFilename(arg0: FilenameSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addMajority(arg0: MajoritySelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addModified(arg0: ModifiedSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addNone(arg0: NoneSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addNot(arg0: NotSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addOr(arg0: OrSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addPresent(arg0: PresentSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addSelector(arg0: SelectSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addSize(arg0: SizeSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addType(arg0: TypeSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
appendSelector(arg0: FileSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
final
def
asInstanceOf[T0]: T0
Cast the receiver object to be of type
T0
.Cast the receiver object to be of type
T0
.Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression
1.asInstanceOf[String]
will throw aClassCastException
at runtime, while the expressionList(1).asInstanceOf[List[String]]
will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.- returns
the receiver object.
- Definition Classes
- Any
- Exceptions thrown
ClassCastException
if the receiver object is not an instance of the erasure of typeT0
.
-
final
def
bindToOwner(arg0: Task): Unit
- Definition Classes
- Task
-
def
buildError(message: String): Nothing
Generates a build error.
Generates a build error. Error location will be the current task in the ant file.
- message
A message describing the error.
- Attributes
- protected
- Definition Classes
- ScalaTask
- Exceptions thrown
BuildException
A build error exception thrown in every case.
-
def
clone(): AnyRef
Create a copy of the receiver object.
Create a copy of the receiver object.
The default implementation of the
clone
method is platform dependent.- returns
a copy of the receiver object.
- Definition Classes
- ProjectComponent → AnyRef
- Annotations
- @throws( ... )
- Note
not specified by SLS as a member of AnyRef
-
def
createClassPath: Path
A special method that allows ant classpath path definitions to be nested within this ant task.
-
def
createExclude(): NameEntry
- Definition Classes
- MatchingTask
-
def
createExcludesFile(): NameEntry
- Definition Classes
- MatchingTask
-
def
createInclude(): NameEntry
- Definition Classes
- MatchingTask
-
def
createIncludesFile(): NameEntry
- Definition Classes
- MatchingTask
-
def
createPatternSet(): PatternSet
- Definition Classes
- MatchingTask
- def ensuring(cond: (ScalaTool) ⇒ Boolean, msg: ⇒ Any): ScalaTool
- def ensuring(cond: (ScalaTool) ⇒ Boolean): ScalaTool
- def ensuring(cond: Boolean, msg: ⇒ Any): ScalaTool
- def ensuring(cond: Boolean): ScalaTool
-
final
def
eq(arg0: AnyRef): Boolean
Tests whether the argument (
that
) is a reference to the receiver object (this
).Tests whether the argument (
that
) is a reference to the receiver object (this
).The
eq
method implements an equivalence relation on non-null instances ofAnyRef
, and has three additional properties:- It is consistent: for any non-null instances
x
andy
of typeAnyRef
, multiple invocations ofx.eq(y)
consistently returnstrue
or consistently returnsfalse
. - For any non-null instance
x
of typeAnyRef
,x.eq(null)
andnull.eq(x)
returnsfalse
. null.eq(null)
returnstrue
.
When overriding the
equals
orhashCode
methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2
), they should be equal to each other (o1 == o2
) and they should hash to the same value (o1.hashCode == o2.hashCode
).- returns
true
if the argument is a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
- It is consistent: for any non-null instances
-
def
equals(arg0: Any): Boolean
The equality method for reference types.
-
def
execute(): Unit
Performs the tool creation.
Performs the tool creation.
- Definition Classes
- ScalaTool → Task
-
def
finalize(): Unit
Called by the garbage collector on the receiver object when there are no more references to the object.
Called by the garbage collector on the receiver object when there are no more references to the object.
The details of when and if the
finalize
method is invoked, as well as the interaction betweenfinalize
and non-local returns and exceptions, are all platform dependent.- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- Note
not specified by SLS as a member of AnyRef
- def formatted(fmtstr: String): String
-
final
def
getClass(): Class[_]
Returns the runtime class representation of the object.
Returns the runtime class representation of the object.
- returns
a class object corresponding to the runtime type of the receiver.
- Definition Classes
- AnyRef → Any
-
def
getDescription(): String
- Definition Classes
- ProjectComponent
-
def
getDirectoryScanner(arg0: File): DirectoryScanner
- Attributes
- protected[org.apache.tools.ant.taskdefs]
- Definition Classes
- MatchingTask
-
final
def
getImplicitFileSet(): FileSet
- Attributes
- protected[org.apache.tools.ant.taskdefs]
- Definition Classes
- MatchingTask
-
def
getLocation(): Location
- Definition Classes
- ProjectComponent
-
def
getOwningTarget(): Target
- Definition Classes
- Task
-
def
getProject(): Project
- Definition Classes
- ProjectComponent
-
def
getRuntimeConfigurableWrapper(): RuntimeConfigurable
- Definition Classes
- Task
-
def
getSelectors(arg0: Project): Array[FileSelector]
- Definition Classes
- MatchingTask → SelectorContainer
-
def
getTaskName(): String
- Definition Classes
- Task
-
def
getTaskType(): String
- Definition Classes
- Task
-
def
getWrapper(): RuntimeConfigurable
- Attributes
- protected[org.apache.tools.ant]
- Definition Classes
- Task
-
def
handleErrorFlush(arg0: String): Unit
- Attributes
- protected[org.apache.tools.ant]
- Definition Classes
- Task
-
def
handleErrorOutput(arg0: String): Unit
- Attributes
- protected[org.apache.tools.ant]
- Definition Classes
- Task
-
def
handleFlush(arg0: String): Unit
- Attributes
- protected[org.apache.tools.ant]
- Definition Classes
- Task
-
def
handleInput(arg0: Array[Byte], arg1: Int, arg2: Int): Int
- Attributes
- protected[org.apache.tools.ant]
- Definition Classes
- Task
- Annotations
- @throws( classOf[java.io.IOException] )
-
def
handleOutput(arg0: String): Unit
- Attributes
- protected[org.apache.tools.ant]
- Definition Classes
- Task
-
def
hasSelectors(): Boolean
- Definition Classes
- MatchingTask → SelectorContainer
-
def
hashCode(): Int
The hashCode method for reference types.
-
def
init(): Unit
- Definition Classes
- Task
- Annotations
- @throws( ... )
-
final
def
isInstanceOf[T0]: Boolean
Test whether the dynamic type of the receiver object is
T0
.Test whether the dynamic type of the receiver object is
T0
.Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression
1.isInstanceOf[String]
will returnfalse
, while the expressionList(1).isInstanceOf[List[String]]
will returntrue
. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.- returns
true
if the receiver object is an instance of erasure of typeT0
;false
otherwise.
- Definition Classes
- Any
-
final
def
isInvalid(): Boolean
- Attributes
- protected[org.apache.tools.ant]
- Definition Classes
- Task
-
def
log(arg0: String, arg1: java.lang.Throwable, arg2: Int): Unit
- Definition Classes
- Task
-
def
log(arg0: java.lang.Throwable, arg1: Int): Unit
- Definition Classes
- Task
-
def
log(arg0: String, arg1: Int): Unit
- Definition Classes
- Task → ProjectComponent
-
def
log(arg0: String): Unit
- Definition Classes
- Task → ProjectComponent
-
def
maybeConfigure(): Unit
- Definition Classes
- Task
- Annotations
- @throws( ... )
-
final
def
ne(arg0: AnyRef): Boolean
Equivalent to
!(this eq that)
.Equivalent to
!(this eq that)
.- returns
true
if the argument is not a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up a single thread that is waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Note
not specified by SLS as a member of AnyRef
-
final
def
notifyAll(): Unit
Wakes up all threads that are waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Note
not specified by SLS as a member of AnyRef
-
final
def
perform(): Unit
- Definition Classes
- Task
-
def
reconfigure(): Unit
- Definition Classes
- Task
-
def
selectorCount(): Int
- Definition Classes
- MatchingTask → SelectorContainer
-
def
selectorElements(): java.util.Enumeration[FileSelector]
- Definition Classes
- MatchingTask → SelectorContainer
-
def
setCaseSensitive(arg0: Boolean): Unit
- Definition Classes
- MatchingTask
-
def
setClass(input: String): Unit
Sets the main class attribute.
-
def
setClassPath(input: String): Unit
Sets the classpath with which to run the tool.
Sets the classpath with which to run the tool.
Note that this mechanism of setting the classpath is generally preferred for general purpose scripts, as this does not assume all elements are relative to the Ant
basedir
. Additionally, the platform specific demarcation of any script variables (e.g.${SCALA_HOME}
or%SCALA_HOME%
) can be specified in a platform independent way (e.g.@SCALA_HOME@
) and automatically translated for you. -
def
setClassPathRef(input: Reference): Unit
Adds an Ant Path reference to the tool's classpath.
Adds an Ant Path reference to the tool's classpath. Note that all entries in the path must exist either relative to the project basedir or with an absolute path to a file in the filesystem. As a result, this is not a mechanism for setting the classpath for more general use scripts.
-
def
setDefaultexcludes(arg0: Boolean): Unit
- Definition Classes
- MatchingTask
-
def
setDescription(arg0: String): Unit
- Definition Classes
- ProjectComponent
-
def
setExcludes(arg0: String): Unit
- Definition Classes
- MatchingTask
-
def
setExcludesfile(arg0: File): Unit
- Definition Classes
- MatchingTask
-
def
setFile(input: File): Unit
Sets the file attribute.
-
def
setFollowSymlinks(arg0: Boolean): Unit
- Definition Classes
- MatchingTask
-
def
setIncludes(arg0: String): Unit
- Definition Classes
- MatchingTask
-
def
setIncludesfile(arg0: File): Unit
- Definition Classes
- MatchingTask
-
def
setJavaflags(input: String): Unit
Sets flags to be passed to the Java interpreter.
-
def
setLocation(arg0: Location): Unit
- Definition Classes
- ProjectComponent
-
def
setOwningTarget(arg0: Target): Unit
- Definition Classes
- Task
-
def
setPlatforms(input: String): Unit
Sets the platforms attribute.
-
def
setProject(arg0: Project): Unit
- Definition Classes
- MatchingTask → ProjectComponent
-
def
setProperties(input: String): Unit
Sets JVM properties that will be set whilst running the tool.
-
def
setRuntimeConfigurableWrapper(arg0: RuntimeConfigurable): Unit
- Definition Classes
- Task
-
def
setTaskName(arg0: String): Unit
- Definition Classes
- Task
-
def
setTaskType(arg0: String): Unit
- Definition Classes
- Task
-
def
setToolflags(input: String): Unit
Sets flags to be passed to the tool.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
Creates a String representation of this object.
Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.
- returns
a String representation of the object.
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- def →[B](y: B): (ScalaTool, B)
-
object
Platforms
extends PermissibleValue
Defines valid values for the platforms property.
The Scala compiler API.
The following resources are useful for Scala plugin/compiler development: