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