A B C D E F G I O P R S T W

A

addClass(JavaClass) - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Adds a new class.
addSourceRoots(File) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Adds a new file to the source path.

B

buildFileSets() - Method in class org.acmsl.contractchecker.ContractCheckerDoclet
Builds the file sets.
buildTemplate(JavaClass, ContractCheckerAspectTemplateFactory, String) - Method in class org.acmsl.contractchecker.ContractCheckerDoclet
Builds a ContractCheckerAspectTemplate from information provided by given class.
buildTemplate(String, String, ContractCheckerAspectTemplateFactory, String, ContractCheckerUtils) - Method in class org.acmsl.contractchecker.ContractCheckerDoclet
Builds a ContractCheckerAspectTemplate from information provided by given class.
buildTemplates(Collection, ContractCheckerAspectTemplateFactory, String) - Method in class org.acmsl.contractchecker.ContractCheckerDoclet
Builds the templates for given classes.

C

ContractCheckerAspectTemplate - class org.acmsl.contractchecker.ContractCheckerAspectTemplate.
Template to generate AspectJ's aspect to ensure pre- and post-conditions are satisfied.
ContractCheckerAspectTemplate(String, String) - Constructor for class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Builds a ContractCheckerAspectTemplate using given information.
ContractCheckerAspectTemplate(String, String, String, String, String, String, String, String, String, String, String, String, String, String) - Constructor for class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Builds a ContractCheckerAspect using given information.
ContractCheckerAspectTemplateFactory - interface org.acmsl.contractchecker.ContractCheckerAspectTemplateFactory.
Represents entities able to create ContractCheckerAspect templates.
ContractCheckerAspectTemplateGenerator - class org.acmsl.contractchecker.ContractCheckerAspectTemplateGenerator.
Is able to generate ContractCheckerAspect templates from Javadoc information.
ContractCheckerAspectTemplateGenerator() - Constructor for class org.acmsl.contractchecker.ContractCheckerAspectTemplateGenerator
Protected constructor to avoid accidental instantiation.
ContractCheckerDoclet - class org.acmsl.contractchecker.ContractCheckerDoclet.
QDox doclet for retrieving methods' pre- and post-conditions.
ContractCheckerDoclet() - Constructor for class org.acmsl.contractchecker.ContractCheckerDoclet
 
ContractCheckerException - exception org.acmsl.contractchecker.ContractCheckerException.
Models runtime information in abnormal, but managed, situations.
ContractCheckerException(String) - Constructor for class org.acmsl.contractchecker.ContractCheckerException
Creates a ContractCheckerException to model an abnormal situation described by given message.
ContractCheckerException(String, Throwable) - Constructor for class org.acmsl.contractchecker.ContractCheckerException
Creates a ContractCheckerException to model an abnormal situation described by given message, wrapping additional exception.
ContractCheckerTask - class org.acmsl.contractchecker.ContractCheckerTask.
Generates ContractChecker aspects and weaves them using Ant.
ContractCheckerTask() - Constructor for class org.acmsl.contractchecker.ContractCheckerTask
Creates a ContractCheckerTask.
ContractCheckerUtils - class org.acmsl.contractchecker.ContractCheckerUtils.
Provides some general-purpose methods needed by ContractChecker.
ContractCheckerUtils() - Constructor for class org.acmsl.contractchecker.ContractCheckerUtils
Protected constructor to avoid accidental instantiation.
ContractViolation - exception org.acmsl.contractchecker.ContractViolation.
Represents violation of declared contracts.
ContractViolation(String) - Constructor for class org.acmsl.contractchecker.ContractViolation
Creates a ContractCheckerException to model an abnormal situation described by given message.
ContractViolation(String, Throwable) - Constructor for class org.acmsl.contractchecker.ContractViolation
Creates a ContractCheckerException to model an abnormal situation described by given message, wrapping additional exception.
createClasspath() - Method in class org.acmsl.contractchecker.ContractCheckerTask
Creates the classpath.
createContractCheckerAspectTemplate(String, String) - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplateGenerator
Generates a ContractCheckerAspect template.
createContractCheckerAspectTemplate(String, String) - Method in interface org.acmsl.contractchecker.ContractCheckerAspectTemplateFactory
Creates a ContractCheckerAspect template.
createContractCheckerTemplate(String, String) - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplateGenerator
Generates a ContractChecker template.
createSourceRoots() - Method in class org.acmsl.contractchecker.ContractCheckerTask
Creates the source-roots path.

