Class List Method List File List

# Class: VertxWeb::ErrorHandler

Inherits:
  Object
  - Object
  - VertxWeb::ErrorHandler
  show all
Defined in:
  /Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/error_handler.rb

## Overview

A pretty error handler for rendering error pages.

## Constant Summary

@@j_api_type =

      Object.new

## Class Method Summary (collapse)

- + (Boolean) accept?(obj)
- + (::VertxWeb::ErrorHandler) create(param_1 = nil, param_2 = nil)
  Create an error handler.
- + (Object) DEFAULT_DISPLAY_EXCEPTION_DETAILS
  Should exception details be displayed by default?.
- + (Object) DEFAULT_ERROR_HANDLER_TEMPLATE
  The default template to use for rendering.
- + (Object) j_api_type
- + (Object) j_class
- + (Object) unwrap(obj)
- + (Object) wrap(obj)

## Instance Method Summary (collapse)

- - (void) handle(event = nil)
  Something has happened, so handle it.

## Class Method Details

### + (`Boolean`) accept?(obj)

Returns:

- (`Boolean`)

    18
    19
    20
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/error_handler.rb', line 18

    def @@j_api_type.accept?(obj)
      obj.class == ErrorHandler
    end

### + (`::VertxWeb::ErrorHandler`) create + (`::VertxWeb::ErrorHandler`) create(displayExceptionDetails) + (`::VertxWeb::ErrorHandler`) create(errorTemplateName) + (`::VertxWeb::ErrorHandler`) create(errorTemplateName, displayExceptionDetails)

Create an error handler

Overloads:

- + (`::VertxWeb::ErrorHandler`) create(displayExceptionDetails)

  Parameters:

  - displayExceptionDetails (`true`, `false`) —
    true if exception details should be displayed
- + (`::VertxWeb::ErrorHandler`) create(errorTemplateName)

  Parameters:

  - errorTemplateName (`String`) —
    the error template name - will be looked up from the classpath
- + (`::VertxWeb::ErrorHandler`) create(errorTemplateName, displayExceptionDetails)

  Parameters:

  - errorTemplateName (`String`) —
    the error template name - will be looked up from the classpath
  - displayExceptionDetails (`true`, `false`) —
    true if exception details should be displayed

Returns:

- (`::VertxWeb::ErrorHandler`) —
  the handler

Raises:

- (`ArgumentError`)

    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/error_handler.rb', line 52

    def self.create(param_1=nil,param_2=nil)
      if !block_given? && param_1 == nil && param_2 == nil
        return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtWebHandler::ErrorHandler.java_method(:create, []).call(),::VertxWeb::ErrorHandler)
      elsif (param_1.class == TrueClass || param_1.class == FalseClass) && !block_given? && param_2 == nil
        return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtWebHandler::ErrorHandler.java_method(:create, [Java::boolean.java_class]).call(param_1),::VertxWeb::ErrorHandler)
      elsif param_1.class == String && !block_given? && param_2 == nil
        return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtWebHandler::ErrorHandler.java_method(:create, [Java::java.lang.String.java_class]).call(param_1),::VertxWeb::ErrorHandler)
      elsif param_1.class == String && (param_2.class == TrueClass || param_2.class == FalseClass) && !block_given?
        return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtWebHandler::ErrorHandler.java_method(:create, [Java::java.lang.String.java_class,Java::boolean.java_class]).call(param_1,param_2),::VertxWeb::ErrorHandler)
      end
      raise ArgumentError, "Invalid arguments when calling create(#{param_1},#{param_2})"
    end

### + (`Object`) DEFAULT_DISPLAY_EXCEPTION_DETAILS

Should exception details be displayed by default?

    69
    70
    71
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/error_handler.rb', line 69

    def self.DEFAULT_DISPLAY_EXCEPTION_DETAILS
      Java::IoVertxExtWebHandler::ErrorHandler.DEFAULT_DISPLAY_EXCEPTION_DETAILS
    end

### + (`Object`) DEFAULT_ERROR_HANDLER_TEMPLATE

The default template to use for rendering

    65
    66
    67
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/error_handler.rb', line 65

    def self.DEFAULT_ERROR_HANDLER_TEMPLATE
      Java::IoVertxExtWebHandler::ErrorHandler.DEFAULT_ERROR_HANDLER_TEMPLATE
    end

### + (`Object`) j_api_type

    27
    28
    29
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/error_handler.rb', line 27

    def self.j_api_type
      @@j_api_type
    end

### + (`Object`) j_class

    30
    31
    32
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/error_handler.rb', line 30

    def self.j_class
      Java::IoVertxExtWebHandler::ErrorHandler.java_class
    end

### + (`Object`) unwrap(obj)

    24
    25
    26
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/error_handler.rb', line 24

    def @@j_api_type.unwrap(obj)
      obj.j_del
    end

### + (`Object`) wrap(obj)

    21
    22
    23
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/error_handler.rb', line 21

    def @@j_api_type.wrap(obj)
      ErrorHandler.new(obj)
    end

## Instance Method Details

### - (`void`) handle(event = nil)

This method returns an undefined value.

Something has happened, so handle it.

Parameters:

- event (`::VertxWeb::RoutingContext`) (defaults to: `nil`) —
  the event to handle

Raises:

- (`ArgumentError`)

    36
    37
    38
    39
    40
    41
    # File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/error_handler.rb', line 36

    def handle(event=nil)
      if event.class.method_defined?(:j_del) && !block_given?
        return @j_del.java_method(:handle, [Java::IoVertxExtWeb::RoutingContext.java_class]).call(event.j_del)
      end
      raise ArgumentError, "Invalid arguments when calling handle(#{event})"
    end