com.google.template.soy.error

Class ErrorReporter

java.lang.Object

com.google.template.soy.error.ErrorReporter

public abstract class ErrorReporter
extends Object

Collects errors during parsing.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ErrorReporter.Checkpoint Opaque token, used by checkpoint() and errorsSince(com.google.template.soy.error.ErrorReporter.Checkpoint).

Constructor Summary

Constructors

Constructor and Description
ErrorReporter()

Method Summary

Modifier and Type	Method and Description
ErrorReporter.Checkpoint	checkpoint() Returns an opaque token (the checkpoint) that callers can later pass back into errorsSince(com.google.template.soy.error.ErrorReporter.Checkpoint) to see if any errors have occurred in the interim.
static ErrorReporter	create(Map<String,SoyFileSupplier> filePathsToSuppliers) Creates a new ErrorReporter which can create source snippets from the given files.
static ErrorReporter	createForTest() Creates a new ErrorReporter suitable for asserting on messages in tests.
boolean	errorsSince(ErrorReporter.Checkpoint checkpoint) Returns true iff errors have occurred since checkpoint was obtained from checkpoint().
static ErrorReporter	explodeOnErrorsAndIgnoreWarnings() Returns an ErrorReporter that throws assertion error on every error but ignores warnings.
static ErrorReporter	exploding() Returns an ErrorReporter that throws an assertion error on every error and warning.
abstract com.google.common.collect.ImmutableList<SoyError>	getErrors() Returns all the errors reported so far.
abstract com.google.common.collect.ImmutableList<SoyError>	getWarnings() Returns all the warnings reported so far.
boolean	hasErrors() Returns true if any errors have been reported.
abstract void	report(SourceLocation sourceLocation, SoyErrorKind error, Object... args) Reports the given error, formatted according to args and associated with the given sourceLocation.
abstract void	warn(SourceLocation sourceLocation, SoyErrorKind error, Object... args) Reports a warning.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ErrorReporter

public ErrorReporter()

Method Detail

create

public static ErrorReporter create(Map<String,SoyFileSupplier> filePathsToSuppliers)

Creates a new ErrorReporter which can create source snippets from the given files.

createForTest

public static ErrorReporter createForTest()

Creates a new ErrorReporter suitable for asserting on messages in tests.

exploding

public static ErrorReporter exploding()

Returns an ErrorReporter that throws an assertion error on every error and warning.

Useful for tests.

explodeOnErrorsAndIgnoreWarnings

public static ErrorReporter explodeOnErrorsAndIgnoreWarnings()

Returns an ErrorReporter that throws assertion error on every error but ignores warnings.

report

public abstract void report(SourceLocation sourceLocation,
                            SoyErrorKind error,
                            Object... args)

Reports the given error, formatted according to args and associated with the given sourceLocation.

warn

public abstract void warn(SourceLocation sourceLocation,
                          SoyErrorKind error,
                          Object... args)

Reports a warning.

The formatting is identical to report(com.google.template.soy.base.SourceLocation, com.google.template.soy.error.SoyErrorKind, java.lang.Object...), but it will not cause the build to fail. This should be used sparingly, the best usecase is to add warnings as part of a migration to stop temporary backsliding.

checkpoint

public final ErrorReporter.Checkpoint checkpoint()

Returns an opaque token (the checkpoint) that callers can later pass back into errorsSince(com.google.template.soy.error.ErrorReporter.Checkpoint) to see if any errors have occurred in the interim.

errorsSince

public final boolean errorsSince(ErrorReporter.Checkpoint checkpoint)

Returns true iff errors have occurred since checkpoint was obtained from checkpoint().

Useful for callers whose outputs are dependent on whether some code path resulted in new errors (for example, returning an error node if parsing encountered errors).

hasErrors

public final boolean hasErrors()

Returns true if any errors have been reported.

getErrors

public abstract com.google.common.collect.ImmutableList<SoyError> getErrors()

Returns all the errors reported so far.

getWarnings

public abstract com.google.common.collect.ImmutableList<SoyError> getWarnings()

Returns all the warnings reported so far.