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 RequestLine} 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 FluentRequestLineAssertion}
058 *    <ul class='javatreec'>
059 *       <li class='jm'>{@link FluentRequestLineAssertion#asMethod() asMethod()}
060 *       <li class='jm'>{@link FluentRequestLineAssertion#asUri() asUri()}
061 *       <li class='jm'>{@link FluentRequestLineAssertion#asProtocolVersion() asProtocolVersion()}
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 *
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 FluentRequestLineAssertion<R> extends FluentObjectAssertion<RequestLine,R> {
095   /**
096    * Chained constructor.
097    *
098    * <p>
099    * Used when transforming one assertion into another so that the assertion config can be used by the new assertion.
100    *
101    * @param creator
102    *    The assertion that created this assertion.
103    *    <br>Should be <jk>null</jk> if this is the top-level assertion.
104    * @param value
105    *    The object being tested.
106    *    <br>Can be <jk>null</jk>.
107    * @param returns
108    *    The object to return after a test method is called.
109    *    <br>If <jk>null</jk>, the test method returns this object allowing multiple test method calls to be
110    * used on the same assertion.
111    */
112   public FluentRequestLineAssertion(Assertion creator, RequestLine value, R returns) {
113      super(creator, value, returns);
114      setThrowable(BadRequest.class);
115   }
116
117   /**
118    * Constructor.
119    *
120    * @param value
121    *    The object being tested.
122    *    <br>Can be <jk>null</jk>.
123    * @param returns
124    *    The object to return after a test method is called.
125    *    <br>If <jk>null</jk>, the test method returns this object allowing multiple test method calls to be
126    * used on the same assertion.
127    */
128   public FluentRequestLineAssertion(RequestLine value, R returns) {
129      this(null, value, returns);
130   }
131
132   /**
133    * Returns the request line method string as a new assertion.
134    *
135    * @return A new assertion.
136    */
137   public FluentStringAssertion<R> asMethod() {
138      return new FluentStringAssertion<>(value().getMethod(), returns());
139   }
140
141   /**
142    * Returns the request line protocol version as a new assertion.
143    *
144    * @return A new assertion.
145    */
146   public FluentProtocolVersionAssertion<R> asProtocolVersion() {
147      return new FluentProtocolVersionAssertion<>(value().getProtocolVersion(), returns());
148   }
149
150   /**
151    * Returns the request line uri string as a new assertion.
152    *
153    * @return A new assertion.
154    */
155   public FluentStringAssertion<R> asUri() {
156      return new FluentStringAssertion<>(value().getUri(), returns());
157   }
158
159   @Override /* Overridden from Assertion */
160   public FluentRequestLineAssertion<R> setMsg(String msg, Object...args) {
161      super.setMsg(msg, args);
162      return this;
163   }
164
165   @Override /* Overridden from Assertion */
166   public FluentRequestLineAssertion<R> setOut(PrintStream value) {
167      super.setOut(value);
168      return this;
169   }
170
171   @Override /* Overridden from Assertion */
172   public FluentRequestLineAssertion<R> setSilent() {
173      super.setSilent();
174      return this;
175   }
176
177   @Override /* Overridden from Assertion */
178   public FluentRequestLineAssertion<R> setStdOut() {
179      super.setStdOut();
180      return this;
181   }
182
183   @Override /* Overridden from Assertion */
184   public FluentRequestLineAssertion<R> setThrowable(Class<? extends java.lang.RuntimeException> value) {
185      super.setThrowable(value);
186      return this;
187   }
188}