org.eclipse.xtext.web.server.generator

Class GeneratorService

java.lang.Object

org.eclipse.xtext.web.server.model.AbstractCachedService<GeneratorService.GeneratedArtifacts>

org.eclipse.xtext.web.server.generator.GeneratorService

public class GeneratorService
extends AbstractCachedService<GeneratorService.GeneratedArtifacts>

Service class for code generation. The resulting documents are sent back to the client; if exactly one document is generated, the result should be unwrapped, i.e. the response body is the generated document.

Results of this service are cached in the session state. However, the service is not invoked automatically after a document change (in contrast to e.g. validation), but only after an explicit request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeneratorService.GeneratedArtifacts This service result class is just a wrapper to store all generated documents.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_ARTIFACT The default artifact name that is accessed when no specific artifact is requested.

Constructor Summary

Constructors

Constructor and Description
GeneratorService()

Method Summary

Modifier and Type	Method and Description
GeneratorService.GeneratedArtifacts	compute(IXtextWebDocument it, org.eclipse.xtext.util.CancelIndicator cancelIndicator) Generate artifacts for the given document.
GeneratorResult	getArtifact(XtextWebDocumentAccess document, java.lang.String artifactId) Retrieve the generated artifact with given identifier.
GeneratorResult	getArtifact(XtextWebDocumentAccess document, java.lang.String artifactId, boolean includeContent) Retrieve the generated artifact with given identifier.
GeneratorService.GeneratedArtifacts	getResult(XtextWebDocumentAccess document, boolean includeContent) Returns a GeneratorService.GeneratedArtifacts result with or without content.

Methods inherited from class org.eclipse.xtext.web.server.model.AbstractCachedService

getResult

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ARTIFACT

public static final java.lang.String DEFAULT_ARTIFACT

The default artifact name that is accessed when no specific artifact is requested. Value: "DEFAULT_OUTPUT/DEFAULT_ARTIFACT"

See Also:

Constant Field Values

Constructor Detail

GeneratorService

public GeneratorService()

Method Detail

compute

public GeneratorService.GeneratedArtifacts compute(IXtextWebDocument it,
                                                   org.eclipse.xtext.util.CancelIndicator cancelIndicator)

Generate artifacts for the given document. The result can be fetched with AbstractCachedService.getResult(XtextWebDocumentAccess).

Specified by:

compute in class AbstractCachedService<GeneratorService.GeneratedArtifacts>

getArtifact

public GeneratorResult getArtifact(XtextWebDocumentAccess document,
                                   java.lang.String artifactId)

Retrieve the generated artifact with given identifier. The identifier must match the name of one of the generator results; each name is created by concatenating the output configuration name and the file name (see InMemoryFileSystemAccess.getFileName(String,String)). If artifactId is null, DEFAULT_ARTIFACT is used as identifier. If the requested artifact is in IFileSystemAccess.DEFAULT_OUTPUT, the output configuration prefix may be omitted.

getArtifact

public GeneratorResult getArtifact(XtextWebDocumentAccess document,
                                   java.lang.String artifactId,
                                   boolean includeContent)

Retrieve the generated artifact with given identifier. If includeContent is false, only the metadata is included in the service result.

getResult

public GeneratorService.GeneratedArtifacts getResult(XtextWebDocumentAccess document,
                                                     boolean includeContent)

Returns a GeneratorService.GeneratedArtifacts result with or without content. If includeContent is false, only the metadata is included in the service result, which is useful to explore the generated artifacts.