content: /*
   * Created on Dec 14, 2010
   *
   * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
   * the License. You may obtain a copy of the License at
   *
   * http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
   * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
   * specific language governing permissions and limitations under the License.
   *
   * Copyright @2010-2013 the original author or authors.
   */
  package org.fest.assertions.api;
  
  import org.fest.assertions.core.EnumerableAssert;
  import org.fest.assertions.data.Index;
  import org.fest.assertions.description.Description;
  import org.fest.assertions.internal.BooleanArrays;
  import org.fest.util.VisibleForTesting;
  
  /**
   * Assertion methods for arrays of {@code boolean}s.
   * <p>
   * To create an instance of this class, invoke <code>{@link Assertions#assertThat(boolean[])}</code>.
   * </p>
   *
   * @author Yvonne Wang
   * @author Alex Ruiz
   */
  public class BooleanArrayAssert extends AbstractAssert<BooleanArrayAssert, boolean[]> implements
      EnumerableAssert<BooleanArrayAssert> {
  
    @VisibleForTesting
    BooleanArrays arrays = BooleanArrays.instance();
  
    protected BooleanArrayAssert(boolean[] actual) {
      super(actual, BooleanArrayAssert.class);
    }
  
    protected BooleanArrayAssert(boolean[] actual, Description description) {
      super(actual, BooleanArrayAssert.class, description);
    }
  
    /** {@inheritDoc} */
    @Override
    public BooleanArrayAssert isNullOrEmpty() {
      arrays.assertNullOrEmpty(description, actual);
      return this;
    }
  
    /** {@inheritDoc} */
    @Override
    public BooleanArrayAssert isEmpty() {
      arrays.assertEmpty(description, actual);
      return this;
    }
  
    /** {@inheritDoc} */
    @Override
    public BooleanArrayAssert isNotEmpty() {
      arrays.assertNotEmpty(description, actual);
      return this;
    }
  
    /** {@inheritDoc} */
    @Override
    public BooleanArrayAssert hasSize(int expected) {
      arrays.assertHasSize(description, actual, expected);
      return this;
    }
  
    /**
     * Verifies that the actual array contains the given values, in any order.
     *
     * @param values the given values.
     * @return {@code this} assertion object.
     * @throws NullPointerException if the given argument is {@code null}.
     * @throws IllegalArgumentException if the given argument is an empty array.
     * @throws AssertionError if the actual array is {@code null}.
     * @throws AssertionError if the actual array does not contain the given values.
     */
    public BooleanArrayAssert contains(boolean... values) {
      arrays.assertContains(description, actual, values);
      return this;
    }
  
    /**
     * Verifies that the actual array contains only the given values and nothing else, in any order.
     *
     * @param values the given values.
     * @return {@code this} assertion object.
     * @throws NullPointerException if the given argument is {@code null}.
     * @throws IllegalArgumentException if the given argument is an empty array.
     * @throws AssertionError if the actual array is {@code null}.
     * @throws AssertionError if the actual array does not contain the given values, i.e. the actual array contains some
     *           or none of the given values, or the actual array contains more values than the given ones.
     */
    public BooleanArrayAssert containsOnly(boolean... values) {
      arrays.assertContainsOnly(description, actual, values);
      return this;
    }
  
    /**
     * Verifies that the actual array contains the given sequence, without any other values between them.
     *
     * @param sequence the sequence of values to look for.
     * @return this assertion object.
     * @throws AssertionError if the actual array is {@code null}.
     * @throws AssertionError if the given array is {@code null}.
     * @throws AssertionError if the actual array does not contain the given sequence.
     */
    public BooleanArrayAssert containsSequence(boolean... sequence) {
      arrays.assertContainsSequence(description, actual, sequence);
      return this;
    }
  
    /**
     * Verifies that the actual array contains the given value at the given index.
     *
     * @param value the value to look for.
     * @param index the index where the value should be stored in the actual array.
     * @return this assertion object.
     * @throws AssertionError if the actual array is {@code null} or empty.
     * @throws NullPointerException if the given {@code Index} is {@code null}.
     * @throws IndexOutOfBoundsException if the value of the given {@code Index} is equal to or greater than the size of
     *           the actual array.
     * @throws AssertionError if the actual array does not contain the given value at the given index.
     */
    public BooleanArrayAssert contains(boolean value, Index index) {
      arrays.assertContains(description, actual, value, index);
      return this;
    }
  
    /**
     * Verifies that the actual array does not contain the given values.
     *
     * @param values the given values.
     * @return {@code this} assertion object.
     * @throws NullPointerException if the given argument is {@code null}.
     * @throws IllegalArgumentException if the given argument is an empty array.
     * @throws AssertionError if the actual array is {@code null}.
     * @throws AssertionError if the actual array contains any of the given values.
     */
    public BooleanArrayAssert doesNotContain(boolean... values) {
      arrays.assertDoesNotContain(description, actual, values);
      return this;
    }
  
    /**
     * Verifies that the actual array does not contain the given value at the given index.
     *
     * @param value the value to look for.
     * @param index the index where the value should be stored in the actual array.
     * @return this assertion object.
     * @throws AssertionError if the actual array is {@code null}.
     * @throws NullPointerException if the given {@code Index} is {@code null}.
     * @throws AssertionError if the actual array contains the given value at the given index.
     */
    public BooleanArrayAssert doesNotContain(boolean value, Index index) {
      arrays.assertDoesNotContain(description, actual, value, index);
      return this;
    }
  
    /**
     * Verifies that the actual array does not contain duplicates.
     *
     * @return {@code this} assertion object.
     * @throws AssertionError if the actual array is {@code null}.
     * @throws AssertionError if the actual array contains duplicates.
     */
    public BooleanArrayAssert doesNotHaveDuplicates() {
      arrays.assertDoesNotHaveDuplicates(description, actual);
      return this;
    }
  
    /**
     * Verifies that the actual array starts with the given sequence of values, without any other values between them.
     * Similar to <code>{@link #containsSequence(boolean...)}</code>, but it also verifies that the first element in the
     * sequence is also first element of the actual array.
     *
     * @param sequence the sequence of values to look for.
     * @return this assertion object.
     * @throws NullPointerException if the given argument is {@code null}.
     * @throws IllegalArgumentException if the given argument is an empty array.
     * @throws AssertionError if the actual array is {@code null}.
     * @throws AssertionError if the actual array does not start with the given sequence.
     */
    public BooleanArrayAssert startsWith(boolean... sequence) {
      arrays.assertStartsWith(description, actual, sequence);
      return this;
    }
  
    /**
     * Verifies that the actual array ends with the given sequence of values, without any other values between them.
     * Similar to <code>{@link #containsSequence(boolean...)}</code>, but it also verifies that the last element in the
     * sequence is also last element of the actual array.
     *
     * @param sequence the sequence of values to look for.
     * @return this assertion object.
     * @throws NullPointerException if the given argument is {@code null}.
     * @throws IllegalArgumentException if the given argument is an empty array.
     * @throws AssertionError if the actual array is {@code null}.
     * @throws AssertionError if the actual array does not end with the given sequence.
     */
    public BooleanArrayAssert endsWith(boolean... sequence) {
      arrays.assertEndsWith(description, actual, sequence);
      return this;
    }
  }
  