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 * <h2 class='section'>Example:</h2> 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 * <h2 class='section'>Test Methods:</h2> 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#isSame(Object) isSame(Object)} 071 * <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)} 072 * <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)} 073 * </ul> 074 * </ul> 075 * 076 * <h2 class='section'>Transform Methods:</h2> 077 * <ul class='javatree'> 078 * <li class='jc'>{@link FluentStringAssertion} 079 * <ul class='javatreec'> 080 * <li class='jm'>{@link FluentStringAssertion#asReplaceAll(String,String) asReplaceAll(String,String)} 081 * <li class='jm'>{@link FluentStringAssertion#asReplace(String,String) asReplace(String,String)} 082 * <li class='jm'>{@link FluentStringAssertion#asUrlDecode() asUrlDecode()} 083 * <li class='jm'>{@link FluentStringAssertion#asLc() asLc()} 084 * <li class='jm'>{@link FluentStringAssertion#asUc() asUc()} 085 * <li class='jm'>{@link FluentStringAssertion#asLines() asLines()} 086 * <li class='jm'>{@link FluentStringAssertion#asSplit(String) asSplit(String)} 087 * <li class='jm'>{@link FluentStringAssertion#asLength() asLength()} 088 * <li class='jm'>{@link FluentStringAssertion#asOneLine() asOneLine()} 089 * </ul> 090 * <li class='jc'>{@link FluentObjectAssertion} 091 * <ul class='javatreec'> 092 * <li class='jm'>{@link FluentObjectAssertion#asString() asString()} 093 * <li class='jm'>{@link FluentObjectAssertion#asString(ThrowingFunction) asString(ThrowingFunction)} 094 * <li class='jm'>{@link FluentObjectAssertion#asTransformed(UnaryOperator) asTransformed(UnaryOperator)} 095 * <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()} 096 * </ul> 097 * </ul> 098 * 099 * <h2 class='section'>Configuration Methods:</h2> 100 * <ul class='javatree'> 101 * <li class='jc'>{@link Assertion} 102 * <ul class='javatreec'> 103 * <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)} 104 * <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)} 105 * <li class='jm'>{@link Assertion#setSilent() setSilent()} 106 * <li class='jm'>{@link Assertion#setStdOut() setStdOut()} 107 * <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)} 108 * </ul> 109 * </ul> 110 * 111 * <h2 class='section'>See Also:</h2><ul> 112 * <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem</a> 113 * </ul> 114 */ 115public class StringAssertion extends FluentStringAssertion<StringAssertion> { 116 117 /** 118 * Static creator. 119 * 120 * @param value 121 * The object being tested. 122 * <br>Can be <jk>null</jk> (assertions such as {@code isNull()} then operate on the absence of a value). 123 * @return A new assertion object. 124 */ 125 public static StringAssertion create(Object value) { 126 return new StringAssertion(value); 127 } 128 129 /** 130 * Constructor. 131 * 132 * @param value 133 * The object being tested. 134 * <br>Can be <jk>null</jk> (assertions such as {@code isNull()} then operate on the absence of a value). 135 */ 136 public StringAssertion(Object value) { 137 super(s(value), null); 138 } 139 140 @Override /* Overridden from FluentStringAssertion */ 141 public StringAssertion asJavaStrings() { 142 super.asJavaStrings(); 143 return this; 144 } 145 146 @Override /* Overridden from Assertion */ 147 public StringAssertion setMsg(String msg, Object...args) { 148 super.setMsg(msg, args); 149 return this; 150 } 151 152 @Override /* Overridden from Assertion */ 153 public StringAssertion setOut(PrintStream value) { 154 super.setOut(value); 155 return this; 156 } 157 158 @Override /* Overridden from Assertion */ 159 public StringAssertion setSilent() { 160 super.setSilent(); 161 return this; 162 } 163 164 @Override /* Overridden from Assertion */ 165 public StringAssertion setStdOut() { 166 super.setStdOut(); 167 return this; 168 } 169 170 @Override /* Overridden from Assertion */ 171 public StringAssertion setThrowable(Class<? extends RuntimeException> value) { 172 super.setThrowable(value); 173 return this; 174 } 175}