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.*;
021import java.time.temporal.*;
022import java.util.function.*;
023
024import org.apache.juneau.serializer.*;
025
026/**
027 * Used for assertion calls against {@link ZonedDateTime} 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>assertZonedDateTime</jsm>(<jv>myZdt</jv>).isAfterNow();
033 * </p>
034 *
035 *
036 * <h5 class='section'>Test Methods:</h5>
037 * <p>
038 * <ul class='javatree'>
039 *    <li class='jc'>{@link FluentZonedDateTimeAssertion}
040 *    <ul class='javatreec'>
041 *       <li class='jm'>{@link FluentZonedDateTimeAssertion#is(ZonedDateTime,ChronoUnit) is(ZonedDateTime,ChronoUnit)}
042 *       <li class='jm'>{@link FluentZonedDateTimeAssertion#isAfter(ZonedDateTime) isAfter(ZonedDateTime)}
043 *       <li class='jm'>{@link FluentZonedDateTimeAssertion#isAfterNow() isAfterNow()}
044 *       <li class='jm'>{@link FluentZonedDateTimeAssertion#isBefore(ZonedDateTime) isBefore(ZonedDateTime)}
045 *       <li class='jm'>{@link FluentZonedDateTimeAssertion#isBeforeNow() isBeforeNow()}
046 *       <li class='jm'>{@link FluentZonedDateTimeAssertion#isBetween(ZonedDateTime,ZonedDateTime) isBetween(ZonedDateTime,ZonedDateTime)}
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 FluentObjectAssertion}
081 *    <ul class='javatreec'>
082 *       <li class='jm'>{@link FluentObjectAssertion#asString() asString()}
083 *       <li class='jm'>{@link FluentObjectAssertion#asString(WriterSerializer) asString(WriterSerializer)}
084 *       <li class='jm'>{@link FluentObjectAssertion#asString(Function) asString(Function)}
085 *       <li class='jm'>{@link FluentObjectAssertion#asJson() asJson()}
086 *       <li class='jm'>{@link FluentObjectAssertion#asJsonSorted() asJsonSorted()}
087 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(Function) asApplied(Function)}
088 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
089 * </ul>
090 * </ul>
091 *
092 * <h5 class='section'>Configuration Methods:</h5>
093 * <p>
094 * <ul class='javatree'>
095 *    <li class='jc'>{@link Assertion}
096 *    <ul class='javatreec'>
097 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
098 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
099 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
100 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
101 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
102 *    </ul>
103 * </ul>
104 *
105 * <h5 class='section'>See Also:</h5><ul>
106 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem Overview</a>
107 * </ul>
108 */
109public class ZonedDateTimeAssertion extends FluentZonedDateTimeAssertion<ZonedDateTimeAssertion> {
110
111   /**
112    * Static creator.
113    *
114    * @param value
115    *    The object being tested.
116    *    <br>Can be <jk>null</jk>.
117    * @return A new assertion object.
118    */
119   public static ZonedDateTimeAssertion create(ZonedDateTime value) {
120      return new ZonedDateTimeAssertion(value);
121   }
122
123   /**
124    * Constructor.
125    *
126    * @param value
127    *    The object being tested.
128    *    <br>Can be <jk>null</jk>.
129    */
130   public ZonedDateTimeAssertion(ZonedDateTime value) {
131      super(value, null);
132   }
133
134   @Override /* Overridden from Assertion */
135   public ZonedDateTimeAssertion setMsg(String msg, Object...args) {
136      super.setMsg(msg, args);
137      return this;
138   }
139
140   @Override /* Overridden from Assertion */
141   public ZonedDateTimeAssertion setOut(PrintStream value) {
142      super.setOut(value);
143      return this;
144   }
145
146   @Override /* Overridden from Assertion */
147   public ZonedDateTimeAssertion setSilent() {
148      super.setSilent();
149      return this;
150   }
151
152   @Override /* Overridden from Assertion */
153   public ZonedDateTimeAssertion setStdOut() {
154      super.setStdOut();
155      return this;
156   }
157
158   @Override /* Overridden from Assertion */
159   public ZonedDateTimeAssertion setThrowable(Class<? extends java.lang.RuntimeException> value) {
160      super.setThrowable(value);
161      return this;
162   }
163}