org.assertj.db.api.AbstractSubAssert Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of assertj-db Show documentation
AssertJ-DB - Rich and fluent assertions for testing with database
There is a newer version: 2.0.2
/**
 * 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.db.api;

import org.assertj.db.api.navigation.ToValue;
import org.assertj.db.api.origin.OriginWithColumnsAndRows;
import org.assertj.db.exception.AssertJDBException;
import org.assertj.db.type.AbstractDbData;
import org.assertj.db.type.Column;
import org.assertj.db.type.Row;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * Assertion methods about {@link Column} or {@link Row}.
 * 
 * @author Régis Pouiller
 * 
 * @param  The class of the actual value (an sub-class of {@link AbstractDbData}).
 * @param  The class of the original assertion (an sub-class of {@link AbstractDbAssert}).
 * @param  The class of this assertion (an sub-class of {@link AbstractSubAssert}).
 * @param  The class of this assertion on the value (an sub-class of {@link AbstractValueAssert}).
 * @param  The class of this assertion (an sub-class of {@link AbstractColumnAssert}).
 * @param  The class of this assertion on the value (an sub-class of {@link AbstractColumnValueAssert}).
 * @param  The class of the equivalent row assertion (an sub-class of {@link AbstractRowAssert}).
 * @param  The class of the equivalent row assertion on the value (an sub-class of {@link AbstractRowValueAssert}).
 */
public abstract class AbstractSubAssert, A extends AbstractDbAssert, S extends AbstractSubAssert, V extends AbstractValueAssert, C extends AbstractColumnAssert, CV extends AbstractColumnValueAssert, R extends AbstractRowAssert, RV extends AbstractRowValueAssert>
        extends AbstractAssertWithOriginWithColumnsAndRows
        implements OriginWithColumnsAndRows,
                   ToValue {

  /**
   * Class of the assertion on the value (used to make instance).
   */
  private final Class valueAssertClass;

  /**
   * Index of the next value to get.
   */
  private int indexNextValue;
  /**
   * Map the values assertion with their index in key (contains the values assertion already generated).
   */
  private final Map valuesAssertMap = new HashMap<>();

  /**
   * Constructor.
   * 
   * @param originalDbAssert The original assert. That could be a {@link RequestAssert} or a {@link TableAssert}.
   * @param selfType Type of this assertion class : a sub-class of {@code AbstractSubAssert}.
   * @param valueAssertType Class of the assertion on the value : a sub-class of {@code AbstractValueAssert}.
   */
  AbstractSubAssert(A originalDbAssert, Class selfType, Class valueAssertType) {
    super(selfType, originalDbAssert);
    valueAssertClass = valueAssertType;
  }

  /**
   * Gets an instance of value assert corresponding to the index. If this instance is already instanced, the method
   * returns it from the cache.
   * 
   * @param index Index of the value on which is the instance of value assert.
   * @return The value assert implementation.
   */
  protected V getValueAssertInstance(int index) {
    if (valuesAssertMap.containsKey(index)) {
      V valueAssert = valuesAssertMap.get(index);
      indexNextValue = index + 1;
      return valueAssert;
    }

    Object value = getValue(index);
    try {
      V instance = getValueAssertInstance(valueAssertClass, index, value);
      valuesAssertMap.put(index, instance);
      return instance;
    } catch (Exception e) {
      throw new AssertJDBException("There is an exception '" + e.getMessage()
          + "'\n\t in the instantiation of the assertion " + valueAssertClass.getName() + "\n\t on the value with "
          + myself.getClass() + ".\n "
          + "It is normally impossible.\n That means there is a big mistake in the development of AssertJDB.\n "
          + "Please write an issue for that if you meet this problem.");
    }
  }

  /**
   * Gets an instance of value assert corresponding to the index and the value.
   *
   * @param valueAssertType Class of the assertion on the value : a sub-class of {@code AbstractValueAssert}.
   * @param index Index of the value on which is the instance of value assert.
   * @param value Value on which is the instance of value assert.
   * @return The value assert implementation.
   * @throws Exception Exception during the instantiation.
   */
  protected abstract V getValueAssertInstance(Class valueAssertType, int index, Object value) throws Exception;

  /** {@inheritDoc} */
  @Override
  public V value() {
    return getValueAssertInstance(indexNextValue);
  }

  /** {@inheritDoc} */
  @Override
  public V value(int index) {
    return getValueAssertInstance(index);
  }

  /**
   * Returns the list of values.
   * 
   * @return The list of values.
   */
  protected abstract List