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 collections objects.
028 *
029 * <h5 class='section'>Example:</h5>
030 * <p class='bjava'>
031 *    <jc>// Validates the specified list is not empty.</jc>
032 *    <jsm>assertCollection</jsm>(<jv>myList</jv>).isNotEmpty();
033 * </p>
034 *
035 * <h5 class='section'>Test Methods:</h5>
036 * <p>
037 * <ul class='javatree'>
038 *    <li class='jc'>{@link FluentCollectionAssertion}
039 *    <ul class='javatreec'>
040 *       <li class='jm'>{@link FluentCollectionAssertion#isEmpty() isEmpty()}
041 *       <li class='jm'>{@link FluentCollectionAssertion#isNotEmpty() isNotEmpty()}
042 *       <li class='jm'>{@link FluentCollectionAssertion#isContains(Object) isContains(Object)}
043 *       <li class='jm'>{@link FluentCollectionAssertion#isNotContains(Object) isNotContains(Object)}
044 *       <li class='jm'>{@link FluentCollectionAssertion#isAny(Predicate) isAny(Predicate)}
045 *       <li class='jm'>{@link FluentCollectionAssertion#isAll(Predicate) isAll(Predicate)}
046 *       <li class='jm'>{@link FluentCollectionAssertion#isSize(int size) isSize(int size)}
047 *    </ul>
048 *    <li class='jc'>{@link FluentObjectAssertion}
049 *    <ul class='javatreec'>
050 *       <li class='jm'>{@link FluentObjectAssertion#isExists() isExists()}
051 *       <li class='jm'>{@link FluentObjectAssertion#is(Object) is(Object)}
052 *       <li class='jm'>{@link FluentObjectAssertion#is(Predicate) is(Predicate)}
053 *       <li class='jm'>{@link FluentObjectAssertion#isNot(Object) isNot(Object)}
054 *       <li class='jm'>{@link FluentObjectAssertion#isAny(Object...) isAny(Object...)}
055 *       <li class='jm'>{@link FluentObjectAssertion#isNotAny(Object...) isNotAny(Object...)}
056 *       <li class='jm'>{@link FluentObjectAssertion#isNull() isNull()}
057 *       <li class='jm'>{@link FluentObjectAssertion#isNotNull() isNotNull()}
058 *       <li class='jm'>{@link FluentObjectAssertion#isString(String) isString(String)}
059 *       <li class='jm'>{@link FluentObjectAssertion#isJson(String) isJson(String)}
060 *       <li class='jm'>{@link FluentObjectAssertion#isSame(Object) isSame(Object)}
061 *       <li class='jm'>{@link FluentObjectAssertion#isSameJsonAs(Object) isSameJsonAs(Object)}
062 *       <li class='jm'>{@link FluentObjectAssertion#isSameSortedJsonAs(Object) isSameSortedJsonAs(Object)}
063 *       <li class='jm'>{@link FluentObjectAssertion#isSameSerializedAs(Object, WriterSerializer) isSameSerializedAs(Object, WriterSerializer)}
064 *       <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)}
065 *       <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)}
066 *    </ul>
067 * </ul>
068 *
069 * <h5 class='section'>Transform Methods:</h5>
070 * <p>
071 * <ul class='javatree'>
072 *    <li class='jc'>{@link FluentCollectionAssertion}
073 *    <ul class='javatreec'>
074 *       <li class='jm'>{@link FluentCollectionAssertion#asStrings() asStrings()}
075 *       <li class='jm'>{@link FluentCollectionAssertion#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 <E> The element type.
107 */
108public class CollectionAssertion<E> extends FluentCollectionAssertion<E,CollectionAssertion<E>> {
109
110   //-----------------------------------------------------------------------------------------------------------------
111   // Static
112   //-----------------------------------------------------------------------------------------------------------------
113
114   /**
115    * Static creator.
116    *
117    * @param <E> The element type.
118    * @param value
119    *    The object being tested.
120    *    <br>Can be <jk>null</jk>.
121    * @return A new assertion object.
122    */
123   public static <E> CollectionAssertion<E> create(Collection<E> value) {
124      return new CollectionAssertion<>(value);
125   }
126
127   //-----------------------------------------------------------------------------------------------------------------
128   // Instance
129   //-----------------------------------------------------------------------------------------------------------------
130
131   /**
132    * Constructor.
133    *
134    * @param value
135    *    The object being tested.
136    *    <br>Can be <jk>null</jk>.
137    */
138   public CollectionAssertion(Collection<E> value) {
139      super(value, null);
140   }
141
142   //-----------------------------------------------------------------------------------------------------------------
143   // Fluent setters
144   //-----------------------------------------------------------------------------------------------------------------
145   @Override /* Overridden from Assertion */
146   public CollectionAssertion<E> setMsg(String msg, Object...args) {
147      super.setMsg(msg, args);
148      return this;
149   }
150
151   @Override /* Overridden from Assertion */
152   public CollectionAssertion<E> setOut(PrintStream value) {
153      super.setOut(value);
154      return this;
155   }
156
157   @Override /* Overridden from Assertion */
158   public CollectionAssertion<E> setSilent() {
159      super.setSilent();
160      return this;
161   }
162
163   @Override /* Overridden from Assertion */
164   public CollectionAssertion<E> setStdOut() {
165      super.setStdOut();
166      return this;
167   }
168
169   @Override /* Overridden from Assertion */
170   public CollectionAssertion<E> setThrowable(Class<? extends java.lang.RuntimeException> value) {
171      super.setThrowable(value);
172      return this;
173   }
174}