/**
 * 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 2012-2015 the original author or authors.
 */
package org.assertj.swing.fixture;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.util.Preconditions.checkNotNull;
import static org.assertj.swing.util.Colors.colorFromHexString;

import java.awt.Color;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import org.assertj.core.api.AbstractObjectAssert;
import org.assertj.core.description.Description;
import org.assertj.core.description.TextDescription;

/**
 * Verifies the state of {@code Color}s.
 * 
 * @author Alex Ruiz
 */
public class ColorFixture {
  private final Color target;
  private final Description description;

  /**
   * Creates a new {@link ColorFixture}.
   * 
   * @param target the color to manage.
   * @throws NullPointerException if {@code target} is {@code null}.
   */
  public ColorFixture(@Nonnull Color target) {
    this(target, (Description) null);
  }

  /**
   * Creates a new {@link ColorFixture}.
   * 
   * @param target the color to manage.
   * @param description this fixture's description.
   * @throws NullPointerException if {@code target} is {@code null}.
   */
  public ColorFixture(@Nonnull Color target, @Nonnull String description) {
    this(target, new TextDescription(description));
  }

  /**
   * Creates a new {@link ColorFixture}.
   * 
   * @param target the color to manage.
   * @param description this fixture's description.
   * @throws NullPointerException if {@code target} is {@code null}.
   */
  public ColorFixture(@Nonnull Color target, @Nullable Description description) {
    this.target = checkNotNull(target);
    this.description = description;
  }

  /**
   * Verifies that this fixture's {@code Color} is equal to the given color represented by the given hexadecimal value
   * (e.g. "82A9FF").
   * 
   * @param hexValue the value representing the color to compare to.
   * @return this fixture.
   * @throws NullPointerException if the hexadecimal code is {@code null}.
   * @throws IllegalArgumentException if the hexadecimal code is empty.
   * @throws NumberFormatException if the hexadecimal code is empty.
   * @throws AssertionError if this fixture's {@code Color} is not equal to the given one.
   */
  public @Nonnull ColorFixture requireEqualTo(@Nonnull String hexValue) {
    return requireEqualTo(colorFromHexString(hexValue));
  }

  /**
   * Verifies that this fixture's {@code Color} is equal to the given one.
   * 
   * @param color the given {@code Color} to compare to.
   * @return this fixture.
   * @throws AssertionError if this fixture's {@code Color} is not equal to the given one.
   */
  public @Nonnull ColorFixture requireEqualTo(@Nullable Color color) {
    AbstractObjectAssert<?, Color> assertThat = assertThat(target);
    describe(assertThat);
    assertThat.isEqualTo(color);
    return this;
  }

  private void describe(AbstractObjectAssert<?, Color> assertThat) {
    if (description != null) {
      assertThat.as(description);
    }
  }

  /**
   * Verifies that this fixture's {@code Color} is not equal to the given color represented by the given hexadecimal
   * value (e.g. "82A9FF").
   * 
   * @param hexValue the value representing the color to compare to.
   * @return this fixture.
   * @throws NullPointerException if the hexadecimal code is {@code null}.
   * @throws IllegalArgumentException if the hexadecimal code is empty.
   * @throws NumberFormatException if the hexadecimal code is empty.
   * @throws AssertionError if this fixture's {@code Color} is equal to the given one.
   */
  public @Nonnull ColorFixture requireNotEqualTo(@Nonnull String hexValue) {
    return requireNotEqualTo(colorFromHexString(hexValue));
  }

  /**
   * Verifies that this fixture's {@code Color} is not equal to the given one.
   * 
   * @param color the given {@code Color} to compare to.
   * @return this fixture.
   * @throws AssertionError if this fixture's {@code Color} is equal to the given one.
   */
  public @Nonnull ColorFixture requireNotEqualTo(@Nullable Color color) {
    AbstractObjectAssert<?, Color> assertThat = assertThat(target);
    describe(assertThat);
    assertThat.isNotEqualTo(color);
    return this;
  }

  /**
   * @return this fixture's {@code Color}.
   */
  public @Nonnull Color target() {
    return target;
  }

  /**
   * @return this fixture's description.
   */
  public final @Nullable String description() {
    return description != null ? description.value() : null;
  }
}