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 java.io.*; 020import java.util.function.*; 021 022 023/** 024 * Used for fluent assertion calls against longs. 025 * 026 * <h2 class='section'>Example:</h2> 027 * <p class='bjava'> 028 * <jc>// Validates the response length isn't too long.</jc> 029 * <jv>client</jv> 030 * .get(<jsf>URL</jsf>) 031 * .run() 032 * .assertLongHeader(<js>"Length"</js>).isLessThan(100000); 033 * </p> 034 * 035 * 036 * <h2 class='section'>Test Methods:</h2> 037 * <ul class='javatree'> 038 * <li class='jc'>{@link FluentComparableAssertion} 039 * <ul class='javatreec'> 040 * <li class='jm'>{@link FluentComparableAssertion#isGt(Comparable) isGt(Comparable)} 041 * <li class='jm'>{@link FluentComparableAssertion#isGte(Comparable) isGte(Comparable)} 042 * <li class='jm'>{@link FluentComparableAssertion#isLt(Comparable) isLt(Comparable)} 043 * <li class='jm'>{@link FluentComparableAssertion#isLte(Comparable) isLte(Comparable)} 044 * <li class='jm'>{@link FluentComparableAssertion#isBetween(Comparable,Comparable) isBetween(Comparable,Comparable)} 045 * </ul> 046 * <li class='jc'>{@link FluentObjectAssertion} 047 * <ul class='javatreec'> 048 * <li class='jm'>{@link FluentObjectAssertion#isExists() isExists()} 049 * <li class='jm'>{@link FluentObjectAssertion#is(Object) is(Object)} 050 * <li class='jm'>{@link FluentObjectAssertion#is(Predicate) is(Predicate)} 051 * <li class='jm'>{@link FluentObjectAssertion#isNot(Object) isNot(Object)} 052 * <li class='jm'>{@link FluentObjectAssertion#isAny(Object...) isAny(Object...)} 053 * <li class='jm'>{@link FluentObjectAssertion#isNotAny(Object...) isNotAny(Object...)} 054 * <li class='jm'>{@link FluentObjectAssertion#isNull() isNull()} 055 * <li class='jm'>{@link FluentObjectAssertion#isNotNull() isNotNull()} 056 * <li class='jm'>{@link FluentObjectAssertion#isString(String) isString(String)} 057 * <li class='jm'>{@link FluentObjectAssertion#isSame(Object) isSame(Object)} 058 * <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)} 059 * <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)} 060 * </ul> 061 * </ul> 062 * 063 * <h2 class='section'>Transform Methods:</h2> 064 * <ul class='javatree'> 065 * <li class='jc'>{@link FluentLongAssertion} 066 * <ul class='javatreec'> 067 * <li class='jm'>{@link FluentLongAssertion#asInteger() asInteger()} 068 * </ul> 069 * <li class='jc'>{@link FluentObjectAssertion} 070 * <ul class='javatreec'> 071 * <li class='jm'>{@link FluentObjectAssertion#asString() asString()} 072 * <li class='jm'>{@link FluentObjectAssertion#asString(ThrowingFunction) asString(ThrowingFunction)} 073 * <li class='jm'>{@link FluentObjectAssertion#asTransformed(UnaryOperator) asTransformed(UnaryOperator)} 074 * <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()} 075 * </ul> 076 * </ul> 077 * 078 * <h2 class='section'>Configuration Methods:</h2> 079 * <ul class='javatree'> 080 * <li class='jc'>{@link Assertion} 081 * <ul class='javatreec'> 082 * <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)} 083 * <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)} 084 * <li class='jm'>{@link Assertion#setSilent() setSilent()} 085 * <li class='jm'>{@link Assertion#setStdOut() setStdOut()} 086 * <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)} 087 * </ul> 088 * </ul> 089 * 090 * <h2 class='section'>See Also:</h2><ul> 091 * <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem</a> 092 * </ul> 093 * 094 * @param <R> The return type. 095 */ 096public class FluentLongAssertion<R> extends FluentComparableAssertion<Long,R> { 097 098 /** 099 * Chained constructor. 100 * 101 * <p> 102 * Used when transforming one assertion into another so that the assertion config can be used by the new assertion. 103 * 104 * @param creator 105 * The assertion that created this assertion. 106 * <br>Should be <jk>null</jk> if this is the top-level assertion. 107 * @param value 108 * The object being tested. 109 * <br>Can be <jk>null</jk> (assertions such as {@code isNull()} then operate on the absence of a value). 110 * @param returns 111 * The object to return after a test method is called. 112 * <br>If <jk>null</jk>, the test method returns this object allowing multiple test method calls to be 113 * used on the same assertion. 114 */ 115 public FluentLongAssertion(Assertion creator, Long value, R returns) { 116 super(creator, value, returns); 117 } 118 119 /** 120 * Constructor. 121 * 122 * @param value 123 * The object being tested. 124 * <br>Can be <jk>null</jk> (assertions such as {@code isNull()} then operate on the absence of a value). 125 * @param returns 126 * The object to return after a test method is called. 127 * <br>If <jk>null</jk>, the test method returns this object allowing multiple test method calls to be 128 * used on the same assertion. 129 */ 130 public FluentLongAssertion(Long value, R returns) { 131 this(null, value, returns); 132 } 133 134 /** 135 * Converts this long into an integer and then returns it as an integer assertion. 136 * 137 * @return A new assertion. 138 */ 139 public FluentIntegerAssertion<R> asInteger() { 140 return new FluentIntegerAssertion<>(this, map(Long::intValue).orElse(null), returns()); 141 } 142 143 @Override /* Overridden from Assertion */ 144 public FluentLongAssertion<R> setMsg(String msg, Object...args) { 145 super.setMsg(msg, args); 146 return this; 147 } 148 149 @Override /* Overridden from Assertion */ 150 public FluentLongAssertion<R> setOut(PrintStream value) { 151 super.setOut(value); 152 return this; 153 } 154 155 @Override /* Overridden from Assertion */ 156 public FluentLongAssertion<R> setSilent() { 157 super.setSilent(); 158 return this; 159 } 160 161 @Override /* Overridden from Assertion */ 162 public FluentLongAssertion<R> setStdOut() { 163 super.setStdOut(); 164 return this; 165 } 166 167 @Override /* Overridden from Assertion */ 168 public FluentLongAssertion<R> setThrowable(Class<? extends RuntimeException> value) { 169 super.setThrowable(value); 170 return this; 171 } 172}