Micronaut (micronaut 1.0.0 API)

java.lang.Object
- io.micronaut.context.DefaultApplicationContextBuilder
- - io.micronaut.runtime.Micronaut

All Implemented Interfaces:

ApplicationContextBuilder
```
public class Micronaut
extends DefaultApplicationContextBuilder
implements ApplicationContextBuilder
```
Main entry point for running a Micronaut application.

Since:

1.0

Author:

Graeme Rocher

Constructor Summary

Constructors
Modifier Constructor and Description

protected Micronaut()
The default constructor.

Constructors
Modifier	Constructor and Description
`protected`	`Micronaut()` The default constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Micronaut`	`args(String... args)` Set the command line arguments.
`static Micronaut`	`build(String... args)` Run the application for the given arguments.
`Micronaut`	`classes(Class... classes)` Add classes to be included in the initialization of the application.
`Micronaut`	`classLoader(ClassLoader classLoader)` The class loader to be used.
`Micronaut`	`environments(String... environments)` The environments to use.
`Micronaut`	`exclude(String... configurations)` Allow customizing the configurations that will be loaded.
`protected void`	`handleStartupException(Environment environment, Throwable exception)` Default handling of startup exceptions.
`Micronaut`	`include(String... configurations)` Allow customizing the configurations that will be loaded.
`Micronaut`	`mainClass(Class mainClass)` The main class used by this application.
`<T extends Throwable> Micronaut`	`mapError(Class<T> exception, Function<T,Integer> mapper)` Maps an exception to the given error code.
`Micronaut`	`packages(String... packages)` The packages to include for package scanning.
`Micronaut`	`properties(Map<String,Object> properties)` Properties to override from the environment.
`Micronaut`	`propertySources(PropertySource... propertySources)` Additional property sources.
`static ApplicationContext`	`run(Class[] classes, String... args)` Run the application for the given arguments.
`static ApplicationContext`	`run(Class cls, String... args)` Run the application for the given arguments.
`static ApplicationContext`	`run(String... args)` Run the application for the given arguments.
`Micronaut`	`singletons(Object... beans)` Additional singletons to register prior to startup.
`ApplicationContext`	`start()` Starts the `ApplicationContext`.

Methods inherited from class io.micronaut.context.DefaultApplicationContextBuilder
build

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

Methods inherited from interface io.micronaut.context.ApplicationContextBuilder
build, run

- Constructor Detail
  - Micronaut
```
protected Micronaut()
```
    The default constructor.
- Method Detail
  - start
```
public ApplicationContext start()
```
    Description copied from interface: ApplicationContextBuilder
    
    Starts the ApplicationContext.
    
    Specified by:
    
    start in interface ApplicationContextBuilder
    
    Returns:
    
    Run this Micronaut
  - include
```
public Micronaut include(@Nullable
                         String... configurations)
```
    Description copied from class: DefaultApplicationContextBuilder
    
    Allow customizing the configurations that will be loaded.
    
    Specified by:
    
    include in interface ApplicationContextBuilder
    
    Overrides:
    
    include in class DefaultApplicationContextBuilder
    
    Parameters:
    
    configurations - The configurations to include
    
    Returns:
    
    This application
  - exclude
```
public Micronaut exclude(@Nullable
                         String... configurations)
```
    Description copied from class: DefaultApplicationContextBuilder
    
    Allow customizing the configurations that will be loaded.
    
    Specified by:
    
    exclude in interface ApplicationContextBuilder
    
    Overrides:
    
    exclude in class DefaultApplicationContextBuilder
    
    Parameters:
    
    configurations - The configurations to exclude
    
    Returns:
    
    This application
  - classes
```
public Micronaut classes(@Nullable
                         Class... classes)
```
    Add classes to be included in the initialization of the application.
    
    Parameters:
    
    classes - The application
    
    Returns:
    
    The classes
  - properties
```
public Micronaut properties(@Nullable
                            Map<String,Object> properties)
```
    Description copied from interface: ApplicationContextBuilder
    
    Properties to override from the environment.
    
    Specified by:
    
    properties in interface ApplicationContextBuilder
    
    Overrides:
    
    properties in class DefaultApplicationContextBuilder
    
    Parameters:
    
    properties - The properties
    
    Returns:
    
    This builder
  - singletons
```
public Micronaut singletons(Object... beans)
```
    Description copied from interface: ApplicationContextBuilder
    
    Additional singletons to register prior to startup.
    
    Specified by:
    
    singletons in interface ApplicationContextBuilder
    
    Overrides:
    
    singletons in class DefaultApplicationContextBuilder
    
    Parameters:
    
    beans - The beans
    
    Returns:
    
    This builder
  - propertySources
```
public Micronaut propertySources(@Nullable
                                 PropertySource... propertySources)
