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 * <h2 class='section'>Example:</h2> 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 * <h2 class='section'>Test Methods:</h2> 034 * <ul class='javatree'> 035 * <li class='jc'>{@link FluentCollectionAssertion} 036 * <ul class='javatreec'> 037 * <li class='jm'>{@link FluentCollectionAssertion#isEmpty() isEmpty()} 038 * <li class='jm'>{@link FluentCollectionAssertion#isNotEmpty() isNotEmpty()} 039 * <li class='jm'>{@link FluentCollectionAssertion#isContains(Object) isContains(Object)} 040 * <li class='jm'>{@link FluentCollectionAssertion#isNotContains(Object) isNotContains(Object)} 041 * <li class='jm'>{@link FluentCollectionAssertion#isAny(Predicate) isAny(Predicate)} 042 * <li class='jm'>{@link FluentCollectionAssertion#isAll(Predicate) isAll(Predicate)} 043 * <li class='jm'>{@link FluentCollectionAssertion#isSize(int size) isSize(int size)} 044 * </ul> 045 * <li class='jc'>{@link FluentObjectAssertion} 046 * <ul class='javatreec'> 047 * <li class='jm'>{@link FluentObjectAssertion#isExists() isExists()} 048 * <li class='jm'>{@link FluentObjectAssertion#is(Object) is(Object)} 049 * <li class='jm'>{@link FluentObjectAssertion#is(Predicate) is(Predicate)} 050 * <li class='jm'>{@link FluentObjectAssertion#isNot(Object) isNot(Object)} 051 * <li class='jm'>{@link FluentObjectAssertion#isAny(Object...) isAny(Object...)} 052 * <li class='jm'>{@link FluentObjectAssertion#isNotAny(Object...) isNotAny(Object...)} 053 * <li class='jm'>{@link FluentObjectAssertion#isNull() isNull()} 054 * <li class='jm'>{@link FluentObjectAssertion#isNotNull() isNotNull()} 055 * <li class='jm'>{@link FluentObjectAssertion#isString(String) isString(String)} 056 * <li class='jm'>{@link FluentObjectAssertion#isSame(Object) isSame(Object)} 057 * <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)} 058 * <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)} 059 * </ul> 060 * </ul> 061 * 062 * <h2 class='section'>Transform Methods:</h2> 063 * <ul class='javatree'> 064 * <li class='jc'>{@link FluentCollectionAssertion} 065 * <ul class='javatreec'> 066 * <li class='jm'>{@link FluentCollectionAssertion#asStrings() asStrings()} 067 * <li class='jm'>{@link FluentCollectionAssertion#asSize() asSize()} 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(ThrowingFunction) asString(ThrowingFunction)} 073 * <li class='jm'>{@link FluentObjectAssertion#asTransformed(UnaryOperator) asTransformed(UnaryOperator)} 074 * <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()} 075 * </ul> 076 * </ul> 077 * 078 * <h2 class='section'>Configuration Methods:</h2> 079 * <ul class='javatree'> 080 * <li class='jc'>{@link Assertion} 081 * <ul class='javatreec'> 082 * <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)} 083 * <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)} 084 * <li class='jm'>{@link Assertion#setSilent() setSilent()} 085 * <li class='jm'>{@link Assertion#setStdOut() setStdOut()} 086 * <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)} 087 * </ul> 088 * </ul> 089 * 090 * <h2 class='section'>See Also:</h2><ul> 091 * <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem</a> 092 * </ul> 093 * 094 * @param <E> The element type. 095 */ 096public class CollectionAssertion<E> extends FluentCollectionAssertion<E,CollectionAssertion<E>> { 097 098 /** 099 * Static creator. 100 * 101 * @param <E> The element type. 102 * @param value 103 * The object being tested. 104 * <br>Can be <jk>null</jk> (assertions such as {@code isNull()} then operate on the absence of a value). 105 * @return A new assertion object. 106 */ 107 public static <E> CollectionAssertion<E> create(Collection<E> value) { 108 return new CollectionAssertion<>(value); 109 } 110 111 /** 112 * Constructor. 113 * 114 * @param value 115 * The object being tested. 116 * <br>Can be <jk>null</jk> (assertions such as {@code isNull()} then operate on the absence of a value). 117 */ 118 public CollectionAssertion(Collection<E> value) { 119 super(value, null); 120 } 121 122 @Override /* Overridden from Assertion */ 123 public CollectionAssertion<E> setMsg(String msg, Object...args) { 124 super.setMsg(msg, args); 125 return this; 126 } 127 128 @Override /* Overridden from Assertion */ 129 public CollectionAssertion<E> setOut(PrintStream value) { 130 super.setOut(value); 131 return this; 132 } 133 134 @Override /* Overridden from Assertion */ 135 public CollectionAssertion<E> setSilent() { 136 super.setSilent(); 137 return this; 138 } 139 140 @Override /* Overridden from Assertion */ 141 public CollectionAssertion<E> setStdOut() { 142 super.setStdOut(); 143 return this; 144 } 145 146 @Override /* Overridden from Assertion */ 147 public CollectionAssertion<E> setThrowable(Class<? extends RuntimeException> value) { 148 super.setThrowable(value); 149 return this; 150 } 151}