com.google.template.soy.error

Class SoyErrorKind

java.lang.Object

com.google.template.soy.error.SoyErrorKind

public final class SoyErrorKind
extends Object

Represents any syntactic or semantic error made by a Soy template author, which can be collected during compilation and displayed back to the author. (In particular, this class is not intended to convey errors in the Soy implementation itself.) The error can be customized with string arguments.

Classes that report SoyErrorKinds should declare them as static final fields, making it easy for readers to inspect the errors that the class could report.

Error messages should be capitalized, and concluded with a punctuation mark.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoyErrorKind.StyleAllowance Enum to enable exceptions to Soy error message formatting rules.

Method Summary

Modifier and Type	Method and Description
String	format(Object... args)
static SoyErrorKind	of(String format, SoyErrorKind.StyleAllowance... exceptions)
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

format

public String format(Object... args)

of

public static SoyErrorKind of(String format,
                              SoyErrorKind.StyleAllowance... exceptions)

toString

public String toString()

Overrides:

toString in class Object