Package: org.gmetrics.source

## [Groovy] Class SourceFile

- org.gmetrics.source.SourceFile

- 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: 29 \$ - \$Date: 2009-12-13 15:50:29 -0500 (Sun, 13 Dec 2009) \$

- - ### Constructor Summary

    Constructors
    Constructor and description
    `SourceFile (File file)` Construct a new instance for the file at the specified path

  - ### Methods Summary

    Methods
    Type Params | Return Type | Name and description
    --- | --- | ---
    `` | `protected def` | `createSourceUnit()`
    `` | `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()`

  - ### Inherited Methods Summary

    Inherited Methods
    Methods inherited from class | Name
    --- | ---
    `class AbstractSourceCode` | `createSourceUnit, getAst, getLineNumberForCharacterIndex, getLines, isValid, line, normalizePath`

- - ### Constructor Detail

    - #### 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

    - #### protected def createSourceUnit()

    - #### String getName()

      Returns:
        the filename for this source file, excluding path

    - #### String getPath()

      Returns:
        the normalized path for this source file, including filename

    - #### String getText()

      Returns:
        the full text of the source code

    - #### String toString()