001/*
002 * Licensed to the author under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 * http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package de.cuioss.test.generator.internal.net.java.quickcheck;
018
019import lombok.Getter;
020
021/**
022 * Indicates that a characteristic specification was not true for a given
023 * instance.
024 */
025@SuppressWarnings("java:S1948") // owolff: not a problem for test-code
026public class CharacteristicException extends RuntimeException {
027
028    private static final long serialVersionUID = 1L;
029
030    private final Object instance;
031
032    @Getter
033    private final Characteristic<?> charateristic;
034
035    /**
036     * @param message       error message
037     * @param cause         causing exception thrown by characteristic
038     * @param charateristic characteristic violated
039     */
040    public CharacteristicException(String message, Throwable cause, Characteristic<?> charateristic) {
041        this(message, cause, charateristic, null);
042    }
043
044    /**
045     * @param message       error message
046     * @param cause         causing exception thrown by characteristic
047     * @param instance      violating the specified characteristic
048     * @param charateristic characteristic violated
049     */
050    public CharacteristicException(String message, Throwable cause, Characteristic<?> charateristic, Object instance) {
051        super(message, cause);
052        this.instance = instance;
053        this.charateristic = charateristic;
054    }
055
056    /**
057     * Instance causing the characteristic violation.
058     *
059     * @return the violating instance
060     */
061    public Object getInstance() {
062        return instance;
063    }
064}