org.assertj.db.api.navigation.ToValueFromRow 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.navigation;

/**
 * Defines methods to navigate to a value from a {@link org.assertj.db.type.Row}.
 * The different methods return an assertion on one value {@link org.assertj.db.api.navigation.ValueAssert}.
 * These methods exists when navigating (at the beginning {@code assertThat()}) from changes, from a {@link org.assertj.db.type.Table} or from a {@link org.assertj.db.type.Request}.
 * As shown in the diagram below, if navigating from table or request, it is possible to call the method to navigate to a {@link org.assertj.db.api.navigation.ValueAssert} from :
 * 
 *     a row ({@link org.assertj.db.api.AbstractRowAssert})
 *     a value of a row ({@link org.assertj.db.api.AbstractRowValueAssert})
 * 
 * 
 * 
 * 
 * If navigating from table or request, it is important to keep in mind that the methods are executed from the point of view of the last instance with assertion methods on a row ({@link org.assertj.db.api.AbstractRowAssert}).

 * So all the lines of code below are equivalent : they point on the value called "name" of first column.
 * 
 *  * 
 * assertThat(table_or_request).row().value("name")......;                                // Point directly on the value called "name"
 * assertThat(table_or_request).row().value().returnToOrigin().value("name")......;       // Use the returnToOrigin() method of AbstractAssertWithOrigin
 *                                                                                        // to return on the table or request and access to the value called "name"
 * assertThat(table_or_request).row().value().value("name")......;                        // Same as precedent but returnToOrigin() is implicit
 * assertThat(table_or_request).row().value(2).value(0).value("name")......;              // Idem
 * assertThat(table_or_request).row().value().row().value("name")......;
 * // Equivalent to the precedent but with the use of the returnToOrigin() method of AbstractAssertWithOrigin
 * assertThat(table_or_request).row().value().returnToOrigin().returnToOrigin().row().value("name")......;
 * 
 * 
 * As shown in the diagram below, if navigating from changes, it is possible to call the method to navigate to a {@link org.assertj.db.api.navigation.ValueAssert} from :
 * 
 *     a row of a change ({@link org.assertj.db.api.ChangeRowAssert})
 *     a value of a row of a change ({@link org.assertj.db.api.ChangeRowValueAssert})
 * 
 * 
 * 
 * 
 * If navigating from changes, it is important to keep in mind that the methods are executed from the point of view of the last instance with assertion methods on a row of a change ({@link org.assertj.db.api.ChangeRowAssert}).

 * So all the lines of code below are equivalent : they point on the value called "name" of first row.
 * 
 *  * 
 * assertThat(changes).change().row().value("name")......;                                 // Point directly on the value called "name"
 * // Use the returnToOrigin() method of AbstractAssertWithOrigin to return on the row and access to the value called "name"
 * assertThat(changes).change().row().value().returnToOrigin().value("name")......;
 * assertThat(changes).change().row().value().value("name")......;                         // Same as precedent but returnToOrigin() is implicit
 * assertThat(changes).change().row().value(2).value(0).value("name")......;               // Idem
 * assertThat(changes).change().row().value().change(0).row().value("name")......;
 * // Equivalent to the precedent but with the use of the returnToOrigin() method of AbstractAssertWithOrigin
 * assertThat(changes).change().row().value().returnToOrigin().returnToOrigin().returnToOrigin().change(0).row().value("name")......;
 * 
 * 
 *
 * @author Régis Pouiller
 *
 * @param  The class of a assertion on a value (an sub-class of {@link org.assertj.db.api.navigation.ValueAssert}).
 */
public interface ToValueFromRow {

  /**
   * Returns assertion methods on the value corresponding to the column name in parameter.
   *
   * @param columnName The column name.
   * @return An object to make assertions on the value.
   * @throws NullPointerException If the column name in parameter is {@code null}.
   * @throws org.assertj.db.exception.AssertJDBException If there is no column with this name.
   * @see org.assertj.db.api.AbstractRowAssert#value(String)
   * @see org.assertj.db.api.AbstractRowValueAssert#value(String)
   * @see org.assertj.db.api.ChangeRowAssert#value(String)
   * @see org.assertj.db.api.ChangeRowValueAssert#value(String)
   */
  public V value(String columnName);
}