ImportUtil (CodeNarc 2.2.0 API)

org.codenarc.util.ImportUtil

Contains static utility methods and constants related to Import statements.
This is an internal class and its API is subject to change.
Authors:
Chris Mair

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static java.util.List<org.codehaus.groovy.ast.ImportNode>`	`getAllImports(SourceCode sourceCode)`
	`static java.util.List<org.codehaus.groovy.ast.ImportNode>`	`getNonStaticImportsSortedByLineNumber(SourceCode sourceCode)`
	`static java.lang.String`	`packageNameForImport(org.codehaus.groovy.ast.ImportNode importNode)` Return the package name for the specified import statement or else an empty String
	`static java.util.Map`	`sourceLineAndNumberForImport(SourceCode sourceCode, java.lang.String className, java.lang.String alias)` Return the source line and line number for the specified import class name and alias
	`static java.util.Map`	`sourceLineAndNumberForImport(SourceCode sourceCode, org.codehaus.groovy.ast.ImportNode importNode)` Return the source line and line number for the specified import
	`static java.util.Map`	`sourceLineAndNumberForNonStarImport(SourceCode sourceCode, org.codehaus.groovy.ast.ImportNode importNode)`
	`static java.util.Map`	`sourceLineAndNumberForStarImport(SourceCode sourceCode, org.codehaus.groovy.ast.ImportNode importNode)` Return the source line and line number for the specified import class name and alias

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), 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()`

- Method Detail
  - static java.util.List<org.codehaus.groovy.ast.ImportNode> getAllImports(SourceCode sourceCode)
  - static java.util.List<org.codehaus.groovy.ast.ImportNode> getNonStaticImportsSortedByLineNumber(SourceCode sourceCode)
  - static java.lang.String packageNameForImport(org.codehaus.groovy.ast.ImportNode importNode)
    
    Return the package name for the specified import statement or else an empty String
    Parameters:
    importNode - - the ImportNode for the import
    Returns:
    the name package being imported (i.e., the import minus the class name/spec) or an empty String if the import contains no package component
  - static java.util.Map sourceLineAndNumberForImport(SourceCode sourceCode, java.lang.String className, java.lang.String alias)
    
    Return the source line and line number for the specified import class name and alias
    Parameters:
    sourceCode - - the SourceCode being processed
    importNode - - the ImportNode representing the import
    Returns:
    an object that has 'sourceLine' and 'lineNumber' fields
  - static java.util.Map sourceLineAndNumberForImport(SourceCode sourceCode, org.codehaus.groovy.ast.ImportNode importNode)
    
    Return the source line and line number for the specified import
    Parameters:
    sourceCode - - the SourceCode being processed
    importNode - - the ImportNode representing the import
    Returns:
    an object that has 'sourceLine' and 'lineNumber' fields
  - static java.util.Map sourceLineAndNumberForNonStarImport(SourceCode sourceCode, org.codehaus.groovy.ast.ImportNode importNode)
  - static java.util.Map sourceLineAndNumberForStarImport(SourceCode sourceCode, org.codehaus.groovy.ast.ImportNode importNode)
    
    Return the source line and line number for the specified import class name and alias
    Parameters:
    sourceCode - - the SourceCode being processed
    importNode - - the ImportNode representing the import
    Returns:
    an object that has 'sourceLine' and 'lineNumber' fields

Summary:
Method

| Detail:
Method

Groovy Documentation

[Groovy] Class ImportUtil

Methods Summary

Inherited Methods Summary

Method Detail

static java.util.List<org.codehaus.groovy.ast.ImportNode> getAllImports(SourceCode sourceCode)

static java.util.List<org.codehaus.groovy.ast.ImportNode> getNonStaticImportsSortedByLineNumber(SourceCode sourceCode)

static java.lang.String packageNameForImport(org.codehaus.groovy.ast.ImportNode importNode)

static java.util.Map sourceLineAndNumberForImport(SourceCode sourceCode, java.lang.String className, java.lang.String alias)

static java.util.Map sourceLineAndNumberForImport(SourceCode sourceCode, org.codehaus.groovy.ast.ImportNode importNode)

static java.util.Map sourceLineAndNumberForNonStarImport(SourceCode sourceCode, org.codehaus.groovy.ast.ImportNode importNode)

static java.util.Map sourceLineAndNumberForStarImport(SourceCode sourceCode, org.codehaus.groovy.ast.ImportNode importNode)