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.nio.charset.*;
021import java.util.function.*;
022
023import org.apache.juneau.internal.*;
024import org.apache.juneau.serializer.*;
025
026/**
027 * Used for assertion calls against byte arrays.
028 *
029 * <h5 class='section'>Example:</h5>
030 * <p class='bjava'>
031 *    <jc>// Validates the byte array contains the string "foo".</jc>
032 *    <jsm>assertBytes</jsm>(<jv>myByteArray</jv>).asHex().is(<js>"666F6F"</js>);
033 * </p>
034 *
035 *
036 * <h5 class='section'>Test Methods:</h5>
037 * <p>
038 * <ul class='javatree'>
039 *    <li class='jc'>{@link FluentPrimitiveArrayAssertion}
040 *    <ul class='javatreec'>
041 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#isHas(Object...) isHas(Object...)}
042 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#is(Predicate) is(Predicate)}
043 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#isAny(Predicate) isAny(Predicate)}
044 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#isAll(Predicate) isAll(Predicate)}
045 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#isEmpty() isEmpty()}
046 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#isNotEmpty() isNotEmpty()}
047 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#isSize(int) isSize(int)}
048 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#isContains(Object) isContains(Object)}
049 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#isNotContains(Object) isNotContains(Object)}
050 *    </ul>
051 *    <li class='jc'>{@link FluentObjectAssertion}
052 *    <ul class='javatreec'>
053 *       <li class='jm'>{@link FluentObjectAssertion#isExists() isExists()}
054 *       <li class='jm'>{@link FluentObjectAssertion#is(Object) is(Object)}
055 *       <li class='jm'>{@link FluentObjectAssertion#is(Predicate) is(Predicate)}
056 *       <li class='jm'>{@link FluentObjectAssertion#isNot(Object) isNot(Object)}
057 *       <li class='jm'>{@link FluentObjectAssertion#isAny(Object...) isAny(Object...)}
058 *       <li class='jm'>{@link FluentObjectAssertion#isNotAny(Object...) isNotAny(Object...)}
059 *       <li class='jm'>{@link FluentObjectAssertion#isNull() isNull()}
060 *       <li class='jm'>{@link FluentObjectAssertion#isNotNull() isNotNull()}
061 *       <li class='jm'>{@link FluentObjectAssertion#isString(String) isString(String)}
062 *       <li class='jm'>{@link FluentObjectAssertion#isJson(String) isJson(String)}
063 *       <li class='jm'>{@link FluentObjectAssertion#isSame(Object) isSame(Object)}
064 *       <li class='jm'>{@link FluentObjectAssertion#isSameJsonAs(Object) isSameJsonAs(Object)}
065 *       <li class='jm'>{@link FluentObjectAssertion#isSameSortedJsonAs(Object) isSameSortedJsonAs(Object)}
066 *       <li class='jm'>{@link FluentObjectAssertion#isSameSerializedAs(Object, WriterSerializer) isSameSerializedAs(Object, WriterSerializer)}
067 *       <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)}
068 *       <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)}
069 *    </ul>
070 * </ul>
071 *
072 * <h5 class='section'>Transform Methods:</h5>
073 * <p>
074 * <ul class='javatree'>
075 *    <li class='jc'>{@link FluentByteArrayAssertion}
076 *    <ul class='javatreec'>
077 *       <li class='jm'>{@link FluentByteArrayAssertion#asString() asString()}
078 *       <li class='jm'>{@link FluentByteArrayAssertion#asString(Charset) asString(Charset)}
079 *       <li class='jm'>{@link FluentByteArrayAssertion#asBase64() asBase64()}
080 *       <li class='jm'>{@link FluentByteArrayAssertion#asHex() asHex()}
081 *       <li class='jm'>{@link FluentByteArrayAssertion#asSpacedHex() asSpacedHex()}
082 *    </ul>
083 *    <li class='jc'>{@link FluentPrimitiveArrayAssertion}
084 *    <ul class='javatreec'>
085 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#asItem(int) asItem(int)}
086 *       <li class='jm'>{@link FluentPrimitiveArrayAssertion#asLength() asLength()}
087 *    </ul>
088 *    <li class='jc'>{@link FluentObjectAssertion}
089 *    <ul class='javatreec'>
090 *       <li class='jm'>{@link FluentObjectAssertion#asString() asString()}
091 *       <li class='jm'>{@link FluentObjectAssertion#asString(WriterSerializer) asString(WriterSerializer)}
092 *       <li class='jm'>{@link FluentObjectAssertion#asString(Function) asString(Function)}
093 *       <li class='jm'>{@link FluentObjectAssertion#asJson() asJson()}
094 *       <li class='jm'>{@link FluentObjectAssertion#asJsonSorted() asJsonSorted()}
095 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(Function) asApplied(Function)}
096 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
097 * </ul>
098 * </ul>
099 *
100 * <h5 class='section'>Configuration Methods:</h5>
101 * <p>
102 * <ul class='javatree'>
103 *    <li class='jc'>{@link Assertion}
104 *    <ul class='javatreec'>
105 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
106 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
107 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
108 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
109 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
110 *    </ul>
111 * </ul>
112 *
113 * <h5 class='section'>See Also:</h5><ul>
114 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem Overview</a>
115 * </ul>
116 */
117public class ByteArrayAssertion extends FluentByteArrayAssertion<ByteArrayAssertion> {
118
119   //-----------------------------------------------------------------------------------------------------------------
120   // Static
121   //-----------------------------------------------------------------------------------------------------------------
122
123   /**
124    * Static creator.
125    *
126    * @param value
127    *    The object being tested.
128    *    <br>Can be <jk>null</jk>.
129    * @return A new assertion object.
130    */
131   public static ByteArrayAssertion create(byte[] value) {
132      return new ByteArrayAssertion(value);
133   }
134
135   //-----------------------------------------------------------------------------------------------------------------
136   // Instance
137   //-----------------------------------------------------------------------------------------------------------------
138
139   /**
140    * Constructor.
141    *
142    * @param value
143    *    The object being tested.
144    *    <br>Can be <jk>null</jk>.
145    */
146   public ByteArrayAssertion(byte[] value) {
147      super(value, null);
148   }
149
150   //-----------------------------------------------------------------------------------------------------------------
151   // Fluent setters
152   //-----------------------------------------------------------------------------------------------------------------
153   @Override /* Overridden from Assertion */
154   public ByteArrayAssertion setMsg(String msg, Object...args) {
155      super.setMsg(msg, args);
156      return this;
157   }
158
159   @Override /* Overridden from Assertion */
160   public ByteArrayAssertion setOut(PrintStream value) {
161      super.setOut(value);
162      return this;
163   }
164
165   @Override /* Overridden from Assertion */
166   public ByteArrayAssertion setSilent() {
167      super.setSilent();
168      return this;
169   }
170
171   @Override /* Overridden from Assertion */
172   public ByteArrayAssertion setStdOut() {
173      super.setStdOut();
174      return this;
175   }
176
177   @Override /* Overridden from Assertion */
178   public ByteArrayAssertion setThrowable(Class<? extends java.lang.RuntimeException> value) {
179      super.setThrowable(value);
180      return this;
181   }
182}