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.bct.assertions;
018
019import java.io.*;
020import java.util.*;
021import java.util.function.*;
022
023
024/**
025 * Used for assertion calls against collections objects.
026 *
027 * <h5 class='section'>Example:</h5>
028 * <p class='bjava'>
029 *    <jc>// Validates the specified list is not empty.</jc>
030 *    <jsm>assertCollection</jsm>(<jv>myList</jv>).isNotEmpty();
031 * </p>
032 *
033 * <h5 class='section'>Test Methods:</h5>
034 * <p>
035 * <ul class='javatree'>
036 *    <li class='jc'>{@link FluentCollectionAssertion}
037 *    <ul class='javatreec'>
038 *       <li class='jm'>{@link FluentCollectionAssertion#isEmpty() isEmpty()}
039 *       <li class='jm'>{@link FluentCollectionAssertion#isNotEmpty() isNotEmpty()}
040 *       <li class='jm'>{@link FluentCollectionAssertion#isContains(Object) isContains(Object)}
041 *       <li class='jm'>{@link FluentCollectionAssertion#isNotContains(Object) isNotContains(Object)}
042 *       <li class='jm'>{@link FluentCollectionAssertion#isAny(Predicate) isAny(Predicate)}
043 *       <li class='jm'>{@link FluentCollectionAssertion#isAll(Predicate) isAll(Predicate)}
044 *       <li class='jm'>{@link FluentCollectionAssertion#isSize(int size) isSize(int size)}
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#isSame(Object) isSame(Object)}
058 *       <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)}
059 *       <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)}
060 *    </ul>
061 * </ul>
062 *
063 * <h5 class='section'>Transform Methods:</h5>
064 * <p>
065 * <ul class='javatree'>
066 *    <li class='jc'>{@link FluentCollectionAssertion}
067 *    <ul class='javatreec'>
068 *       <li class='jm'>{@link FluentCollectionAssertion#asStrings() asStrings()}
069 *       <li class='jm'>{@link FluentCollectionAssertion#asSize() asSize()}
070 *    </ul>
071 *    <li class='jc'>{@link FluentObjectAssertion}
072 *    <ul class='javatreec'>
073 *       <li class='jm'>{@link FluentObjectAssertion#asString() asString()}
074 *       <li class='jm'>{@link FluentObjectAssertion#asString(ThrowingFunction) asString(ThrowingFunction)}
075 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(UnaryOperator) asTransformed(UnaryOperator)}
076 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
077 * </ul>
078 * </ul>
079 *
080 * <h5 class='section'>Configuration Methods:</h5>
081 * <p>
082 * <ul class='javatree'>
083 *    <li class='jc'>{@link Assertion}
084 *    <ul class='javatreec'>
085 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
086 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
087 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
088 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
089 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
090 *    </ul>
091 * </ul>
092 *
093 * <h5 class='section'>See Also:</h5><ul>
094 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem</a>
095 * </ul>
096 *
097 * @param <E> The element type.
098 */
099public class CollectionAssertion<E> extends FluentCollectionAssertion<E,CollectionAssertion<E>> {
100
101   /**
102    * Static creator.
103    *
104    * @param <E> The element type.
105    * @param value
106    *    The object being tested.
107    *    <br>Can be <jk>null</jk> (assertions such as {@code isNull()} then operate on the absence of a value).
108    * @return A new assertion object.
109    */
110   public static <E> CollectionAssertion<E> create(Collection<E> value) {
111      return new CollectionAssertion<>(value);
112   }
113
114   /**
115    * Constructor.
116    *
117    * @param value
118    *    The object being tested.
119    *    <br>Can be <jk>null</jk> (assertions such as {@code isNull()} then operate on the absence of a value).
120    */
121   public CollectionAssertion(Collection<E> value) {
122      super(value, null);
123   }
124
125   @Override /* Overridden from Assertion */
126   public CollectionAssertion<E> setMsg(String msg, Object...args) {
127      super.setMsg(msg, args);
128      return this;
129   }
130
131   @Override /* Overridden from Assertion */
132   public CollectionAssertion<E> setOut(PrintStream value) {
133      super.setOut(value);
134      return this;
135   }
136
137   @Override /* Overridden from Assertion */
138   public CollectionAssertion<E> setSilent() {
139      super.setSilent();
140      return this;
141   }
142
143   @Override /* Overridden from Assertion */
144   public CollectionAssertion<E> setStdOut() {
145      super.setStdOut();
146      return this;
147   }
148
149   @Override /* Overridden from Assertion */
150   public CollectionAssertion<E> setThrowable(Class<? extends RuntimeException> value) {
151      super.setThrowable(value);
152      return this;
153   }
154}