com.atlassian.clover.instr.java

Class Instrumenter

java.lang.Object

com.atlassian.clover.instr.java.Instrumenter

public class Instrumenter
extends Object

Constructor Summary

Constructors

Constructor and Description
Instrumenter(JavaInstrumentationConfig config)
Instrumenter(Logger log, JavaInstrumentationConfig config)

Method Summary

Modifier and Type	Method and Description
Clover2Registry	endInstrumentation()
Clover2Registry	endInstrumentation(boolean append)
protected void	finishAndApply(InstrumentationSession session)
JavaInstrumentationConfig	getConfig()
InstrumentationSession	getSession()
CharSequence	instrument(File orig, CharSequence charSequence, String fileEncoding) Reads the charSequence and returns an instrumented version of it.
File	instrument(File srcFile, File destRoot, String fileEncoding) reads the srcFile and produces an instrumented version of that file at the package path rooted at destRoot, creating parent dirs as needed.
FileStructureInfo	instrument(InstrumentationSource in, Writer out, String fileEncoding) registers orig and produces an instrumented version of in to out
void	startInstrumentation()
void	startInstrumentation(Clover2Registry reg)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Instrumenter

public Instrumenter(JavaInstrumentationConfig config)

Instrumenter

public Instrumenter(Logger log,
                    JavaInstrumentationConfig config)

Method Detail

getConfig

public JavaInstrumentationConfig getConfig()

startInstrumentation

public void startInstrumentation()
                          throws CloverException

Throws:

CloverException

startInstrumentation

public void startInstrumentation(Clover2Registry reg)
                          throws CloverException

Throws:

CloverException

instrument

public File instrument(@NotNull
                       File srcFile,
                       @NotNull
                       File destRoot,
                       @Nullable
                       String fileEncoding)
                throws CloverException

reads the srcFile and produces an instrumented version of that file at the package path rooted at destRoot, creating parent dirs as needed.

Parameters:

srcFile - the file to instrument

destRoot - the destination root dir

fileEncoding - encoding of the file being instrumented, if null then a global setting from the config.getEncoding() will be used

Returns:

file reference to the instrumented version

Throws:

CloverException - if something goes wrong

instrument

public FileStructureInfo instrument(@NotNull
                                    InstrumentationSource in,
                                    @NotNull
                                    Writer out,
                                    @Nullable
                                    String fileEncoding)
                             throws clover.antlr.TokenStreamException,
                                    IOException,
                                    clover.antlr.RecognitionException,
                                    CloverException

registers orig and produces an instrumented version of in to out

Parameters:

in - the input file to instrument

out - the destination stream

fileEncoding - encoding of the file being instrumented, a null value means undefined

Returns:

FileStructureInfo - file reference to the instrumented version

Throws:

clover.antlr.TokenStreamException

IOException

clover.antlr.RecognitionException

CloverException

instrument

public CharSequence instrument(@NotNull
                               File orig,
                               @NotNull
                               CharSequence charSequence,
                               @Nullable
                               String fileEncoding)
                        throws clover.antlr.TokenStreamException,
                               IOException,
                               clover.antlr.RecognitionException,
                               CloverException

Reads the charSequence and returns an instrumented version of it.

Parameters:

orig - represents a source file location associated the input charSequence

charSequence - source text to be instrumented

fileEncoding - original file encodng, a null value means undefined

Returns:

CharSequence instrumented version of sources

Throws:

clover.antlr.TokenStreamException

IOException

clover.antlr.RecognitionException

CloverException

endInstrumentation

public Clover2Registry endInstrumentation()
                                   throws CloverException

Throws:

CloverException

endInstrumentation

public Clover2Registry endInstrumentation(boolean append)
                                   throws CloverException

Throws:

CloverException

finishAndApply

protected void finishAndApply(InstrumentationSession session)
                       throws ConcurrentInstrumentationException

Throws:

ConcurrentInstrumentationException

getSession

public InstrumentationSession getSession()