001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.assertions;
014
015import java.io.*;
016import java.util.*;
017import java.util.function.*;
018
019import org.apache.juneau.internal.*;
020import org.apache.juneau.serializer.*;
021
022/**
023 * Used for assertion calls against lists of strings.
024 *
025 * <h5 class='section'>Test Methods:</h5>
026 * <p>
027 * <ul class='javatree'>
028 *    <li class='jc'>{@link FluentListAssertion}
029 *    <ul class='javatreec'>
030 *       <li class='jm'>{@link FluentListAssertion#isHas(Object...) isHas(Object...)}
031 *       <li class='jm'>{@link FluentListAssertion#isEach(Predicate...) isEach(Predicate...)}
032 *    </ul>
033 *    <li class='jc'>{@link FluentCollectionAssertion}
034 *    <ul class='javatreec'>
035 *       <li class='jm'>{@link FluentCollectionAssertion#isEmpty() isEmpty()}
036 *       <li class='jm'>{@link FluentCollectionAssertion#isNotEmpty() isNotEmpty()}
037 *       <li class='jm'>{@link FluentCollectionAssertion#isContains(Object) isContains(Object)}
038 *       <li class='jm'>{@link FluentCollectionAssertion#isNotContains(Object) isNotContains(Object)}
039 *       <li class='jm'>{@link FluentCollectionAssertion#isAny(Predicate) isAny(Predicate)}
040 *       <li class='jm'>{@link FluentCollectionAssertion#isAll(Predicate) isAll(Predicate)}
041 *       <li class='jm'>{@link FluentCollectionAssertion#isSize(int size) isSize(int size)}
042 *    </ul>
043 *    <li class='jc'>{@link FluentObjectAssertion}
044 *    <ul class='javatreec'>
045 *       <li class='jm'>{@link FluentObjectAssertion#isExists() isExists()}
046 *       <li class='jm'>{@link FluentObjectAssertion#is(Object) is(Object)}
047 *       <li class='jm'>{@link FluentObjectAssertion#is(Predicate) is(Predicate)}
048 *       <li class='jm'>{@link FluentObjectAssertion#isNot(Object) isNot(Object)}
049 *       <li class='jm'>{@link FluentObjectAssertion#isAny(Object...) isAny(Object...)}
050 *       <li class='jm'>{@link FluentObjectAssertion#isNotAny(Object...) isNotAny(Object...)}
051 *       <li class='jm'>{@link FluentObjectAssertion#isNull() isNull()}
052 *       <li class='jm'>{@link FluentObjectAssertion#isNotNull() isNotNull()}
053 *       <li class='jm'>{@link FluentObjectAssertion#isString(String) isString(String)}
054 *       <li class='jm'>{@link FluentObjectAssertion#isJson(String) isJson(String)}
055 *       <li class='jm'>{@link FluentObjectAssertion#isSame(Object) isSame(Object)}
056 *       <li class='jm'>{@link FluentObjectAssertion#isSameJsonAs(Object) isSameJsonAs(Object)}
057 *       <li class='jm'>{@link FluentObjectAssertion#isSameSortedJsonAs(Object) isSameSortedJsonAs(Object)}
058 *       <li class='jm'>{@link FluentObjectAssertion#isSameSerializedAs(Object, WriterSerializer) isSameSerializedAs(Object, WriterSerializer)}
059 *       <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)}
060 *       <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)}
061 *    </ul>
062 * </ul>
063 *
064 * <h5 class='section'>Transform Methods:</h5>
065 * <p>
066 * <ul class='javatree'>
067 *    <li class='jc'>{@link FluentStringListAssertion}
068 *    <ul class='javatreec'>
069 *       <li class='jm'>{@link FluentStringListAssertion#asJoin() asJoin()}
070 *       <li class='jm'>{@link FluentStringListAssertion#asJoin(String) asJoin(String)}
071 *       <li class='jm'>{@link FluentStringListAssertion#asJoin(String,String,String) asJoin(String,String,String)}
072 *       <li class='jm'>{@link FluentStringListAssertion#asTrimmed() asTrimmed()}
073 *    </ul>
074 *    <li class='jc'>{@link FluentListAssertion}
075 *    <ul class='javatreec'>
076 *       <li class='jm'>{@link FluentListAssertion#asStrings() asStrings()}
077 *       <li class='jm'>{@link FluentListAssertion#asStrings(Function) asStrings(Function)}
078 *       <li class='jm'>{@link FluentListAssertion#asCdl() asCdl()}
079 *       <li class='jm'>{@link FluentListAssertion#asCdl(Function) asCdl(Function)}
080 *       <li class='jm'>{@link FluentListAssertion#asItem(int) asItem(int)}
081 *       <li class='jm'>{@link FluentListAssertion#asSorted() asSorted()}
082 *       <li class='jm'>{@link FluentListAssertion#asSorted(Comparator) asSorted(Comparator)}
083 *    </ul>
084 *    <li class='jc'>{@link FluentCollectionAssertion}
085 *    <ul class='javatreec'>
086 *       <li class='jm'>{@link FluentCollectionAssertion#asStrings() asStrings()}
087 *       <li class='jm'>{@link FluentCollectionAssertion#asSize() asSize()}
088 *    </ul>
089 *    <li class='jc'>{@link FluentObjectAssertion}
090 *    <ul class='javatreec'>
091 *       <li class='jm'>{@link FluentObjectAssertion#asString() asString()}
092 *       <li class='jm'>{@link FluentObjectAssertion#asString(WriterSerializer) asString(WriterSerializer)}
093 *       <li class='jm'>{@link FluentObjectAssertion#asString(Function) asString(Function)}
094 *       <li class='jm'>{@link FluentObjectAssertion#asJson() asJson()}
095 *       <li class='jm'>{@link FluentObjectAssertion#asJsonSorted() asJsonSorted()}
096 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(Function) asApplied(Function)}
097 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
098 * </ul>
099 * </ul>
100 *
101 * <h5 class='section'>Configuration Methods:</h5>
102 * <p>
103 * <ul class='javatree'>
104 *    <li class='jc'>{@link Assertion}
105 *    <ul class='javatreec'>
106 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
107 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
108 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
109 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
110 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
111*  </ul>
112 * </ul>
113 *
114 * <h5 class='section'>See Also:</h5><ul>
115 *    <li class='link'><a class="doclink" href="../../../../index.html#ja.Overview">Overview &gt; juneau-assertions &gt; Overview</a>
116 * </ul>
117 */
118@FluentSetters(returns="StringListAssertion")
119public class StringListAssertion extends FluentStringListAssertion<StringListAssertion> {
120
121   //-----------------------------------------------------------------------------------------------------------------
122   // Static
123   //-----------------------------------------------------------------------------------------------------------------
124
125   /**
126    * Static creator.
127    *
128    * @param value
129    *    The object being tested.
130    *    <br>Can be <jk>null</jk>.
131    * @return A new assertion object.
132    */
133   public static StringListAssertion create(List<String> value) {
134      return new StringListAssertion(value);
135   }
136
137   //-----------------------------------------------------------------------------------------------------------------
138   // Instance
139   //-----------------------------------------------------------------------------------------------------------------
140
141   /**
142    * Constructor.
143    *
144    * @param value
145    *    The object being tested.
146    *    <br>Can be <jk>null</jk>.
147    */
148   public StringListAssertion(List<String> value) {
149      super(value, null);
150   }
151
152   //-----------------------------------------------------------------------------------------------------------------
153   // Fluent setters
154   //-----------------------------------------------------------------------------------------------------------------
155
156   // <FluentSetters>
157
158   @Override /* GENERATED - org.apache.juneau.assertions.Assertion */
159   public StringListAssertion setMsg(String msg, Object...args) {
160      super.setMsg(msg, args);
161      return this;
162   }
163
164   @Override /* GENERATED - org.apache.juneau.assertions.Assertion */
165   public StringListAssertion setOut(PrintStream value) {
166      super.setOut(value);
167      return this;
168   }
169
170   @Override /* GENERATED - org.apache.juneau.assertions.Assertion */
171   public StringListAssertion setSilent() {
172      super.setSilent();
173      return this;
174   }
175
176   @Override /* GENERATED - org.apache.juneau.assertions.Assertion */
177   public StringListAssertion setStdOut() {
178      super.setStdOut();
179      return this;
180   }
181
182   @Override /* GENERATED - org.apache.juneau.assertions.Assertion */
183   public StringListAssertion setThrowable(Class<? extends java.lang.RuntimeException> value) {
184      super.setThrowable(value);
185      return this;
186   }
187
188   // </FluentSetters>
189}