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.function.*;
021import java.util.regex.*;
022
023import org.apache.juneau.common.utils.*;
024import org.apache.juneau.internal.*;
025import org.apache.juneau.serializer.*;
026
027/**
028 * Used for assertion calls against string objects.
029 *
030 * <h5 class='section'>Example:</h5>
031 * <p class='bjava'>
032 *    <jc>// Validates the response body of an HTTP call is the text "OK".</jc>
033 *    <jsm>assertString</jsm>(<jv>httpBody</jv>).is(<js>"OK"</js>);
034 * </p>
035 *
036 * <h5 class='section'>Test Methods:</h5>
037 * <p>
038 * <ul class='javatree'>
039 *    <li class='jc'>{@link FluentStringAssertion}
040 *    <ul class='javatreec'>
041 *       <li class='jm'>{@link FluentStringAssertion#is(String) is(String)}
042 *       <li class='jm'>{@link FluentStringAssertion#isNot(String) isNot(String)}
043 *       <li class='jm'>{@link FluentStringAssertion#isLines(String...) isLines(String...)}
044 *       <li class='jm'>{@link FluentStringAssertion#isSortedLines(String...) isSortedLines(String...)}
045 *       <li class='jm'>{@link FluentStringAssertion#isIc(String) isIc(String)}
046 *       <li class='jm'>{@link FluentStringAssertion#isNotIc(String) isNotIc(String)}
047 *       <li class='jm'>{@link FluentStringAssertion#isContains(String...) isContains(String...)}
048 *       <li class='jm'>{@link FluentStringAssertion#isNotContains(String...) isNotContains(String...)}
049 *       <li class='jm'>{@link FluentStringAssertion#isEmpty() isEmpty()}
050 *       <li class='jm'>{@link FluentStringAssertion#isNotEmpty() isNotEmpty()}
051 *       <li class='jm'>{@link FluentStringAssertion#isString(Object) isString(Object)}
052 *       <li class='jm'>{@link FluentStringAssertion#isMatches(String) isMatches(String)}
053 *       <li class='jm'>{@link FluentStringAssertion#isPattern(String) isPattern(String)}
054 *       <li class='jm'>{@link FluentStringAssertion#isPattern(String,int) isPattern(String,int)}
055 *       <li class='jm'>{@link FluentStringAssertion#isPattern(Pattern) isPattern(Pattern)}
056 *       <li class='jm'>{@link FluentStringAssertion#isStartsWith(String) isStartsWith(String)}
057 *       <li class='jm'>{@link FluentStringAssertion#isEndsWith(String) isEndsWith(String)}
058 *    </ul>
059 *    <li class='jc'>{@link FluentObjectAssertion}
060 *    <ul class='javatreec'>
061 *       <li class='jm'>{@link FluentObjectAssertion#isExists() isExists()}
062 *       <li class='jm'>{@link FluentObjectAssertion#is(Object) is(Object)}
063 *       <li class='jm'>{@link FluentObjectAssertion#is(Predicate) is(Predicate)}
064 *       <li class='jm'>{@link FluentObjectAssertion#isNot(Object) isNot(Object)}
065 *       <li class='jm'>{@link FluentObjectAssertion#isAny(Object...) isAny(Object...)}
066 *       <li class='jm'>{@link FluentObjectAssertion#isNotAny(Object...) isNotAny(Object...)}
067 *       <li class='jm'>{@link FluentObjectAssertion#isNull() isNull()}
068 *       <li class='jm'>{@link FluentObjectAssertion#isNotNull() isNotNull()}
069 *       <li class='jm'>{@link FluentObjectAssertion#isString(String) isString(String)}
070 *       <li class='jm'>{@link FluentObjectAssertion#isJson(String) isJson(String)}
071 *       <li class='jm'>{@link FluentObjectAssertion#isSame(Object) isSame(Object)}
072 *       <li class='jm'>{@link FluentObjectAssertion#isSameJsonAs(Object) isSameJsonAs(Object)}
073 *       <li class='jm'>{@link FluentObjectAssertion#isSameSortedJsonAs(Object) isSameSortedJsonAs(Object)}
074 *       <li class='jm'>{@link FluentObjectAssertion#isSameSerializedAs(Object, WriterSerializer) isSameSerializedAs(Object, WriterSerializer)}
075 *       <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)}
076 *       <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)}
077 *    </ul>
078 * </ul>
079 *
080 * <h5 class='section'>Transform Methods:</h5>
081 * <p>
082 * <ul class='javatree'>
083 *    <li class='jc'>{@link FluentStringAssertion}
084 *    <ul class='javatreec'>
085 *       <li class='jm'>{@link FluentStringAssertion#asReplaceAll(String,String) asReplaceAll(String,String)}
086 *       <li class='jm'>{@link FluentStringAssertion#asReplace(String,String) asReplace(String,String)}
087 *       <li class='jm'>{@link FluentStringAssertion#asUrlDecode() asUrlDecode()}
088 *       <li class='jm'>{@link FluentStringAssertion#asLc() asLc()}
089 *       <li class='jm'>{@link FluentStringAssertion#asUc() asUc()}
090 *       <li class='jm'>{@link FluentStringAssertion#asLines() asLines()}
091 *       <li class='jm'>{@link FluentStringAssertion#asSplit(String) asSplit(String)}
092 *       <li class='jm'>{@link FluentStringAssertion#asLength() asLength()}
093 *       <li class='jm'>{@link FluentStringAssertion#asOneLine() asOneLine()}
094 *    </ul>
095 *    <li class='jc'>{@link FluentObjectAssertion}
096 *    <ul class='javatreec'>
097 *       <li class='jm'>{@link FluentObjectAssertion#asString() asString()}
098 *       <li class='jm'>{@link FluentObjectAssertion#asString(WriterSerializer) asString(WriterSerializer)}
099 *       <li class='jm'>{@link FluentObjectAssertion#asString(Function) asString(Function)}
100 *       <li class='jm'>{@link FluentObjectAssertion#asJson() asJson()}
101 *       <li class='jm'>{@link FluentObjectAssertion#asJsonSorted() asJsonSorted()}
102 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(Function) asApplied(Function)}
103 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
104 * </ul>
105 * </ul>
106 *
107 * <h5 class='section'>Configuration Methods:</h5>
108 * <p>
109 * <ul class='javatree'>
110 *    <li class='jc'>{@link Assertion}
111 *    <ul class='javatreec'>
112 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
113 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
114 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
115 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
116 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
117 *    </ul>
118 * </ul>
119 *
120 * <h5 class='section'>See Also:</h5><ul>
121 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem Overview</a>
122 * </ul>
123 */
124public class StringAssertion extends FluentStringAssertion<StringAssertion> {
125
126   //-----------------------------------------------------------------------------------------------------------------
127   // Static
128   //-----------------------------------------------------------------------------------------------------------------
129
130   /**
131    * Static creator.
132    *
133    * @param value
134    *    The object being tested.
135    *    <br>Can be <jk>null</jk>.
136    * @return A new assertion object.
137    */
138   public static StringAssertion create(Object value) {
139      return new StringAssertion(value);
140   }
141
142   //-----------------------------------------------------------------------------------------------------------------
143   // Instance
144   //-----------------------------------------------------------------------------------------------------------------
145
146   /**
147    * Constructor.
148    *
149    * @param value
150    *    The object being tested.
151    *    <br>Can be <jk>null</jk>.
152    */
153   public StringAssertion(Object value) {
154      super(Utils.s(value), null);
155   }
156
157   //-----------------------------------------------------------------------------------------------------------------
158   // Fluent setters
159   //-----------------------------------------------------------------------------------------------------------------
160   @Override /* Overridden from Assertion */
161   public StringAssertion setMsg(String msg, Object...args) {
162      super.setMsg(msg, args);
163      return this;
164   }
165
166   @Override /* Overridden from Assertion */
167   public StringAssertion setOut(PrintStream value) {
168      super.setOut(value);
169      return this;
170   }
171
172   @Override /* Overridden from Assertion */
173   public StringAssertion setSilent() {
174      super.setSilent();
175      return this;
176   }
177
178   @Override /* Overridden from Assertion */
179   public StringAssertion setStdOut() {
180      super.setStdOut();
181      return this;
182   }
183
184   @Override /* Overridden from Assertion */
185   public StringAssertion setThrowable(Class<? extends java.lang.RuntimeException> value) {
186      super.setThrowable(value);
187      return this;
188   }
189
190   @Override /* Overridden from FluentStringAssertion */
191   public StringAssertion asJavaStrings() {
192      super.asJavaStrings();
193      return this;
194   }
195}