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