Package: org.gmetrics.source

## [Groovy] Class SourceString

- org.gmetrics.source.SourceString

- SourceCode implementation that uses source from a pre-defined String. 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) \$

- - ### Properties Summary

    Properties
    Type | Name and description
    --- | ---
    `String` | `name`
    `String` | `path`

  - ### Constructor Summary

    Constructors
    Constructor and description
    `SourceString (String source, String path = null, String name = null)` 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` | `getText()` @return the full text of the source code
    `` | `void` | `setPath(String path)`
    `` | `String` | `toString()`

  - ### Inherited Methods Summary

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

- - ### Property Detail

    - #### String name

    - #### String path

  - ### Constructor Detail

    - #### SourceString(String source, String path = null, String name = null)

      Construct a new instance for the file at the specified path

      Parameters:
        `source` - - the source; must not be null or empty
        `path` - - the path for the source code; may be null; defaults to null
        `name` - - the name for the source code; may be null; defaults to null

  - ### Method Detail

    - #### protected def createSourceUnit()

    - #### String getText()

      Returns:
        the full text of the source code

    - #### void setPath(String path)

    - #### String toString()