bundles/org.simantics.db.common/src/org/simantics/db/common/provider/AsyncResourceProvider.java

   1 /*******************************************************************************
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management
   3  * in Industry THTH ry.
   4  * All rights reserved. This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License v1.0
   6  * which accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *     VTT Technical Research Centre of Finland - initial API and implementation
  11  *******************************************************************************/
  12 package org.simantics.db.common.provider;
  13
  14 import org.simantics.db.AsyncReadGraph;
  15 import org.simantics.db.ReadGraph;
  16 import org.simantics.db.Resource;
  17 import org.simantics.utils.datastructures.Callback;
  18
  19 /**
  20  * An interface for externalizing the logic of retrieving an arbitrary resource
  21  * for some purpose.
  22  *
  23  * <p>
  24  * A {@link ReadGraph} is provided to allow implementations to browse the graph
  25  * in order to retrieve a resource.
  26  * </p>
  27  *
  28  * <p>
  29  * This interface has a synchronously operating counterpart, {@link ResourceProvider}.
  30  * </p>
  31  *
  32  * @see ResourceProviders
  33  * @see ResourceProvider
  34  *
  35  * @author Tuukka Lehtonen
  36  */
  37 public interface AsyncResourceProvider {
  38
  39     /**
  40      * @param graph an asynchronous graph for retrieving the resource to return
  41      * @param callback a callback that is invoked with the provided resource
  42      */
  43     void get(AsyncReadGraph graph, Callback<Resource> callback);
  44
  45 }