Modifier and Type	Class and Description
pack-priv static interface	BindingSourceRestriction.PermitMap Mapping between an element source and its permit annotations.
pack-priv static class	BindingSourceRestriction.PermitMapConstruction Builds the map from each module to all the permit annotations on its module stack.

Modifier and Type	Field and Description
private static final Logger	logger

Access	Constructor and Description
private	BindingSourceRestriction()

Method Summary

Modifier and Type	Method and Description
public static ImmutableList<Message>	check(GuiceInternal guiceInternal, List<Element> elements) Returns all the restriction violations found on the given Module Elements, as error messages.
private static ImmutableList<Message>	check(List<Element> elements)
private static ImmutableList<Message>	check(Element element)
private static Optional<Message>	check(Binding<?> binding)
private static void	clear(Element element)
private static void	clear(ElementSource elementSource)
private static Iterable<String>	getAllModules(ElementSource elementSource)
private static ImmutableSet<Class<? extends Annotation>>	getAllPermits(ElementSource elementSource) Get all permits on the element source chain.
public static Optional<String>	getMissingImplementationSuggestion(GuiceInternal guiceInternal, Key<?> key) Returns a suggestion for how a restricted binding should be created in case it's missing.
private static Stream<Class<? extends Annotation>>	getPermits(Class<?> clazz)
private static RestrictedBindingSource	getRestriction(Key<?> key)
private static String	getViolationMessage(Key<?> key, String explanation, ImmutableSet<Class<? extends Annotation>> acceptablePermits, boolean annotationRestricted)
private static boolean	isExempt(ElementSource elementSource, String exemptModulesRegex)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

logger	back to summary
private static final Logger logger

BindingSourceRestriction	back to summary
private BindingSourceRestriction()

Method Detail

check back to summary

check	back to summary
public static ImmutableList<Message> check(GuiceInternal guiceInternal, List<Element> elements) Returns all the restriction violations found on the given Module Elements, as error messages. Note: Intended to be used on Module Elements, not Injector Elements, ie. the result of `Elements#getElements` not `Injector.getElements`. The Module Elements this check cares about are: Module Bindings, which are always explicit and always have an `ElementSource` (with a Module Stack), unlike Injector Bindings, which may be implicit and bereft of an ElementSource. `PrivateElements`, which represent the recursive case of this check. They contain a list of elements that this check is recursively called on.

public static ImmutableList<Message> check(GuiceInternal guiceInternal, List<Element> elements)

Returns all the restriction violations found on the given Module Elements, as error messages.

Note: Intended to be used on Module Elements, not Injector Elements, ie. the result of Elements#getElements not Injector.getElements. The Module Elements this check cares about are:

Module Bindings, which are always explicit and always have an ElementSource (with a Module Stack), unlike Injector Bindings, which may be implicit and bereft of an ElementSource.
PrivateElements, which represent the recursive case of this check. They contain a list of elements that this check is recursively called on.

check	back to summary
private static ImmutableList<Message> check(List<Element> elements)

check	back to summary
private static ImmutableList<Message> check(Element element)

check	back to summary
private static Optional<Message> check(Binding<?> binding)

clear	back to summary
private static void clear(Element element)

clear	back to summary
private static void clear(ElementSource elementSource)

getAllModules	back to summary
private static Iterable<String> getAllModules(ElementSource elementSource)

getAllPermits	back to summary
private static ImmutableSet<Class<? extends Annotation>> getAllPermits(ElementSource elementSource) Get all permits on the element source chain.

getMissingImplementationSuggestion	back to summary
public static Optional<String> getMissingImplementationSuggestion(GuiceInternal guiceInternal, Key<?> key) Returns a suggestion for how a restricted binding should be created in case it's missing.

getPermits	back to summary
private static Stream<Class<? extends Annotation>> getPermits(Class<?> clazz)

getRestriction	back to summary
private static RestrictedBindingSource getRestriction(Key<?> key)

getViolationMessage	back to summary
private static String getViolationMessage(Key<?> key, String explanation, ImmutableSet<Class<? extends Annotation>> acceptablePermits, boolean annotationRestricted)

isExempt	back to summary
private static boolean isExempt(ElementSource elementSource, String exemptModulesRegex)

com.google.inject.spi back to summary

pack-priv Interface BindingSourceRestriction.PermitMap

Known Direct Implementers: com.google.inject.spi.BindingSourceRestriction.PermitMapConstruction.PermitMapImpl

Mapping between an element source and its permit annotations.

Method Summary

Modifier and Type	Method and Description
public void	clear()
public ImmutableSet<Class<? extends Annotation>>	getPermits(ElementSource elementSource)

Method Detail

clear	back to summary
public void clear()

getPermits	back to summary
public ImmutableSet<Class<? extends Annotation>> getPermits(ElementSource elementSource)

com.google.inject.spi back to summary

pack-priv final Class BindingSourceRestriction.PermitMapConstruction

Class Inheritance

extends Object

java.lang.Object
com.google.inject.spi.BindingSourceRestriction.PermitMapConstruction

Builds the map from each module to all the permit annotations on its module stack.

Bindings refer to the module that created them via a ModuleSource. The map built here maps a module's ModuleSource to all the RestrictedBindingSource.Permit annotations found on the path from the root of the module hierarchy to it. This path contains all the modules that transitively install the module (including the module itself). This path is also known as the module stack.

