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