Class 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

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

        allowEmptyProviders, bootstrapEnvironment, build, deduceEnvironment, eagerInitAnnotated, enableDefaultPropertySources, getClassLoader, getDeduceEnvironments, getDefaultEnvironments, getEagerInitAnnotated, getEnvironments, getEnvironmentVariableExcludes, getEnvironmentVariableIncludes, getOverrideConfigLocations, getResourceLoader, isAllowEmptyProviders, isBannerEnabled, isBootstrapEnvironmentEnabled, 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, 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 Detail

      • Micronaut

        protected Micronaut()
        The default constructor.
    • Method Detail

      • start

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

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

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

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

        @NonNull
        public Micronaut classes​(@Nullable
                                 java.lang.Class... classes)
        Add classes to be included in the initialization of the application.
        Parameters:
        classes - The application
        Returns:
        The classes
      • properties

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

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

        @NonNull
        public Micronaut propertySources​(@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 Micronaut environmentPropertySource​(boolean environmentPropertySource)
        Specified by:
        environmentPropertySource in interface io.micronaut.context.ApplicationContextBuilder
        Overrides:
        environmentPropertySource in class io.micronaut.context.DefaultApplicationContextBuilder
      • environmentVariableIncludes

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

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

        @NonNull
        public Micronaut mainClass​(java.lang.Class mainClass)
        Specified by:
        mainClass in interface io.micronaut.context.ApplicationContextBuilder
        Overrides:
        mainClass in class io.micronaut.context.DefaultApplicationContextBuilder
      • classLoader

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

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

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

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

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

        public <T extends java.lang.Throwable> Micronaut mapError​(java.lang.Class<T> exception,
                                                                  java.util.function.Function<T,​java.lang.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​(java.lang.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​(java.lang.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​(java.lang.Class cls,
                                                                  java.lang.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​(java.lang.Class[] classes,
                                                                  java.lang.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,
                                              java.lang.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