PrivateBinder

implements Binder

com.google.inject.PrivateBinder

Class Overview

Returns a binder whose configuration information is hidden from its environment by default. See PrivateModule for details.

Summary

Public Methods
abstract void	expose(Key<?> key) Makes the binding for `key` available to the enclosing environment
abstract AnnotatedElementBuilder	expose(TypeLiteral<?> type) Makes a binding for `type` available to the enclosing environment.
abstract AnnotatedElementBuilder	expose(Class<?> type) Makes a binding for `type` available to the enclosing environment.
abstract PrivateBinder	skipSources(Class... classesToSkip) Returns a binder that skips `classesToSkip` when identify the calling code.
abstract PrivateBinder	withSource(Object source) Returns a binder that uses `source` as the reference location for configuration errors.

[Expand]

Inherited Methods

From interface com.google.inject.Binder

abstract void	addError(Message message) Records an error message to be presented to the user at a later time.
abstract void	addError(String message, Object... arguments) Records an error message which will be presented to the user at a later time.
abstract void	addError(Throwable t) Records an exception, the full details of which will be logged, and the message of which will be presented to the user at a later time.
abstract <T> LinkedBindingBuilder<T>	bind(Key<T> key) See the EDSL examples at `Binder`.
abstract <T> AnnotatedBindingBuilder<T>	bind(TypeLiteral<T> typeLiteral) See the EDSL examples at `Binder`.
abstract <T> AnnotatedBindingBuilder<T>	bind(Class<T> type) See the EDSL examples at `Binder`.
abstract AnnotatedConstantBindingBuilder	bindConstant() See the EDSL examples at `Binder`.
abstract void	bindInterceptor(Matcher<? super Class<?>> classMatcher, Matcher<? super Method> methodMatcher, MethodInterceptor... interceptors) Binds method interceptor[s] to methods matched by class and method matchers.
abstract void	bindListener(Matcher<? super TypeLiteral<?>> typeMatcher, TypeListener listener) Registers a listener for injectable types.
abstract void	bindScope(Class<? extends Annotation> annotationType, Scope scope) Binds a scope to an annotation.
abstract void	convertToTypes(Matcher<? super TypeLiteral<?>> typeMatcher, TypeConverter converter) Binds a type converter.
abstract Stage	currentStage() Gets the current stage.
abstract void	disableCircularProxies() Prevents Guice from constructing a Proxy when a circular dependency is found.
abstract <T> MembersInjector<T>	getMembersInjector(TypeLiteral<T> typeLiteral) Returns the members injector used to inject dependencies into methods and fields on instances of the given type `T`.
abstract <T> MembersInjector<T>	getMembersInjector(Class<T> type) Returns the members injector used to inject dependencies into methods and fields on instances of the given type `T`.
abstract <T> Provider<T>	getProvider(Key<T> key) Returns the provider used to obtain instances for the given injection key.
abstract <T> Provider<T>	getProvider(Class<T> type) Returns the provider used to obtain instances for the given injection type.
abstract void	install(Module module) Uses the given module to configure more bindings.
abstract PrivateBinder	newPrivateBinder() Creates a new private child environment for bindings and other configuration.
abstract <T> void	requestInjection(TypeLiteral<T> type, T instance) Upon successful creation, the `Injector` will inject instance fields and methods of the given object.
abstract void	requestInjection(Object instance) Upon successful creation, the `Injector` will inject instance fields and methods of the given object.
abstract void	requestStaticInjection(Class...<?> types) Upon successful creation, the `Injector` will inject static fields and methods in the given classes.
abstract void	requireExplicitBindings() Instructs the Injector that bindings must be listed in a Module in order to be injected.
abstract Binder	skipSources(Class... classesToSkip) Returns a binder that skips `classesToSkip` when identify the calling code.
abstract Binder	withSource(Object source) Returns a binder that uses `source` as the reference location for configuration errors.

Public Methods

public abstract void expose (Key<?> key)

Since: API Level Guice_2.0

Makes the binding for key available to the enclosing environment

public abstract AnnotatedElementBuilder expose (TypeLiteral<?> type)

Since: API Level Guice_2.0

Makes a binding for type available to the enclosing environment. Use annotatedWith() to expose type with a binding annotation.

public abstract AnnotatedElementBuilder expose (Class<?> type)

Since: API Level Guice_2.0

Makes a binding for type available to the enclosing environment. Use annotatedWith() to expose type with a binding annotation.

public abstract PrivateBinder skipSources (Class... classesToSkip)

Since: API Level Guice_2.0

Returns a binder that skips classesToSkip when identify the calling code. The caller's StackTraceElement is used to locate the source of configuration errors.

Parameters

classesToSkip	library classes that create bindings on behalf of their clients.

Returns

a binder that shares its configuration with this binder.

public abstract PrivateBinder withSource (Object source)

Since: API Level Guice_2.0

Returns a binder that uses source as the reference location for configuration errors. This is typically a StackTraceElement for .java source but it could any binding source, such as the path to a .properties file.

Parameters

source	any object representing the source location and has a concise `toString()` value

Returns

a binder that shares its configuration with this binder

Interfaces

Classes

Annotations

Enums

Exceptions

PrivateBinder

Class Overview

Summary

Public Methods

public abstract void expose (Key<?> key)

public abstract AnnotatedElementBuilder expose (TypeLiteral<?> type)

public abstract AnnotatedElementBuilder expose (Class<?> type)

public abstract PrivateBinder skipSources (Class... classesToSkip)

Parameters

Returns

public abstract PrivateBinder withSource (Object source)

Parameters

Returns