com.mysema.query.SimpleProjectable Maven / Gradle / Ivy
/*
* Copyright 2011, Mysema Ltd
*
* 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 com.mysema.query;
import java.util.List;
import javax.annotation.Nullable;
import com.mysema.commons.lang.CloseableIterator;
/**
* SimpleProjectable defines a simpler projection interface than {@link Projectable}.
*
* @author tiwe
* @see Projectable
*/
public interface SimpleProjectable {
/**
* @return true, if rows matching the given criteria exist, otherwise false
*/
boolean exists();
/**
* @return true, if no rows matching the given criteria exist, otherwise false
*/
boolean notExists();
/**
* Get the projection as a typed closeable Iterator
*
* @return
*/
CloseableIterator iterate();
/**
* Get the projection as a typed List
*
* @return
*/
List list();
/**
* Get the projection as a single result or null if no result is found
*
* for multiple results only the first one is returned
*
* @return
*/
@Nullable
T singleResult();
/**
* Get the projection as a unique result or null if no result is found
*
* @throws NonUniqueResultException if there is more than one matching result
* @return
*/
@Nullable
T uniqueResult();
/**
* Get the projection in {@link SearchResults} form
*
* @return
*/
SearchResults listResults();
/**
* Get the count of matched elements
*
* @return
*/
long count();
}