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