A B C D E F G H I J L M N O P Q R S T U V W

A

addChild(SandDeclTreeWrapper) - Method in class org.sandev.sandbuild.SandDeclTreeWrapper

Add a child, resorting all children to maintain order.

addClassPath - Variable in class org.sandev.sandbuild.SandManifest

Whether we should add a Class-Path specification with the names of the local .jar files.

addDeletedDecls(Collection, Collection) - Method in class org.sandev.sandbuild.SandProject

Given a collection of current declarations, and a collection of previous declarations, add any deleted declarations to the current collection.

addEnvFile(File) - Method in class org.sandev.sandbuild.SandProject

Add a file to the list of required files.

addGenDecl(SandGenDecl) - Method in class org.sandev.sandbuild.SandProject

Add a generator declaration to the collection.

addRequiredBy(SandProject) - Method in class org.sandev.sandbuild.SandProject

Add a new project to those projects that require this one.

addUIDeployment(SandUIDeployment) - Method in class org.sandev.sandbuild.SandProject

Add a SandUIDeployment to our list of UIs for this project.

additionalparam - Variable in class org.sandev.sandbuild.SandJavadoc

Additional javadoc params can be passed via the additionalParam element.

allGens - Variable in class org.sandev.sandbuild.SandBuildDriver

a collection of all the SandGenDecls for the build

allNodes - Variable in class org.sandev.sandbuild.SandBuildDriver

all the node declarations for the build

allStructs - Variable in class org.sandev.sandbuild.SandBuildDriver

all the struct declarations for the build

allStructsAndNodes - Variable in class org.sandev.sandbuild.SandBuildDriver

all the struct and node declarations for the build

antProject - Variable in class org.sandev.sandbuild.SandProject

A reference to the Ant Project object for this SandProject

appendProject(String) - Method in class org.sandev.sandbuild.SandBuildDriver

Like requiredProject, except the specified project is appended to the end of the dependency graph.

array2Path(String[]) - Method in class org.sandev.sandbuild.SandJavadoc

Return an array of path elements as a single path string

B

BridgeAnt2SAND - class org.sandev.sandbuild.BridgeAnt2SAND.

A bridge from Ant Tasks into the SAND build.

BridgeAnt2SAND() - Constructor for class org.sandev.sandbuild.BridgeAnt2SAND

buildFinished(BuildEvent) - Method in class org.sandev.sandbuild.SandLogger

Fail the build if there were any warnings or errors.

buildGenerators(SandProject) - Method in class org.sandev.sandbuild.SandBuildDriver

Build the generators for this project and any downstream projects.

buildRoot - Variable in class org.sandev.sandbuild.SandBuildDriver

The project to start the build with.

buildTrigger - Variable in class org.sandev.sandbuild.SandBuildDriver

The project that started the build.

C

callTarget(String) - Method in class org.sandev.sandbuild.SandProject

Call the specified target in this project.

cd - Variable in class org.sandev.sandbuild.SandDecl

The ClassDoc for this declaration.

changed - Variable in class org.sandev.sandbuild.SandGenDecl

Setting this field to true will force the generator to be rebuilt when the build is run.

changedGeneratorFound(String) - Method in class org.sandev.sandbuild.SandProject

Search through all the projects which declare this generator and return true if any of them have changed.

changedGeneratorFoundInProject(SandProject, String) - Method in class org.sandev.sandbuild.SandProject

checkDefaultDebugFlag() - Method in class org.sandev.sandbuild.SandProject

Check that the debug flag is set, and default it if nothing was specified.

checkDefaultJarPrefix() - Method in class org.sandev.sandbuild.SandProject

Check that the DeploymentPrefix for jarfiles is set.

checkLocalDTD(SandProject) - Method in class org.sandev.sandbuild.SARDeploymentPackager

If the XHTML DTDs are defined locally, then copy them into the runtime area for offline use.

children - Variable in class org.sandev.sandbuild.SandDeclTreeWrapper

Our SandDeclTreeWrapper children

classFile - Variable in class org.sandev.sandbuild.SandGenDecl

The class file is set when the build checks the generator for updates.

classname - Variable in class org.sandev.sandbuild.SandGenDecl

The fully qualified class name of the generator to run.

classpath - Variable in class org.sandev.sandbuild.SandJavadoc

Classpath

cleanCompileGenerators() - Method in class org.sandev.sandbuild.SandProject

Undo the work done by compileGenerators.

cleanDocGenerators() - Method in class org.sandev.sandbuild.SandProject

Undo the work done by docGenerators

cleanDocSource() - Method in class org.sandev.sandbuild.SandProject

Undo work done by docSource

cleanGenerators(SandProject) - Method in class org.sandev.sandbuild.SandBuildDriver

Clean up the generators for this project and any downstream projects.

cleanJarGenerators() - Method in class org.sandev.sandbuild.SandProject

Undo the work done by jarGenerators

cleanup(SandDecl[], File, boolean, String) - Method in interface org.sandev.sandbuild.SandGenerator

Delete generated files.

compareTo(Object) - Method in class org.sandev.sandbuild.SandDecl

The natural ordering of SandDecls is the natural ordering of their source files.

compareTo(Object) - Method in class org.sandev.sandbuild.SandDeclTreeWrapper

The natural ordering of SandDeclTreeWrappers is the ordering of the unqualified declaration names.

compileGenerators() - Method in class org.sandev.sandbuild.SandProject

Compile the generators by calling the build.compile.generators target.

converterClass - Variable in class org.sandev.sandbuild.SandPersistDef

The fully qualified name of the Converter that will be used to convert forward outdated storage structures.

copyfile(String, String) - Method in class org.sandev.sandbuild.SandProject

Copy the specified file to the specified directory.

countFile(String) - Method in class org.sandev.sandbuild.SandBuildDriver

countLine(String) - Method in interface org.sandev.sandbuild.LineCounter

Given a line for output, increment the count.

countLine(String) - Method in class org.sandev.sandbuild.SandBuildDriver

