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.lang.reflect.*;
021import java.util.*;
022import java.util.function.*;
023import java.util.regex.*;
024
025import org.apache.juneau.assertions.*;
026import org.apache.juneau.http.response.*;
027import org.apache.juneau.rest.httppart.*;
028import org.apache.juneau.serializer.*;
029
030/**
031 * Used for fluent assertion calls against {@link RequestHeader} objects.
032 *
033 * <h5 class='topic'>Test Methods</h5>
034 * <p>
035 * <ul class='javatree'>
036 *    <li class='jc'>{@link FluentStringAssertion}
037 *    <ul class='javatreec'>
038 *       <li class='jm'>{@link FluentStringAssertion#is(String) is(String)}
039 *       <li class='jm'>{@link FluentStringAssertion#isNot(String) isNot(String)}
040 *       <li class='jm'>{@link FluentStringAssertion#isLines(String...) isLines(String...)}
041 *       <li class='jm'>{@link FluentStringAssertion#isSortedLines(String...) isSortedLines(String...)}
042 *       <li class='jm'>{@link FluentStringAssertion#isIc(String) isIc(String)}
043 *       <li class='jm'>{@link FluentStringAssertion#isNotIc(String) isNotIc(String)}
044 *       <li class='jm'>{@link FluentStringAssertion#isContains(String...) isContains(String...)}
045 *       <li class='jm'>{@link FluentStringAssertion#isNotContains(String...) isNotContains(String...)}
046 *       <li class='jm'>{@link FluentStringAssertion#isEmpty() isEmpty()}
047 *       <li class='jm'>{@link FluentStringAssertion#isNotEmpty() isNotEmpty()}
048 *       <li class='jm'>{@link FluentStringAssertion#isString(Object) isString(Object)}
049 *       <li class='jm'>{@link FluentStringAssertion#isMatches(String) isMatches(String)}
050 *       <li class='jm'>{@link FluentStringAssertion#isPattern(String) isPattern(String)}
051 *       <li class='jm'>{@link FluentStringAssertion#isPattern(String,int) isPattern(String,int)}
052 *       <li class='jm'>{@link FluentStringAssertion#isPattern(Pattern) isPattern(Pattern)}
053 *       <li class='jm'>{@link FluentStringAssertion#isStartsWith(String) isStartsWith(String)}
054 *       <li class='jm'>{@link FluentStringAssertion#isEndsWith(String) isEndsWith(String)}
055 *    </ul>
056 *    <li class='jc'>{@link FluentObjectAssertion}
057 *    <ul class='javatreec'>
058 *       <li class='jm'>{@link FluentObjectAssertion#isExists() isExists()}
059 *       <li class='jm'>{@link FluentObjectAssertion#is(Object) is(Object)}
060 *       <li class='jm'>{@link FluentObjectAssertion#is(Predicate) is(Predicate)}
061 *       <li class='jm'>{@link FluentObjectAssertion#isNot(Object) isNot(Object)}
062 *       <li class='jm'>{@link FluentObjectAssertion#isAny(Object...) isAny(Object...)}
063 *       <li class='jm'>{@link FluentObjectAssertion#isNotAny(Object...) isNotAny(Object...)}
064 *       <li class='jm'>{@link FluentObjectAssertion#isNull() isNull()}
065 *       <li class='jm'>{@link FluentObjectAssertion#isNotNull() isNotNull()}
066 *       <li class='jm'>{@link FluentObjectAssertion#isString(String) isString(String)}
067 *       <li class='jm'>{@link FluentObjectAssertion#isJson(String) isJson(String)}
068 *       <li class='jm'>{@link FluentObjectAssertion#isSame(Object) isSame(Object)}
069 *       <li class='jm'>{@link FluentObjectAssertion#isSameJsonAs(Object) isSameJsonAs(Object)}
070 *       <li class='jm'>{@link FluentObjectAssertion#isSameSortedJsonAs(Object) isSameSortedJsonAs(Object)}
071 *       <li class='jm'>{@link FluentObjectAssertion#isSameSerializedAs(Object, WriterSerializer) isSameSerializedAs(Object, WriterSerializer)}
072 *       <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)}
073 *       <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)}
074 *    </ul>
075 * </ul>
076 *
077 * <h5 class='topic'>Transform Methods</h5>
078 * <p>
079 * <ul class='javatree'>
080 *    <li class='jc'>{@link FluentRequestHeaderAssertion}
081 *    <ul class='javatreec'>
082 *       <li class='jm'>{@link FluentRequestHeaderAssertion#asBoolean() asBoolean()}
083 *       <li class='jm'>{@link FluentRequestHeaderAssertion#asInteger() asInteger()}
084 *       <li class='jm'>{@link FluentRequestHeaderAssertion#asLong() asLong()}
085 *       <li class='jm'>{@link FluentRequestHeaderAssertion#asZonedDateTime() asZonedDateTime()}
086 *       <li class='jm'>{@link FluentRequestHeaderAssertion#as(Class) as(Class)}
087 *    </ul>
088 *    <li class='jc'>{@link FluentStringAssertion}
089 *    <ul class='javatreec'>
090 *       <li class='jm'>{@link FluentStringAssertion#asReplaceAll(String,String) asReplaceAll(String,String)}
091 *       <li class='jm'>{@link FluentStringAssertion#asReplace(String,String) asReplace(String,String)}
092 *       <li class='jm'>{@link FluentStringAssertion#asUrlDecode() asUrlDecode()}
093 *       <li class='jm'>{@link FluentStringAssertion#asLc() asLc()}
094 *       <li class='jm'>{@link FluentStringAssertion#asUc() asUc()}
095 *       <li class='jm'>{@link FluentStringAssertion#asLines() asLines()}
096 *       <li class='jm'>{@link FluentStringAssertion#asSplit(String) asSplit(String)}
097 *       <li class='jm'>{@link FluentStringAssertion#asLength() asLength()}
098 *       <li class='jm'>{@link FluentStringAssertion#asOneLine() asOneLine()}
099 *    </ul>
100 *    <li class='jc'>{@link FluentObjectAssertion}
101 *    <ul class='javatreec'>
102 *       <li class='jm'>{@link FluentObjectAssertion#asString() asString()}
103 *       <li class='jm'>{@link FluentObjectAssertion#asString(WriterSerializer) asString(WriterSerializer)}
104 *       <li class='jm'>{@link FluentObjectAssertion#asString(Function) asString(Function)}
105 *       <li class='jm'>{@link FluentObjectAssertion#asJson() asJson()}
106 *       <li class='jm'>{@link FluentObjectAssertion#asJsonSorted() asJsonSorted()}
107 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(Function) asApplied(Function)}
108 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
109 * </ul>
110 * </ul>
111 *
112 * <h5 class='topic'>Configuration Methods</h5>
113 * <p>
114 * <ul class='javatree'>
115 *    <li class='jc'>{@link Assertion}
116 *    <ul class='javatreec'>
117 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
118 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
119 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
120 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
121 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
122 *    </ul>
123 * </ul>
124 *
125 * <h5 class='section'>See Also:</h5><ul>
126 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem Overview</a>
127 * </ul>
128 *
129 * @param <R> The return type.
130 */
131public class FluentRequestHeaderAssertion<R> extends FluentStringAssertion<R> {
132
133   private final RequestHeader value;
134
135   /**
136    * Chained constructor.
137    *
138    * <p>
139    * Used when transforming one assertion into another so that the assertion config can be used by the new assertion.
140    *
141    * @param creator
142    *    The assertion that created this assertion.
143    *    <br>Should be <jk>null</jk> if this is the top-level assertion.
144    * @param value
145    *    The object being tested.
146    *    <br>Can be <jk>null</jk>.
147    * @param returns
148    *    The object to return after a test method is called.
149    *    <br>If <jk>null</jk>, the test method returns this object allowing multiple test method calls to be
150    * used on the same assertion.
151    */
152   public FluentRequestHeaderAssertion(Assertion creator, RequestHeader value, R returns) {
153      super(null, value.asString().orElse(null), returns);
154      this.value = value;
155      setThrowable(BadRequest.class);
156   }
157
158   /**
159    * Constructor.
160    *
161    * @param value
162    *    The object being tested.
163    *    <br>Can be <jk>null</jk>.
164    * @param returns
165    *    The object to return after a test method is called.
166    *    <br>If <jk>null</jk>, the test method returns this object allowing multiple test method calls to be
167    * used on the same assertion.
168    */
169   public FluentRequestHeaderAssertion(RequestHeader value, R returns) {
170      this(null, value, returns);
171   }
172
173   /**
174    * Converts the parameter value to a type using {@link RequestHeader#as(Class)} and then returns the value as an any-object assertion.
175    *
176    * @param <T> The object type to create.
177    * @param type The object type to create.
178    * @return A new fluent assertion object.
179    */
180   public <T> FluentAnyAssertion<T,R> as(Class<T> type) {
181      return new FluentAnyAssertion<>(value.as(type).orElse(null), returns());
182   }
183
184   /**
185    * Converts the parameter value to a type using {@link RequestHeader#as(Type,Type...)} and then returns the value as an any-object assertion.
186    *
187    * <p>
188    * See <a class="doclink" href="https://juneau.apache.org/docs/topics/ComplexDataTypes">Complex Data Types</a> for information on defining complex generic types of {@link Map Maps} and {@link Collection Collections}.
189    *
190    * @param type The object type to create.
191    * @param args Optional type arguments.
192    * @return A new fluent assertion object.
193    */
194   public FluentAnyAssertion<Object,R> as(Type type, Type...args) {
195      return new FluentAnyAssertion<>(value.as(type, args).orElse(null), returns());
196   }
197
198   /**
199    * Converts this object assertion into a boolean assertion.
200    *
201    * @return A new assertion.
202    * @throws AssertionError If object is not a boolean.
203    */
204   public FluentBooleanAssertion<R> asBoolean() {
205      return new FluentBooleanAssertion<>(this, value.asBoolean().orElse(null), returns());
206   }
207
208   /**
209    * Converts this object assertion into an integer assertion.
210    *
211    * @return A new assertion.
212    * @throws AssertionError If object is not an integer.
213    */
214   public FluentIntegerAssertion<R> asInteger() {
215      return new FluentIntegerAssertion<>(this, value.asInteger().orElse(null), returns());
216   }
217
218   @Override /* Overridden from FluentStringAssertion */
219   public FluentRequestHeaderAssertion<R> asJavaStrings() {
220      super.asJavaStrings();
221      return this;
222   }
223
224   /**
225    * Converts this object assertion into a long assertion.
226    *
227    * @return A new assertion.
228    * @throws AssertionError If object is not a long.
229    */
230   public FluentLongAssertion<R> asLong() {
231      return new FluentLongAssertion<>(this, value.asLong().orElse(null), returns());
232   }
233
234   /**
235    * Converts this object assertion into a zoned-datetime assertion.
236    *
237    * @return A new assertion.
238    * @throws AssertionError If object is not a zoned-datetime.
239    */
240   public FluentZonedDateTimeAssertion<R> asZonedDateTime() {
241      return new FluentZonedDateTimeAssertion<>(this, value.asDateHeader().asZonedDateTime().orElse(null), returns());
242   }
243
244   @Override /* Overridden from Assertion */
245   public FluentRequestHeaderAssertion<R> setMsg(String msg, Object...args) {
246      super.setMsg(msg, args);
247      return this;
248   }
249
250   @Override /* Overridden from Assertion */
251   public FluentRequestHeaderAssertion<R> setOut(PrintStream value) {
252      super.setOut(value);
253      return this;
254   }
255
256   @Override /* Overridden from Assertion */
257   public FluentRequestHeaderAssertion<R> setSilent() {
258      super.setSilent();
259      return this;
260   }
261
262   @Override /* Overridden from Assertion */
263   public FluentRequestHeaderAssertion<R> setStdOut() {
264      super.setStdOut();
265      return this;
266   }
267
268   @Override /* Overridden from Assertion */
269   public FluentRequestHeaderAssertion<R> setThrowable(Class<? extends java.lang.RuntimeException> value) {
270      super.setThrowable(value);
271      return this;
272   }
273}