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