createClasspath() - Method in class org.sandev.sandbuild.SandJavadoc

createDoclet() - Method in class org.sandev.sandbuild.SandJavadoc

csvsourcefiles - Variable in class org.sandev.sandbuild.SandJavadoc

Takes a list of source file names, separated by commas, to use as the doclet source.

D

dataSource - Variable in class org.sandev.sandbuild.SandPersistDef

The persistence technology lookup handle.

decl - Variable in class org.sandev.sandbuild.SandDeclTreeWrapper

The SandDecl we are wrapping

declType - Variable in class org.sandev.sandbuild.SandDecl

What kind of SAND declaration this is.

deletefile(String) - Method in class org.sandev.sandbuild.SandProject

Delete the specified file.

deploymentDir - Variable in class org.sandev.sandbuild.SARDeploymentPackager

The directory where the application files will be copied to on build completion.

deploymentDir - Variable in class org.sandev.sandbuild.SandPackager

The directory where the application files will be copied to on build completion.

deploymentDir - Variable in class org.sandev.sandbuild.WARDeploymentPackager

The directory where the application files will be copied to on build completion.

description - Variable in class org.sandev.sandbuild.SandEnvFile

A description of the file.

destdir - Variable in class org.sandev.sandbuild.SandJavadoc

Destination dir

diagnoseMethodAccess(Class, String, Class[]) - Method in class org.sandev.sandbuild.SandJavadoc

Try and figure out what access we have to the defined method.

dir - Variable in class org.sandev.sandbuild.SandManifest

The directory you are verifying exists or doesn't exist.

dirtyFiles - Variable in class org.sandev.sandbuild.SandBuildDriver

a collection of dirty file names

doDeployment(SandProject, SandProject, int) - Method in class org.sandev.sandbuild.SARDeploymentPackager

Deploy the files into the container.

doDeployment(SandProject, SandProject, int) - Method in interface org.sandev.sandbuild.SandDeploymentPackager

Deploy the build files.

doDeployment(SandProject, SandProject, int) - Method in class org.sandev.sandbuild.WARDeploymentPackager

Deploy the files into the container.

doDownstreamFiles(SandProject) - Method in class org.sandev.sandbuild.SandBuildDriver

Deal with moving jar, war, and sandenvfile declarations for downstream projects.

doDownstreamFiles(SandProject, String, boolean) - Method in class org.sandev.sandbuild.SandBuildDriver

recursive workhorse.

doGen(SandProject, String, String) - Method in class org.sandev.sandbuild.SandBuildDriver

Given all the initialized data structures, run the generators for this project and all subprojects.

doGenerators() - Method in class org.sandev.sandbuild.SandBuildDriver

Build and run all the declared generators

doProjectTree(SandProject, Collection) - Method in class org.sandev.sandbuild.SandBuildDriver

Walk through the projects in dependency order and build each one.

docGenerators(Collection) - Method in class org.sandev.sandbuild.SandProject

Document the generators.

docSource(Collection) - Method in class org.sandev.sandbuild.SandProject

Document the main source.

doclet - Variable in class org.sandev.sandbuild.SandJavadoc

Doclet code

dumpCallSummary(String, String) - Method in class org.sandev.sandbuild.SandJavadoc

Dump out a summary of the environment and such for the call

dumpClassLoaderInfo(String, ClassLoader, boolean) - Method in class org.sandev.sandbuild.SandJavadoc

Dump out some descriptive info about the specified ClassLoader.

dumpDependencyGraph(SandProject, String) - Method in class org.sandev.sandbuild.SandBuildDriver

Recursively dump out the given root and it's downstream projects.

dumpSearchPath(URLClassLoader) - Method in class org.sandev.sandbuild.SandJavadoc

Utility method to dump the current search path elements.

E

entry - Variable in class org.sandev.sandbuild.BridgeAnt2SAND

This is the primary target name, which gets converted into appropriate flags for the SAND build.

envFiles - Variable in class org.sandev.sandbuild.SandProject

A SandProject may require access to zero or more files at runtime.

errorList - Variable in class org.sandev.sandbuild.SandLogger

List of warning/error messages we've seen so far.

execute() - Method in class org.sandev.sandbuild.BridgeAnt2SAND

execute() - Method in class org.sandev.sandbuild.PassGen

Set the specified property to the random password value.

execute() - Method in class org.sandev.sandbuild.RequiredProject

See class comments.

execute() - Method in class org.sandev.sandbuild.SandEnvFile

See class comments

execute() - Method in class org.sandev.sandbuild.SandGenDecl

See class comments.

execute() - Method in class org.sandev.sandbuild.SandJavadoc

Do our thing.

execute() - Method in class org.sandev.sandbuild.SandManifest

Write the MANIFEST.MF

execute() - Method in class org.sandev.sandbuild.SandPackager

Add ourselves to our project so the build has access to this information.

execute() - Method in class org.sandev.sandbuild.SandPersistDef

Add ourselves to our project so the generators have access to this information.

execute() - Method in class org.sandev.sandbuild.SandUIDeployment

Add ourselves to our project so the generators have access to this information.

extra - Variable in class org.sandev.sandbuild.SandGenDecl

This field can be set to hold any additional information that should be passed to the generator at runtime.

F

failonerror - Variable in class org.sandev.sandbuild.SandJavadoc

True if the task should fail when an error occurs.

fileCount - Variable in class org.sandev.sandbuild.SandBuildDriver

findNodeDecls(File, ArrayList) - Method in class org.sandev.sandbuild.SandProject

Walk the directory tree downwards recursively, loading any node declarations.

findProject(String) - Method in class org.sandev.sandbuild.SandBuildDriver

Return the SandProject instance matching this name, or null if no instance was found off the buildRoot.

findProject(String) - Method in class org.sandev.sandbuild.SandProject

Return the project instance matching the specified name, or null if have no matching instance.

findProjectParent(String) - Method in class org.sandev.sandbuild.SandBuildDriver

