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