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 java.util.function.Consumer;
  15
  16 import org.simantics.db.AsyncReadGraph;
  17 import org.simantics.db.ReadGraph;
  18 import org.simantics.db.Resource;
  19
  20 /**
  21  * An interface for externalizing the logic of retrieving an arbitrary resource
  22  * for some purpose.
  23  *
  24  * <p>
  25  * A {@link ReadGraph} is provided to allow implementations to browse the graph
  26  * in order to retrieve a resource.
  27  * </p>
  28  *
  29  * <p>
  30  * This interface has a synchronously operating counterpart, {@link ResourceProvider}.
  31  * </p>
  32  *
  33  * @see ResourceProviders
  34  * @see ResourceProvider
  35  *
  36  * @author Tuukka Lehtonen
  37  */
  38 public interface AsyncResourceProvider {
  39
  40     /**
  41      * @param graph an asynchronous graph for retrieving the resource to return
  42      * @param callback a callback that is invoked with the provided resource
  43      */
  44     void get(AsyncReadGraph graph, Consumer<Resource> callback);
  45
  46 }