D

DEFAULT_ASPECT_DEFINITION - Static variable in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
The aspect definition.
DEFAULT_ASPECT_END - Static variable in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
The default aspect end.
DEFAULT_ASPECT_JAVADOC - Static variable in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
The default aspect Javadoc.
DEFAULT_ASPECT_START - Static variable in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
The aspect start.
DEFAULT_EXCEPTION_DECLARATION - Static variable in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
The default exception declarations.
DEFAULT_HEADER - Static variable in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
The default header.
DEFAULT_PACKAGE_DECLARATION - Static variable in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
The default package declaration.
DEFAULT_PRECONDITION_ADVICE - Static variable in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
The default precondition advice.
DEFAULT_PRECONDITION_CHECK - Static variable in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
The default precondition check.
DEFAULT_PRECONDITION_POINTCUT - Static variable in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
The default precondition pointcut Javadoc.
DEFAULT_PROJECT_IMPORTS - Static variable in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
The project imports.
DEFAULT_PROJECT_IMPORTS_JAVADOC - Static variable in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
The default project imports.
DEFAULT_VIOLATION_EXCEPTION - Static variable in class org.acmsl.contractchecker.ContractCheckerDoclet
The default exception.

E

EMPTY_ASPECTTEMPLATE_ARRAY - Static variable in class org.acmsl.contractchecker.ContractCheckerDoclet
Cached empty contractcheckeraspecttemplate array.
EMPTY_FILESET_ARRAY - Static variable in class org.acmsl.contractchecker.ContractCheckerUtils
Empty fileset array.
EMPTY_JAVACLASS_ARRAY - Static variable in class org.acmsl.contractchecker.ContractCheckerDoclet
Cached empty javaclass array.
EMPTY_JAVAMETHOD_ARRAY - Static variable in class org.acmsl.contractchecker.ContractCheckerDoclet
Cached empty javamethod array.
execute() - Method in class org.acmsl.contractchecker.ContractCheckerTask
Requests the ContractChecker compilation to be performed.
execute() - Method in class org.acmsl.contractchecker.ContractCheckerDoclet
Tag information retrieval starting point.
executeDoclet(File, String) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Requests the Javadoc task invokation to generate the aspects using ContractCheckerDoclet.

F

findGuardedClasses(Collection) - Method in class org.acmsl.contractchecker.ContractCheckerDoclet
Finds the guarded classes from given collection.
findGuardedMethods(JavaMethod[], boolean) - Static method in class org.acmsl.contractchecker.ContractCheckerDoclet
Finds the guarded method from given collection.

G

