org.apache.juneau.assertions.StringAssertion Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of juneau-assertions Show documentation
Apache Juneau Assertions API
The newest version!
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
// * with the License.  You may obtain a copy of the License at                                                              *
// *                                                                                                                         *
// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
// *                                                                                                                         *
// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
// * specific language governing permissions and limitations under the License.                                              *
// ***************************************************************************************************************************
package org.apache.juneau.assertions;

import static org.apache.juneau.common.internal.StringUtils.*;

import java.io.*;
import java.util.function.*;
import java.util.regex.*;

import org.apache.juneau.internal.*;
import org.apache.juneau.serializer.*;

/**
 * Used for assertion calls against string objects.
 *
 * Example:
 * 
 * 	// Validates the response body of an HTTP call is the text "OK".
 * 	assertString(httpBody).is("OK");
 * 
 *
 * Test Methods:
 * 
 * 

 * 	{@link FluentStringAssertion}
 * 	
 * 		{@link FluentStringAssertion#is(String) is(String)}
 * 		
{@link FluentStringAssertion#isNot(String) isNot(String)}
 * 		
{@link FluentStringAssertion#isLines(String...) isLines(String...)}
 * 		
{@link FluentStringAssertion#isSortedLines(String...) isSortedLines(String...)}
 * 		
{@link FluentStringAssertion#isIc(String) isIc(String)}
 * 		
{@link FluentStringAssertion#isNotIc(String) isNotIc(String)}
 * 		
{@link FluentStringAssertion#isContains(String...) isContains(String...)}
 * 		
{@link FluentStringAssertion#isNotContains(String...) isNotContains(String...)}
 * 		
{@link FluentStringAssertion#isEmpty() isEmpty()}
 * 		
{@link FluentStringAssertion#isNotEmpty() isNotEmpty()}
 * 		
{@link FluentStringAssertion#isString(Object) isString(Object)}
 * 		
{@link FluentStringAssertion#isMatches(String) isMatches(String)}
 * 		
{@link FluentStringAssertion#isPattern(String) isPattern(String)}
 * 		
{@link FluentStringAssertion#isPattern(String,int) isPattern(String,int)}
 * 		
{@link FluentStringAssertion#isPattern(Pattern) isPattern(Pattern)}
 * 		
{@link FluentStringAssertion#isStartsWith(String) isStartsWith(String)}
 * 		
{@link FluentStringAssertion#isEndsWith(String) isEndsWith(String)}
 * 	
 * 	
{@link FluentObjectAssertion}
 * 	
 * 		{@link FluentObjectAssertion#isExists() isExists()}
 * 		
{@link FluentObjectAssertion#is(Object) is(Object)}
 * 		
{@link FluentObjectAssertion#is(Predicate) is(Predicate)}
 * 		
{@link FluentObjectAssertion#isNot(Object) isNot(Object)}
 * 		
{@link FluentObjectAssertion#isAny(Object...) isAny(Object...)}
 * 		
{@link FluentObjectAssertion#isNotAny(Object...) isNotAny(Object...)}
 * 		
{@link FluentObjectAssertion#isNull() isNull()}
 * 		
{@link FluentObjectAssertion#isNotNull() isNotNull()}
 * 		
{@link FluentObjectAssertion#isString(String) isString(String)}
 * 		
{@link FluentObjectAssertion#isJson(String) isJson(String)}
 * 		
{@link FluentObjectAssertion#isSame(Object) isSame(Object)}
 * 		
{@link FluentObjectAssertion#isSameJsonAs(Object) isSameJsonAs(Object)}
 * 		
{@link FluentObjectAssertion#isSameSortedJsonAs(Object) isSameSortedJsonAs(Object)}
 * 		
{@link FluentObjectAssertion#isSameSerializedAs(Object, WriterSerializer) isSameSerializedAs(Object, WriterSerializer)}
 * 		
{@link FluentObjectAssertion#isType(Class) isType(Class)}
 * 		
{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)}
 * 	
 * 
 *
 * Transform Methods:
 * 
 * 

 * 	{@link FluentStringAssertion}
 * 	
 * 		{@link FluentStringAssertion#asReplaceAll(String,String) asReplaceAll(String,String)}
 * 		
{@link FluentStringAssertion#asReplace(String,String) asReplace(String,String)}
 * 		
{@link FluentStringAssertion#asUrlDecode() asUrlDecode()}
 * 		
{@link FluentStringAssertion#asLc() asLc()}
 * 		
{@link FluentStringAssertion#asUc() asUc()}
 * 		
{@link FluentStringAssertion#asLines() asLines()}
 * 		
{@link FluentStringAssertion#asSplit(String) asSplit(String)}
 * 		
{@link FluentStringAssertion#asLength() asLength()}
 * 		
{@link FluentStringAssertion#asOneLine() asOneLine()}
 * 	
 * 	
{@link FluentObjectAssertion}
 * 	
 * 		{@link FluentObjectAssertion#asString() asString()}
 * 		
{@link FluentObjectAssertion#asString(WriterSerializer) asString(WriterSerializer)}
 * 		
{@link FluentObjectAssertion#asString(Function) asString(Function)}
 * 		
{@link FluentObjectAssertion#asJson() asJson()}
 * 		
{@link FluentObjectAssertion#asJsonSorted() asJsonSorted()}
 * 		
{@link FluentObjectAssertion#asTransformed(Function) asApplied(Function)}
 * 		
{@link FluentObjectAssertion#asAny() asAny()}
 *	
 * 
 *
 * Configuration Methods:
 * 
 * 

 * 	{@link Assertion}
 * 	
 * 		{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
 * 		
{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
 * 		
{@link Assertion#setSilent() setSilent()}
 * 		
{@link Assertion#setStdOut() setStdOut()}
 * 		
{@link Assertion#setThrowable(Class) setThrowable(Class)}
 * 	
 * 
 *
 * See Also:

 * 	Overview > juneau-assertions > Overview
 * 
 */
