Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.google.javascript.jscomp
Interface SourceExcerptProvider

All Known Implementing Classes:
AbstractCompiler, Compiler, SimpleSourceExcerptProvider
public interface SourceExcerptProvider

A source excerpt provider is responsible for building source code excerpt of specific locations, such as a specific line or a region around a given line number.

Nested Class Summary
static interface SourceExcerptProvider.ExcerptFormatter
          A excerpt formatter is responsible of formatting source excerpts.
static class SourceExcerptProvider.SourceExcerpt
          Source excerpt variety.
 
Method Summary
 String getSourceLine(String sourceName, int lineNumber)
          Get the line indicated by the line number.
 Region getSourceRegion(String sourceName, int lineNumber)
          Get a region around the indicated line number.
 

Method Detail

getSourceLine

String getSourceLine(String sourceName,
                     int lineNumber)
Get the line indicated by the line number. This call will return only the specific line.

Parameters:
lineNumber - the line number, 1 being the first line of the file
Returns:
the line indicated, or null if it does not exist

getSourceRegion

Region getSourceRegion(String sourceName,
                       int lineNumber)
Get a region around the indicated line number. The exact definition of a region is implementation specific, but it must contain the line indicated by the line number. A region must not start or end by a carriage return.

Parameters:
lineNumber - the line number, 1 being the first line of the file
Returns:
the region around the line number indicated, or null if it does not exist
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD