org.incendo.cloud.kotlin.extension.ExceptionControllerExtensions.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cloud-kotlin-extensions Show documentation

Command framework and dispatcher for the JVM

The newest version!

//
// MIT License
//
// Copyright (c) 2024 Incendo
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//
package org.incendo.cloud.kotlin.extension

import org.checkerframework.common.returnsreceiver.qual.This
import org.incendo.cloud.exception.handling.ExceptionController
import org.incendo.cloud.exception.handling.ExceptionHandler
import org.incendo.cloud.exception.handling.ExceptionHandlerRegistration

/**
 * Decorates a registration builder using the given [decorator] and registers the result.
 *
 * The ordering matters when multiple handlers are registered tor the same exception type.
 * The last registered handler will get priority.
 *
 * @return [this] exception controller
 */
public inline fun  @This ExceptionController.register(
    decorator: ExceptionHandlerRegistration.BuilderDecorator
): ExceptionController = this.register(T::class.java, decorator)

/**
 * Registers the given [handler].
 *
 * The ordering matters when multiple handlers are registered tor the same exception type.
 * The last registered handler will get priority.
 *
 * @return [this] exception controller
 */
public inline fun  @This ExceptionController.registerHandler(
    handler: ExceptionHandler
): ExceptionController = this.registerHandler(T::class.java, handler)