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 fluent assertion calls against {@link Version} objects.
027 *
028 * <h5 class='section'>Example:</h5>
029 * <p class='bjava'>
030 *    <jc>// Validates the response expiration is after the current date.</jc>
031 *    <jv>client</jv>
032 *       .get(<jsf>URL</jsf>)
033 *       .run()
034 *       .getHeader(ClientVersion.<jk>class</jk>).assertVersion().asMajor().isGreaterThanOrEqual(2);
035 * </p>
036 *
037 *
038 * <h5 class='section'>Test Methods:</h5>
039 * <p>
040 * <ul class='javatree'>
041 *    <li class='jc'>{@link FluentComparableAssertion}
042 *    <ul class='javatreec'>
043 *       <li class='jm'>{@link FluentComparableAssertion#isGt(Comparable) isGt(Comparable)}
044 *       <li class='jm'>{@link FluentComparableAssertion#isGte(Comparable) isGte(Comparable)}
045 *       <li class='jm'>{@link FluentComparableAssertion#isLt(Comparable) isLt(Comparable)}
046 *       <li class='jm'>{@link FluentComparableAssertion#isLte(Comparable) isLte(Comparable)}
047 *       <li class='jm'>{@link FluentComparableAssertion#isBetween(Comparable,Comparable) isBetween(Comparable,Comparable)}
048  *   </ul>
049 *    <li class='jc'>{@link FluentObjectAssertion}
050 *    <ul class='javatreec'>
051 *       <li class='jm'>{@link FluentObjectAssertion#isExists() isExists()}
052 *       <li class='jm'>{@link FluentObjectAssertion#is(Object) is(Object)}
053 *       <li class='jm'>{@link FluentObjectAssertion#is(Predicate) is(Predicate)}
054 *       <li class='jm'>{@link FluentObjectAssertion#isNot(Object) isNot(Object)}
055 *       <li class='jm'>{@link FluentObjectAssertion#isAny(Object...) isAny(Object...)}
056 *       <li class='jm'>{@link FluentObjectAssertion#isNotAny(Object...) isNotAny(Object...)}
057 *       <li class='jm'>{@link FluentObjectAssertion#isNull() isNull()}
058 *       <li class='jm'>{@link FluentObjectAssertion#isNotNull() isNotNull()}
059 *       <li class='jm'>{@link FluentObjectAssertion#isString(String) isString(String)}
060 *       <li class='jm'>{@link FluentObjectAssertion#isJson(String) isJson(String)}
061 *       <li class='jm'>{@link FluentObjectAssertion#isSame(Object) isSame(Object)}
062 *       <li class='jm'>{@link FluentObjectAssertion#isSameJsonAs(Object) isSameJsonAs(Object)}
063 *       <li class='jm'>{@link FluentObjectAssertion#isSameSortedJsonAs(Object) isSameSortedJsonAs(Object)}
064 *       <li class='jm'>{@link FluentObjectAssertion#isSameSerializedAs(Object, WriterSerializer) isSameSerializedAs(Object, WriterSerializer)}
065 *       <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)}
066 *       <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)}
067 *    </ul>
068 * </ul>
069 *
070 * <h5 class='section'>Transform Methods:</h5>
071 * <p>
072 * <ul class='javatree'>
073 *    <li class='jc'>{@link FluentVersionAssertion}
074 *    <ul class='javatreec'>
075 *       <li class='jm'>{@link FluentVersionAssertion#asPart(int) asPart(int)}
076 *       <li class='jm'>{@link FluentVersionAssertion#asMajor() asMajor()}
077 *       <li class='jm'>{@link FluentVersionAssertion#asMinor() asMinor()}
078 *       <li class='jm'>{@link FluentVersionAssertion#asMaintenance() asMaintenance()}
079 *    </ul>
080 *    <li class='jc'>{@link FluentObjectAssertion}
081 *    <ul class='javatreec'>
082 *       <li class='jm'>{@link FluentObjectAssertion#asString() asString()}
083 *       <li class='jm'>{@link FluentObjectAssertion#asString(WriterSerializer) asString(WriterSerializer)}
084 *       <li class='jm'>{@link FluentObjectAssertion#asString(Function) asString(Function)}
085 *       <li class='jm'>{@link FluentObjectAssertion#asJson() asJson()}
086 *       <li class='jm'>{@link FluentObjectAssertion#asJsonSorted() asJsonSorted()}
087 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(Function) asApplied(Function)}
088 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
089 * </ul>
090 * </ul>
091 *
092 * <h5 class='section'>Configuration Methods:</h5>
093 * <p>
094 * <ul class='javatree'>
095 *    <li class='jc'>{@link Assertion}
096 *    <ul class='javatreec'>
097 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
098 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
099 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
100 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
101 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
102 *    </ul>
103 * </ul>
104 *
105 * <h5 class='section'>See Also:</h5><ul>
106 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem Overview</a>
107 * </ul>
108 *
109 * @param <R> The return type.
110 */
111public class FluentVersionAssertion<R> extends FluentComparableAssertion<Version,R> {
112
113   /**
114    * Chained constructor.
115    *
116    * <p>
117    * Used when transforming one assertion into another so that the assertion config can be used by the new assertion.
118    *
119    * @param creator
120    *    The assertion that created this assertion.
121    *    <br>Should be <jk>null</jk> if this is the top-level assertion.
122    * @param value
123    *    The object being tested.
124    *    <br>Can be <jk>null</jk>.
125    * @param returns
126    *    The object to return after a test method is called.
127    *    <br>If <jk>null</jk>, the test method returns this object allowing multiple test method calls to be
128    * used on the same assertion.
129    */
130   public FluentVersionAssertion(Assertion creator, Version value, R returns) {
131      super(creator, value, returns);
132   }
133
134   /**
135    * Constructor.
136    *
137    * @param value
138    *    The object being tested.
139    *    <br>Can be <jk>null</jk>.
140    * @param returns
141    *    The object to return after a test method is called.
142    *    <br>If <jk>null</jk>, the test method returns this object allowing multiple test method calls to be
143    * used on the same assertion.
144    */
145   public FluentVersionAssertion(Version value, R returns) {
146      this(null, value, returns);
147   }
148
149   /**
150    * Extracts the maintenance part of the version string (index position 2).
151    *
152    * @return This object.
153    */
154   public FluentIntegerAssertion<R> asMaintenance() {
155      return asPart(2);
156   }
157
158   /**
159    * Extracts the major part of the version string (index position 0).
160    *
161    * @return This object.
162    */
163   public FluentIntegerAssertion<R> asMajor() {
164      return asPart(0);
165   }
166
167   /**
168    * Extracts the minor part of the version string (index position 1).
169    *
170    * @return This object.
171    */
172   public FluentIntegerAssertion<R> asMinor() {
173      return asPart(1);
174   }
175
176   /**
177    * Extracts the specified version part (zero-indexed position).
178    *
179    * @param index The index of the version part to extract.
180    * @return This object.
181    */
182   public FluentIntegerAssertion<R> asPart(int index) {
183      return new FluentIntegerAssertion<>(this, valueIsNull() ? null : value().getPart(index).orElse(null), returns());
184   }
185
186   @Override /* Overridden from Assertion */
187   public FluentVersionAssertion<R> setMsg(String msg, Object...args) {
188      super.setMsg(msg, args);
189      return this;
190   }
191
192   @Override /* Overridden from Assertion */
193   public FluentVersionAssertion<R> setOut(PrintStream value) {
194      super.setOut(value);
195      return this;
196   }
197
198   @Override /* Overridden from Assertion */
199   public FluentVersionAssertion<R> setSilent() {
200      super.setSilent();
201      return this;
202   }
203
204   @Override /* Overridden from Assertion */
205   public FluentVersionAssertion<R> setStdOut() {
206      super.setStdOut();
207      return this;
208   }
209
210   @Override /* Overridden from Assertion */
211   public FluentVersionAssertion<R> setThrowable(Class<? extends java.lang.RuntimeException> value) {
212      super.setThrowable(value);
213      return this;
214   }
215}