Package io.micronaut.runtime

Class Micronaut

java.lang.Object
io.micronaut.context.DefaultApplicationContextBuilder
io.micronaut.runtime.Micronaut
All Implemented Interfaces:
io.micronaut.context.ApplicationContextBuilder, io.micronaut.context.ApplicationContextConfiguration, io.micronaut.context.BeanContextConfiguration
public class Micronaut extends io.micronaut.context.DefaultApplicationContextBuilder implements io.micronaut.context.ApplicationContextBuilder

Main entry point for running a Micronaut application.

Since:
1.0

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull Micronaut
    args(@Nullable String... args)
     
    @NonNull Micronaut
    banner(boolean isEnabled)
     
    static Micronaut
    build(String... args)
    Run the application for the given arguments.
    @NonNull Micronaut
    classes(@Nullable Class<?>... classes)
    Add classes to be included in the initialization of the application.
    @NonNull Micronaut
    classLoader(ClassLoader classLoader)
     
    @NonNull Micronaut
    defaultEnvironments(@Nullable String... environments)
     
    @NonNull Micronaut
    environmentPropertySource(boolean environmentPropertySource)
     
    @NonNull Micronaut
    environments(@Nullable String... environments)
     
    @NonNull Micronaut
    environmentVariableExcludes(@Nullable String... environmentVariables)
     
    @NonNull Micronaut
    environmentVariableIncludes(@Nullable String... environmentVariables)
     
    @NonNull Micronaut
    exclude(@Nullable String... configurations)
     
    protected void
    handleStartupException(io.micronaut.context.env.Environment environment, Throwable exception)
    Default handling of startup exceptions.
    @NonNull Micronaut
    include(@Nullable String... configurations)
     
    @NonNull Micronaut
    mainClass(Class<?> mainClass)
     
    <T extends Throwable>
    Micronaut
    mapError(Class<T> exception, Function<T,Integer> mapper)
    Maps an exception to the given error code.
    @NonNull Micronaut
    packages(@Nullable String... packages)
     
    @NonNull Micronaut
    properties(@Nullable Map<String,Object> properties)
     
    @NonNull Micronaut
    propertySources(@Nullable io.micronaut.context.env.PropertySource... propertySources)
     
    static io.micronaut.context.ApplicationContext
    run(Class<?>[] classes, String... args)
    Run the application for the given arguments.
    static io.micronaut.context.ApplicationContext
    run(Class<?> cls, String... args)
    Run the application for the given arguments.
    static io.micronaut.context.ApplicationContext
    run(String... args)
    Run the application for the given arguments.
    @NonNull Micronaut
    singletons(Object... beans)
     
    @NonNull io.micronaut.context.ApplicationContext
    start()
     

    Methods inherited from class io.micronaut.context.DefaultApplicationContextBuilder

    allowEmptyProviders, bootstrapEnvironment, build, deduceCloudEnvironment, deduceEnvironment, eagerInitAnnotated, enableDefaultPropertySources, getClassLoader, getDeduceEnvironments, getDefaultEnvironments, getEagerInitAnnotated, getEnvironments, getEnvironmentVariableExcludes, getEnvironmentVariableIncludes, getOverrideConfigLocations, getResourceLoader, isAllowEmptyProviders, isBannerEnabled, isBootstrapEnvironmentEnabled, isDeduceCloudEnvironment, isEnableDefaultPropertySources, isEnvironmentPropertySource, newApplicationContext, overrideConfigLocations

    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

    allowEmptyProviders, bootstrapEnvironment, build, deduceCloudEnvironment, deduceEnvironment, eagerInitAnnotated, eagerInitConfiguration, eagerInitSingletons, enableDefaultPropertySources, overrideConfigLocations, run

    Methods inherited from interface io.micronaut.context.ApplicationContextConfiguration

    getConversionService

    Methods inherited from interface io.micronaut.context.BeanContextConfiguration

    isEagerInitConfiguration, isEagerInitSingletons

  • Constructor Details

    • Micronaut

      protected Micronaut()
      The default constructor.

  • Method Details

    • start

      @NonNull public @NonNull io.micronaut.context.ApplicationContext start()
      Specified by:
      start in interface io.micronaut.context.ApplicationContextBuilder
      Returns:
      Run this Micronaut

    • include

      @NonNull public @NonNull Micronaut include(@Nullable @Nullable String... configurations)
      Specified by:
      include in interface io.micronaut.context.ApplicationContextBuilder
      Overrides:
      include in class io.micronaut.context.DefaultApplicationContextBuilder

    • exclude

      @NonNull public @NonNull Micronaut exclude(@Nullable @Nullable String... configurations)
      Specified by:
      exclude in interface io.micronaut.context.ApplicationContextBuilder
      Overrides:
      exclude in class io.micronaut.context.DefaultApplicationContextBuilder

    • banner

      @NonNull public @NonNull Micronaut banner(boolean isEnabled)
      Specified by:
      banner in interface io.micronaut.context.ApplicationContextBuilder
      Overrides:
      banner in class io.micronaut.context.DefaultApplicationContextBuilder

    • classes

      @NonNull public @NonNull Micronaut classes(@Nullable @Nullable Class<?>... classes)
      Add classes to be included in the initialization of the application.
      Parameters:
      classes - The application
      Returns:
      The classes

    • properties

      @NonNull public @NonNull Micronaut properties(@Nullable @Nullable Map<String,Object> properties)
      Specified by:
      properties in interface io.micronaut.context.ApplicationContextBuilder
      Overrides:
      properties in class io.micronaut.context.DefaultApplicationContextBuilder

    • singletons

      @NonNull public @NonNull Micronaut singletons(Object... beans)
      Specified by:
      singletons in interface io.micronaut.context.ApplicationContextBuilder
      Overrides:
      singletons in class io.micronaut.context.DefaultApplicationContextBuilder

    • propertySources

      @NonNull public @NonNull Micronaut propertySources(@Nullable @Nullable io.micronaut.context.env.PropertySource... propertySources)
      Specified by:
      propertySources in interface io.micronaut.context.ApplicationContextBuilder
      Overrides:
      propertySources in class io.micronaut.context.DefaultApplicationContextBuilder

    • environmentPropertySource

      @NonNull public @NonNull Micronaut environmentPropertySource(boolean environmentPropertySource)
      Specified by:
      environmentPropertySource in interface io.micronaut.context.ApplicationContextBuilder
      Overrides:
      environmentPropertySource in class io.micronaut.context.DefaultApplicationContextBuilder

    • environmentVariableIncludes

      @NonNull public @NonNull Micronaut environmentVariableIncludes(@Nullable @Nullable String... environmentVariables)
      Specified by:
      environmentVariableIncludes in interface io.micronaut.context.ApplicationContextBuilder
      Overrides:
      environmentVariableIncludes in class io.micronaut.context.DefaultApplicationContextBuilder

    • environmentVariableExcludes

      @NonNull public @NonNull Micronaut environmentVariableExcludes(@Nullable @Nullable String... environmentVariables)
      Specified by:
      environmentVariableExcludes in interface io.micronaut.context.ApplicationContextBuilder
      Overrides:
      environmentVariableExcludes in class io.micronaut.context.DefaultApplicationContextBuilder

    • mainClass

      @NonNull public @NonNull Micronaut mainClass(Class<?> mainClass)
      Specified by:
      mainClass in interface io.micronaut.context.ApplicationContextBuilder
      Overrides:
      mainClass in class io.micronaut.context.DefaultApplicationContextBuilder

    • classLoader

      @NonNull public @NonNull Micronaut classLoader(ClassLoader classLoader)
      Specified by:
      classLoader in interface io.micronaut.context.ApplicationContextBuilder
      Overrides:
      classLoader in class io.micronaut.context.DefaultApplicationContextBuilder

    • args

      @NonNull public @NonNull Micronaut args(@Nullable @Nullable String... args)
      Specified by:
      args in interface io.micronaut.context.ApplicationContextBuilder
      Overrides:
      args in class io.micronaut.context.DefaultApplicationContextBuilder

    • environments

      @NonNull public @NonNull Micronaut environments(@Nullable @Nullable String... environments)
      Specified by:
      environments in interface io.micronaut.context.ApplicationContextBuilder
      Overrides:
      environments in class io.micronaut.context.DefaultApplicationContextBuilder

    • defaultEnvironments

      @NonNull public @NonNull Micronaut defaultEnvironments(@Nullable @Nullable String... environments)
      Specified by:
      defaultEnvironments in interface io.micronaut.context.ApplicationContextBuilder
      Overrides:
      defaultEnvironments in class io.micronaut.context.DefaultApplicationContextBuilder

    • packages

      @NonNull public @NonNull Micronaut packages(@Nullable @Nullable String... packages)
      Specified by:
      packages in interface io.micronaut.context.ApplicationContextBuilder
      Overrides:
      packages in class io.micronaut.context.DefaultApplicationContextBuilder

    • 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 io.micronaut.context.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 io.micronaut.context.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 io.micronaut.context.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(io.micronaut.context.env.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