org.assertj.db.navigation.origin.package-info 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-2016 the original author or authors.
 */
/**
 * This package contains interfaces that defines the different {@link org.assertj.db.navigation.origin.Origin}s used by the navigation.
 * These {@link org.assertj.db.navigation.origin.Origin}s are the key to help the navigation.

 * The {@link org.assertj.db.navigation.origin.Origin} is used by the {@link org.assertj.db.api.AbstractAssertWithOrigin#returnToOrigin()} method
 * to return to the previous instance that provides assertion methods :
 * for example to return to a object with assertion methods on a table ({@link org.assertj.db.api.TableAssert})
 * from a object with assertion methods on a column ({@link org.assertj.db.api.TableColumnAssert}).

 * As shown in the javadoc of the navigation package, it is possible to navigate to a "smaller" thing (from a column to a value)
 * but also to a "bigger or equivalent" thing (from a column to another column or to a row).
 * The second possibility is possible thank to the {@link org.assertj.db.navigation.origin.Origin} because the classes with {@link org.assertj.db.navigation.origin.Origin}
 * use the navigation methods of their {@link org.assertj.db.navigation.origin.Origin}s.
 * 
 * This diagram shows the part on the tables and requests (the origin interfaces are in blue) :
 * 
 * 
 * 
 * This diagram shows the part on the changes (the origin interfaces are in blue) :
 * 
 * 
 * 
 *
 * @author Régis Pouiller
 */
package org.assertj.db.navigation.origin;