Return the SandProject instance containing the specified project in its requiredBy.

findProjectParent(SandProject, String) - Method in class org.sandev.sandbuild.SandBuildDriver

Recursive workhorse.

findStructDecls(File, ArrayList) - Method in class org.sandev.sandbuild.SandProject

If this is a structs directory, load any struct declarations.

fixEnvironment() - Method in class org.sandev.sandbuild.SandJavadoc

To avoid issues with duplicate class loadings, we trim down the additional environment that the doclet invocation references.

fixedMode - Variable in class org.sandev.sandbuild.SandUIDeployment

If fixedMode is true, then the UI will not attempt to change modes for secure access.

forgotPasswordPrimary - Variable in class org.sandev.sandbuild.SandUIDeployment

If forgotPassword is true, then the user has the option to enter just their username to be passed into the app for processing.

forgotPasswordSecondary - Variable in class org.sandev.sandbuild.SandUIDeployment

If forgotPassword is true, then the user will be prompted for their username.

G

genDecls - Variable in class org.sandev.sandbuild.SandProject

The SandGenDecl instances for this project.

genJarExists() - Method in class org.sandev.sandbuild.SandProject

Return true if the generator jar file is found, false otherwise.

generate(SandDecl[], File, boolean, Collection, String) - Method in interface org.sandev.sandbuild.SandGenerator

Generate the code.

getAllGens() - Method in class org.sandev.sandbuild.SandBuildDriver

accessor for allGens

getAllNodes() - Method in class org.sandev.sandbuild.SandBuildDriver

accessor for allNodes

getAllStructs() - Method in class org.sandev.sandbuild.SandBuildDriver

accessor for allStructs

getAllStructsAndNodes() - Method in class org.sandev.sandbuild.SandBuildDriver

accessor for allStructsAndNodes

getAntProject() - Method in class org.sandev.sandbuild.SandProject

accessor for antProject

getBuildRoot() - Method in class org.sandev.sandbuild.SandBuildDriver

accessor for buildRoot

getBuildTrigger() - Method in class org.sandev.sandbuild.SandBuildDriver

accessor for buildTrigger

getChildren() - Method in class org.sandev.sandbuild.SandDeclTreeWrapper

accessor for children

getClassDoc() - Method in class org.sandev.sandbuild.SandDecl

accessor for ClassDoc

getClassFile() - Method in class org.sandev.sandbuild.SandGenDecl

getClassname() - Method in class org.sandev.sandbuild.SandGenDecl

getConverterClass() - Method in class org.sandev.sandbuild.SandPersistDef

accessor for converterClass

getDataSource() - Method in class org.sandev.sandbuild.SandPersistDef

accessor for dataSource

getDecl() - Method in class org.sandev.sandbuild.SandDeclTreeWrapper

accessor for decl

getDeclFiles(Collection, Collection, String) - Method in class org.sandev.sandbuild.SandBuildDriver

The GenDriverDoclet needs a CSV list of all the struct and node declaration files as input.

getDeclType() - Method in class org.sandev.sandbuild.SandDecl

accessor for declType

getDeploymentDir() - Method in class org.sandev.sandbuild.SARDeploymentPackager

accessor for deploymentDir

getDeploymentDir() - Method in interface org.sandev.sandbuild.SandDeploymentPackager

Return the directory where the application files will be copied to on build completion.

getDeploymentDir() - Method in class org.sandev.sandbuild.SandPackager

accessor for deploymentDir

getDeploymentDir() - Method in class org.sandev.sandbuild.WARDeploymentPackager

accessor for deploymentDir

getDirtyFiles() - Method in class org.sandev.sandbuild.SandBuildDriver

accessor for dirtyFiles

getEntry() - Method in class org.sandev.sandbuild.BridgeAnt2SAND

getEnvDir(SandProject) - Method in class org.sandev.sandbuild.WARDeploymentPackager

Return the name of the env dir for the specified project.

getEnvFiles() - Method in class org.sandev.sandbuild.SandProject

Return the files this project requires at runtime.

getErrors() - Method in class org.sandev.sandbuild.SandLogger

Return a list of the errors + warnings in the build, if any.

getExtra() - Method in class org.sandev.sandbuild.SandGenDecl

getFileCount() - Method in class org.sandev.sandbuild.SandBuildDriver

getFixedMode() - Method in class org.sandev.sandbuild.SandUIDeployment

getForgotPasswordPrimary() - Method in class org.sandev.sandbuild.SandUIDeployment

getForgotPasswordSecondary() - Method in class org.sandev.sandbuild.SandUIDeployment

getGenDecls() - Method in class org.sandev.sandbuild.SandProject

initializing accessor for genDecls

getGenPath(SandProject) - Method in class org.sandev.sandbuild.SandBuildDriver

Build a path specification out of the generator .jar files we have built.

getGeneratorSrcDirName() - Method in class org.sandev.sandbuild.SandProject

Return the name of the generator src directory.

getImplClass() - Method in class org.sandev.sandbuild.SandUIDeployment

getImportExportSourceName() - Method in class org.sandev.sandbuild.SandPersistDef

accessor for importExportSourceName

getLeafmostProject(SandProject) - Method in class org.sandev.sandbuild.SandBuildDriver

Given a SandProject reference, return the leafmost project in the dependency graph.

getLength() - Method in class org.sandev.sandbuild.PassGen

getLineCount() - Method in interface org.sandev.sandbuild.LineCounter

Return the line count

getLineCount() - Method in class org.sandev.sandbuild.SandBuildDriver

getMappedStructPrefix() - Method in class org.sandev.sandbuild.SandPersistDef

accessor for mappedStructPrefix

getMode() - Method in class org.sandev.sandbuild.SandBuildDriver

accessor for mode

getName() - Method in class org.sandev.sandbuild.PassGen

getName() - Method in class org.sandev.sandbuild.SandPackager

accessor for name

getName() - Method in class org.sandev.sandbuild.SandProject

accessor for name

getName() - Method in class org.sandev.sandbuild.SandUIDeployment

