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