Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.codenarc.source
[Groovy] Class SourceFile

java.lang.Object
  org.codenarc.source.AbstractSourceCode
      org.codenarc.source.SourceFile

class SourceFile
extends AbstractSourceCode

The SourceCode implementation for a single file. Note that the path is normalized: file separator chars are normalized to standard '/'.

Authors:
Chris Mair
Version:
\$Revision: 439 \$ - \$Date: 2010-11-08 15:16:30 -0500 (Mon, 08 Nov 2010) \$

Constructor Summary
SourceFile(File file)

Construct a new instance for the file at the specified path
 
Method Summary
String getName()

@return the filename for this source file, excluding path
String getPath()

@return the normalized path for this source file, including filename
String getText()

@return the full text of the source code
String toString()

 
Methods inherited from class AbstractSourceCode
getAst, getLineNumberForCharacterIndex, getLines, isValid, line, normalizePath
 

Constructor Detail

SourceFile

SourceFile(File file)
Construct a new instance for the file at the specified path
Parameters:
path - - the path of the file; must not be null or empty

 
Method Detail

getName

String getName()
Returns:
the filename for this source file, excluding path

getPath

String getPath()
Returns:
the normalized path for this source file, including filename

getText

String getText()
Returns:
the full text of the source code

toString

String toString()

 

Groovy Documentation