getNodeDecls() - Method in class org.sandev.sandbuild.SandProject

Initializing accessor for nodeDecls

getOkEscapes() - Method in class org.sandev.sandbuild.PassGen

getOwnerNodeNameLookup() - Method in class org.sandev.sandbuild.SandUIDeployment

getPackager() - Method in class org.sandev.sandbuild.SandBuildDriver

accessor for packager

getParent() - Method in class org.sandev.sandbuild.SandDeclTreeWrapper

accessor for parent

getPersistenceDef() - Method in class org.sandev.sandbuild.SandProject

accessor for persistenceDef

getPersisterClass() - Method in class org.sandev.sandbuild.SandPersistDef

accessor for persisterClass

getProjName() - Method in class org.sandev.sandbuild.SandGenDecl

getQualifiedName() - Method in class org.sandev.sandbuild.SandDecl

accessor for qualifiedName

getRandomChar(Random) - Method in class org.sandev.sandbuild.PassGen

Return the next random character from the sequence generator.

getRememberMe() - Method in class org.sandev.sandbuild.SandUIDeployment

getRememberMePassphrase() - Method in class org.sandev.sandbuild.SandUIDeployment

getRequiredBy() - Method in class org.sandev.sandbuild.SandProject

Returns an array of the projects that require this one.

getRequiredMode() - Method in class org.sandev.sandbuild.SandPersistDef

accessor for requiredMode

getRunscope() - Method in class org.sandev.sandbuild.SandGenDecl

getSandBuildDriver() - Static method in class org.sandev.sandbuild.SandBuildDriver

getSandHome(SandProject) - Static method in class org.sandev.sandbuild.SandBuildDriver

Use the given project to look up the SAND_HOME property from Ant.

getSandName() - Method in class org.sandev.sandbuild.SandProject

Return the SAND project name.

getSandUIDeployments() - Method in class org.sandev.sandbuild.SandProject

Return the SandUI deployment definitions for this project.

getScope() - Method in class org.sandev.sandbuild.SandBuildDriver

accessor for scope

getSource() - Method in class org.sandev.sandbuild.SandGenDecl

getSourceFile() - Method in class org.sandev.sandbuild.SandDecl

accessor for sourceFile

getSourcescope() - Method in class org.sandev.sandbuild.SandGenDecl

getStatus() - Method in class org.sandev.sandbuild.SandDecl

accessor for status

getStringPersistConverterClass() - Method in class org.sandev.sandbuild.SandPersistDef

accessor for stringPersistConverterClass

getStructAndNodeDecls() - Method in class org.sandev.sandbuild.SandProject

Return all the struct and node declarations for this project.

getStructDecls() - Method in class org.sandev.sandbuild.SandProject

Initializing accessor for structDecls

getStructMapperClass() - Method in class org.sandev.sandbuild.SandPersistDef

accessor for structMapperClass

getToolsJarName() - Method in class org.sandev.sandbuild.SandJavadoc

Return the name of the tools jar file.

getToolsURL() - Method in class org.sandev.sandbuild.SandJavadoc

Return the tools URL.

getType() - Method in class org.sandev.sandbuild.SandBuildDriver

accessor for type

getType() - Method in class org.sandev.sandbuild.SandUIDeployment

getUniqueIDManagerClass() - Method in class org.sandev.sandbuild.SandPersistDef

accessor for uniqueIDManagerClass

getUnqualifiedName() - Method in class org.sandev.sandbuild.SandDecl

Get the unqualified name of this declaration.

H

hasChanged() - Method in class org.sandev.sandbuild.SandDecl

Returns true if this SAND declaration is NOT STATUS_UNCHANGED

hasChanged() - Method in class org.sandev.sandbuild.SandGenDecl

hasRequiredBy(String) - Method in class org.sandev.sandbuild.SandProject

Return true if the specified project name exists in our requiredBy array, false otherwise.

I

implClass - Variable in class org.sandev.sandbuild.SandUIDeployment

The fully qualified name of the class implementing the interface specified by the type.

importExportSourceName - Variable in class org.sandev.sandbuild.SandPersistDef

Default source/sink for data import/export.

init() - Method in class org.sandev.sandbuild.SandDecl

Set the qualifiedName from our source, and update our status.

initDecls(Collection) - Method in class org.sandev.sandbuild.SandProject

Given a collection of SandDecls, call to initialize the qualifiedName and the status for each one.

initSandDecls(SandProject, Collection, Collection, Collection) - Method in class org.sandev.sandbuild.SandBuildDriver

Walk the project tree from the given root downwards, setting up the generator, struct and node collections.

initializeSandBuildDriverSingleton() - Static method in class org.sandev.sandbuild.SandBuildDriver

J

jarGenerators() - Method in class org.sandev.sandbuild.SandProject

Jar the generators by calling the build.jar.generators target.

L

LineCounter - interface org.sandev.sandbuild.LineCounter.

A line counter keeps track of lines written.

last - Variable in class org.sandev.sandbuild.RequiredProject

Flag indicating that this required project is a postrequisite rather than a prerequisite.

length - Variable in class org.sandev.sandbuild.PassGen

The length of the generated password.

lineCount - Variable in class org.sandev.sandbuild.SandBuildDriver

loadAntProject(String, SandProject) - Method in class org.sandev.sandbuild.SandProject

Given a sand directory specification (eg "apps/basics"), load the corresponding ant project into our local references.

loadNodeDecls() - Method in class org.sandev.sandbuild.SandProject

Load the node declarations for this project

loadPrevDecls(int) - Method in class org.sandev.sandbuild.SandProject

The last time we built, we wrote out the declarations we were dealing with so we could keep track of what happened for an incremental build.

loadProject(SandProject) - Method in class org.sandev.sandbuild.SandBuildDriver

Given a project, process the SAND build declarations to setup dependencies, generators, and env files.

loadStructDecls() - Method in class org.sandev.sandbuild.SandProject

Load the struct declarations for this project

