All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • com.avaje.ebeaninternal.api.BeanIdList Maven / Gradle / Ivy

    There is a newer version: 2.8.1
    Show newest version
    /**
 * Copyright (C) 2009 Authors
 * 
 * This file is part of Ebean.
 * 
 * Ebean is free software; you can redistribute it and/or modify it 
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *  
 * Ebean is distributed in the hope that it will be useful, but 
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with Ebean; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA  
 */
package com.avaje.ebeaninternal.api;

import java.util.List;
import java.util.concurrent.FutureTask;
import java.util.concurrent.TimeUnit;

import javax.persistence.PersistenceException;

/**
 * Wrapper of the list of Id's adding support for background fetching
 * future object. 
 * 
 * @author rbygrave
 */
public class BeanIdList {

	private final List idList;
	
	private boolean hasMore = true;
	
	private FutureTask fetchFuture;
	
	public BeanIdList(List idList) {
		this.idList = idList;
	}
	
	/**
	 * Return true if the fetch is continuing in a background thread.
	 */
	public boolean isFetchingInBackground() {
		return fetchFuture != null;
	}

	/**
	 * Set the FutureTask that is continuing the fetch in a background thread.
	 */
	public void setBackgroundFetch(FutureTask fetchFuture) {
		this.fetchFuture = fetchFuture;
	}

	/**
	 * Wait for the background fetching to complete with a timeout.
	 */
	public void backgroundFetchWait(long wait, TimeUnit timeUnit) {
		if (fetchFuture != null){
			try {
				fetchFuture.get(wait, timeUnit);
			} catch (Exception e) {
				throw new PersistenceException(e);
			} 		
		}
	}
	
	/**
	 * Wait for the background fetching to complete.
	 */
	public void backgroundFetchWait() {
		if (fetchFuture != null){
			try {
				fetchFuture.get();
			} catch (Exception e) {
				throw new PersistenceException(e);
			} 		
		}
	}

	/**
	 * Add an Id to the list.
	 */
	public void add(Object id){
		idList.add(id);
	}

	/**
	 * Return the list of Id's.
	 */
	public List getIdList() {
		return idList;
	}

	/**
	 * Return true if max rows was hit and there is more rows to fetch.
	 */
	public boolean isHasMore() {
		return hasMore;
	}

	/**
	 * Set to true when max rows is hit and there are more rows to fetch.
	 */
	public void setHasMore(boolean hasMore) {
		this.hasMore = hasMore;
	}
	
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy