com.google.template.soy.error

Class SoyErrors

java.lang.Object

com.google.template.soy.error.SoyErrors

public final class SoyErrors
extends Object

Utility methods for constructing Soy error messages.

Constructor Summary

Constructors

Constructor and Description
SoyErrors()

Method Summary

Modifier and Type	Method and Description
static String	formatErrors(Iterable<SoyError> errors) Formats the errors in a standard way for displaying to a user.
static String	getDidYouMeanMessage(Iterable<String> allNames, String wrongName) Given a collection of strings and a name that isn't contained in it.
static String	getDidYouMeanMessageForProtoFields(com.google.common.collect.ImmutableSet<String> fields, String fieldName) Same as getDidYouMeanMessage(Iterable, String) but with some additional heuristics for proto fields.

Methods inherited from class java.lang.Object

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

Constructor Detail

SoyErrors

public SoyErrors()

Method Detail

getDidYouMeanMessage

public static String getDidYouMeanMessage(Iterable<String> allNames,
                                          String wrongName)

Given a collection of strings and a name that isn't contained in it. Return a message that suggests one of the names.

Returns the empty string if allNames is empty or there is no close match.

getDidYouMeanMessageForProtoFields

public static String getDidYouMeanMessageForProtoFields(com.google.common.collect.ImmutableSet<String> fields,
                                                        String fieldName)

Same as getDidYouMeanMessage(Iterable, String) but with some additional heuristics for proto fields.

formatErrors

public static String formatErrors(Iterable<SoyError> errors)

Formats the errors in a standard way for displaying to a user.