org.appng.api

## Class InvalidConfigurationException

- java.lang.Object
- - java.lang.Throwable
  - - java.lang.Exception
    - - org.appng.api.InvalidConfigurationException

- All Implemented Interfaces:
    Serializable

      public class InvalidConfigurationException
      extends Exception

  An `InvalidConfigurationException` is a checked exception thrown by the platform whenever something goes wrong during `Application`-execution.
  Some examples:
  - a `Application` could not be found
  - a `Resource` could not be found
  - there was an error while reading a `Resource`, e.g. an invalid XML-file was found
  - etc.
  Author:
    Matthias Müller
  See Also:
    Serialized Form

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `InvalidConfigurationException(Site site, String applicationName, String message)` Create a new `InvalidConfigurationException`.
    `InvalidConfigurationException(String applicationName, String message)` Create a new `InvalidConfigurationException`.
    `InvalidConfigurationException(String applicationName, String message, Throwable cause)` Create a new `InvalidConfigurationException`.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `getApplicationName()` Returns the name of the `Application` where the error occurred, if present.
    `Site` | `getSite()` Returns the `Site` where the error occurred, if present.

    - ### Methods inherited from class java.lang.Throwable

      `addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Constructor Detail

    - #### InvalidConfigurationException

          public InvalidConfigurationException(Site site,
                                               String applicationName,
                                               String message)

      Create a new `InvalidConfigurationException`.
      Parameters:
        `site` - the `Site` where the error occurred
        `applicationName` - the name of the `Application` where the error occurred
        `message` - the error message

    - #### InvalidConfigurationException

          public InvalidConfigurationException(String applicationName,
                                               String message)

      Create a new `InvalidConfigurationException`.
      Parameters:
        `applicationName` - the name of the `Application` where the error occurred
        `message` - the error message

    - #### InvalidConfigurationException

          public InvalidConfigurationException(String applicationName,
                                               String message,
                                               Throwable cause)

      Create a new `InvalidConfigurationException`.
      Parameters:
        `applicationName` - the name of the `Application` where the error occurred
        `message` - the error message
        `cause` - the cause of the `InvalidConfigurationException`

  - ### Method Detail

    - #### getSite

          public Site getSite()

      Returns the `Site` where the error occurred, if present.
      Returns:
        the `Site`

    - #### getApplicationName

          public String getApplicationName()

      Returns the name of the `Application` where the error occurred, if present.
      Returns:
        the name of the `Application`

Copyright © 2011–2023 aiticon GmbH. All rights reserved.