public final class Errors
extends java.lang.Object
implements java.io.Serializable
Errors can be chained to provide additional context. To add context, call withSource(java.lang.Object)
to create a new Errors instance that contains additional context. All messages added to the
returned instance will contain full context.
To avoid messages with redundant context, withSource(java.lang.Object)
should be added sparingly. A
good rule of thumb is to assume a method's caller has already specified enough context to
identify that method. When calling a method that's defined in a different context, call that
method with an errors object that includes its context.
Modifier and Type | Field and Description |
---|---|
private static com.google.common.collect.ImmutableSet<java.lang.Class<?>> |
COMMON_AMBIGUOUS_TYPES
If the key is unknown and it is one of these types, it generally means there is a missing
annotation.
|
private static java.lang.String |
CONSTRUCTOR_RULES |
private java.util.List<Message> |
errors
null unless (root == this) and error messages exist.
|
private static int |
MAX_MATCHING_TYPES_REPORTED
When a binding is not found, show at most this many bindings with the same type
|
private static int |
MAX_RELATED_TYPES_REPORTED
When a binding is not found, show at most this many bindings that have some similarities
|
private Errors |
parent
The parent errors object.
|
private Errors |
root
The root errors object.
|
private java.lang.Object |
source
The leaf source for errors added here.
|
Modifier | Constructor and Description |
---|---|
|
Errors() |
private |
Errors(Errors parent,
java.lang.Object source) |
|
Errors(java.lang.Object source) |
Modifier and Type | Method and Description |
---|---|
Errors |
addMessage(Message message) |
Errors |
addMessage(java.lang.String messageFormat,
java.lang.Object... arguments) |
private Errors |
addMessage(java.lang.Throwable cause,
java.lang.String messageFormat,
java.lang.Object... arguments) |
Errors |
ambiguousTypeConversion(java.lang.String stringValue,
java.lang.Object source,
TypeLiteral<?> type,
TypeConverterBinding a,
TypeConverterBinding b) |
Errors |
atInjectRequired(java.lang.Class clazz) |
Errors |
bindingAlreadySet(Key<?> key,
java.lang.Object source) |
Errors |
bindingToProvider() |
Errors |
cannotBindToGuiceType(java.lang.String simpleName) |
Errors |
cannotInjectAbstractMethod(java.lang.reflect.Method method) |
Errors |
cannotInjectFinalField(java.lang.reflect.Field field) |
Errors |
cannotInjectInnerClass(java.lang.Class<?> type) |
Errors |
cannotInjectMethodWithTypeParameters(java.lang.reflect.Method method) |
Errors |
cannotInjectNonVoidMethod(java.lang.reflect.Method method) |
Errors |
cannotInjectRawMembersInjector() |
Errors |
cannotInjectRawProvider() |
Errors |
cannotInjectRawTypeLiteral() |
Errors |
cannotInjectTypeLiteralOf(java.lang.reflect.Type unsupportedType) |
(package private) static void |
checkConfiguration(boolean condition,
java.lang.String format,
java.lang.Object... args)
Throws a ConfigurationException with a formatted
Message if this condition is false . |
(package private) static <T> T |
checkNotNull(T reference,
java.lang.String name)
Throws a ConfigurationException with an NullPointerExceptions as the cause if the given
reference is
null . |
Errors |
childBindingAlreadySet(Key<?> key,
java.util.Set<java.lang.Object> sources) |
Errors |
constructorNotDefinedByType(java.lang.reflect.Constructor<?> constructor,
TypeLiteral<?> type) |
Errors |
conversionError(java.lang.String stringValue,
java.lang.Object source,
TypeLiteral<?> type,
TypeConverterBinding typeConverterBinding,
java.lang.RuntimeException cause) |
Errors |
conversionTypeError(java.lang.String stringValue,
java.lang.Object source,
TypeLiteral<?> type,
TypeConverterBinding typeConverterBinding,
java.lang.Object converted) |
static java.lang.Object |
convert(java.lang.Object o) |
static java.lang.Object |
convert(java.lang.Object o,
ElementSource source) |
Errors |
converterReturnedNull(java.lang.String stringValue,
java.lang.Object source,
TypeLiteral<?> type,
TypeConverterBinding typeConverterBinding) |
Errors |
duplicateBindingAnnotations(java.lang.reflect.Member member,
java.lang.Class<? extends java.lang.annotation.Annotation> a,
java.lang.Class<? extends java.lang.annotation.Annotation> b) |
Errors |
duplicateScopeAnnotations(java.lang.Class<? extends java.lang.annotation.Annotation> a,
java.lang.Class<? extends java.lang.annotation.Annotation> b) |
Errors |
duplicateScopes(ScopeBinding existing,
java.lang.Class<? extends java.lang.annotation.Annotation> annotationType,
Scope scope) |
Errors |
errorCheckingDuplicateBinding(Key<?> key,
java.lang.Object source,
java.lang.Throwable t) |
Errors |
errorEnhancingClass(java.lang.Class<?> clazz,
java.lang.Throwable cause) |
Errors |
errorInUserCode(java.lang.Throwable cause,
java.lang.String messageFormat,
java.lang.Object... arguments) |
Errors |
errorNotifyingTypeListener(TypeListenerBinding listener,
TypeLiteral<?> type,
java.lang.Throwable cause) |
Errors |
exposedButNotBound(Key<?> key) |
static java.lang.String |
format(java.lang.String messageFormat,
java.lang.Object... arguments) |
static void |
formatSource(java.util.Formatter formatter,
java.lang.Object source) |
java.util.List<Message> |
getMessages() |
static java.util.Collection<Message> |
getMessagesFromThrowable(java.lang.Throwable throwable) |
private java.util.List<java.lang.Object> |
getSources() |
boolean |
hasErrors() |
Errors |
jitBindingAlreadySet(Key<?> key) |
Errors |
jitDisabled(Key<?> key) |
Errors |
jitDisabledInParent(Key<?> key) |
Errors |
keyNotFullySpecified(TypeLiteral<?> typeLiteral) |
Errors |
merge(java.util.Collection<Message> messages) |
Errors |
merge(Errors moreErrors) |
Errors |
merge(InternalProvisionException ipe) |
Errors |
misplacedBindingAnnotation(java.lang.reflect.Member member,
java.lang.annotation.Annotation bindingAnnotation) |
Errors |
missingConstantValues() |
Errors |
missingConstructor(TypeLiteral<?> type) |
Errors |
missingImplementation(Key key)
We use a fairly generic error message here.
|
(package private) <T> Errors |
missingImplementationWithHint(Key<T> key,
Injector injector)
Within guice's core, allow for better missing binding messages
|
Errors |
missingRuntimeRetention(java.lang.Class<? extends java.lang.annotation.Annotation> annotation) |
Errors |
missingScopeAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotation) |
Errors |
notASubtype(java.lang.Class<?> implementationType,
java.lang.Class<?> type) |
Errors |
optionalConstructor(java.lang.reflect.Constructor constructor) |
Errors |
recursiveBinding() |
Errors |
recursiveImplementationType() |
Errors |
recursiveProviderType() |
Errors |
scopeAnnotationOnAbstractType(java.lang.Class<? extends java.lang.annotation.Annotation> scopeAnnotation,
java.lang.Class<?> type,
java.lang.Object source) |
Errors |
scopeNotFound(java.lang.Class<? extends java.lang.annotation.Annotation> scopeAnnotation) |
int |
size() |
Errors |
staticInjectionOnInterface(java.lang.Class<?> clazz) |
void |
throwConfigurationExceptionIfErrorsExist() |
void |
throwCreationExceptionIfErrorsExist() |
void |
throwIfNewErrors(int expectedSize) |
void |
throwProvisionExceptionIfErrorsExist() |
ErrorsException |
toException() |
Errors |
tooManyConstructors(java.lang.Class<?> implementation) |
Errors |
voidProviderMethod() |
Errors |
withSource(java.lang.Object source)
Returns an instance that uses
source as a reference point for newly added errors. |
private static final int MAX_MATCHING_TYPES_REPORTED
private static final int MAX_RELATED_TYPES_REPORTED
private static final com.google.common.collect.ImmutableSet<java.lang.Class<?>> COMMON_AMBIGUOUS_TYPES
private final Errors root
private final Errors parent
private final java.lang.Object source
private java.util.List<Message> errors
private static final java.lang.String CONSTRUCTOR_RULES
public Errors()
public Errors(java.lang.Object source)
private Errors(Errors parent, java.lang.Object source)
static <T> T checkNotNull(T reference, java.lang.String name)
null
.static void checkConfiguration(boolean condition, java.lang.String format, java.lang.Object... args)
Message
if this condition is false
.public Errors withSource(java.lang.Object source)
source
as a reference point for newly added errors.public Errors missingImplementation(Key key)
Guice.createInjector(new AbstractModule() {
public void configure() {
bind(Runnable.class);
}
}
...and at provide-time errors:
Guice.createInjector().getInstance(Runnable.class);
Otherwise we need to know who's calling when resolving a just-in-time binding, which makes
things unnecessarily complex.<T> Errors missingImplementationWithHint(Key<T> key, Injector injector)
public Errors atInjectRequired(java.lang.Class clazz)
public Errors converterReturnedNull(java.lang.String stringValue, java.lang.Object source, TypeLiteral<?> type, TypeConverterBinding typeConverterBinding)
public Errors conversionTypeError(java.lang.String stringValue, java.lang.Object source, TypeLiteral<?> type, TypeConverterBinding typeConverterBinding, java.lang.Object converted)
public Errors conversionError(java.lang.String stringValue, java.lang.Object source, TypeLiteral<?> type, TypeConverterBinding typeConverterBinding, java.lang.RuntimeException cause)
public Errors ambiguousTypeConversion(java.lang.String stringValue, java.lang.Object source, TypeLiteral<?> type, TypeConverterBinding a, TypeConverterBinding b)
public Errors bindingToProvider()
public Errors notASubtype(java.lang.Class<?> implementationType, java.lang.Class<?> type)
public Errors recursiveImplementationType()
public Errors recursiveProviderType()
public Errors missingRuntimeRetention(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
public Errors missingScopeAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
public Errors optionalConstructor(java.lang.reflect.Constructor constructor)
public Errors cannotBindToGuiceType(java.lang.String simpleName)
public Errors scopeNotFound(java.lang.Class<? extends java.lang.annotation.Annotation> scopeAnnotation)
public Errors scopeAnnotationOnAbstractType(java.lang.Class<? extends java.lang.annotation.Annotation> scopeAnnotation, java.lang.Class<?> type, java.lang.Object source)
public Errors misplacedBindingAnnotation(java.lang.reflect.Member member, java.lang.annotation.Annotation bindingAnnotation)
public Errors missingConstructor(TypeLiteral<?> type)
public Errors tooManyConstructors(java.lang.Class<?> implementation)
public Errors constructorNotDefinedByType(java.lang.reflect.Constructor<?> constructor, TypeLiteral<?> type)
public Errors duplicateScopes(ScopeBinding existing, java.lang.Class<? extends java.lang.annotation.Annotation> annotationType, Scope scope)
public Errors voidProviderMethod()
public Errors missingConstantValues()
public Errors cannotInjectInnerClass(java.lang.Class<?> type)
public Errors duplicateBindingAnnotations(java.lang.reflect.Member member, java.lang.Class<? extends java.lang.annotation.Annotation> a, java.lang.Class<? extends java.lang.annotation.Annotation> b)
public Errors staticInjectionOnInterface(java.lang.Class<?> clazz)
public Errors cannotInjectFinalField(java.lang.reflect.Field field)
public Errors cannotInjectAbstractMethod(java.lang.reflect.Method method)
public Errors cannotInjectNonVoidMethod(java.lang.reflect.Method method)
public Errors cannotInjectMethodWithTypeParameters(java.lang.reflect.Method method)
public Errors duplicateScopeAnnotations(java.lang.Class<? extends java.lang.annotation.Annotation> a, java.lang.Class<? extends java.lang.annotation.Annotation> b)
public Errors recursiveBinding()
public Errors childBindingAlreadySet(Key<?> key, java.util.Set<java.lang.Object> sources)
public Errors errorCheckingDuplicateBinding(Key<?> key, java.lang.Object source, java.lang.Throwable t)
public Errors errorNotifyingTypeListener(TypeListenerBinding listener, TypeLiteral<?> type, java.lang.Throwable cause)
public Errors keyNotFullySpecified(TypeLiteral<?> typeLiteral)
public Errors errorEnhancingClass(java.lang.Class<?> clazz, java.lang.Throwable cause)
public static java.util.Collection<Message> getMessagesFromThrowable(java.lang.Throwable throwable)
public Errors errorInUserCode(java.lang.Throwable cause, java.lang.String messageFormat, java.lang.Object... arguments)
public Errors cannotInjectRawProvider()
public Errors cannotInjectRawMembersInjector()
public Errors cannotInjectTypeLiteralOf(java.lang.reflect.Type unsupportedType)
public Errors cannotInjectRawTypeLiteral()
public void throwCreationExceptionIfErrorsExist()
public void throwConfigurationExceptionIfErrorsExist()
public void throwProvisionExceptionIfErrorsExist()
public Errors merge(InternalProvisionException ipe)
private java.util.List<java.lang.Object> getSources()
public void throwIfNewErrors(int expectedSize) throws ErrorsException
ErrorsException
public ErrorsException toException()
public boolean hasErrors()
public Errors addMessage(java.lang.String messageFormat, java.lang.Object... arguments)
private Errors addMessage(java.lang.Throwable cause, java.lang.String messageFormat, java.lang.Object... arguments)
public static java.lang.String format(java.lang.String messageFormat, java.lang.Object... arguments)
public java.util.List<Message> getMessages()
public int size()
public static java.lang.Object convert(java.lang.Object o)
public static java.lang.Object convert(java.lang.Object o, ElementSource source)
public static void formatSource(java.util.Formatter formatter, java.lang.Object source)