log(String) - Method in class org.sandev.sandbuild.SARDeploymentPackager

Dump the specified text to the build log.

log(String) - Method in class org.sandev.sandbuild.SandBuildDriver

This is how we dump processing messages and such.

log(String) - Method in class org.sandev.sandbuild.WARDeploymentPackager

Dump the specified text to the build log.

M

MODE_BUILD - Static variable in class org.sandev.sandbuild.SandBuildDriver

we are building

MODE_CLEAN - Static variable in class org.sandev.sandbuild.SandBuildDriver

we are cleaning

mappedStructPrefix - Variable in class org.sandev.sandbuild.SandPersistDef

An additional prefix to be applied to all mapped struct names returned by the StructMapper.

messageLogged(BuildEvent) - Method in class org.sandev.sandbuild.SandLogger

Trap + record any warnings or errors.

mode - Variable in class org.sandev.sandbuild.SandBuildDriver

One of the MODE_* values.

N

NODE_DECLS_FILE - Static variable in class org.sandev.sandbuild.SandProject

Name of the NodeDecls.txt file

name - Variable in class org.sandev.sandbuild.PassGen

The name of the property to set with a random password value.

name - Variable in class org.sandev.sandbuild.SandEnvFile

The name of the file which must be available at runtime.

name - Variable in class org.sandev.sandbuild.SandPackager

The name of the build class implementing the SandDeploymentPackager interface

name - Variable in class org.sandev.sandbuild.SandProject

A SandProject has a name which is used to identify it within the overall build.

name - Variable in class org.sandev.sandbuild.SandUIDeployment

The name identifies this SandUI deployment.

nodeDecls - Variable in class org.sandev.sandbuild.SandProject

The SandDecl objects for the nodes declared in this project

nodoc() - Method in class org.sandev.sandbuild.SandBuildDriver

If the nodoc flag is set, then return true.

O

okEscapes - Variable in class org.sandev.sandbuild.PassGen

Characters between ascii 33 and and ascii 126, other than letters or numbers, which can be included in the resulting password.

org.sandev.sandbuild - package org.sandev.sandbuild

Generator declarations and custom tasks for the SAND build.

ownerNodeNameLookup - Variable in class org.sandev.sandbuild.SandUIDeployment

The fully qualified name of the OwnerNodeNameLookup class.

P

PassGen - class org.sandev.sandbuild.PassGen.

Sets the defined property to be a random password of the given length.

PassGen() - Constructor for class org.sandev.sandbuild.PassGen

packager - Variable in class org.sandev.sandbuild.SandBuildDriver

The SandDeploymentPackager that will be used to build the finished SAND application.

parent - Variable in class org.sandev.sandbuild.SandDeclTreeWrapper

Our parent SandDeclTreeWrapper

persistenceDef - Variable in class org.sandev.sandbuild.SandProject

A SandProject has a single persistence definition.

persisterClass - Variable in class org.sandev.sandbuild.SandPersistDef

The fully qualified name of the Persister that will be used for persistence and query processing.

pln(String) - Method in class org.sandev.sandbuild.SandJavadoc

Just in case we want to hook this output for debugging, or make everything quiet.

prepareForExec(String, String) - Method in class org.sandev.sandbuild.SandJavadoc

Do what is necessary to make the exec call work.

projName - Variable in class org.sandev.sandbuild.SandGenDecl

The project this generator is associated with.

Q

qualifiedName - Variable in class org.sandev.sandbuild.SandDecl

The fully qualified name of this declaration.

qualifiedNameFromSource(String) - Method in class org.sandev.sandbuild.SandDecl

Given a file specification, return the corresponding qualified class name.

R

RequiredProject - class org.sandev.sandbuild.RequiredProject.

A required project is a project which the current project needs in order to function.

RequiredProject() - Constructor for class org.sandev.sandbuild.RequiredProject

rememberMe - Variable in class org.sandev.sandbuild.SandUIDeployment

If rememberMe is true, the user has the option to record their login information on their computer so they don't need to enter the login information again.

rememberMePassphrase - Variable in class org.sandev.sandbuild.SandUIDeployment

If rememberMe is true, then a passphrase for encrypting the saved login information is required.

removeChild(SandDeclTreeWrapper) - Method in class org.sandev.sandbuild.SandDeclTreeWrapper

Remove the given child.

removeChild(int) - Method in class org.sandev.sandbuild.SandDeclTreeWrapper

Remove the child at the given index, returning it.

removeRequiredBy(String) - Method in class org.sandev.sandbuild.SandProject

Removes a project from our requiredBy.

requiredBy - Variable in class org.sandev.sandbuild.SandProject

A SandProject may be required by zero or more other SandProjects.

requiredMode - Variable in class org.sandev.sandbuild.SandPersistDef

The value of the sandevBuildMode property that must be present for this sandpersist declaration to be active.

requiredProject(String, String) - Method in class org.sandev.sandbuild.SandBuildDriver

Record the given project dependency.

runBuild() - Method in class org.sandev.sandbuild.SandBuildDriver

Do the build processing and return null if everything went fine.

runGenerators(SandProject) - Method in class org.sandev.sandbuild.SandBuildDriver

Run the generators for this project and any downstream projects, returning the collection of any files that were changed.

runscope - Variable in class org.sandev.sandbuild.SandGenDecl

What the scope of the generator runtime should be.

S

SARDeploymentPackager - class org.sandev.sandbuild.SARDeploymentPackager.

Deploy the finished build files into JBOSS_HOME/bin and SAND_DEPLOY and launch the application from the SAND SAR.

SARDeploymentPackager() - Constructor for class org.sandev.sandbuild.SARDeploymentPackager

SCOPE_GLOBAL - Static variable in class org.sandev.sandbuild.SandBuildDriver

build the entire dependency graph

SCOPE_LOCAL - Static variable in class org.sandev.sandbuild.SandBuildDriver

just build the current project

STATUS_CHANGED - Static variable in class org.sandev.sandbuild.SandDecl

