com.google.inject.spi
Class PrivateEnvironment

java.lang.Object
  extended by com.google.inject.spi.PrivateEnvironment
All Implemented Interfaces:
Element

public final class PrivateEnvironment
extends Object
implements Element

A private environment whose configuration information is hidden from the enclosing environment by default. See PrivateModule for details.

Since:
2.0

Method Summary
<T> T
acceptVisitor(ElementVisitor<T> visitor)
          Accepts an element visitor.
 List<Element> getElements()
          Returns the configuration information in this private environment.
 Set<Key<?>> getExposedKeys()
          Returns the unique exposed keys for these private elements.
 Object getSource()
          Returns an arbitrary object containing information about the "place" where this element was configured.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getSource

public Object getSource()
Description copied from interface: Element
Returns an arbitrary object containing information about the "place" where this element was configured. Used by Guice in the production of descriptive error messages.

Tools might specially handle types they know about; StackTraceElement is a good example. Tools should simply call toString() on the source object if the type is unfamiliar.

Specified by:
getSource in interface Element

getElements

public List<Element> getElements()
Returns the configuration information in this private environment.


getExposedKeys

public Set<Key<?>> getExposedKeys()
Returns the unique exposed keys for these private elements.


acceptVisitor

public <T> T acceptVisitor(ElementVisitor<T> visitor)
Description copied from interface: Element
Accepts an element visitor. Invokes the visitor method specific to this element's type.

Specified by:
acceptVisitor in interface Element
Parameters:
visitor - to call back on