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