com.google.template.soy.error

Class SoyError

java.lang.Object

com.google.template.soy.error.SoyError

All Implemented Interfaces:

Comparable<SoyError>

public abstract class SoyError
extends Object
implements Comparable<SoyError>

A structured error object for reporting

Method Summary

Modifier and Type	Method and Description
int	compareTo(SoyError o)
abstract SoyErrorKind	errorKind() The error kind.
abstract boolean	isWarning() Whether or not this error should be considered a warning (i.e., don't fail the build).
abstract SourceLocation	location() The location where the error occurred.
abstract String	message() The error message.
String	toString() The full formatted error.

Methods inherited from class java.lang.Object

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

Method Detail

location

public abstract SourceLocation location()

The location where the error occurred.

errorKind

public abstract SoyErrorKind errorKind()

The error kind. For classification usecases.

message

public abstract String message()

The error message.

This does not contain location information. Use toString() for a formatted message.

isWarning

public abstract boolean isWarning()

Whether or not this error should be considered a warning (i.e., don't fail the build).

toString

public String toString()

The full formatted error.

Overrides:

toString in class Object

compareTo

public int compareTo(SoyError o)

Specified by:

compareTo in interface Comparable<SoyError>