com.atlassian.clover.instr.java

Interface InstrumentationSource

All Known Implementing Classes:

CharSequenceInstrumentationSource, FileInstrumentationSource, StringInstrumentationSource

public interface InstrumentationSource

A data source from which we can get a file and its content to be instrumented.

Method Summary

Modifier and Type	Method and Description
Reader	createReader() Creates an instance of a Reader which allows to get the content of the file.
File	getSourceFileLocation() Returns a location of the source file.

Method Detail

getSourceFileLocation

File getSourceFileLocation()

Returns a location of the source file. This is just a description and there's no guarantee that the file actually exists, therefore a consumer of the IntrumentationSource shall not try to read this file directly. Use createReader instead.

Returns:

File - location of the source file

createReader

Reader createReader()
             throws IOException

Creates an instance of a Reader which allows to get the content of the file.

Returns:

Reader - to get the content

Throws:

IOException