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