getAjcTask() - Method in class org.acmsl.contractchecker.ContractCheckerTask
Retrieves the AjcTask.
getAspectDefinition() - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Retrieves the aspect definition.
getAspectEnd() - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Retrieves the aspect end.
getAspectJavadoc() - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Retrieves the aspect javadoc.
getAspectoutput() - Method in class org.acmsl.contractchecker.ContractCheckerTask
Retrieves the output folder for the generated aspects.
getAspectStart() - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Retrieves the aspect start.
getClasses() - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Retrieves the classes.
getClasspath() - Method in class org.acmsl.contractchecker.ContractCheckerTask
Retrieves the classpath.
getExceptionDeclaration() - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Retrieves the exception declaration.
getHeader() - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Retrieves the header.
getInput() - Method in class org.acmsl.contractchecker.ContractCheckerDoclet
Retrieves the input path.
getInstance() - Static method in class org.acmsl.contractchecker.ContractCheckerUtils
Retrieves a ContractCheckerUtils instance.
getInstance() - Static method in class org.acmsl.contractchecker.ContractCheckerAspectTemplateGenerator
Retrieves a ContractCheckerTemplateGenerator instance.
getOutputfolder() - Method in class org.acmsl.contractchecker.ContractCheckerDoclet
Retrieves the output folder.
getPackageDeclaration() - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Retrieves the package declaration.
getPackageName() - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Retrieves the package name.
getPreconditionAdvice() - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Retrieves the precondition advice.
getPreconditionCheck() - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Retrieves the precondition check.
getPreconditionPointcut() - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Retrieves the precondition pointcut.
getProjectImports() - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Retrieves the project imports.
getProjectImportsJavadoc() - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Retrieves the project imports' Javadoc.
getReference() - Static method in class org.acmsl.contractchecker.ContractCheckerUtils
Retrieves the weak reference.
getReference() - Static method in class org.acmsl.contractchecker.ContractCheckerAspectTemplateGenerator
Retrieves the weak reference.
getSourceRoots() - Method in class org.acmsl.contractchecker.ContractCheckerTask
Retrieves the source roots.
getTempBasedAspectOutput() - Method in class org.acmsl.contractchecker.ContractCheckerTask
Defines the output folder for classes, using the operating system temporary folder.
getTemplatefactoryclass() - Method in class org.acmsl.contractchecker.ContractCheckerTask
Retrieves the template factory class.
getTemplatefactoryclass() - Method in class org.acmsl.contractchecker.ContractCheckerDoclet
Retrieves the template factory class.
getViolationexception() - Method in class org.acmsl.contractchecker.ContractCheckerTask
Retrieves the contract violation exception.
getViolationexception() - Method in class org.acmsl.contractchecker.ContractCheckerDoclet
Retrieves the contract violation exception.
getViolationException() - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Retrieves the default exception.

I

instantiateFactory(String) - Method in class org.acmsl.contractchecker.ContractCheckerDoclet
Creates the factory instance.

O

org.acmsl.contractchecker - package org.acmsl.contractchecker
 

P

packageToFilePath(String) - Method in class org.acmsl.contractchecker.ContractCheckerUtils
Translates given package name to a relative file path.
PRECONDITION_TAG - Static variable in class org.acmsl.contractchecker.ContractCheckerDoclet
The precondition tag.
processClass(JavaClass) - Method in class org.acmsl.contractchecker.ContractCheckerDoclet
Processes given class.
processClasses(JavaClass[]) - Method in class org.acmsl.contractchecker.ContractCheckerDoclet
Processes given classes.
processSource(JavaSource) - Method in class org.acmsl.contractchecker.ContractCheckerDoclet
Processes given source.
processSources(JavaSource[]) - Method in class org.acmsl.contractchecker.ContractCheckerDoclet
Processes given sources.

R

removeExceptions(String) - Method in class org.acmsl.contractchecker.ContractCheckerUtils
Removes the exception declaration from given method signature.
removeReturn(String) - Method in class org.acmsl.contractchecker.ContractCheckerUtils
Removes the return declaration from given method signature.
retrieveAspectFolder(File, String) - Method in class org.acmsl.contractchecker.ContractCheckerUtils
Retrieves the folder for the aspects associated to given package.
retrieveAspectPackage(String) - Method in class org.acmsl.contractchecker.ContractCheckerUtils
Retrieves the package name of the aspects associated to given package.

S