this declaration has changed since the last build

STATUS_DELETED - Static variable in class org.sandev.sandbuild.SandDecl

this declaration has been deleted since the last build.

STATUS_NEW - Static variable in class org.sandev.sandbuild.SandDecl

this declaration has been created after the last build

STATUS_UNCHANGED - Static variable in class org.sandev.sandbuild.SandDecl

this declaration has NOT changed since the last build

STRUCT_DECLS_FILE - Static variable in class org.sandev.sandbuild.SandProject

Name of the StructDecls.txt file

SandBuildDriver - class org.sandev.sandbuild.SandBuildDriver.

The SAND build structure for runtime execution.

SandBuildDriver() - Constructor for class org.sandev.sandbuild.SandBuildDriver

Use getSandBuildDriver accessor to retrieve the SandBuildDriver instance.

SandBuildException - exception org.sandev.sandbuild.SandBuildException.

Base class for all SAND build exceptions.

SandBuildException() - Constructor for class org.sandev.sandbuild.SandBuildException

SandBuildException(String) - Constructor for class org.sandev.sandbuild.SandBuildException

SandBuildException(String, Throwable) - Constructor for class org.sandev.sandbuild.SandBuildException

SandBuildException(Throwable) - Constructor for class org.sandev.sandbuild.SandBuildException

SandDecl - class org.sandev.sandbuild.SandDecl.

The primary source information passed to a SandGenerator.

SandDecl() - Constructor for class org.sandev.sandbuild.SandDecl

The default ctor does nothing.

SandDeclTreeWrapper - class org.sandev.sandbuild.SandDeclTreeWrapper.

A wrapper for SandDecl that allows organization into a tree structure.

SandDeclTreeWrapper() - Constructor for class org.sandev.sandbuild.SandDeclTreeWrapper

Default ctor does nothing.

SandDeclTreeWrapper(SandDecl) - Constructor for class org.sandev.sandbuild.SandDeclTreeWrapper

Set our decl to the instance specified.

SandDeclTreeWrapper(SandDeclTreeWrapper, SandDecl) - Constructor for class org.sandev.sandbuild.SandDeclTreeWrapper

Set our parent and decl to the instances specified.

SandDeploymentPackager - interface org.sandev.sandbuild.SandDeploymentPackager.

Support for creating the final SAND application deployment files.

SandEnvFile - class org.sandev.sandbuild.SandEnvFile.

A SandEnvFile is a file that must be available at runtime.

SandEnvFile() - Constructor for class org.sandev.sandbuild.SandEnvFile

SandGenDecl - class org.sandev.sandbuild.SandGenDecl.

Declare a generator to be run as part of the build.

SandGenDecl() - Constructor for class org.sandev.sandbuild.SandGenDecl

SandGenerator - interface org.sandev.sandbuild.SandGenerator.

A class implementing the SandGenerator interface can be invoked as part of the sandbox build.

SandGeneratorException - exception org.sandev.sandbuild.SandGeneratorException.

Base class for all SandGenerator exception conditions.

SandGeneratorException() - Constructor for class org.sandev.sandbuild.SandGeneratorException

SandGeneratorException(String) - Constructor for class org.sandev.sandbuild.SandGeneratorException

SandGeneratorException(String, Throwable) - Constructor for class org.sandev.sandbuild.SandGeneratorException

SandGeneratorException(Throwable) - Constructor for class org.sandev.sandbuild.SandGeneratorException

SandJavadoc - class org.sandev.sandbuild.SandJavadoc.

Ant task to run Javadoc in the same VM as Ant.

SandJavadoc() - Constructor for class org.sandev.sandbuild.SandJavadoc

SandLogger - class org.sandev.sandbuild.SandLogger.

BuildLogger that fails the build if any warning or error messages are logged.

SandLogger() - Constructor for class org.sandev.sandbuild.SandLogger

SandManifest - class org.sandev.sandbuild.SandManifest.

Creates a simple manifest, including the .jar files needed.

SandManifest() - Constructor for class org.sandev.sandbuild.SandManifest

SandPackager - class org.sandev.sandbuild.SandPackager.

Supports the declaration of a SandDeploymentPackager class which will create the necessary deployment files for the SAND application.

SandPackager() - Constructor for class org.sandev.sandbuild.SandPackager

SandPersistDef - class org.sandev.sandbuild.SandPersistDef.

A sandpersist declaration provides information about application persistence.

SandPersistDef() - Constructor for class org.sandev.sandbuild.SandPersistDef

SandProject - class org.sandev.sandbuild.SandProject.

A representation of a SAND project used in dependency structures and other build processing.

SandProject(String) - Constructor for class org.sandev.sandbuild.SandProject

All projects must have a name, so no default ctor.

SandTask - class org.sandev.sandbuild.SandTask.

This is a common base class for all custom SAND build tasks.

SandTask() - Constructor for class org.sandev.sandbuild.SandTask

SandUIDeployment - class org.sandev.sandbuild.SandUIDeployment.

A SandUI declaration provides enough information for the build to create the necessary deployment linkage for a SandUI.

SandUIDeployment() - Constructor for class org.sandev.sandbuild.SandUIDeployment

sandDir - Variable in class org.sandev.sandbuild.RequiredProject

This is the directory specification of the required project based off of SAND_HOME.

sandUIDeployments - Variable in class org.sandev.sandbuild.SandProject

A SandProject may declare zero or more deployments of a SandUI definition.

scope - Variable in class org.sandev.sandbuild.SandBuildDriver

One of the SCOPE_* values.

setAddClassPath(boolean) - Method in class org.sandev.sandbuild.SandManifest

setAdditionalparam(String) - Method in class org.sandev.sandbuild.SandJavadoc

setAllNodes(SandDecl[]) - Method in class org.sandev.sandbuild.SandBuildDriver

mutator for allNodes

setAllNodes(ArrayList) - Method in class org.sandev.sandbuild.SandBuildDriver

convenience wrapper for setAllNodes

