AbstractSourceCode (CodeNarc 3.4.0 API)

org.codenarc.source.AbstractSourceCode

All Implemented Interfaces and Traits:: SourceCode

@java.lang.SuppressWarnings(value: AbstractClassWithoutAbstractMethod)
abstract class AbstractSourceCode
extends java.lang.Object
implements SourceCode

Abstract superclass for SourceCode implementations

Authors:: Chris Mair; Hamlet D'Arcy

Properties Summary

Properties
Type	Name and description
`static org.slf4j.Logger`	`LOG`
`static java.lang.String`	`SEPARATOR_PROP`
`SuppressionAnalyzer`	`suppressionAnalyzer`

Constructor Summary

Constructors
Constructor and description
`AbstractSourceCode ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`ModuleNode`	`getAst()` Return the Groovy AST (Abstract Syntax Tree) for this source file
	`int`	`getAstCompilerPhase()` Returns: compiler phase (as in org.codehaus.groovy.control.Phases) up to which the AST will be processed
	`int`	`getLineNumberForCharacterIndex(int charIndex)` Return the line index for the line containing the character at the specified index within the source code.
	`java.util.List`	`getLines()` Returns: the List of lines of the source code (with line terminators removed)
	`java.util.Map<ClassNode, java.util.List<MethodCallExpression>>`	`getMethodCallExpressions()`
	`boolean`	`isValid()` Return true if and only if the source code can be successfully compiled
	`java.lang.String`	`line(int lineNumber)` Get the trimmed line at the specified index
	`protected java.lang.String`	`normalizePath(java.lang.String path)` Return the normalized value of the specified path.
	`protected void`	`setSuppressionAnalyzer(SuppressionAnalyzer suppressionAnalyzer)` Setter exists to avoid circular dependency.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - static final org.slf4j.Logger LOG
  - static final java.lang.String SEPARATOR_PROP
  - SuppressionAnalyzer suppressionAnalyzer
- Constructor Detail
  - AbstractSourceCode()
- Method Detail
  - @java.lang.Override ModuleNode getAst()
    
    Return the Groovy AST (Abstract Syntax Tree) for this source file
    Returns:
    the ModuleNode representing the AST for this source file
  - @java.lang.SuppressWarnings(value: GetterMethodCouldBeProperty) @java.lang.Override int getAstCompilerPhase()
    
    Returns:
    compiler phase (as in org.codehaus.groovy.control.Phases) up to which the AST will be processed
  - @java.lang.Override int getLineNumberForCharacterIndex(int charIndex)
    
    Return the line index for the line containing the character at the specified index within the source code.
    Parameters:
    charIndex - - the index of the character within the source code (zero-based)
    Returns:
    the line number (one-based) containing the specified character; Return -1 if charIndex is not valid.
  - @java.lang.Override java.util.List getLines()
    
    Returns:
    the List of lines of the source code (with line terminators removed)
  - @java.lang.Override java.util.Map<ClassNode, java.util.List<MethodCallExpression>> getMethodCallExpressions()
  - @java.lang.Override boolean isValid()
    
    Return true if and only if the source code can be successfully compiled
    Returns:
    true only if the source code is valid
  - @java.lang.Override java.lang.String line(int lineNumber)
    
    Get the trimmed line at the specified index
    Parameters:
    lineNumber - - the zero-based line number; may be negative
    Returns:
    the trimmed line at the specified index, or null if lineNumber is not valid
  - protected java.lang.String normalizePath(java.lang.String path)
    
    Return the normalized value of the specified path. Convert file separator chars to standard '/'.
    Parameters:
    path - - the path to normalize
    Returns:
    the normalized value
  - protected void setSuppressionAnalyzer(SuppressionAnalyzer suppressionAnalyzer)
    
    Setter exists to avoid circular dependency.
    Parameters:
    suppressionAnalyzer - suppression analyzer

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class AbstractSourceCode

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

static final org.slf4j.Logger LOG

static final java.lang.String SEPARATOR_PROP

SuppressionAnalyzer suppressionAnalyzer

Constructor Detail

AbstractSourceCode()

Method Detail

@java.lang.Override ModuleNode getAst()

@java.lang.SuppressWarnings(value: GetterMethodCouldBeProperty) @java.lang.Override int getAstCompilerPhase()

@java.lang.Override int getLineNumberForCharacterIndex(int charIndex)

@java.lang.Override java.util.List getLines()

@java.lang.Override java.util.Map<ClassNode, java.util.List<MethodCallExpression>> getMethodCallExpressions()

@java.lang.Override boolean isValid()

@java.lang.Override java.lang.String line(int lineNumber)

protected java.lang.String normalizePath(java.lang.String path)

protected void setSuppressionAnalyzer(SuppressionAnalyzer suppressionAnalyzer)