setAjcTask(AjcTask) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the AjcTask.
setAspectDefinition(String) - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Specifies the aspect definition.
setAspectEnd(String) - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Specifies the aspect end.
setAspectJavadoc(String) - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Specifies the Javadoc for the aspect.
setAspectoutput(File) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the output folder for the generated aspects.
setAspectStart(String) - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Specifies the aspect start.
setClasses(List) - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Specifies the classes.
setClasspath(Path) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the classpath.
setClasspathref(Reference) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the classpath reference.
setCompliance(String) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the language compliance level.
setCopyInjars(boolean) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies whether to copy all non-.class contents of injars to outjar after compile completes.
setDebug(boolean) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the debug flag.
setDebugLevel(String) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the debug level.
setDeprecation(boolean) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the deprecation flag.
setDestdir(File) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the destination folder.
setEmacssym(boolean) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the emacssym flag.
setEncoding(String) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the encoding.
setExceptionDeclaration(String) - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Specifies the exception declaration.
setFailonerror(boolean) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the fail-on-error flag.
setFork(boolean) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the fork setting.
setHeader(String) - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Specifies the header.
setHelp(boolean) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the help flag.
setIncremental(boolean) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the incremental behaviour.
setInput(Path) - Method in class org.acmsl.contractchecker.ContractCheckerDoclet
Specifies the input path.
setListFileArgs(boolean) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the list-file-args flag.
setLog(File) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the log file.
setMaxmem(String) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the maxMem flag.
setNoExit(boolean) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the no-exit flag.
setNoImportError(boolean) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the no-import-error flag.
setNowarn(boolean) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the nowarn flag.
setOutjar(File) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the outjar file.
setOutputfolder(File) - Method in class org.acmsl.contractchecker.ContractCheckerDoclet
Specifies the output folder.
setPackageDeclaration(String) - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Specifies the package declaration.
setPackageName(String) - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Specifies the package name.
setPreconditionAdvice(String) - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Specifies the precondition advice.
setPreconditionCheck(String) - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Specifies the precondition check.
setPreconditionPointcut(String) - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Specifies the precondition pointcut.
setPreserveAllLocals(boolean) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the preserve-all-locals flag.
setProceedOnError(boolean) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the proceed-on-error flag.
setProgress(boolean) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the progress.
setProjectImports(String) - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Specifies the project imports.
setProjectImportsJavadoc(String) - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Specifies the project imports' Javadoc.
setReference(ContractCheckerAspectTemplateGenerator) - Static method in class org.acmsl.contractchecker.ContractCheckerAspectTemplateGenerator
Specifies a new weak reference.
setReference(ContractCheckerUtils) - Static method in class org.acmsl.contractchecker.ContractCheckerUtils
Specifies a new weak reference.
setReferenceInfo(boolean) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the reference info.
setSource(String) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the source compliance level.
setSourceRootCopyFilter(String) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies whether to copy all files from all source root directories except those specified here.
setSourceRoots(Path) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the source roots.
setSourcerootsref(Reference) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the source roots reference.
setTagFile(File) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the tag file.
setTarget(String) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the target.
setTemplatefactoryclass(String) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the template factory class.
setTemplatefactoryclass(String) - Method in class org.acmsl.contractchecker.ContractCheckerDoclet
Specifies the template factory class.
setTime(boolean) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the time flag.
setVerbose(boolean) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the verbose flag.
setVersion(boolean) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the version flag.
setViolationexception(String) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the contract violation exception.
setViolationexception(String) - Method in class org.acmsl.contractchecker.ContractCheckerDoclet
Specifies the contract violation exception.
setViolationException(String) - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Specifies the default exception.
setWarn(String) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the warnings.
setX(String) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the X option.
setXlint(String) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the Xlint value.
setXlintfile(File) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the xlint file.
setXlintwarnings(boolean) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the Xlint warnings.
setXNoweave(boolean) - Method in class org.acmsl.contractchecker.ContractCheckerTask
Specifies the xnoweave flag.

T

toFileSet(String, Project) - Method in class org.acmsl.contractchecker.ContractCheckerUtils
BUilds a FileSet for given location.
toFileSets(Path) - Method in class org.acmsl.contractchecker.ContractCheckerUtils
Translates given path to a collection of filesets.
toString() - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplate
Retrieves the source code of the generated table repository.

W

write(ContractCheckerAspectTemplate, File) - Method in class org.acmsl.contractchecker.ContractCheckerAspectTemplateGenerator
Writes a ContractCheckerAspect template to disk.
writeFile(File, String) - Method in class org.acmsl.contractchecker.ContractCheckerUtils
Writes a file with given contents.
writeFile(String, String) - Method in class org.acmsl.contractchecker.ContractCheckerUtils
Writes a file referred by given path, with given contents.
writeTemplates(ContractCheckerAspectTemplate[], File) - Method in class org.acmsl.contractchecker.ContractCheckerDoclet
Writes given templates.

A B C D E F G I O P R S T W

Copyright © 2003-2004 ACM S.L.. All Rights Reserved.