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.rest.assertions;
018
019import java.io.*;
020import java.util.function.*;
021
022import org.apache.http.*;
023import org.apache.juneau.assertions.*;
024import org.apache.juneau.http.response.*;
025import org.apache.juneau.internal.*;
026import org.apache.juneau.serializer.*;
027
028/**
029 * Used for fluent assertion calls against {@link ProtocolVersion} objects.
030 *
031 * <h5 class='topic'>Test Methods</h5>
032 * <p>
033 * <ul class='javatree'>
034 *    <li class='jc'>{@link FluentObjectAssertion}
035 *    <ul class='javatreec'>
036 *       <li class='jm'>{@link FluentObjectAssertion#isExists() isExists()}
037 *       <li class='jm'>{@link FluentObjectAssertion#is(Object) is(Object)}
038 *       <li class='jm'>{@link FluentObjectAssertion#is(Predicate) is(Predicate)}
039 *       <li class='jm'>{@link FluentObjectAssertion#isNot(Object) isNot(Object)}
040 *       <li class='jm'>{@link FluentObjectAssertion#isAny(Object...) isAny(Object...)}
041 *       <li class='jm'>{@link FluentObjectAssertion#isNotAny(Object...) isNotAny(Object...)}
042 *       <li class='jm'>{@link FluentObjectAssertion#isNull() isNull()}
043 *       <li class='jm'>{@link FluentObjectAssertion#isNotNull() isNotNull()}
044 *       <li class='jm'>{@link FluentObjectAssertion#isString(String) isString(String)}
045 *       <li class='jm'>{@link FluentObjectAssertion#isJson(String) isJson(String)}
046 *       <li class='jm'>{@link FluentObjectAssertion#isSame(Object) isSame(Object)}
047 *       <li class='jm'>{@link FluentObjectAssertion#isSameJsonAs(Object) isSameJsonAs(Object)}
048 *       <li class='jm'>{@link FluentObjectAssertion#isSameSortedJsonAs(Object) isSameSortedJsonAs(Object)}
049 *       <li class='jm'>{@link FluentObjectAssertion#isSameSerializedAs(Object, WriterSerializer) isSameSerializedAs(Object, WriterSerializer)}
050 *       <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)}
051 *       <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)}
052 *    </ul>
053 * </ul>
054 *
055 * <h5 class='topic'>Transform Methods</h5>
056 * <p>
057 * <ul class='javatree'>
058 *    <li class='jc'>{@link FluentProtocolVersionAssertion}
059 *    <ul class='javatreec'>
060 *       <li class='jm'>{@link FluentProtocolVersionAssertion#asProtocol() asProtocol()}
061 *       <li class='jm'>{@link FluentProtocolVersionAssertion#asMajor() asMajor()}
062 *       <li class='jm'>{@link FluentProtocolVersionAssertion#asMinor() asMinor()}
063 *    </ul>
064 *    <li class='jc'>{@link FluentObjectAssertion}
065 *    <ul class='javatreec'>
066 *       <li class='jm'>{@link FluentObjectAssertion#asString() asString()}
067 *       <li class='jm'>{@link FluentObjectAssertion#asString(WriterSerializer) asString(WriterSerializer)}
068 *       <li class='jm'>{@link FluentObjectAssertion#asString(Function) asString(Function)}
069 *       <li class='jm'>{@link FluentObjectAssertion#asJson() asJson()}
070 *       <li class='jm'>{@link FluentObjectAssertion#asJsonSorted() asJsonSorted()}
071 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(Function) asApplied(Function)}
072 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
073 * </ul>
074 * </ul>
075 *
076 * <h5 class='topic'>Configuration Methods</h5>
077 * <p>
078 * <ul class='javatree'>
079 *    <li class='jc'>{@link Assertion}
080 *    <ul class='javatreec'>
081 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
082 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
083 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
084 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
085 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
086 *    </ul>
087 * </ul>
088 * <h5 class='section'>See Also:</h5><ul>
089 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem Overview</a>
090 * </ul>
091 *
092 * @param <R> The return type.
093 */
094public class FluentProtocolVersionAssertion<R> extends FluentObjectAssertion<ProtocolVersion,R> {
095
096   //-----------------------------------------------------------------------------------------------------------------
097   // Constructors
098   //-----------------------------------------------------------------------------------------------------------------
099
100   /**
101    * Constructor.
102    *
103    * @param value
104    *    The object being tested.
105    *    <br>Can be <jk>null</jk>.
106    * @param returns
107    *    The object to return after a test method is called.
108    *    <br>If <jk>null</jk>, the test method returns this object allowing multiple test method calls to be
109    * used on the same assertion.
110    */
111   public FluentProtocolVersionAssertion(ProtocolVersion value, R returns) {
112      this(null, value, returns);
113   }
114
115   /**
116    * Chained constructor.
117    *
118    * <p>
119    * Used when transforming one assertion into another so that the assertion config can be used by the new assertion.
120    *
121    * @param creator
122    *    The assertion that created this assertion.
123    *    <br>Should be <jk>null</jk> if this is the top-level assertion.
124    * @param value
125    *    The object being tested.
126    *    <br>Can be <jk>null</jk>.
127    * @param returns
128    *    The object to return after a test method is called.
129    *    <br>If <jk>null</jk>, the test method returns this object allowing multiple test method calls to be
130    * used on the same assertion.
131    */
132   public FluentProtocolVersionAssertion(Assertion creator, ProtocolVersion value, R returns) {
133      super(creator, value, returns);
134      setThrowable(BadRequest.class);
135   }
136
137   //-----------------------------------------------------------------------------------------------------------------
138   // Transform methods
139   //-----------------------------------------------------------------------------------------------------------------
140
141   /**
142    * Returns the protocol string as a new assertion.
143    *
144    * @return A new assertion.
145    */
146   public FluentStringAssertion<R> asProtocol() {
147      return new FluentStringAssertion<>(value().getProtocol(), returns());
148   }
149
150   /**
151    * Returns the protocol major version as a new assertion.
152    *
153    * @return A new assertion.
154    */
155   public FluentIntegerAssertion<R> asMajor() {
156      return new FluentIntegerAssertion<>(value().getMajor(), returns());
157   }
158
159   /**
160    * Returns the protocol minor version as a new assertion.
161    *
162    * @return A new assertion.
163    */
164   public FluentIntegerAssertion<R> asMinor() {
165      return new FluentIntegerAssertion<>(value().getMinor(), returns());
166   }
167
168   //-----------------------------------------------------------------------------------------------------------------
169   // Fluent setters
170   //-----------------------------------------------------------------------------------------------------------------
171   @Override /* Overridden from Assertion */
172   public FluentProtocolVersionAssertion<R> setMsg(String msg, Object...args) {
173      super.setMsg(msg, args);
174      return this;
175   }
176
177   @Override /* Overridden from Assertion */
178   public FluentProtocolVersionAssertion<R> setOut(PrintStream value) {
179      super.setOut(value);
180      return this;
181   }
182
183   @Override /* Overridden from Assertion */
184   public FluentProtocolVersionAssertion<R> setSilent() {
185      super.setSilent();
186      return this;
187   }
188
189   @Override /* Overridden from Assertion */
190   public FluentProtocolVersionAssertion<R> setStdOut() {
191      super.setStdOut();
192      return this;
193   }
194
195   @Override /* Overridden from Assertion */
196   public FluentProtocolVersionAssertion<R> setThrowable(Class<? extends java.lang.RuntimeException> value) {
197      super.setThrowable(value);
198      return this;
199   }
200}