Jcontract API
A C D E G I L M P R S

A

AssertException - exception jcontract.AssertException.
Signals that an @assert contract has been violated
AssertException() - Constructor for class jcontract.AssertException
 
AssertException(String) - Constructor for class jcontract.AssertException
 

C

ConcurrencyException - exception jcontract.ConcurrencyException.
Signals that a @concurrency contract has been violated
ConcurrencyException() - Constructor for class jcontract.ConcurrencyException
 
ConcurrencyException(ContractException) - Constructor for class jcontract.ConcurrencyException
 
ConcurrencyException(String) - Constructor for class jcontract.ConcurrencyException
 
ConcurrencyException(String, ContractException) - Constructor for class jcontract.ConcurrencyException
 
ContractException - exception jcontract.ContractException.
Base class for all the contract exceptions
ContractException() - Constructor for class jcontract.ContractException
Constructs a ContractException with no message
ContractException(String) - Constructor for class jcontract.ContractException
Constructs a ContractException with the specific message
contractViolation(RuntimeException) - Method in class jcontract.ExceptionRuntimeHandler
Throws the ContractException that describes the contract being violated
contractViolation(RuntimeException) - Method in class jcontract.LogRuntimeHandler
Logs the contract violated
contractViolation(RuntimeException) - Method in class jcontract.RuntimeHandler
Called whenever a contract is violated

D

documentedExceptionThrown(Throwable) - Method in class jcontract.RuntimeHandler
Called whenever an exception documented with either an @exception or @throws tag is thrown

E

ExceptionRuntimeHandler - class jcontract.ExceptionRuntimeHandler.
Simplest implementation of RuntimeHandler.
On contract violation in throws the ContractException that describes the contract being violated.
ExceptionRuntimeHandler() - Constructor for class jcontract.ExceptionRuntimeHandler
 

G

getAlreadyExecutingThread() - Method in class jcontract.ConcurrencyException
 
getLogStream() - Method in class jcontract.LogRuntimeHandler
Returns the current log stream
getNumAssertExecuted() - Method in class jcontract.RuntimeStatistics
Returns the current number of @assert contracts executed
getNumConcurrencyExecuted() - Method in class jcontract.RuntimeStatistics
Returns the current number of @concurrency contracts executed
getNumInstClassesInitialized() - Method in class jcontract.RuntimeStatistics
Returns the current number of instrumented classes that have been loaded and initialized
getNumInvariantExecuted() - Method in class jcontract.RuntimeStatistics
Returns the current number of @invariant contracts executed
getNumPostExecuted() - Method in class jcontract.RuntimeStatistics
Returns the current number of @post contracts executed
getNumPreExecuted() - Method in class jcontract.RuntimeStatistics
Returns the current number of @pre contracts executed
getRuntimeStatistics() - Method in class jcontract.RuntimeHandler
Returns the accumulated RuntimeStatistics object for the RuntimeHandler

I

instrumentedClassLoaded(String) - Method in class jcontract.LogRuntimeHandler
Logs the name of the class
instrumentedClassLoaded(String) - Method in class jcontract.RuntimeHandler
Called whenever an instrumented class is loaded
InvariantException - exception jcontract.InvariantException.
Signals that an @invariant contract has been violated
InvariantException() - Constructor for class jcontract.InvariantException
 
InvariantException(String) - Constructor for class jcontract.InvariantException
 

L

log() - Method in class jcontract.LogRuntimeHandler
logs an empty line
log(String) - Method in class jcontract.LogRuntimeHandler
Logs a line to the log stream
logActive() - Method in class jcontract.LogRuntimeHandler
Returns true if the log stream is not null
LogRuntimeHandler - class jcontract.LogRuntimeHandler.
A non-intrusive RuntimeHandler.
Logs all the contract violations into a "./jcontract.log" file.
The logging information also includes the instrumented classes loaded, environment information and statistics collected while running the program.
LogRuntimeHandler() - Constructor for class jcontract.LogRuntimeHandler
 
LogStderrRuntimeHandler - class jcontract.LogStderrRuntimeHandler.
A LogRuntimeHandler that writes the logging information to the standard error output.
LogStderrRuntimeHandler() - Constructor for class jcontract.LogStderrRuntimeHandler
 
LogStdoutRuntimeHandler - class jcontract.LogStdoutRuntimeHandler.
A LogRuntimeHandler that writes the logging information to the standard output.
LogStdoutRuntimeHandler() - Constructor for class jcontract.LogStdoutRuntimeHandler
 
logViolation(RuntimeException) - Method in class jcontract.LogRuntimeHandler
Logs the contract violation described by the exception

M

makeLogStream() - Method in class jcontract.LogRuntimeHandler
Returns the default log PrintStream (the file "jcontract.log").
Override this method if you want the log PrintStream to go to a different stream.

P

PostException - exception jcontract.PostException.
Signals that a @post contract has been violated
PostException() - Constructor for class jcontract.PostException
 
PostException(String) - Constructor for class jcontract.PostException
 
PreException - exception jcontract.PreException.
Signals that a @pre contract has been violated
PreException() - Constructor for class jcontract.PreException
 
PreException(String) - Constructor for class jcontract.PreException
 
print(PrintStream) - Method in class jcontract.RuntimeStatistics
Prints the current statistics

R

RuntimeHandler - class jcontract.RuntimeHandler.
Base class for all JContract Runtime Handlers.
Subclases should at least implement the contractViolated() method.
RuntimeHandler() - Constructor for class jcontract.RuntimeHandler
 
RuntimeStatistics - class jcontract.RuntimeStatistics.
Keeps information about the contracts executed.
RuntimeStatistics() - Constructor for class jcontract.RuntimeStatistics
 

S

shutdownAction() - Method in class jcontract.LogRuntimeHandler
Prints the RuntimeStatistics for this Runtime Handler
shutdownAction() - Method in class jcontract.RuntimeHandler
Called when the virtual machine where this class has been loaded is about to exit
startAction() - Method in class jcontract.LogRuntimeHandler
Prints the JContract's Copyright message
startAction() - Method in class jcontract.RuntimeHandler
Called when the Runtime Handler is instantiated

A C D E G I L M P R S
Jcontract API