org.sandev.sandbuild
Class SandEnvFile

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.sandev.sandbuild.SandTask
              org.sandev.sandbuild.SandEnvFile

public class SandEnvFile

extends SandTask

A SandEnvFile is a file that must be available at runtime. This can be anything from a third party .jar to an initialization file or whatever your code needs. These files are copied into downstream projects in the dependency graph, and are left alone when a project is being cleaned up.

Field Summary

protected java.lang.String	description A description of the file.
protected java.lang.String	name The name of the file which must be available at runtime.

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

location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

SandEnvFile()

Method Summary

void	execute() See class comments
void	setDescription(java.lang.String val)
void	setName(java.lang.String name)

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, 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

Field Detail

name

protected java.lang.String name

The name of the file which must be available at runtime. The file is presumed to be in the env directory.

description

protected java.lang.String description

A description of the file. This is not required but provides some documentation of why this file is needed.

Constructor Detail

SandEnvFile

public SandEnvFile()

Method Detail

setName

public void setName(java.lang.String name)

setDescription

public void setDescription(java.lang.String val)

execute

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

See class comments

Throws:

org.apache.tools.ant.BuildException