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