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.server.assertions;
018
019import java.io.*;
020import java.util.function.*;
021
022import org.apache.juneau.commons.function.*;
023import org.apache.juneau.http.*;
024import org.apache.juneau.http.response.*;
025import org.apache.juneau.bct.assertions.*;
026
027/**
028 * Used for fluent assertion calls against {@link HttpProtocolVersion} 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#isSame(Object) isSame(Object)}
045 *       <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)}
046 *       <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)}
047 *    </ul>
048 * </ul>
049 *
050 * <h5 class='topic'>Transform Methods</h5>
051 * <p>
052 * <ul class='javatree'>
053 *    <li class='jc'>{@link FluentProtocolVersionAssertion}
054 *    <ul class='javatreec'>
055 *       <li class='jm'>{@link FluentProtocolVersionAssertion#asProtocol() asProtocol()}
056 *       <li class='jm'>{@link FluentProtocolVersionAssertion#asMajor() asMajor()}
057 *       <li class='jm'>{@link FluentProtocolVersionAssertion#asMinor() asMinor()}
058 *    </ul>
059 *    <li class='jc'>{@link FluentObjectAssertion}
060 *    <ul class='javatreec'>
061 *       <li class='jm'>{@link FluentObjectAssertion#asString() asString()}
062 *       <li class='jm'>{@link FluentObjectAssertion#asString(ThrowingFunction) asString(ThrowingFunction)}
063 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(UnaryOperator) asTransformed(UnaryOperator)}
064 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
065 * </ul>
066 * </ul>
067 *
068 * <h5 class='topic'>Configuration Methods</h5>
069 * <p>
070 * <ul class='javatree'>
071 *    <li class='jc'>{@link Assertion}
072 *    <ul class='javatreec'>
073 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
074 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
075 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
076 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
077 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
078 *    </ul>
079 * </ul>
080 * <h5 class='section'>See Also:</h5><ul>
081 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem</a>
082 * </ul>
083 *
084 * @param <R> The return type.
085 */
086public class FluentProtocolVersionAssertion<R> extends FluentObjectAssertion<HttpProtocolVersion,R> {
087
088   /**
089    * Chained constructor.
090    *
091    * <p>
092    * Used when transforming one assertion into another so that the assertion config can be used by the new assertion.
093    *
094    * @param creator
095    *    The assertion that created this assertion.
096    *    <br>Should be <jk>null</jk> if this is the top-level assertion.
097    * @param value
098    *    The object being tested.
099    *    <br>Can be <jk>null</jk> (assertions such as {@code isNull()} then operate on the absence of a value).
100    * @param returns
101    *    The object to return after a test method is called.
102    *    <br>If <jk>null</jk>, the test method returns this object allowing multiple test method calls to be
103    * used on the same assertion.
104    */
105   public FluentProtocolVersionAssertion(Assertion creator, HttpProtocolVersion value, R returns) {
106      super(creator, value, returns);
107      setThrowable(BadRequest.class);
108   }
109
110   /**
111    * Constructor.
112    *
113    * @param value
114    *    The object being tested.
115    *    <br>Can be <jk>null</jk> (assertions such as {@code isNull()} then operate on the absence of a value).
116    * @param returns
117    *    The object to return after a test method is called.
118    *    <br>If <jk>null</jk>, the test method returns this object allowing multiple test method calls to be
119    * used on the same assertion.
120    */
121   public FluentProtocolVersionAssertion(HttpProtocolVersion value, R returns) {
122      this(null, value, returns);
123   }
124
125   /**
126    * Returns the protocol major version as a new assertion.
127    *
128    * @return A new assertion.
129    */
130   public FluentIntegerAssertion<R> asMajor() {
131      return new FluentIntegerAssertion<>(value().major(), returns());
132   }
133
134   /**
135    * Returns the protocol minor version as a new assertion.
136    *
137    * @return A new assertion.
138    */
139   public FluentIntegerAssertion<R> asMinor() {
140      return new FluentIntegerAssertion<>(value().minor(), returns());
141   }
142
143   /**
144    * Returns the protocol string as a new assertion.
145    *
146    * @return A new assertion.
147    */
148   public FluentStringAssertion<R> asProtocol() {
149      return new FluentStringAssertion<>(value().protocol(), returns());
150   }
151
152   @Override /* Overridden from Assertion */
153   public FluentProtocolVersionAssertion<R> setMsg(String msg, Object...args) {
154      super.setMsg(msg, args);
155      return this;
156   }
157
158   @Override /* Overridden from Assertion */
159   public FluentProtocolVersionAssertion<R> setOut(PrintStream value) {
160      super.setOut(value);
161      return this;
162   }
163
164   @Override /* Overridden from Assertion */
165   public FluentProtocolVersionAssertion<R> setSilent() {
166      super.setSilent();
167      return this;
168   }
169
170   @Override /* Overridden from Assertion */
171   public FluentProtocolVersionAssertion<R> setStdOut() {
172      super.setStdOut();
173      return this;
174   }
175
176   @Override /* Overridden from Assertion */
177   public FluentProtocolVersionAssertion<R> setThrowable(Class<? extends RuntimeException> value) {
178      super.setThrowable(value);
179      return this;
180   }
181}