Join.java

/*
 * Copyright 2016 requery.io
 *
 * 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.
 */

package io.requery.query;

/**
 * join expression
 *
 * @param <E> result type
 */
public interface Join<E> {

    /**
     * inner join on the type
     *
     * @param type type
     * @param <J>  corresponding join type
     * @return joining condition
     */
    <J> JoinOn<E> join(Class<J> type);

    /**
     * left inner join on the type
     *
     * @param type type
     * @param <J>  corresponding join type
     * @return joining condition
     */
    <J> JoinOn<E> leftJoin(Class<J> type);

    /**
     * right inner join on the type
     *
     * @param type type
     * @param <J>  corresponding join type
     * @return joining condition
     */
    <J> JoinOn<E> rightJoin(Class<J> type);

    /**
     * inner join on the type
     *
     * @param query query
     * @param <J>   corresponding join type
     * @return joining condition
     */
    <J> JoinOn<E> join(Return<J> query);

    /**
     * left inner join on the type
     *
     * @param query query
     * @param <J>   corresponding join type
     * @return joining condition
     */
    <J> JoinOn<E> leftJoin(Return<J> query);

    /**
     * right inner join on the type
     *
     * @param query query
     * @param <J>   corresponding join type
     * @return joining condition
     */
    <J> JoinOn<E> rightJoin(Return<J> query);
}