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

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