WeldContainer (Weld SE (Uber Jar) 2.4.6.Final API)

java.lang.Object
- javax.enterprise.inject.spi.CDI<T>
- - org.jboss.weld.AbstractCDI<Object>
  - - org.jboss.weld.environment.se.WeldContainer

All Implemented Interfaces:

AutoCloseable, Iterable<Object>, javax.enterprise.inject.Instance<Object>, javax.inject.Provider<Object>, org.jboss.weld.environment.ContainerInstance, org.jboss.weld.inject.WeldInstance<Object>
```
@Vetoed
public class WeldContainer
extends AbstractCDI<Object>
implements AutoCloseable, org.jboss.weld.environment.ContainerInstance
```
Represents a Weld SE container.
An new instance can be initialized using the Weld builder:
```
 WeldContainer container = new Weld().initialize();
 
```
It's also possible to obtain the instance of a running container by id:
```
 WeldContainer container = WeldContainer.instance("myCustomId");
 
```
shutdown() must be always called to shutdown the container properly. AutoCloseable is implemented, so the container is automatically shut down when leaving the try-with-resources block:
```
 try (WeldContainer container = new Weld().initialize()) {
     container.select(Foo.class).get();
 }
 
```
The container is also registered as a Singleton bean.

Provides convenient access to beans, BeanManager and events, which is particularly helpful when bootstrapping an application in Java SE:
```
 Foo foo = container.select(Foo.class).get();
 container.getBeanManager().fireEvent(new Bar())
 container.event().select(Bar.class).fire(new Bar());
 
```
Author:

Peter Royle, Martin Kouba

See Also:

Weld

Nested Class Summary
- Nested classes/interfaces inherited from interface org.jboss.weld.inject.WeldInstance
  org.jboss.weld.inject.WeldInstance.Handler<T>

Field Summary
- Fields inherited from class org.jboss.weld.AbstractCDI
  knownClassNames
- Fields inherited from class javax.enterprise.inject.spi.CDI
  configuredProvider, discoveredProviders

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`checkState()` Check whether the container is in a "valid" state, no-op by default.
`void`	`close()`
`static WeldContainer`	`current()` A convenient method for `CDI.current()`.
`org.jboss.weld.events.WeldEvent<Object>`	`event()` Provides access to all events within the application.
`javax.enterprise.inject.spi.BeanManager`	`getBeanManager()` Provides direct access to the BeanManager.
`String`	`getId()` Weld containers must have a unique identifier assigned when there are multiple Weld instances running at once.
`protected org.jboss.weld.inject.WeldInstance<Object>`	`getInstance()` Subclasses are allowed to override the default behavior, i.e.
`static List<String>`	`getRunningContainerIds()`
`javax.enterprise.inject.Instance<Object>`	`instance()` Deprecated. Applications are encouraged to use methods for programmatic lookup directly.
`static WeldContainer`	`instance(String id)`
`boolean`	`isRunning()`
`void`	`shutdown()` Shutdown the container.

Methods inherited from class org.jboss.weld.AbstractCDI
destroy, get, getCallingClassName, getHandler, getPriorityComparator, handlers, isAmbiguous, isResolvable, isUnsatisfied, iterator, select, select, select, select

Methods inherited from class javax.enterprise.inject.spi.CDI
setCDIProvider

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - instance
```
public static WeldContainer instance(String id)
```
    Parameters:
    
    id -
    
    Returns:
    
    the running container with the specified identifier or null if no such container exists
  - current
```
public static WeldContainer current()
```
    A convenient method for CDI.current(). Returns current WeldContainer instance if there is exactly one instance running. Throws IllegalStateException in any other case.
    
    Returns:
    
    Current WeldContainer instance if and only if exactly one instance exists
    
    Throws:
    
    {@link - IllegalStateException} if there is 0 or more than 1 instance running
  - getRunningContainerIds
```
public static List<String> getRunningContainerIds()
```
    Returns:
    
    an immutable list of ids of running containers
  - instance
```
public javax.enterprise.inject.Instance<Object> instance()
```
    Deprecated. Applications are encouraged to use methods for programmatic lookup directly.
    
    Provides access to all beans within the application. Retained for backward compatibility - WeldContainer implements Instance.
    
    Returns:
    
    the instance
  - event
```
public org.jboss.weld.events.WeldEvent<Object> event()
```
    Provides access to all events within the application. For example: weldContainer.event().select(Bar.class).fire(new Bar());
    
    Returns:
    
    the event
  - getId
```
public String getId()
```
    Weld containers must have a unique identifier assigned when there are multiple Weld instances running at once.
    
    Specified by:
    
    getId in interface org.jboss.weld.environment.ContainerInstance
    
    Returns:
    
    the container id
  - getBeanManager
```
public javax.enterprise.inject.spi.BeanManager getBeanManager()
```
    Provides direct access to the BeanManager.
    
    Specified by:
    
    getBeanManager in interface org.jboss.weld.environment.ContainerInstance
    
    Specified by:
    
    getBeanManager in class javax.enterprise.inject.spi.CDI<Object>
  - shutdown
```
public void shutdown()
```
    Shutdown the container.
    
    Specified by:
    
    shutdown in interface org.jboss.weld.environment.ContainerInstance
    
    See Also:
    
    Weld.initialize()
  - isRunning
```
public boolean isRunning()
```
    Returns:
    
    true if the container was initialized completely and is not shut down yet, false otherwise
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - getInstance
```
protected org.jboss.weld.inject.WeldInstance<Object> getInstance()
```
    Description copied from class: AbstractCDI
    
    Subclasses are allowed to override the default behavior, i.e. to cache instance per BeanManager.
    
    Overrides:
    
    getInstance in class AbstractCDI<Object>
    
    Returns:
    
    the Instance the relevant calls are delegated to
  - checkState
```
protected void checkState()
```
    Description copied from class: AbstractCDI
    
    Check whether the container is in a "valid" state, no-op by default.
    Subclasses are allowed to override the default behavior, i.e. to check whether a container is running.
    
    Overrides:
    
    checkState in class AbstractCDI<Object>

Class WeldContainer

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.weld.inject.WeldInstance

Field Summary

Fields inherited from class org.jboss.weld.AbstractCDI

Fields inherited from class javax.enterprise.inject.spi.CDI

Method Summary

Methods inherited from class org.jboss.weld.AbstractCDI

Methods inherited from class javax.enterprise.inject.spi.CDI

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

instance

current

getRunningContainerIds

instance

event

getId

getBeanManager

shutdown

isRunning

close

getInstance

checkState