com.google.gwt.dev.cfg

Interface LibraryWriter

All Known Implementing Classes:

NullLibraryWriter, ZipLibraryWriter

public interface LibraryWriter

A builder which collects and writes the contents of a library.
It also provides access to a very small subset of properties for LibraryGroup access.

Method Summary

Modifier and Type	Method and Description
void	addBuildResource(Resource buildResource) Adds a build resource.
void	addCompilationUnit(CompilationUnit compilationUnit) Adds a previously compiled (but not yet unified) compilation unit. Provided compilation units are assumed to have already been validated.
void	addDependencyLibraryName(String dependencyLibraryName) Registers a dependency on some other library.
void	addDependencyLibraryNames(Set<String> dependencyLibraryNames) Registers dependency on a set of other libraries.
void	addGeneratedArtifacts(ArtifactSet generatedArtifacts) Adds a generated artifact.
void	addPublicResource(Resource publicResource) Adds a public resource (such as a html, css, or png file).
PersistenceBackedObject<PermutationResult>	getPermutationResultHandle() Returns a handle to the permutation result object that was constructed as part of the compilation for this library.
Set<String>	getProcessedReboundTypeSourceNames(String generatorName) Returns the set of source names of rebound types that have been processed by the given Generator.
Set<String>	getReboundTypeSourceNames() Returns the set of source names of types which are the subject of GWT.create() calls in source code for this library.
void	markReboundTypeProcessed(String processedReboundTypeSourceName, String generatorName) Registers the type (by it's source name) as having been processed by the given generator.
void	markReboundTypesProcessed(Set<String> reboundTypeSourceNames) Records the set of names of types which are the subject of GWT.create() calls in source code for this library.
void	setCompilationErrorsIndex(CompilationErrorsIndex compilationErrorsIndex) Records a source of compilation error information to support detailed logging.
void	setLibraryName(String libraryName) Records the library name. Library names are the way that libraries reference one another as dependencies and should be unique within the build tree.
void	write() Finishes writing all library contents and closes the library.

Method Detail

addBuildResource

void addBuildResource(Resource buildResource)

Adds a build resource. Build resources are any resources provided in source paths but which are not themselves source code. For example *.gwt.xml and *.ui.xml files.

addCompilationUnit

void addCompilationUnit(CompilationUnit compilationUnit)

Adds a previously compiled (but not yet unified) compilation unit.
Provided compilation units are assumed to have already been validated.

addDependencyLibraryName

void addDependencyLibraryName(String dependencyLibraryName)

Registers a dependency on some other library.

addDependencyLibraryNames

void addDependencyLibraryNames(Set<String> dependencyLibraryNames)

Registers dependency on a set of other libraries.

addGeneratedArtifacts

void addGeneratedArtifacts(ArtifactSet generatedArtifacts)

Adds a generated artifact. Artifacts created by generators need to be collected so that they can be provided to the final linker.

addPublicResource

void addPublicResource(Resource publicResource)

Adds a public resource (such as a html, css, or png file).

getPermutationResultHandle

PersistenceBackedObject<PermutationResult> getPermutationResultHandle()

Returns a handle to the permutation result object that was constructed as part of the compilation for this library.

getProcessedReboundTypeSourceNames

Set<String> getProcessedReboundTypeSourceNames(String generatorName)

Returns the set of source names of rebound types that have been processed by the given Generator.

getReboundTypeSourceNames

Set<String> getReboundTypeSourceNames()

Returns the set of source names of types which are the subject of GWT.create() calls in source code for this library.

markReboundTypeProcessed

void markReboundTypeProcessed(String processedReboundTypeSourceName,
                              String generatorName)

Registers the type (by it's source name) as having been processed by the given generator.

markReboundTypesProcessed

void markReboundTypesProcessed(Set<String> reboundTypeSourceNames)

Records the set of names of types which are the subject of GWT.create() calls in source code for this library.

setCompilationErrorsIndex

void setCompilationErrorsIndex(CompilationErrorsIndex compilationErrorsIndex)

Records a source of compilation error information to support detailed logging.

setLibraryName

void setLibraryName(String libraryName)

Records the library name.
Library names are the way that libraries reference one another as dependencies and should be unique within the build tree.

write

void write()

Finishes writing all library contents and closes the library.