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.serializer.*;
025
026/**
027 * Used for assertion calls against {@link Date} objects.
028 *
029 * <h5 class='section'>Example:</h5>
030 * <p class='bjava'>
031 *    <jc>// Validates the specified date is after the current date.</jc>
032 *    <jsm>assertDate</jsm>(<jv>myDate</jv>).isAfterNow();
033 * </p>
034 *
035 * <h5 class='section'>Test Methods:</h5>
036 * <p>
037 * <ul class='javatree'>
038 *    <li class='jc'>{@link FluentDateAssertion}
039 *    <ul class='javatreec'>
040 *       <li class='jm'>{@link FluentDateAssertion#is(Date,ChronoUnit) is(Date,ChronoUnit)}
041 *       <li class='jm'>{@link FluentDateAssertion#isAfter(Date) isAfter(Date)}
042 *       <li class='jm'>{@link FluentDateAssertion#isAfterNow() isAfterNow()}
043 *       <li class='jm'>{@link FluentDateAssertion#isBefore(Date) isBefore(Date)}
044 *       <li class='jm'>{@link FluentDateAssertion#isBeforeNow() isBeforeNow()}
045 *       <li class='jm'>{@link FluentDateAssertion#isBetween(Date,Date) isBetween(Date,Date)}
046 *    </ul>
047 *    <li class='jc'>{@link FluentComparableAssertion}
048 *    <ul class='javatreec'>
049 *       <li class='jm'>{@link FluentComparableAssertion#isGt(Comparable) isGt(Comparable)}
050 *       <li class='jm'>{@link FluentComparableAssertion#isGte(Comparable) isGte(Comparable)}
051 *       <li class='jm'>{@link FluentComparableAssertion#isLt(Comparable) isLt(Comparable)}
052 *       <li class='jm'>{@link FluentComparableAssertion#isLte(Comparable) isLte(Comparable)}
053 *       <li class='jm'>{@link FluentComparableAssertion#isBetween(Comparable,Comparable) isBetween(Comparable,Comparable)}
054  *   </ul>
055 *    <li class='jc'>{@link FluentObjectAssertion}
056 *    <ul class='javatreec'>
057 *       <li class='jm'>{@link FluentObjectAssertion#isExists() isExists()}
058 *       <li class='jm'>{@link FluentObjectAssertion#is(Object) is(Object)}
059 *       <li class='jm'>{@link FluentObjectAssertion#is(Predicate) is(Predicate)}
060 *       <li class='jm'>{@link FluentObjectAssertion#isNot(Object) isNot(Object)}
061 *       <li class='jm'>{@link FluentObjectAssertion#isAny(Object...) isAny(Object...)}
062 *       <li class='jm'>{@link FluentObjectAssertion#isNotAny(Object...) isNotAny(Object...)}
063 *       <li class='jm'>{@link FluentObjectAssertion#isNull() isNull()}
064 *       <li class='jm'>{@link FluentObjectAssertion#isNotNull() isNotNull()}
065 *       <li class='jm'>{@link FluentObjectAssertion#isString(String) isString(String)}
066 *       <li class='jm'>{@link FluentObjectAssertion#isJson(String) isJson(String)}
067 *       <li class='jm'>{@link FluentObjectAssertion#isSame(Object) isSame(Object)}
068 *       <li class='jm'>{@link FluentObjectAssertion#isSameJsonAs(Object) isSameJsonAs(Object)}
069 *       <li class='jm'>{@link FluentObjectAssertion#isSameSortedJsonAs(Object) isSameSortedJsonAs(Object)}
070 *       <li class='jm'>{@link FluentObjectAssertion#isSameSerializedAs(Object, WriterSerializer) isSameSerializedAs(Object, WriterSerializer)}
071 *       <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)}
072 *       <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)}
073 *    </ul>
074 * </ul>
075 *
076 * <h5 class='section'>Transform Methods:</h5>
077 * <p>
078 * <ul class='javatree'>
079 *    <li class='jc'>{@link FluentDateAssertion}
080 *    <ul class='javatreec'>
081 *       <li class='jm'>{@link FluentDateAssertion#asEpochMillis() asEpochMillis()}
082 *       <li class='jm'>{@link FluentDateAssertion#asEpochSeconds() asEpochSeconds()}
083 *    </ul>
084 *    <li class='jc'>{@link FluentObjectAssertion}
085 *    <ul class='javatreec'>
086 *       <li class='jm'>{@link FluentObjectAssertion#asString() asString()}
087 *       <li class='jm'>{@link FluentObjectAssertion#asString(WriterSerializer) asString(WriterSerializer)}
088 *       <li class='jm'>{@link FluentObjectAssertion#asString(Function) asString(Function)}
089 *       <li class='jm'>{@link FluentObjectAssertion#asJson() asJson()}
090 *       <li class='jm'>{@link FluentObjectAssertion#asJsonSorted() asJsonSorted()}
091 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(Function) asApplied(Function)}
092 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
093 * </ul>
094 * </ul>
095 *
096 * <h5 class='section'>Configuration Methods:</h5>
097 * <p>
098 * <ul class='javatree'>
099 *    <li class='jc'>{@link Assertion}
100 *    <ul class='javatreec'>
101 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
102 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
103 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
104 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
105 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
106 *    </ul>
107 * </ul>
108 *
109 * <h5 class='section'>See Also:</h5><ul>
110 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem Overview</a>
111 * </ul>
112 */
113public class DateAssertion extends FluentDateAssertion<DateAssertion> {
114
115   /**
116    * Static creator.
117    *
118    * @param value
119    *    The object being tested.
120    *    <br>Can be <jk>null</jk>.
121    * @return A new assertion object.
122    */
123   public static DateAssertion create(Date value) {
124      return new DateAssertion(value);
125   }
126
127   /**
128    * Constructor.
129    *
130    * @param value
131    *    The object being tested.
132    *    <br>Can be <jk>null</jk>.
133    */
134   public DateAssertion(Date value) {
135      super(value, null);
136   }
137
138   @Override /* Overridden from Assertion */
139   public DateAssertion setMsg(String msg, Object...args) {
140      super.setMsg(msg, args);
141      return this;
142   }
143
144   @Override /* Overridden from Assertion */
145   public DateAssertion setOut(PrintStream value) {
146      super.setOut(value);
147      return this;
148   }
149
150   @Override /* Overridden from Assertion */
151   public DateAssertion setSilent() {
152      super.setSilent();
153      return this;
154   }
155
156   @Override /* Overridden from Assertion */
157   public DateAssertion setStdOut() {
158      super.setStdOut();
159      return this;
160   }
161
162   @Override /* Overridden from Assertion */
163   public DateAssertion setThrowable(Class<? extends java.lang.RuntimeException> value) {
164      super.setThrowable(value);
165      return this;
166   }
167}