setAllStructs(SandDecl[]) - Method in class org.sandev.sandbuild.SandBuildDriver

mutator for allStructs

setAllStructs(ArrayList) - Method in class org.sandev.sandbuild.SandBuildDriver

convenience wrapper for setAllStructs

setAllStructsAndNodes(SandDecl[]) - Method in class org.sandev.sandbuild.SandBuildDriver

mutator for allStructsAndNodes

setAllStructsAndNodes(ArrayList) - Method in class org.sandev.sandbuild.SandBuildDriver

convenience wrapper for setAllStructsAndNodes

setAntProject(Project) - Method in class org.sandev.sandbuild.SandProject

mutator for antProject

setBuildRoot(SandProject) - Method in class org.sandev.sandbuild.SandBuildDriver

mutator for buildRoot.

setBuildTrigger(SandProject) - Method in class org.sandev.sandbuild.SandBuildDriver

mutator for buildTrigger

setBuildTriggerDir(String, SandProject) - Method in class org.sandev.sandbuild.SandBuildDriver

Recursively walk the given project tree, setting the buildTriggerDir property of all projects to the given value.

setChanged(boolean) - Method in class org.sandev.sandbuild.SandGenDecl

setChangedGenSrcProperty(Collection) - Method in class org.sandev.sandbuild.SandProject

Set the changedGenSrc property for this project, so we can javadoc just these files.

setChildren(SandDeclTreeWrapper[]) - Method in class org.sandev.sandbuild.SandDeclTreeWrapper

mutator for children

setClassDoc(ClassDoc) - Method in class org.sandev.sandbuild.SandDecl

mutator for ClassDoc

setClassFile(String) - Method in class org.sandev.sandbuild.SandGenDecl

setClassname(String) - Method in class org.sandev.sandbuild.SandGenDecl

setClasspath(Path) - Method in class org.sandev.sandbuild.SandJavadoc

setClasspathRef(Reference) - Method in class org.sandev.sandbuild.SandJavadoc

setConverterClass(String) - Method in class org.sandev.sandbuild.SandPersistDef

mutator for converterClass

setCsvsourcefiles(String) - Method in class org.sandev.sandbuild.SandJavadoc

setDataSource(String) - Method in class org.sandev.sandbuild.SandPersistDef

mutator for dataSource

setDecl(SandDecl) - Method in class org.sandev.sandbuild.SandDeclTreeWrapper

mutator for decl

setDeclType(int) - Method in class org.sandev.sandbuild.SandDecl

mutator for declType

setDeploymentDir(File) - Method in class org.sandev.sandbuild.SARDeploymentPackager

mutator for deploymentDir

setDeploymentDir(File) - Method in interface org.sandev.sandbuild.SandDeploymentPackager

Set the directory where the application files will be copied to on build completion.

setDeploymentDir(File) - Method in class org.sandev.sandbuild.SandPackager

mutator for deploymentDir

setDeploymentDir(File) - Method in class org.sandev.sandbuild.WARDeploymentPackager

mutator for deploymentDir

setDescription(String) - Method in class org.sandev.sandbuild.SandEnvFile

setDestdir(File) - Method in class org.sandev.sandbuild.SandJavadoc

setDir(File) - Method in class org.sandev.sandbuild.SandManifest

setDoclet(String) - Method in class org.sandev.sandbuild.SandJavadoc

setDocletPath(Path) - Method in class org.sandev.sandbuild.SandJavadoc

setDocletPathRef(Reference) - Method in class org.sandev.sandbuild.SandJavadoc

setEntry(String) - Method in class org.sandev.sandbuild.BridgeAnt2SAND

setEnvFiles(File[]) - Method in class org.sandev.sandbuild.SandProject

mutator for envFiles

setExtra(String) - Method in class org.sandev.sandbuild.SandGenDecl

setFailonerror(boolean) - Method in class org.sandev.sandbuild.SandJavadoc

setFileCount(int) - Method in class org.sandev.sandbuild.SandBuildDriver

setFixedMode(boolean) - Method in class org.sandev.sandbuild.SandUIDeployment

setForgotPasswordPrimary(String) - Method in class org.sandev.sandbuild.SandUIDeployment

setForgotPasswordSecondary(String) - Method in class org.sandev.sandbuild.SandUIDeployment

setGenDecls(Collection) - Method in class org.sandev.sandbuild.SandProject

mutator for genDecls

setGenJarDir(File, SandProject) - Method in class org.sandev.sandbuild.SandBuildDriver

Recursively walk the given project tree, setting the genJarDir property of all projects to point to the given root.

setImplClass(String) - Method in class org.sandev.sandbuild.SandUIDeployment

setImportExportSourceName(String) - Method in class org.sandev.sandbuild.SandPersistDef

mutator for importExportSourceName

setLast(boolean) - Method in class org.sandev.sandbuild.RequiredProject

setLength(int) - Method in class org.sandev.sandbuild.PassGen

setLineCount(int) - Method in interface org.sandev.sandbuild.LineCounter

Set the line count

setLineCount(int) - Method in class org.sandev.sandbuild.SandBuildDriver

setMappedStructPrefix(String) - Method in class org.sandev.sandbuild.SandPersistDef

mutator for mappedStructPrefix

setMode(int) - Method in class org.sandev.sandbuild.SandBuildDriver

mutator for mode

setName(String) - Method in class org.sandev.sandbuild.PassGen

setName(String) - Method in class org.sandev.sandbuild.SandEnvFile

setName(String) - Method in class org.sandev.sandbuild.SandPackager

mutator for name

setName(String) - Method in class org.sandev.sandbuild.SandProject

mutator for name

setName(String) - Method in class org.sandev.sandbuild.SandUIDeployment

setNodeDecls(SandDecl[]) - Method in class org.sandev.sandbuild.SandProject

mutator for nodeDecls

setOkEscapes(String) - Method in class org.sandev.sandbuild.PassGen

setOwnerNodeNameLookup(String) - Method in class org.sandev.sandbuild.SandUIDeployment