@FluentSetters(returns="StringAssertion")
public class StringAssertion extends FluentStringAssertion {

	//-----------------------------------------------------------------------------------------------------------------
	// Static
	//-----------------------------------------------------------------------------------------------------------------

	/**
	 * Static creator.
	 *
	 * @param value
	 * 	The object being tested.
	 * 	
Can be null.
	 * @return A new assertion object.
	 */
	public static StringAssertion create(Object value) {
		return new StringAssertion(value);
	}

	//-----------------------------------------------------------------------------------------------------------------
	// Instance
	//-----------------------------------------------------------------------------------------------------------------

	/**
	 * Constructor.
	 *
	 * @param value
	 * 	The object being tested.
	 * 	
Can be null.
	 */
	public StringAssertion(Object value) {
		super(stringify(value), null);
	}

	//-----------------------------------------------------------------------------------------------------------------
	// Fluent setters
	//-----------------------------------------------------------------------------------------------------------------

	// 

	@Override /* GENERATED - org.apache.juneau.assertions.Assertion */
	public StringAssertion setMsg(String msg, Object...args) {
		super.setMsg(msg, args);
		return this;
	}

	@Override /* GENERATED - org.apache.juneau.assertions.Assertion */
	public StringAssertion setOut(PrintStream value) {
		super.setOut(value);
		return this;
	}

	@Override /* GENERATED - org.apache.juneau.assertions.Assertion */
	public StringAssertion setSilent() {
		super.setSilent();
		return this;
	}

	@Override /* GENERATED - org.apache.juneau.assertions.Assertion */
	public StringAssertion setStdOut() {
		super.setStdOut();
		return this;
	}

	@Override /* GENERATED - org.apache.juneau.assertions.Assertion */
	public StringAssertion setThrowable(Class value) {
		super.setThrowable(value);
		return this;
	}

	@Override /* GENERATED - org.apache.juneau.assertions.FluentStringAssertion */
	public StringAssertion asJavaStrings() {
		super.asJavaStrings();
		return this;
	}

	// 
}