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 RequestFormParam} 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 FluentRequestFormParamAssertion}
081 *    <ul class='javatreec'>
082 *       <li class='jm'>{@link FluentRequestFormParamAssertion#asBoolean() asBoolean()}
083 *       <li class='jm'>{@link FluentRequestFormParamAssertion#asInteger() asInteger()}
084 *       <li class='jm'>{@link FluentRequestFormParamAssertion#asLong() asLong()}
085 *       <li class='jm'>{@link FluentRequestFormParamAssertion#asZonedDateTime() asZonedDateTime()}
086 *       <li class='jm'>{@link FluentRequestFormParamAssertion#as(Class) as(Class)}
087 *       <li class='jm'>{@link FluentRequestFormParamAssertion#as(Type,Type...) as(Type,Type...)}
088 *    </ul>
089 *    <li class='jc'>{@link FluentStringAssertion}
090 *    <ul class='javatreec'>
091 *       <li class='jm'>{@link FluentStringAssertion#asReplaceAll(String,String) asReplaceAll(String,String)}
092 *       <li class='jm'>{@link FluentStringAssertion#asReplace(String,String) asReplace(String,String)}
093 *       <li class='jm'>{@link FluentStringAssertion#asUrlDecode() asUrlDecode()}
094 *       <li class='jm'>{@link FluentStringAssertion#asLc() asLc()}
095 *       <li class='jm'>{@link FluentStringAssertion#asUc() asUc()}
096 *       <li class='jm'>{@link FluentStringAssertion#asLines() asLines()}
097 *       <li class='jm'>{@link FluentStringAssertion#asSplit(String) asSplit(String)}
098 *       <li class='jm'>{@link FluentStringAssertion#asLength() asLength()}
099 *       <li class='jm'>{@link FluentStringAssertion#asOneLine() asOneLine()}
100 *    </ul>
101 *    <li class='jc'>{@link FluentObjectAssertion}
102 *    <ul class='javatreec'>
103 *       <li class='jm'>{@link FluentObjectAssertion#asString() asString()}
104 *       <li class='jm'>{@link FluentObjectAssertion#asString(WriterSerializer) asString(WriterSerializer)}
105 *       <li class='jm'>{@link FluentObjectAssertion#asString(Function) asString(Function)}
106 *       <li class='jm'>{@link FluentObjectAssertion#asJson() asJson()}
107 *       <li class='jm'>{@link FluentObjectAssertion#asJsonSorted() asJsonSorted()}
108 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(Function) asApplied(Function)}
109 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
110 * </ul>
111 * </ul>
112 *
113 * <h5 class='topic'>Configuration Methods</h5>
114 * <p>
115 * <ul class='javatree'>
116 *    <li class='jc'>{@link Assertion}
117 *    <ul class='javatreec'>
118 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
119 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
120 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
121 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
122 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
123 *    </ul>
124 * </ul>
125 *
126 * <h5 class='section'>See Also:</h5><ul>
127 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem Overview</a>
128 * </ul>
129 *
130 * @param <R> The return type.
131 */
132public class FluentRequestFormParamAssertion<R> extends FluentStringAssertion<R> {
133
134   private final RequestFormParam value;
135
136   /**
137    * Chained constructor.
138    *
139    * <p>
140    * Used when transforming one assertion into another so that the assertion config can be used by the new assertion.
141    *
142    * @param creator
143    *    The assertion that created this assertion.
144    *    <br>Should be <jk>null</jk> if this is the top-level assertion.
145    * @param value
146    *    The object being tested.
147    *    <br>Can be <jk>null</jk>.
148    * @param returns
149    *    The object to return after a test method is called.
150    *    <br>If <jk>null</jk>, the test method returns this object allowing multiple test method calls to be
151    * used on the same assertion.
152    */
153   public FluentRequestFormParamAssertion(Assertion creator, RequestFormParam value, R returns) {
154      super(creator, value.asString().orElse(null), returns);
155      this.value = value;
156      setThrowable(BadRequest.class);
157   }
158
159   /**
160    * Constructor.
161    *
162    * @param value
163    *    The object being tested.
164    *    <br>Can be <jk>null</jk>.
165    * @param returns
166    *    The object to return after a test method is called.
167    *    <br>If <jk>null</jk>, the test method returns this object allowing multiple test method calls to be
168    * used on the same assertion.
169    */
170   public FluentRequestFormParamAssertion(RequestFormParam value, R returns) {
171      this(null, value, returns);
172   }
173
174   /**
175    * Converts the parameter value to a type using {@link RequestFormParam#as(Class)} and then returns the value as an any-object assertion.
176    *
177    * @param <T> The object type to create.
178    * @param type The object type to create.
179    * @return A new fluent assertion object.
180    */
181   public <T> FluentAnyAssertion<T,R> as(Class<T> type) {
182      return new FluentAnyAssertion<>(value.as(type).orElse(null), returns());
183   }
184
185   /**
186    * Converts the parameter value to a type using {@link RequestFormParam#as(Type,Type...)} and then returns the value as an any-object assertion.
187    *
188    * <p>
189    * 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}.
190    *
191    * @param type The object type to create.
192    * @param args Optional type arguments.
193    * @return A new fluent assertion object.
194    */
195   public FluentAnyAssertion<Object,R> as(Type type, Type...args) {
196      return new FluentAnyAssertion<>(value.as(type, args).orElse(null), returns());
197   }
198
199   /**
200    * Converts this object assertion into a boolean assertion.
201    *
202    * @return A new assertion.
203    * @throws AssertionError If object is not a boolean.
204    */
205   public FluentBooleanAssertion<R> asBoolean() {
206      return new FluentBooleanAssertion<>(this, value.asBoolean().orElse(null), returns());
207   }
208
209   /**
210    * Converts this object assertion into an integer assertion.
211    *
212    * @return A new assertion.
213    * @throws AssertionError If object is not an integer.
214    */
215   public FluentIntegerAssertion<R> asInteger() {
216      return new FluentIntegerAssertion<>(this, value.asInteger().orElse(null), returns());
217   }
218
219   @Override /* Overridden from FluentStringAssertion */
220   public FluentRequestFormParamAssertion<R> asJavaStrings() {
221      super.asJavaStrings();
222      return this;
223   }
224
225   /**
226    * Converts this object assertion into a long assertion.
227    *
228    * @return A new assertion.
229    * @throws AssertionError If object is not a long.
230    */
231   public FluentLongAssertion<R> asLong() {
232      return new FluentLongAssertion<>(this, value.asLong().orElse(null), returns());
233   }
234
235   /**
236    * Converts this object assertion into a zoned-datetime assertion.
237    *
238    * @return A new assertion.
239    * @throws AssertionError If object is not a zoned-datetime.
240    */
241   public FluentZonedDateTimeAssertion<R> asZonedDateTime() {
242      return new FluentZonedDateTimeAssertion<>(this, value.asDatePart().asZonedDateTime().orElse(null), returns());
243   }
244
245   @Override /* Overridden from Assertion */
246   public FluentRequestFormParamAssertion<R> setMsg(String msg, Object...args) {
247      super.setMsg(msg, args);
248      return this;
249   }
250
251   @Override /* Overridden from Assertion */
252   public FluentRequestFormParamAssertion<R> setOut(PrintStream value) {
253      super.setOut(value);
254      return this;
255   }
256
257   @Override /* Overridden from Assertion */
258   public FluentRequestFormParamAssertion<R> setSilent() {
259      super.setSilent();
260      return this;
261   }
262
263   @Override /* Overridden from Assertion */
264   public FluentRequestFormParamAssertion<R> setStdOut() {
265      super.setStdOut();
266      return this;
267   }
268
269   @Override /* Overridden from Assertion */
270   public FluentRequestFormParamAssertion<R> setThrowable(Class<? extends java.lang.RuntimeException> value) {
271      super.setThrowable(value);
272      return this;
273   }
274}