The map is built by piggybacking on the depth-first traversal of the module hierarchy during Binder configuration.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	BindingSourceRestriction.PermitMapConstruction.PermitMapImpl

Field Summary

Modifier and Type	Field and Description
pack-priv ImmutableSet<Class<? extends Annotation>>	currentModulePermits
pack-priv final Map<ModuleSource, ImmutableSet<Class<? extends Annotation>>>	modulePermits
pack-priv final Deque<ImmutableSet<Class<? extends Annotation>>>	modulePermitsStack
pack-priv final BindingSourceRestriction.PermitMapConstruction.PermitMapImpl	permitMap

Constructor Summary

Access	Constructor and Description
pack-priv	PermitMapConstruction()

Method Summary

Modifier and Type	Method and Description
pack-priv void	finish() Finishes the `PermitMap`.
pack-priv BindingSourceRestriction.PermitMap	getPermitMap() Returns a possibly unfinished map.
pack-priv static boolean	isElementSourceCleared(ElementSource elementSource)
pack-priv void	popModule() Called by the Binder when it exits a module's configure method.
pack-priv void	pushModule(Class<?> module, ModuleSource moduleSource) Called by the Binder prior to entering a module's configure method.
pack-priv void	restoreCurrentModulePermits(ModuleSource moduleSource) Sets the permits on the current module installation path to the permits on the given module source so that subsequently installed modules may inherit them.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

currentModulePermits	back to summary
pack-priv ImmutableSet<Class<? extends Annotation>> currentModulePermits

modulePermits	back to summary
pack-priv final Map<ModuleSource, ImmutableSet<Class<? extends Annotation>>> modulePermits

modulePermitsStack	back to summary
pack-priv final Deque<ImmutableSet<Class<? extends Annotation>>> modulePermitsStack

permitMap	back to summary
pack-priv final BindingSourceRestriction.PermitMapConstruction.PermitMapImpl permitMap

Constructor Detail

PermitMapConstruction	back to summary
pack-priv PermitMapConstruction()

Method Detail

finish	back to summary
pack-priv void finish() Finishes the `PermitMap`. Called by the Binder when all modules are installed.

getPermitMap	back to summary
pack-priv BindingSourceRestriction.PermitMap getPermitMap() Returns a possibly unfinished map. The map should only be used after the construction is finished.

isElementSourceCleared	back to summary
pack-priv static boolean isElementSourceCleared(ElementSource elementSource) Annotations @VisibleForTesting

popModule	back to summary
pack-priv void popModule() Called by the Binder when it exits a module's configure method.

pushModule	back to summary
pack-priv void pushModule(Class<?> module, ModuleSource moduleSource) Called by the Binder prior to entering a module's configure method.

restoreCurrentModulePermits	back to summary
pack-priv void restoreCurrentModulePermits(ModuleSource moduleSource) Sets the permits on the current module installation path to the permits on the given module source so that subsequently installed modules may inherit them. Used only for method scanning, so that modules installed by scanners inherit permits from the method's module.

com.google.inject.spi back to summary

private final Class BindingSourceRestriction.PermitMapConstruction.PermitMapImpl

Class Inheritance

extends Object
implements PermitMap

java.lang.Object
com.google.inject.spi.BindingSourceRestriction.PermitMapConstruction.PermitMapImpl

All Implemented Interfaces

com.google.inject.spi.BindingSourceRestriction.PermitMap

Field Summary

Modifier and Type	Field and Description
pack-priv Map<ModuleSource, ImmutableSet<Class<? extends Annotation>>>	modulePermits

Constructor Summary

Access	Constructor and Description
private	PermitMapImpl()

Method Summary

Modifier and Type	Method and Description
public void	clear() Implements com.google.inject.spi.BindingSourceRestriction.PermitMap.clear.
public ImmutableSet<Class<? extends Annotation>>	getPermits(ElementSource elementSource) Implements com.google.inject.spi.BindingSourceRestriction.PermitMap.getPermits.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

modulePermits	back to summary
pack-priv Map<ModuleSource, ImmutableSet<Class<? extends Annotation>>> modulePermits

Constructor Detail

PermitMapImpl	back to summary
private PermitMapImpl()

Method Detail

clear	back to summary
public void clear() Implements com.google.inject.spi.BindingSourceRestriction.PermitMap.clear. Annotations @Override

clear

back to summary

public void clear()

Implements com.google.inject.spi.BindingSourceRestriction.PermitMap.clear.

Annotations

@Override

getPermits	back to summary
public ImmutableSet<Class<? extends Annotation>> getPermits(ElementSource elementSource) Implements com.google.inject.spi.BindingSourceRestriction.PermitMap.getPermits. Annotations @Override

getPermits

back to summary

public ImmutableSet<Class<? extends Annotation>> getPermits(ElementSource elementSource)

Implements com.google.inject.spi.BindingSourceRestriction.PermitMap.getPermits.

Annotations

@Override

public final Class BindingSourceRestriction

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Interface BindingSourceRestriction.PermitMap

Method Summary

Method Detail

pack-priv final Class BindingSourceRestriction.PermitMapConstruction

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class BindingSourceRestriction.PermitMapConstruction.PermitMapImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail