Db4oCallback.java

/*
 * Copyright 2005-2011 the original author or authors.
 *
 * 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 org.springextensions.db4o;

import com.db4o.ObjectContainer;

/**
 * Callback interface for db4o code. To be used with Db4oTemplate's execute method,
 * assumably often as anonymous classes within a method implementation. The typical
 * implementation will call ObjectContainer methods  to perform some operations on
 * the db4o object container.
 *
 * @author Costin Leau
 * @author olli
 */
public interface Db4oCallback {

    /**
     * Called by {@link Db4oTemplate#execute} within an active object container
     * {@link com.db4o.ObjectContainer}.
     * <p/>
     * Allows for returning a result object created within the
     * callback, i.e. a domain object or a collection of domain
     * objects.
     */
    Object doInDb4o(ObjectContainer container) throws RuntimeException;

}