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
022import org.apache.juneau.commons.function.*;
023
024
025/**
026 * Used for assertion calls against longs.
027 *
028 * <h5 class='section'>Example:</h5>
029 * <p class='bjava'>
030 *    <jc>// Validates the response length isn't too long.</jc>
031 *    <jsm>assertLong</jsm>(<jv>responseLength</jv>).isLessThan(100000);
032 * </p>
033 *
034 *
035 * <h5 class='section'>Test Methods:</h5>
036 * <p>
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 * <h5 class='section'>Transform Methods:</h5>
064 * <p>
065 * <ul class='javatree'>
066 *    <li class='jc'>{@link FluentLongAssertion}
067 *    <ul class='javatreec'>
068 *       <li class='jm'>{@link FluentLongAssertion#asInteger() asInteger()}
069 *    </ul>
070 *    <li class='jc'>{@link FluentObjectAssertion}
071 *    <ul class='javatreec'>
072 *       <li class='jm'>{@link FluentObjectAssertion#asString() asString()}
073 *       <li class='jm'>{@link FluentObjectAssertion#asString(ThrowingFunction) asString(ThrowingFunction)}
074 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(UnaryOperator) asTransformed(UnaryOperator)}
075 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
076 * </ul>
077 * </ul>
078 *
079 * <h5 class='section'>Configuration Methods:</h5>
080 * <p>
081 * <ul class='javatree'>
082 *    <li class='jc'>{@link Assertion}
083 *    <ul class='javatreec'>
084 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
085 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
086 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
087 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
088 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
089 *    </ul>
090 * </ul>
091 *
092 * <h5 class='section'>See Also:</h5><ul>
093 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem</a>
094 * </ul>
095 */
096@SuppressWarnings({
097   "java:S110" // Inheritance depth acceptable for LongAssertion hierarchy
098})
099public class LongAssertion extends FluentLongAssertion<LongAssertion> {
100
101   /**
102    * Static creator.
103    *
104    * @param value
105    *    The object being tested.
106    *    <br>Can be <jk>null</jk> (assertions such as {@code isNull()} then operate on the absence of a value).
107    * @return A new assertion object.
108    */
109   public static LongAssertion create(Long value) {
110      return new LongAssertion(value);
111   }
112
113   /**
114    * Constructor.
115    *
116    * @param value
117    *    The object being tested.
118    *    <br>Can be <jk>null</jk> (assertions such as {@code isNull()} then operate on the absence of a value).
119    */
120   public LongAssertion(Long value) {
121      super(value, null);
122   }
123
124   @Override /* Overridden from Assertion */
125   public LongAssertion setMsg(String msg, Object...args) {
126      super.setMsg(msg, args);
127      return this;
128   }
129
130   @Override /* Overridden from Assertion */
131   public LongAssertion setOut(PrintStream value) {
132      super.setOut(value);
133      return this;
134   }
135
136   @Override /* Overridden from Assertion */
137   public LongAssertion setSilent() {
138      super.setSilent();
139      return this;
140   }
141
142   @Override /* Overridden from Assertion */
143   public LongAssertion setStdOut() {
144      super.setStdOut();
145      return this;
146   }
147
148   @Override /* Overridden from Assertion */
149   public LongAssertion setThrowable(Class<? extends RuntimeException> value) {
150      super.setThrowable(value);
151      return this;
152   }
153}