001/*
002 * Licensed to the Apache Software Foundation (ASF) 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 org.apache.juneau.assertions;
018
019import java.io.*;
020import java.util.function.*;
021
022import org.apache.juneau.serializer.*;
023
024/**
025 * Used for assertion calls against throwable objects.
026 *
027 * <h5 class='section'>Example:</h5>
028 * <p class='bjava'>
029 *    <jc>// Validates the throwable message or one of the parent messages contain 'Foobar'.</jc>
030 *    <jsm>assertThrowable</jsm>(<jv>throwable</jv>).contains(<js>"Foobar"</js>);
031 * </p>
032 *
033 *
034 * <h5 class='section'>Test Methods:</h5>
035 * <p>
036 * <ul class='javatree'>
037 *    <li class='jc'>{@link FluentObjectAssertion}
038 *    <ul class='javatreec'>
039 *       <li class='jm'>{@link FluentObjectAssertion#isExists() isExists()}
040 *       <li class='jm'>{@link FluentObjectAssertion#is(Object) is(Object)}
041 *       <li class='jm'>{@link FluentObjectAssertion#is(Predicate) is(Predicate)}
042 *       <li class='jm'>{@link FluentObjectAssertion#isNot(Object) isNot(Object)}
043 *       <li class='jm'>{@link FluentObjectAssertion#isAny(Object...) isAny(Object...)}
044 *       <li class='jm'>{@link FluentObjectAssertion#isNotAny(Object...) isNotAny(Object...)}
045 *       <li class='jm'>{@link FluentObjectAssertion#isNull() isNull()}
046 *       <li class='jm'>{@link FluentObjectAssertion#isNotNull() isNotNull()}
047 *       <li class='jm'>{@link FluentObjectAssertion#isString(String) isString(String)}
048 *       <li class='jm'>{@link FluentObjectAssertion#isJson(String) isJson(String)}
049 *       <li class='jm'>{@link FluentObjectAssertion#isSame(Object) isSame(Object)}
050 *       <li class='jm'>{@link FluentObjectAssertion#isSameJsonAs(Object) isSameJsonAs(Object)}
051 *       <li class='jm'>{@link FluentObjectAssertion#isSameSortedJsonAs(Object) isSameSortedJsonAs(Object)}
052 *       <li class='jm'>{@link FluentObjectAssertion#isSameSerializedAs(Object, WriterSerializer) isSameSerializedAs(Object, WriterSerializer)}
053 *       <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)}
054 *       <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)}
055 *    </ul>
056 * </ul>
057 *
058 * <h5 class='section'>Transform Methods:</h5>
059 * <p>
060 * <ul class='javatree'>
061 *    <li class='jc'>{@link FluentThrowableAssertion}
062 *    <ul class='javatreec'>
063 *       <li class='jm'>{@link FluentThrowableAssertion#asMessage() asMessage()}
064 *       <li class='jm'>{@link FluentThrowableAssertion#asMessages() asMessages()}
065 *       <li class='jm'>{@link FluentThrowableAssertion#asLocalizedMessage() asLocalizedMessage()}
066 *       <li class='jm'>{@link FluentThrowableAssertion#asLocalizedMessages() asLocalizedMessages()}
067 *       <li class='jm'>{@link FluentThrowableAssertion#asStackTrace() asStackTrace()}
068 *       <li class='jm'>{@link FluentThrowableAssertion#asCausedBy() asCausedBy()}
069 *       <li class='jm'>{@link FluentThrowableAssertion#asCausedBy(Class) asCausedBy(Class)}
070 *       <li class='jm'>{@link FluentThrowableAssertion#asFind(Class) asFind(Class)}
071 *    </ul>
072 *    <li class='jc'>{@link FluentObjectAssertion}
073 *    <ul class='javatreec'>
074 *       <li class='jm'>{@link FluentObjectAssertion#asString() asString()}
075 *       <li class='jm'>{@link FluentObjectAssertion#asString(WriterSerializer) asString(WriterSerializer)}
076 *       <li class='jm'>{@link FluentObjectAssertion#asString(Function) asString(Function)}
077 *       <li class='jm'>{@link FluentObjectAssertion#asJson() asJson()}
078 *       <li class='jm'>{@link FluentObjectAssertion#asJsonSorted() asJsonSorted()}
079 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(Function) asApplied(Function)}
080 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
081 * </ul>
082 * </ul>
083 *
084 * <h5 class='section'>Configuration Methods:</h5>
085 * <p>
086 * <ul class='javatree'>
087 *    <li class='jc'>{@link Assertion}
088 *    <ul class='javatreec'>
089 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
090 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
091 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
092 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
093 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
094 *    </ul>
095 * </ul>
096 *
097 * <h5 class='section'>See Also:</h5><ul>
098 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem Overview</a>
099 * </ul>
100 *
101 * @param <T> The throwable type.
102 */
103public class ThrowableAssertion<T extends Throwable> extends FluentThrowableAssertion<T,ThrowableAssertion<T>> {
104
105   /**
106    * Static creator.
107    *
108    * @param <X> The throwable type.
109    * @param value
110    *    The object being tested.
111    *    <br>Can be <jk>null</jk>.
112    * @return A new assertion object.
113    */
114   public static <X extends Throwable> ThrowableAssertion<X> create(X value) {
115      return new ThrowableAssertion<>(value);
116   }
117
118   /**
119    * Constructor.
120    *
121    * @param value
122    *    The object being tested.
123    *    <br>Can be <jk>null</jk>.
124    */
125   public ThrowableAssertion(T value) {
126      super(value, null);
127   }
128
129   @Override /* Overridden from Assertion */
130   public ThrowableAssertion<T> setMsg(String msg, Object...args) {
131      super.setMsg(msg, args);
132      return this;
133   }
134
135   @Override /* Overridden from Assertion */
136   public ThrowableAssertion<T> setOut(PrintStream value) {
137      super.setOut(value);
138      return this;
139   }
140
141   @Override /* Overridden from Assertion */
142   public ThrowableAssertion<T> setSilent() {
143      super.setSilent();
144      return this;
145   }
146
147   @Override /* Overridden from Assertion */
148   public ThrowableAssertion<T> setStdOut() {
149      super.setStdOut();
150      return this;
151   }
152
153   @Override /* Overridden from Assertion */
154   public ThrowableAssertion<T> setThrowable(Class<? extends java.lang.RuntimeException> value) {
155      super.setThrowable(value);
156      return this;
157   }
158}