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