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 Java beans.
026 *
027 * <h5 class='section'>Example:</h5>
028 * <p class='bjava'>
029 *    <jc>// Validates the specified POJO is the specified type and serializes to the specified value.</jc>
030 *    <jsm>assertBean</jsm>(<jv>myBean</jv>)
031 *       .isType(MyBean.<jk>class</jk>)
032 *       .asProperties(<js>"foo,bar"</js>).asJson().is(<js>"{foo:1,bar:2}"</js>);
033 * </p>
034 *
035 *
036 * <h5 class='section'>Test Methods:</h5>
037 * <p>
038 * <ul class='javatree'>
039 *    <li class='jc'>{@link FluentObjectAssertion}
040 *    <ul class='javatreec'>
041 *       <li class='jm'>{@link FluentObjectAssertion#isExists() isExists()}
042 *       <li class='jm'>{@link FluentObjectAssertion#is(Object) is(Object)}
043 *       <li class='jm'>{@link FluentObjectAssertion#is(Predicate) is(Predicate)}
044 *       <li class='jm'>{@link FluentObjectAssertion#isNot(Object) isNot(Object)}
045 *       <li class='jm'>{@link FluentObjectAssertion#isAny(Object...) isAny(Object...)}
046 *       <li class='jm'>{@link FluentObjectAssertion#isNotAny(Object...) isNotAny(Object...)}
047 *       <li class='jm'>{@link FluentObjectAssertion#isNull() isNull()}
048 *       <li class='jm'>{@link FluentObjectAssertion#isNotNull() isNotNull()}
049 *       <li class='jm'>{@link FluentObjectAssertion#isString(String) isString(String)}
050 *       <li class='jm'>{@link FluentObjectAssertion#isJson(String) isJson(String)}
051 *       <li class='jm'>{@link FluentObjectAssertion#isSame(Object) isSame(Object)}
052 *       <li class='jm'>{@link FluentObjectAssertion#isSameJsonAs(Object) isSameJsonAs(Object)}
053 *       <li class='jm'>{@link FluentObjectAssertion#isSameSortedJsonAs(Object) isSameSortedJsonAs(Object)}
054 *       <li class='jm'>{@link FluentObjectAssertion#isSameSerializedAs(Object, WriterSerializer) isSameSerializedAs(Object, WriterSerializer)}
055 *       <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)}
056 *       <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)}
057 *    </ul>
058 * </ul>
059 *
060 * <h5 class='section'>Transform Methods:</h5>
061 * <p>
062 * <ul class='javatree'>
063 *    <li class='jc'>{@link FluentBeanAssertion}
064 *    <ul class='javatreec'>
065 *       <li class='jm'>{@link FluentBeanAssertion#asPropertyMap(String...) asPropertyMap(String...)}
066 *       <li class='jm'>{@link FluentBeanAssertion#asProperty(String) asProperty(String)}
067 *       <li class='jm'>{@link FluentBeanAssertion#asProperties(String...) asProperties(String...)}
068 *    </ul>
069 *    <li class='jc'>{@link FluentObjectAssertion}
070 *    <ul class='javatreec'>
071 *       <li class='jm'>{@link FluentObjectAssertion#asString() asString()}
072 *       <li class='jm'>{@link FluentObjectAssertion#asString(WriterSerializer) asString(WriterSerializer)}
073 *       <li class='jm'>{@link FluentObjectAssertion#asString(Function) asString(Function)}
074 *       <li class='jm'>{@link FluentObjectAssertion#asJson() asJson()}
075 *       <li class='jm'>{@link FluentObjectAssertion#asJsonSorted() asJsonSorted()}
076 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(Function) asApplied(Function)}
077 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
078 * </ul>
079 * </ul>
080 *
081 * <h5 class='section'>Configuration Methods:</h5>
082 * <p>
083 * <ul class='javatree'>
084 *    <li class='jc'>{@link Assertion}
085 *    <ul class='javatreec'>
086 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
087 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
088 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
089 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
090 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
091 *    </ul>
092 * </ul>
093 *
094 * <h5 class='section'>See Also:</h5><ul>
095 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem Overview</a>
096 * </ul>
097 *
098 * @param <T> The bean type.
099 */
100public class BeanAssertion<T> extends FluentBeanAssertion<T,BeanAssertion<T>> {
101
102   /**
103    * Static creator.
104    *
105    * @param <T> The value type.
106    * @param value
107    *    The object being tested.
108    *    <br>Can be <jk>null</jk>.
109    * @return A new assertion object.
110    */
111   public static <T> BeanAssertion<T> create(T value) {
112      return new BeanAssertion<>(value);
113   }
114
115   /**
116    * Constructor.
117    *
118    * @param value
119    *    The object being tested.
120    *    <br>Can be <jk>null</jk>.
121    */
122   public BeanAssertion(T value) {
123      super(value, null);
124   }
125
126   @Override /* Overridden from Assertion */
127   public BeanAssertion<T> setMsg(String msg, Object...args) {
128      super.setMsg(msg, args);
129      return this;
130   }
131
132   @Override /* Overridden from Assertion */
133   public BeanAssertion<T> setOut(PrintStream value) {
134      super.setOut(value);
135      return this;
136   }
137
138   @Override /* Overridden from Assertion */
139   public BeanAssertion<T> setSilent() {
140      super.setSilent();
141      return this;
142   }
143
144   @Override /* Overridden from Assertion */
145   public BeanAssertion<T> setStdOut() {
146      super.setStdOut();
147      return this;
148   }
149
150   @Override /* Overridden from Assertion */
151   public BeanAssertion<T> setThrowable(Class<? extends java.lang.RuntimeException> value) {
152      super.setThrowable(value);
153      return this;
154   }
155}