setPackager(SandDeploymentPackager) - Method in class org.sandev.sandbuild.SandBuildDriver

mutator for packager

setParent(SandDeclTreeWrapper) - Method in class org.sandev.sandbuild.SandDeclTreeWrapper

mutator for parent

setPersistenceDef(SandPersistDef) - Method in class org.sandev.sandbuild.SandProject

mutator for persistenceDef

setPersisterClass(String) - Method in class org.sandev.sandbuild.SandPersistDef

mutator for persisterClass

setProjName(String) - Method in class org.sandev.sandbuild.SandGenDecl

setQualifiedName(String) - Method in class org.sandev.sandbuild.SandDecl

mutator for qualifiedName

setRememberMe(boolean) - Method in class org.sandev.sandbuild.SandUIDeployment

setRememberMePassphrase(String) - Method in class org.sandev.sandbuild.SandUIDeployment

setRequiredBy(SandProject[]) - Method in class org.sandev.sandbuild.SandProject

mutator for requiredBy

setRequiredMode(String) - Method in class org.sandev.sandbuild.SandPersistDef

mutator for requiredMode

setRunscope(String) - Method in class org.sandev.sandbuild.SandGenDecl

setSandDir(String) - Method in class org.sandev.sandbuild.RequiredProject

setSandUIDeployments(SandUIDeployment[]) - Method in class org.sandev.sandbuild.SandProject

Mutator for sandUIDeployments.

setScope(int) - Method in class org.sandev.sandbuild.SandBuildDriver

mutator for scope

setSource(String) - Method in class org.sandev.sandbuild.SandGenDecl

setSourceFile(File) - Method in class org.sandev.sandbuild.SandDecl

mutator for sourceFile

setSourcepath(Path) - Method in class org.sandev.sandbuild.SandJavadoc

setSourcescope(String) - Method in class org.sandev.sandbuild.SandGenDecl

setStatus(int) - Method in class org.sandev.sandbuild.SandDecl

mutator for status

setStringPersistConverterClass(String) - Method in class org.sandev.sandbuild.SandPersistDef

mutator for stringPersistConverterClass

setStructDecls(SandDecl[]) - Method in class org.sandev.sandbuild.SandProject

mutator for structDecls

setStructMapperClass(String) - Method in class org.sandev.sandbuild.SandPersistDef

mutator for structMapperClass

setSubpackages(String) - Method in class org.sandev.sandbuild.SandJavadoc

setType(int) - Method in class org.sandev.sandbuild.SandBuildDriver

mutator for type

setType(String) - Method in class org.sandev.sandbuild.SandUIDeployment

setUniqueIDManagerClass(String) - Method in class org.sandev.sandbuild.SandPersistDef

mutator for uniqueIDManagerClass

setupGlobal() - Method in class org.sandev.sandbuild.SandBuildDriver

Setup for a global scope build.

singleton - Static variable in class org.sandev.sandbuild.SandBuildDriver

The singleton reference to the SandBuildDriver

source - Variable in class org.sandev.sandbuild.SandGenDecl

What source this generator uses.

sourceFile - Variable in class org.sandev.sandbuild.SandDecl

The full source file for this declaration.

sourcepath - Variable in class org.sandev.sandbuild.SandJavadoc

Source path

sourcescope - Variable in class org.sandev.sandbuild.SandGenDecl

What the scope of the required input should be.

status - Variable in class org.sandev.sandbuild.SandDecl

The status of this declaration.

statusToString(int) - Static method in class org.sandev.sandbuild.SandDecl

Return the current status as a string.

stringPersistConverterClass - Variable in class org.sandev.sandbuild.SandPersistDef

The fully qualified name of the class which will be used to convert non-reference array fields and unsupported persistency objects into String values for storage.

structDecls - Variable in class org.sandev.sandbuild.SandProject

The SandDecl objects for the structs declared in this project.

structMapperClass - Variable in class org.sandev.sandbuild.SandPersistDef

The fully qualified name of the StructMapper to use.

subpackages - Variable in class org.sandev.sandbuild.SandJavadoc

Package names to run Javadoc on.

T

TYPE_ALL - Static variable in class org.sandev.sandbuild.SandBuildDriver

build both static and dynamic targets

TYPE_DYNAMIC - Static variable in class org.sandev.sandbuild.SandBuildDriver

build generated targets (generators, envfiles, javadoc)

TYPE_NODE - Static variable in class org.sandev.sandbuild.SandDecl

This is a node declaration

TYPE_STATIC - Static variable in class org.sandev.sandbuild.SandBuildDriver

build only static code targets (compile, .jar etc)

TYPE_STRUCT - Static variable in class org.sandev.sandbuild.SandDecl

This is a struct declartion

targetExists(String) - Method in class org.sandev.sandbuild.SandProject

Return true if the specified target is defined in this project, false otherwise.

testInvoke(String, String) - Method in class org.sandev.sandbuild.SandJavadoc

A test invocation mirroring how our doclet actually gets called.

testLoadClass(String, String[]) - Method in class org.sandev.sandbuild.SandJavadoc

Attempt to load our doclet and make sure it has a start method that can be found.

type - Variable in class org.sandev.sandbuild.SandBuildDriver

One of the TYPE_* values.

type - Variable in class org.sandev.sandbuild.SandUIDeployment

The type of SandUI to be created.

U

uniqueIDManagerClass - Variable in class org.sandev.sandbuild.SandPersistDef

The fully qualified name of the UniqueIDManager that will be used for persistence processing.

updateGenChangeStatus() - Method in class org.sandev.sandbuild.SandProject

Walk our generator declarations and set the change flags if their corresponding .class files are older or nonexistent.

updateStatus() - Method in class org.sandev.sandbuild.SandDecl

Figure out our change status from our source file and a known target file.

V

verifyClassLoaderPath(URLClassLoader, String[]) - Method in class org.sandev.sandbuild.SandJavadoc

Verify all the pathElems are loaded so the calls work.