All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.symantec.itools.vcafe.openapi.options.DirectoriesOptions

Object
   |
   +----com.symantec.itools.vcafe.openapi.options.DirectoriesOptions

public abstract class DirectoriesOptions

extends Object

Use ProjectOptionSet.getDirectoriesOptions() to get an instance of this object.

Version:

1.0

Author:

Symantec Internet Tools Division

Since:

VCafe 3.0

See Also:

getOptionSet, getDirectoriesOptions

com.symantec.itools.vcafe.openapi.options.DirectoriesOptions()

getClassPath()

Gets all of the user-entered class paths for this project, merged into a single String.

getClassPaths()

Gets all of the user-entered class paths for this project, as an array of Strings.

getFullClassPath()

Gets the complete class path specified for the project merged into a single String.

getFullClassPaths()

Gets the complete class path specified for the project as an array of Strings.

getJavadocDocumentationDirectory()

Gets the user-entered Javadoc destination directory.

getJavadocSystemDocumentationDirectory()

Gets the user-entered Javadoc system documentation source directory.

getOutputPath()

Gets the user-entered output destination directory.

getSourceFilesDirectories()

Gets all of the user-entered source search paths for this project, as an array of Strings.

getSourceFilesDirectory()

Gets all of the user-entered source search paths for this project, merged into a single String.

isAppendClassPath()

Determines whether the final (full) classpath will have the system classpath appended to it.

isAutoGenerateClassPath()

Determines whether the final (full) classpath will include classpaths for the project files that have been automatically determined.

public DirectoriesOptions()

public abstract java.lang.String getClassPath()

Gets all of the user-entered class paths for this project, merged into a single String.

This method returns a merged class path (like "path1;path2;path3"), while the getClassPaths method returns the same path, but in an array (like [0]="path1",[1]="path2",[2]="path3").

Unlike getFullClassPath and getFullClassPaths, this method doesn't return system class path values.

Returns:

the user-entered class paths as a single String.

See Also:

getClassPaths, getFullClassPath, getFullClassPaths

public abstract java.lang.String[] getClassPaths()

Gets all of the user-entered class paths for this project, as an array of Strings.

This method returns a class path array (like [0]="path1",[1]="path2",[2]="path3"), while the getClassPath method returns the same path, but in a merged String (like "path1;path2;path3").

Unlike getFullClassPath and getFullClassPaths, this method doesn't return system class path values.

Returns:

the user-entered class paths as an array of Strings.

See Also:

getClassPath, getFullClassPath, getFullClassPaths

public abstract java.lang.String getFullClassPath()

Gets the complete class path specified for the project merged into a single String.

This method returns a merged class path (like "path1;path2;path3"), while the getFullClassPaths method returns the same path, but in an array (like [0]="path1",[1]="path2",[2]="path3").

Unlike getClassPath and getClassPaths, this method returns system class path values in addition to the user-defined ones.

To determine the class path, Visual Cafe: a) Uses current classpath option (getClassPath). b) Appends the system classpath if "Append class path" (isAppendClassPath) is set or the current classPath option is empty c) If no output directory is specified (getOutputPath) and "Auto-generate class path" (isAutoGenerateClassPath) is set, appends appropriate directories based on file names and packages added to project, otherwise it appends the output directory.

Returns:

the complete class path for the project as a single String.

See Also:

getFullClassPaths, getClassPath, getClassPaths

public abstract java.lang.String[] getFullClassPaths()

Gets the complete class path specified for the project as an array of Strings.

This method returns a class path array (like [0]="path1",[1]="path2",[2]="path3"), while the getFullClassPath method returns the same path, but in a merged String (like "path1;path2;path3").

Unlike getClassPath and getClassPaths, this method returns system class path values in addition to the user-defined ones.

To determine the class path, Visual Cafe: a) Uses current classpath option (getClassPaths). b) Appends the system classpath if "Append class path" (isAppendClassPath) is set or the current classPath option is empty c) If no output directory is specified (getOutputPath) and "Auto-generate class path" (isAutoGenerateClassPath) is set, appends appropriate directories based on file names and packages added to project, otherwise it appends the output directory.

Returns:

the complete class path for the project as an array of Strings.

See Also:

getFullClassPath, getClassPath, getClassPaths

public abstract java.lang.String getJavadocDocumentationDirectory()

Gets the user-entered Javadoc destination directory.

Returns:

the user-entered value, or an empty String if no value specified.

public abstract java.lang.String getJavadocSystemDocumentationDirectory()

Gets the user-entered Javadoc system documentation source directory.

Returns:

the user-entered value, or an empty String if no value specified.

public abstract java.lang.String getOutputPath()

Gets the user-entered output destination directory.

Returns:

the user-entered value, or an empty String if no value specified.

public abstract java.lang.String[] getSourceFilesDirectories()

Gets all of the user-entered source search paths for this project, as an array of Strings.

This method returns a search path array (like [0]="path1",[1]="path2",[2]="path3"), while the getSourceFilesDirectory method returns the same path, but in a merged String (like "path1;path2;path3").

The source search path applies to Java source files and any text file that can be opened in the Source window.

Returns:

the user-entered source paths as an array of Strings.

See Also:

getSourceFilesDirectory

public abstract java.lang.String getSourceFilesDirectory()

Gets all of the user-entered source search paths for this project, merged into a single String.

This method returns a merged search path (like "path1;path2;path3"), while the getSourceFilesDirectories method returns the same path, but in an array (like [0]="path1",[1]="path2",[2]="path3").

The source search path applies to Java source files and any text file that can be opened in the Source window.

Returns:

the user-entered source paths as a single String.

See Also:

getSourceFilesDirectories

public abstract boolean isAppendClassPath()

Determines whether the final (full) classpath will have the system classpath appended to it.

See Also:

getFullClassPath, getFullClassPaths

public abstract boolean isAutoGenerateClassPath()

Determines whether the final (full) classpath will include classpaths for the project files that have been automatically determined.

For this to happen, an output directory must not be specified (getOutputPath).

See Also:

getFullClassPath, getFullClassPaths, getOutputPath

All Packages  Class Hierarchy  This Package  Previous  Next  Index