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.commons.lang.*;
023import org.apache.juneau.serializer.*;
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#isJson(String) isJson(String)}
058 *       <li class='jm'>{@link FluentObjectAssertion#isSame(Object) isSame(Object)}
059 *       <li class='jm'>{@link FluentObjectAssertion#isSameJsonAs(Object) isSameJsonAs(Object)}
060 *       <li class='jm'>{@link FluentObjectAssertion#isSameSortedJsonAs(Object) isSameSortedJsonAs(Object)}
061 *       <li class='jm'>{@link FluentObjectAssertion#isSameSerializedAs(Object, WriterSerializer) isSameSerializedAs(Object, WriterSerializer)}
062 *       <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)}
063 *       <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)}
064 *    </ul>
065 * </ul>
066 *
067 * <h5 class='section'>Transform Methods:</h5>
068 * <p>
069 * <ul class='javatree'>
070 *    <li class='jc'>{@link FluentVersionAssertion}
071 *    <ul class='javatreec'>
072 *       <li class='jm'>{@link FluentVersionAssertion#asPart(int) asPart(int)}
073 *       <li class='jm'>{@link FluentVersionAssertion#asMajor() asMajor()}
074 *       <li class='jm'>{@link FluentVersionAssertion#asMinor() asMinor()}
075 *       <li class='jm'>{@link FluentVersionAssertion#asMaintenance() asMaintenance()}
076 *    </ul>
077 *    <li class='jc'>{@link FluentObjectAssertion}
078 *    <ul class='javatreec'>
079 *       <li class='jm'>{@link FluentObjectAssertion#asString() asString()}
080 *       <li class='jm'>{@link FluentObjectAssertion#asString(WriterSerializer) asString(WriterSerializer)}
081 *       <li class='jm'>{@link FluentObjectAssertion#asString(Function) asString(Function)}
082 *       <li class='jm'>{@link FluentObjectAssertion#asJson() asJson()}
083 *       <li class='jm'>{@link FluentObjectAssertion#asJsonSorted() asJsonSorted()}
084 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(Function) asApplied(Function)}
085 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
086 * </ul>
087 * </ul>
088 *
089 * <h5 class='section'>Configuration Methods:</h5>
090 * <p>
091 * <ul class='javatree'>
092 *    <li class='jc'>{@link Assertion}
093 *    <ul class='javatreec'>
094 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
095 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
096 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
097 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
098 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
099 *    </ul>
100 * </ul>
101 *
102 * <h5 class='section'>See Also:</h5><ul>
103 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem Overview</a>
104 * </ul>
105 */
106public class VersionAssertion extends FluentVersionAssertion<VersionAssertion> {
107
108   /**
109    * Static creator.
110    *
111    * @param value
112    *    The object being tested.
113    *    <br>Can be <jk>null</jk>.
114    * @return A new assertion object.
115    */
116   public static VersionAssertion create(Version value) {
117      return new VersionAssertion(value);
118   }
119
120   /**
121    * Constructor.
122    *
123    * @param value
124    *    The object being tested.
125    *    <br>Can be <jk>null</jk>.
126    */
127   public VersionAssertion(Version value) {
128      super(value, null);
129   }
130
131   @Override /* Overridden from Assertion */
132   public VersionAssertion setMsg(String msg, Object...args) {
133      super.setMsg(msg, args);
134      return this;
135   }
136
137   @Override /* Overridden from Assertion */
138   public VersionAssertion setOut(PrintStream value) {
139      super.setOut(value);
140      return this;
141   }
142
143   @Override /* Overridden from Assertion */
144   public VersionAssertion setSilent() {
145      super.setSilent();
146      return this;
147   }
148
149   @Override /* Overridden from Assertion */
150   public VersionAssertion setStdOut() {
151      super.setStdOut();
152      return this;
153   }
154
155   @Override /* Overridden from Assertion */
156   public VersionAssertion setThrowable(Class<? extends java.lang.RuntimeException> value) {
157      super.setThrowable(value);
158      return this;
159   }
160}