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.*;
023import org.apache.juneau.internal.*;
024import org.apache.juneau.serializer.*;
025
026/**
027 * Used for assertion calls against {@link Version} objects.
028 *
029 * <h5 class='section'>Example:</h5>
030 * <p class='bjava'>
031 *    <jc>// Validates the specified date is after the current date.</jc>
032 *    <jsm>assertVersion</jsm>(<jv>myVersion</jv>).asMajor().isGreaterThan(2);
033 * </p>
034 *
035 *
036* <h5 class='section'>Test Methods:</h5>
037 * <p>
038 * <ul class='javatree'>
039 *    <li class='jc'>{@link FluentComparableAssertion}
040 *    <ul class='javatreec'>
041 *       <li class='jm'>{@link FluentComparableAssertion#isGt(Comparable) isGt(Comparable)}
042 *       <li class='jm'>{@link FluentComparableAssertion#isGte(Comparable) isGte(Comparable)}
043 *       <li class='jm'>{@link FluentComparableAssertion#isLt(Comparable) isLt(Comparable)}
044 *       <li class='jm'>{@link FluentComparableAssertion#isLte(Comparable) isLte(Comparable)}
045 *       <li class='jm'>{@link FluentComparableAssertion#isBetween(Comparable,Comparable) isBetween(Comparable,Comparable)}
046  *   </ul>
047 *    <li class='jc'>{@link FluentObjectAssertion}
048 *    <ul class='javatreec'>
049 *       <li class='jm'>{@link FluentObjectAssertion#isExists() isExists()}
050 *       <li class='jm'>{@link FluentObjectAssertion#is(Object) is(Object)}
051 *       <li class='jm'>{@link FluentObjectAssertion#is(Predicate) is(Predicate)}
052 *       <li class='jm'>{@link FluentObjectAssertion#isNot(Object) isNot(Object)}
053 *       <li class='jm'>{@link FluentObjectAssertion#isAny(Object...) isAny(Object...)}
054 *       <li class='jm'>{@link FluentObjectAssertion#isNotAny(Object...) isNotAny(Object...)}
055 *       <li class='jm'>{@link FluentObjectAssertion#isNull() isNull()}
056 *       <li class='jm'>{@link FluentObjectAssertion#isNotNull() isNotNull()}
057 *       <li class='jm'>{@link FluentObjectAssertion#isString(String) isString(String)}
058 *       <li class='jm'>{@link FluentObjectAssertion#isJson(String) isJson(String)}
059 *       <li class='jm'>{@link FluentObjectAssertion#isSame(Object) isSame(Object)}
060 *       <li class='jm'>{@link FluentObjectAssertion#isSameJsonAs(Object) isSameJsonAs(Object)}
061 *       <li class='jm'>{@link FluentObjectAssertion#isSameSortedJsonAs(Object) isSameSortedJsonAs(Object)}
062 *       <li class='jm'>{@link FluentObjectAssertion#isSameSerializedAs(Object, WriterSerializer) isSameSerializedAs(Object, WriterSerializer)}
063 *       <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)}
064 *       <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)}
065 *    </ul>
066 * </ul>
067 *
068 * <h5 class='section'>Transform Methods:</h5>
069 * <p>
070 * <ul class='javatree'>
071 *    <li class='jc'>{@link FluentVersionAssertion}
072 *    <ul class='javatreec'>
073 *       <li class='jm'>{@link FluentVersionAssertion#asPart(int) asPart(int)}
074 *       <li class='jm'>{@link FluentVersionAssertion#asMajor() asMajor()}
075 *       <li class='jm'>{@link FluentVersionAssertion#asMinor() asMinor()}
076 *       <li class='jm'>{@link FluentVersionAssertion#asMaintenance() asMaintenance()}
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 */
107public class VersionAssertion extends FluentVersionAssertion<VersionAssertion> {
108
109   //-----------------------------------------------------------------------------------------------------------------
110   // Static
111   //-----------------------------------------------------------------------------------------------------------------
112
113   /**
114    * Static creator.
115    *
116    * @param value
117    *    The object being tested.
118    *    <br>Can be <jk>null</jk>.
119    * @return A new assertion object.
120    */
121   public static VersionAssertion create(Version value) {
122      return new VersionAssertion(value);
123   }
124
125   //-----------------------------------------------------------------------------------------------------------------
126   // Instance
127   //-----------------------------------------------------------------------------------------------------------------
128
129   /**
130    * Constructor.
131    *
132    * @param value
133    *    The object being tested.
134    *    <br>Can be <jk>null</jk>.
135    */
136   public VersionAssertion(Version value) {
137      super(value, null);
138   }
139
140   //-----------------------------------------------------------------------------------------------------------------
141   // Fluent setters
142   //-----------------------------------------------------------------------------------------------------------------
143   @Override /* Overridden from Assertion */
144   public VersionAssertion setMsg(String msg, Object...args) {
145      super.setMsg(msg, args);
146      return this;
147   }
148
149   @Override /* Overridden from Assertion */
150   public VersionAssertion setOut(PrintStream value) {
151      super.setOut(value);
152      return this;
153   }
154
155   @Override /* Overridden from Assertion */
156   public VersionAssertion setSilent() {
157      super.setSilent();
158      return this;
159   }
160
161   @Override /* Overridden from Assertion */
162   public VersionAssertion setStdOut() {
163      super.setStdOut();
164      return this;
165   }
166
167   @Override /* Overridden from Assertion */
168   public VersionAssertion setThrowable(Class<? extends java.lang.RuntimeException> value) {
169      super.setThrowable(value);
170      return this;
171   }
172}