```
    Description copied from interface: ApplicationContextBuilder
    
    Additional property sources.
    
    Specified by:
    
    propertySources in interface ApplicationContextBuilder
    
    Overrides:
    
    propertySources in class DefaultApplicationContextBuilder
    
    Parameters:
    
    propertySources - The property sources to include
    
    Returns:
    
    This builder
  - mainClass
```
public Micronaut mainClass(Class mainClass)
```
    Description copied from interface: ApplicationContextBuilder
    
    The main class used by this application.
    
    Specified by:
    
    mainClass in interface ApplicationContextBuilder
    
    Overrides:
    
    mainClass in class DefaultApplicationContextBuilder
    
    Parameters:
    
    mainClass - The main class
    
    Returns:
    
    This builder
  - classLoader
```
public Micronaut classLoader(ClassLoader classLoader)
```
    Description copied from interface: ApplicationContextBuilder
    
    The class loader to be used.
    
    Specified by:
    
    classLoader in interface ApplicationContextBuilder
    
    Overrides:
    
    classLoader in class DefaultApplicationContextBuilder
    
    Parameters:
    
    classLoader - The classloader
    
    Returns:
    
    This builder
  - args
```
public Micronaut args(@Nullable
                      String... args)
```
    Set the command line arguments.
    
    Parameters:
    
    args - The arguments
    
    Returns:
    
    This application
  - environments
```
public Micronaut environments(@Nullable
                              String... environments)
```
    Description copied from interface: ApplicationContextBuilder
    
    The environments to use.
    
    Specified by:
    
    environments in interface ApplicationContextBuilder
    
    Overrides:
    
    environments in class DefaultApplicationContextBuilder
    
    Parameters:
    
    environments - The environments
    
    Returns:
    
    This builder
  - packages
```
public Micronaut packages(@Nullable
                          String... packages)
```
    Description copied from interface: ApplicationContextBuilder
    
    The packages to include for package scanning.
    
    Specified by:
    
    packages in interface ApplicationContextBuilder
    
    Overrides:
    
    packages in class DefaultApplicationContextBuilder
    
    Parameters:
    
    packages - The packages
    
    Returns:
    
    This builder
  - mapError
```
public <T extends Throwable> Micronaut mapError(Class<T> exception,
                                                Function<T,Integer> mapper)
```
    Maps an exception to the given error code.
    
    Type Parameters:
    
    T - The exception type
    
    Parameters:
    
    exception - The exception
    
    mapper - The mapper
    
    Returns:
    
    This application
  - build
```
public static Micronaut build(String... args)
```
    Run the application for the given arguments. Classes for the application will be discovered automatically
    
    Parameters:
    
    args - The arguments
    
    Returns:
    
    The ApplicationContext
  - run
```
public static ApplicationContext run(String... args)
```
    Run the application for the given arguments. Classes for the application will be discovered automatically
    
    Parameters:
    
    args - The arguments
    
    Returns:
    
    The ApplicationContext
  - run
```
public static ApplicationContext run(Class cls,
                                     String... args)
```
    Run the application for the given arguments.
    
    Parameters:
    
    cls - The application class
    
    args - The arguments
    
    Returns:
    
    The ApplicationContext
  - run
```
public static ApplicationContext run(Class[] classes,
                                     String... args)
```
    Run the application for the given arguments.
    
    Parameters:
    
    classes - The application classes
    
    args - The arguments
    
    Returns:
    
    The ApplicationContext
  - handleStartupException
```
protected void handleStartupException(Environment environment,
                                      Throwable exception)
```
    Default handling of startup exceptions.
    
    Parameters:
    
    environment - The environment
    
    exception - The exception
    
    Throws:
    
    ApplicationStartupException - If the server cannot be shutdown with an appropriate exist code

Class Micronaut

Constructor Summary

Method Summary

Methods inherited from class io.micronaut.context.DefaultApplicationContextBuilder

Methods inherited from class java.lang.Object

Methods inherited from interface io.micronaut.context.ApplicationContextBuilder

Constructor Detail

Micronaut

Method Detail

start

include

exclude

classes

properties

singletons

propertySources

mainClass

classLoader

args

environments

packages

mapError

build

run

run

run

handleStartupException