Package io.vertx.mutiny.ext.web.common

Class WebEnvironment

java.lang.Object
io.vertx.mutiny.ext.web.common.WebEnvironment
All Implemented Interfaces:
MutinyDelegate
public class WebEnvironment extends Object implements MutinyDelegate
Utility API to verify which environment is the web application running. The utility will check initially for the existence of a system property under the name `vertx.mode`, if there is no such property then it will look under the environment variables under the name `VERTX_MODE`. This value will be then used when the API is invoked. By itself this utility will not affect the behavior of your application, however you can use it to simplify your handlers, e.g.: When the development mode is active you can log more information or disable caches.

NOTE: This class has been automatically generated from the original non Mutiny-ified interface.

Author:
Paulo Lopes
See Also:
  • WebEnvironment

  • Field Details

  • Constructor Details

    • WebEnvironment

      public WebEnvironment(io.vertx.ext.web.common.WebEnvironment delegate)
      Create a new instance of WebEnvironment delegating to the given (non-null) instance of WebEnvironment.

    • WebEnvironment

      public WebEnvironment(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.web.common.WebEnvironment getDelegate()
      Get the delegate instance.

      This method returns the instance on which this shim is delegating the calls. And so, give you access to the bare API.

      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate instance

    • development

      public static boolean development()
      Will return true if the mode is not null and equals ignoring case the string "dev"
      Returns:
      always boolean

    • mode

      public static String mode()
      The current mode from the system properties with fallback to environment variables
      Returns:
      String with mode value or null

    • newInstance

      public static WebEnvironment newInstance(io.vertx.ext.web.common.WebEnvironment delegate)
      Creates a new instance of the WebEnvironment.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object