com.google.gwt.dev.cfg

Class ZipLibraryWriter

java.lang.Object

com.google.gwt.dev.cfg.ZipLibraryWriter

All Implemented Interfaces:

LibraryWriter

public class ZipLibraryWriter
extends Object
implements LibraryWriter

A library builder that writes contents to a zip file.

Constructor Summary

Constructors

Constructor and Description
ZipLibraryWriter(String fileName)

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 libraryName) 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).
ZipEntryBackedObject<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.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Constructor Detail

ZipLibraryWriter

public ZipLibraryWriter(String fileName)

Method Detail

addBuildResource

public void addBuildResource(Resource buildResource)

Description copied from interface: LibraryWriter

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.

Specified by:

addBuildResource in interface LibraryWriter

addCompilationUnit

public void addCompilationUnit(CompilationUnit compilationUnit)

Description copied from interface: LibraryWriter

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

Specified by:

addCompilationUnit in interface LibraryWriter

addDependencyLibraryName

public void addDependencyLibraryName(String libraryName)

Description copied from interface: LibraryWriter

Registers a dependency on some other library.

Specified by:

addDependencyLibraryName in interface LibraryWriter

addDependencyLibraryNames

public void addDependencyLibraryNames(Set<String> dependencyLibraryNames)

Description copied from interface: LibraryWriter

Registers dependency on a set of other libraries.

Specified by:

addDependencyLibraryNames in interface LibraryWriter

addGeneratedArtifacts

public void addGeneratedArtifacts(ArtifactSet generatedArtifacts)

Description copied from interface: LibraryWriter

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

Specified by:

addGeneratedArtifacts in interface LibraryWriter

addPublicResource

public void addPublicResource(Resource publicResource)

Description copied from interface: LibraryWriter

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

Specified by:

addPublicResource in interface LibraryWriter

getPermutationResultHandle

public ZipEntryBackedObject<PermutationResult> getPermutationResultHandle()

Description copied from interface: LibraryWriter

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

Specified by:

getPermutationResultHandle in interface LibraryWriter

getProcessedReboundTypeSourceNames

public Set<String> getProcessedReboundTypeSourceNames(String generatorName)

Description copied from interface: LibraryWriter

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

Specified by:

getProcessedReboundTypeSourceNames in interface LibraryWriter

getReboundTypeSourceNames

public Set<String> getReboundTypeSourceNames()

Description copied from interface: LibraryWriter

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

Specified by:

getReboundTypeSourceNames in interface LibraryWriter

markReboundTypeProcessed

public void markReboundTypeProcessed(String processedReboundTypeSourceName,
                                     String generatorName)

Description copied from interface: LibraryWriter

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

Specified by:

markReboundTypeProcessed in interface LibraryWriter

markReboundTypesProcessed

public void markReboundTypesProcessed(Set<String> reboundTypeSourceNames)

Description copied from interface: LibraryWriter

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

Specified by:

markReboundTypesProcessed in interface LibraryWriter

setCompilationErrorsIndex

public void setCompilationErrorsIndex(CompilationErrorsIndex compilationErrorsIndex)

Description copied from interface: LibraryWriter

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

Specified by:

setCompilationErrorsIndex in interface LibraryWriter

setLibraryName

public void setLibraryName(String libraryName)

Description copied from interface: LibraryWriter

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

Specified by:

setLibraryName in interface LibraryWriter

write

public void write()

Description copied from interface: LibraryWriter

Finishes writing all library contents and closes the library.

Specified by:

write in interface LibraryWriter