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