001/* -*- mode: Java; c-basic-offset: 2; indent-tabs-mode: nil; coding: utf-8-unix -*-
002 *
003 * Copyright © 2023–2025 microBean™.
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
006 * the License. You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
011 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
012 * specific language governing permissions and limitations under the License.
013 */
014package org.microbean.bean;
015
016/**
017 * A {@link BeanException} concerning problematic <dfn>reductions</dfn>.
018 *
019 * @author <a href="https://about.me/lairdnelson" target="_top">Laird Nelson</a>
020 */
021public sealed class ReductionException extends BeanException permits AmbiguousReductionException, UnsatisfiedReductionException {
022
023  private static final long serialVersionUID = 1L;
024
025  private final transient Object criteria;
026
027  /**
028   * Creates a new {@link ReductionException}.
029   *
030   * @param criteria an {@link Object} representing reduction criteria; may be {@code null}
031   *
032   * @param message a detail message; may be {@code null}
033   *
034   * @param cause a {@link Throwable} that caused this {@link ReductionException} to be created; may be {@code null}
035   */
036  public ReductionException(final Object criteria, final String message, final Throwable cause) {
037    super(message, cause);
038    this.criteria = criteria;
039  }
040
041  /**
042   * Returns this {@link ReductionException}'s criteria object, which may be {@code null}.
043   *
044   * @return this {@link ReductionException}'s criteria object, which may be {@code null}
045   */
046  public final Object criteria() {
047    return this.criteria;
048  }
049
050  /**
051   * Returns a {@link String} reprsentation of this {@link ReductionException}.
052   *
053   * @return a {@link String} reprsentation of this {@link ReductionException}; never {@code null}
054   */
055  @Override
056  public String toString() {
057    final Object criteria = this.criteria();
058    return criteria == null ? super.toString() : super.toString() + ": criteria: " + criteria;
059  }
060
061}