com.atlassian.clover.instr.java

Class FileInstrumentationSource

java.lang.Object

com.atlassian.clover.instr.java.FileInstrumentationSource

All Implemented Interfaces:

InstrumentationSource

public class FileInstrumentationSource
extends Object
implements InstrumentationSource

Data source reading from a File.

Constructor Summary

Constructors

Constructor and Description
FileInstrumentationSource(File sourceFile, String encoding)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileInstrumentationSource

public FileInstrumentationSource(File sourceFile,
                                 String encoding)

Parameters:

sourceFile - location of the source file

encoding - charset encoding or null

Method Detail

getSourceFileLocation

public File getSourceFileLocation()

Description copied from interface: InstrumentationSource

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.

Specified by:

getSourceFileLocation in interface InstrumentationSource

Returns:

File - location of the source file

createReader

public Reader createReader()
                    throws IOException

Description copied from interface: InstrumentationSource

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

Specified by:

createReader in interface InstrumentationSource

Returns:

Reader - to get the content

Throws:

IOException