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