org.netbeans.modules.parsing.spi
Class EmbeddingProvider

java.lang.Object
  org.netbeans.modules.parsing.api.Task
      org.netbeans.modules.parsing.spi.SchedulerTask
          org.netbeans.modules.parsing.spi.EmbeddingProvider

public abstract class EmbeddingProvider
extends SchedulerTask

EmbeddingProvider returns sources for embedded languages (Embeddings) based on lexical analyse of current snapshot. Embedded source can consist from one or more blocks of original source and it can contain some generated parts that has no mirror in the original text. See Snapshot class for more information how to create embedded source.

Constructor Summary

EmbeddingProvider()

Method Summary

abstract List<Embedding>	getEmbeddings(Snapshot snapshot) Returns list of Embeddings based on lexical analyse.
abstract int	getPriority() Returns priority of this source provider.
Class<? extends Scheduler>	getSchedulerClass() Returns Scheduler class for this SchedulerTask.

Methods inherited from class org.netbeans.modules.parsing.spi.SchedulerTask

cancel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EmbeddingProvider

public EmbeddingProvider()

Method Detail

getSchedulerClass

public final Class<? extends Scheduler> getSchedulerClass()

Returns Scheduler class for this SchedulerTask. See Scheduler documentation for a list of default schedulers, or your your own implementation.

Specified by:

getSchedulerClass in class SchedulerTask

Returns:

Scheduler for this SchedulerTask.

getEmbeddings

public abstract List<Embedding> getEmbeddings(Snapshot snapshot)

Returns list of Embeddings based on lexical analyse.

Parameters:

snapshot - A snapshot that should be scanned for embeddings.

Returns:

List of Embeddings.

getPriority

public abstract int getPriority()

Returns priority of this source provider.

Specified by:

getPriority in class SchedulerTask

Returns:

priority of this source provider