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.assertions;
018
019import java.io.*;
020import java.time.temporal.*;
021import java.util.*;
022import java.util.function.*;
023
024import org.apache.juneau.internal.*;
025import org.apache.juneau.serializer.*;
026
027/**
028 * Used for assertion calls against {@link Date} objects.
029 *
030 * <h5 class='section'>Example:</h5>
031 * <p class='bjava'>
032 *    <jc>// Validates the specified date is after the current date.</jc>
033 *    <jsm>assertDate</jsm>(<jv>myDate</jv>).isAfterNow();
034 * </p>
035 *
036 * <h5 class='section'>Test Methods:</h5>
037 * <p>
038 * <ul class='javatree'>
039 *    <li class='jc'>{@link FluentDateAssertion}
040 *    <ul class='javatreec'>
041 *       <li class='jm'>{@link FluentDateAssertion#is(Date,ChronoUnit) is(Date,ChronoUnit)}
042 *       <li class='jm'>{@link FluentDateAssertion#isAfter(Date) isAfter(Date)}
043 *       <li class='jm'>{@link FluentDateAssertion#isAfterNow() isAfterNow()}
044 *       <li class='jm'>{@link FluentDateAssertion#isBefore(Date) isBefore(Date)}
045 *       <li class='jm'>{@link FluentDateAssertion#isBeforeNow() isBeforeNow()}
046 *       <li class='jm'>{@link FluentDateAssertion#isBetween(Date,Date) isBetween(Date,Date)}
047 *    </ul>
048 *    <li class='jc'>{@link FluentComparableAssertion}
049 *    <ul class='javatreec'>
050 *       <li class='jm'>{@link FluentComparableAssertion#isGt(Comparable) isGt(Comparable)}
051 *       <li class='jm'>{@link FluentComparableAssertion#isGte(Comparable) isGte(Comparable)}
052 *       <li class='jm'>{@link FluentComparableAssertion#isLt(Comparable) isLt(Comparable)}
053 *       <li class='jm'>{@link FluentComparableAssertion#isLte(Comparable) isLte(Comparable)}
054 *       <li class='jm'>{@link FluentComparableAssertion#isBetween(Comparable,Comparable) isBetween(Comparable,Comparable)}
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='section'>Transform Methods:</h5>
078 * <p>
079 * <ul class='javatree'>
080 *    <li class='jc'>{@link FluentDateAssertion}
081 *    <ul class='javatreec'>
082 *       <li class='jm'>{@link FluentDateAssertion#asEpochMillis() asEpochMillis()}
083 *       <li class='jm'>{@link FluentDateAssertion#asEpochSeconds() asEpochSeconds()}
084 *    </ul>
085 *    <li class='jc'>{@link FluentObjectAssertion}
086 *    <ul class='javatreec'>
087 *       <li class='jm'>{@link FluentObjectAssertion#asString() asString()}
088 *       <li class='jm'>{@link FluentObjectAssertion#asString(WriterSerializer) asString(WriterSerializer)}
089 *       <li class='jm'>{@link FluentObjectAssertion#asString(Function) asString(Function)}
090 *       <li class='jm'>{@link FluentObjectAssertion#asJson() asJson()}
091 *       <li class='jm'>{@link FluentObjectAssertion#asJsonSorted() asJsonSorted()}
092 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(Function) asApplied(Function)}
093 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
094 * </ul>
095 * </ul>
096 *
097 * <h5 class='section'>Configuration Methods:</h5>
098 * <p>
099 * <ul class='javatree'>
100 *    <li class='jc'>{@link Assertion}
101 *    <ul class='javatreec'>
102 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
103 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
104 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
105 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
106 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
107 *    </ul>
108 * </ul>
109 *
110 * <h5 class='section'>See Also:</h5><ul>
111 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem Overview</a>
112 * </ul>
113 */
114public class DateAssertion extends FluentDateAssertion<DateAssertion> {
115
116   //-----------------------------------------------------------------------------------------------------------------
117   // Static
118   //-----------------------------------------------------------------------------------------------------------------
119
120   /**
121    * Static creator.
122    *
123    * @param value
124    *    The object being tested.
125    *    <br>Can be <jk>null</jk>.
126    * @return A new assertion object.
127    */
128   public static DateAssertion create(Date value) {
129      return new DateAssertion(value);
130   }
131
132   //-----------------------------------------------------------------------------------------------------------------
133   // Instance
134   //-----------------------------------------------------------------------------------------------------------------
135
136   /**
137    * Constructor.
138    *
139    * @param value
140    *    The object being tested.
141    *    <br>Can be <jk>null</jk>.
142    */
143   public DateAssertion(Date value) {
144      super(value, null);
145   }
146
147   //-----------------------------------------------------------------------------------------------------------------
148   // Fluent setters
149   //-----------------------------------------------------------------------------------------------------------------
150   @Override /* Overridden from Assertion */
151   public DateAssertion setMsg(String msg, Object...args) {
152      super.setMsg(msg, args);
153      return this;
154   }
155
156   @Override /* Overridden from Assertion */
157   public DateAssertion setOut(PrintStream value) {
158      super.setOut(value);
159      return this;
160   }
161
162   @Override /* Overridden from Assertion */
163   public DateAssertion setSilent() {
164      super.setSilent();
165      return this;
166   }
167
168   @Override /* Overridden from Assertion */
169   public DateAssertion setStdOut() {
170      super.setStdOut();
171      return this;
172   }
173
174   @Override /* Overridden from Assertion */
175   public DateAssertion setThrowable(Class<? extends java.lang.RuntimeException> value) {
176      super.setThrowable(value);
177      return this;
178   }
179}