org.apache.juneau.assertions.AnyAssertion 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 java.io.*;
import java.util.function.*;

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

/**
 * Used for assertion calls against generic POJOs.
 *
 * 
 * Extends from {@link ObjectAssertion} allowing you to perform basic assertions, but adds several transform
 * methods to convert to more-specific assertion types.
 *
 * 
Example:
 * 
 * 	import static org.apache.juneau.assertions.Assertions.*;
 *
 * 	List<MyBean> listOfBeans = ...;
 * 	assertList(listOfBeans)
 * 		.asItem(1)  // Returns an AnyAssertion.
 * 		.asBean()  // Transforms to BeanAssertion.
 * 			.asProperty("foo")  // Returns an AnyAssertion.
 * 			.asString()  // Transforms to StringAssertion.
 * 				.is("bar");  // Performs test.
 * 
 *
 *
 * Test Methods:
 * 
 * 

 * 	{@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 FluentAnyAssertion}
 * 	
 * 		{@link FluentAnyAssertion#asArray(Class) asArray(Class)}
 * 		
{@link FluentAnyAssertion#asIntArray() asIntArray()}
 * 		
{@link FluentAnyAssertion#asLongArray() asLongArray()}
 * 		
{@link FluentAnyAssertion#asShortArray() asShortArray()}
 * 		
{@link FluentAnyAssertion#asFloatArray() asFloatArray()}
 * 		
{@link FluentAnyAssertion#asDoubleArray() asDoubleArray()}
 * 		
{@link FluentAnyAssertion#asCharArray() asCharArray()}
 * 		
{@link FluentAnyAssertion#asByteArray() asByteArray()}
 * 		
{@link FluentAnyAssertion#asBooleanArray() asBooleanArray()}
 * 		
{@link FluentAnyAssertion#asBoolean() asBoolean()}
 * 		
{@link FluentAnyAssertion#asBytes() asBytes()}
 * 		
{@link FluentAnyAssertion#asCollection() asCollection()}
 * 		
{@link FluentAnyAssertion#asCollection(Class) asCollection(Class)}
 * 		
{@link FluentAnyAssertion#asStringList() asStringList()}
 * 		
{@link FluentAnyAssertion#asComparable() asComparable()}
 * 		
{@link FluentAnyAssertion#asDate() asDate()}
 * 		
{@link FluentAnyAssertion#asInteger() asInteger()}
 * 		
{@link FluentAnyAssertion#asLong() asLong()}
 * 		
{@link FluentAnyAssertion#asList() asList()}
 * 		
{@link FluentAnyAssertion#asList(Class) asList(Class)}
 * 		
{@link FluentAnyAssertion#asMap() asMap()}
 * 		
{@link FluentAnyAssertion#asMap(Class,Class) asMap(Class,Class)}
 * 		
{@link FluentAnyAssertion#asBean() asBean()}
 * 		
{@link FluentAnyAssertion#asBean(Class) asBean(Class)}
 * 		
{@link FluentAnyAssertion#asBeanList(Class) asBeanList(Class)}
 * 		
{@link FluentAnyAssertion#asZonedDateTime() asZonedDateTime()}
 * 	
 * 	
{@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
 * 
 *
 * @param  The object type.
 */
@FluentSetters(returns="AnyAssertion")
public class AnyAssertion extends FluentAnyAssertion> {

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

	/**
	 * Static creator.
	 *
	 * @param  The value type.
	 * @param value
	 * 	The object being tested.
	 * 	
Can be null.
	 * @return A new assertion object.
	 */
	public static  AnyAssertion create(T value) {
		return new AnyAssertion<>(value);
	}

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

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

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

	// 

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

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

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

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

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

	// 
}