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.internal.*;
023import org.apache.juneau.serializer.*;
024
025/**
026 * Used for assertion calls against comparable objects.
027 *
028 * <h5 class='section'>Test Methods:</h5>
029 * <p>
030 * <ul class='javatree'>
031 *    <li class='jc'>{@link FluentComparableAssertion}
032 *    <ul class='javatreec'>
033 *       <li class='jm'>{@link FluentComparableAssertion#isGt(Comparable) isGt(Comparable)}
034 *       <li class='jm'>{@link FluentComparableAssertion#isGte(Comparable) isGte(Comparable)}
035 *       <li class='jm'>{@link FluentComparableAssertion#isLt(Comparable) isLt(Comparable)}
036 *       <li class='jm'>{@link FluentComparableAssertion#isLte(Comparable) isLte(Comparable)}
037 *       <li class='jm'>{@link FluentComparableAssertion#isBetween(Comparable,Comparable) isBetween(Comparable,Comparable)}
038  *   </ul>
039 *    <li class='jc'>{@link FluentObjectAssertion}
040 *    <ul class='javatreec'>
041 *       <li class='jm'>{@link FluentObjectAssertion#isExists() isExists()}
042 *       <li class='jm'>{@link FluentObjectAssertion#is(Object) is(Object)}
043 *       <li class='jm'>{@link FluentObjectAssertion#is(Predicate) is(Predicate)}
044 *       <li class='jm'>{@link FluentObjectAssertion#isNot(Object) isNot(Object)}
045 *       <li class='jm'>{@link FluentObjectAssertion#isAny(Object...) isAny(Object...)}
046 *       <li class='jm'>{@link FluentObjectAssertion#isNotAny(Object...) isNotAny(Object...)}
047 *       <li class='jm'>{@link FluentObjectAssertion#isNull() isNull()}
048 *       <li class='jm'>{@link FluentObjectAssertion#isNotNull() isNotNull()}
049 *       <li class='jm'>{@link FluentObjectAssertion#isString(String) isString(String)}
050 *       <li class='jm'>{@link FluentObjectAssertion#isJson(String) isJson(String)}
051 *       <li class='jm'>{@link FluentObjectAssertion#isSame(Object) isSame(Object)}
052 *       <li class='jm'>{@link FluentObjectAssertion#isSameJsonAs(Object) isSameJsonAs(Object)}
053 *       <li class='jm'>{@link FluentObjectAssertion#isSameSortedJsonAs(Object) isSameSortedJsonAs(Object)}
054 *       <li class='jm'>{@link FluentObjectAssertion#isSameSerializedAs(Object, WriterSerializer) isSameSerializedAs(Object, WriterSerializer)}
055 *       <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)}
056 *       <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)}
057 *    </ul>
058 * </ul>
059 *
060 * <h5 class='section'>Transform Methods:</h5>
061 * <p>
062 * <ul class='javatree'>
063 *    <li class='jc'>{@link FluentObjectAssertion}
064 *    <ul class='javatreec'>
065 *       <li class='jm'>{@link FluentObjectAssertion#asString() asString()}
066 *       <li class='jm'>{@link FluentObjectAssertion#asString(WriterSerializer) asString(WriterSerializer)}
067 *       <li class='jm'>{@link FluentObjectAssertion#asString(Function) asString(Function)}
068 *       <li class='jm'>{@link FluentObjectAssertion#asJson() asJson()}
069 *       <li class='jm'>{@link FluentObjectAssertion#asJsonSorted() asJsonSorted()}
070 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(Function) asApplied(Function)}
071 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
072 * </ul>
073 * </ul>
074 *
075 * <h5 class='section'>Configuration Methods:</h5>
076 * <p>
077 * <ul class='javatree'>
078 *    <li class='jc'>{@link Assertion}
079 *    <ul class='javatreec'>
080 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
081 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
082 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
083 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
084 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
085 *    </ul>
086 * </ul>
087 *
088 * <h5 class='section'>See Also:</h5><ul>
089 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem Overview</a>
090 * </ul>
091 *
092 * @param <T> The comparable type.
093 */
094public class ComparableAssertion<T extends Comparable<T>> extends FluentComparableAssertion<T,ComparableAssertion<T>> {
095
096   //-----------------------------------------------------------------------------------------------------------------
097   // Static
098   //-----------------------------------------------------------------------------------------------------------------
099
100   /**
101    * Static creator.
102    *
103    * @param <T> The value type.
104    * @param value
105    *    The object being tested.
106    *    <br>Can be <jk>null</jk>.
107    * @return A new assertion object.
108    */
109   public static <T extends Comparable<T>> ComparableAssertion<T> create(T value) {
110      return new ComparableAssertion<>(value);
111   }
112
113   //-----------------------------------------------------------------------------------------------------------------
114   // Instance
115   //-----------------------------------------------------------------------------------------------------------------
116
117   /**
118    * Constructor.
119    *
120    * @param value
121    *    The object being tested.
122    *    <br>Can be <jk>null</jk>.
123    */
124   public ComparableAssertion(T value) {
125      super(value, null);
126   }
127
128   //-----------------------------------------------------------------------------------------------------------------
129   // Fluent setters
130   //-----------------------------------------------------------------------------------------------------------------
131   @Override /* Overridden from Assertion */
132   public ComparableAssertion<T> setMsg(String msg, Object...args) {
133      super.setMsg(msg, args);
134      return this;
135   }
136
137   @Override /* Overridden from Assertion */
138   public ComparableAssertion<T> setOut(PrintStream value) {
139      super.setOut(value);
140      return this;
141   }
142
143   @Override /* Overridden from Assertion */
144   public ComparableAssertion<T> setSilent() {
145      super.setSilent();
146      return this;
147   }
148
149   @Override /* Overridden from Assertion */
150   public ComparableAssertion<T> setStdOut() {
151      super.setStdOut();
152      return this;
153   }
154
155   @Override /* Overridden from Assertion */
156   public ComparableAssertion<T> setThrowable(Class<? extends java.lang.RuntimeException> value) {
157      super.setThrowable(value);
158      return this;
159   }
160}