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