LibraryGroup (GWT 2.7.0)

java.lang.Object
- com.google.gwt.dev.cfg.LibraryGroup

Direct Known Subclasses:

ImmutableLibraryGroup
```
public class LibraryGroup
extends Object
```
A convenience wrapper around a set of libraries.
Indexes library contents to enable single step retrieval of resources by name.
Analyzes the library dependency tree to provide link ordering and property and rebound type change analysis for partial generator execution.
Combines library resource lists for easy iteration over the complete set.
Is mostly immutable, its contained set of libraries can only be set at time of construction.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`LibraryGroup.CollidingCompilationUnitException` An exception that indicates that a single Compilation Unit is being provided by more than one library.
`static class`	`LibraryGroup.DuplicateLibraryNameException` An exception that indicates that more than one library has the same name, thus making name based references ambiguous.
`static class`	`LibraryGroup.UnresolvedLibraryException` An exception that indicates that some library was referenced as a dependency but was not provided to the compiler.

Constructor Summary

Constructors
Modifier Constructor and Description

protected LibraryGroup()

Constructors
Modifier	Constructor and Description
`protected`	`LibraryGroup()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes all read streams.
`boolean`	`containsBuildResource(String buildResourcePath)` Returns whether a build resource is is available at the given path.
`LibraryGroup`	`createSubgroup(List<String> libraryNames)` Create and return a library group of just the given libraries referenced by name.
`static String`	`formatDuplicateCompilationUnitMessage(String compilationUnitTypeSourceName, String oldLibraryName, String newLibraryName)`
`static LibraryGroup`	`fromLibraries(List<? extends Library> libraries, boolean verifyLibraryReferences)` Factory function that constructs and returns a library group from a list of libraries.
`static LibraryGroup`	`fromZipPaths(List<String> zipLibraryPaths)` Factory function that constructs and returns a library group from a list of zip library paths.
`Resource`	`getBuildResourceByPath(String buildResourcePath)` Returns the resource referenced by name if present or null;
`Set<String>`	`getBuildResourcePaths()` Returns the set of all build resource paths.
`InputStream`	`getClassFileStream(String classFilePath)` Opens and returns an input stream for the given class file path if present or null.
`CompilationErrorsIndex`	`getCompilationErrorsIndex()`
`CompilationUnit`	`getCompilationUnitByTypeBinaryName(String typeBinaryName)` Returns the compilation unit for the given compilation unit type name if present or null.
`CompilationUnit`	`getCompilationUnitByTypeSourceName(String typeSourceName)` Returns the compilation unit for the given compilation unit type name if present or null.
`Set<String>`	`getCompilationUnitTypeSourceNames()` Returns the set of all compilation unit type source names (both regular and super sourced).
`ArtifactSet`	`getGeneratedArtifacts()`
`List<PersistenceBackedObject<PermutationResult>>`	`getPermutationResultHandlesInLinkOrder()` Returns the list of all permutation result handles (one per library) in library link order.
`Set<String>`	`getProcessedReboundTypeSourceNames(String generatorName)` Returns a list of source names of types which have already been rebound by the given generator.
`Resource`	`getPublicResourceByPath(String path)` Returns the resource referenced by name if present or null.
`Set<String>`	`getPublicResourcePaths()` Returns the set of all public resource paths.
`Set<String>`	`getReboundTypeSourceNames()` Returns the set of names of types which are the subject of GWT.create() calls in source code in any of the contained libraries.
`Set<String>`	`getSuperSourceCompilationUnitTypeSourceNames()` Returns the set of compilation unit type source names for all contained super source compilation units.
`void`	`verify(TreeLogger logger)`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, toString

- Constructor Detail
  - LibraryGroup
```
protected LibraryGroup()
```
- Method Detail
  - formatDuplicateCompilationUnitMessage
```
public static String formatDuplicateCompilationUnitMessage(String compilationUnitTypeSourceName,
                                                           String oldLibraryName,
                                                           String newLibraryName)
```
  - fromLibraries
```
public static LibraryGroup fromLibraries(List<? extends Library> libraries,
                                         boolean verifyLibraryReferences)
```
    Factory function that constructs and returns a library group from a list of libraries.
  - fromZipPaths
```
public static LibraryGroup fromZipPaths(List<String> zipLibraryPaths)
                                 throws Libraries.IncompatibleLibraryVersionException
```
    Factory function that constructs and returns a library group from a list of zip library paths.
    
    Throws:
    
    Libraries.IncompatibleLibraryVersionException
  - close
```
public void close()
```
    Closes all read streams.
  - containsBuildResource
```
public boolean containsBuildResource(String buildResourcePath)
```
    Returns whether a build resource is is available at the given path.
  - createSubgroup
```
public LibraryGroup createSubgroup(List<String> libraryNames)
```
    Create and return a library group of just the given libraries referenced by name. Useful for taking an overly broad library group of all libraries in a dependency tree and trimming it down to a restricted set of strict top level dependencies.
  - getBuildResourceByPath
```
public Resource getBuildResourceByPath(String buildResourcePath)
```
    Returns the resource referenced by name if present or null;
  - getBuildResourcePaths
```
public Set<String> getBuildResourcePaths()
```
    Returns the set of all build resource paths.
  - getClassFileStream
```
public InputStream getClassFileStream(String classFilePath)
```
    Opens and returns an input stream for the given class file path if present or null.
  - getCompilationErrorsIndex
```
public CompilationErrorsIndex getCompilationErrorsIndex()
```
  - getCompilationUnitByTypeBinaryName
```
public CompilationUnit getCompilationUnitByTypeBinaryName(String typeBinaryName)
```
    Returns the compilation unit for the given compilation unit type name if present or null.
  - getCompilationUnitByTypeSourceName
```
public CompilationUnit getCompilationUnitByTypeSourceName(String typeSourceName)
```
    Returns the compilation unit for the given compilation unit type name if present or null.
  - getCompilationUnitTypeSourceNames
```
public Set<String> getCompilationUnitTypeSourceNames()
```
    Returns the set of all compilation unit type source names (both regular and super sourced). Useful to be able to force loading of all known types to make subtype queries accurate for example when doing global generator execution.
  - getGeneratedArtifacts
```
public ArtifactSet getGeneratedArtifacts()
```
  - getPermutationResultHandlesInLinkOrder
```
public List<PersistenceBackedObject<PermutationResult>> getPermutationResultHandlesInLinkOrder()
```
    Returns the list of all permutation result handles (one per library) in library link order.
  - getProcessedReboundTypeSourceNames
```
public Set<String> getProcessedReboundTypeSourceNames(String generatorName)
```
    Returns a list of source names of types which have already been rebound by the given generator.
  - getPublicResourceByPath
```
public Resource getPublicResourceByPath(String path)
```
    Returns the resource referenced by name if present or null.
  - getPublicResourcePaths
```
public Set<String> getPublicResourcePaths()
```
    Returns the set of all public resource paths.
  - getReboundTypeSourceNames
```
public Set<String> getReboundTypeSourceNames()
```
    Returns the set of names of types which are the subject of GWT.create() calls in source code in any of the contained libraries.
  - getSuperSourceCompilationUnitTypeSourceNames
```
public Set<String> getSuperSourceCompilationUnitTypeSourceNames()
```
    Returns the set of compilation unit type source names for all contained super source compilation units.
  - verify
```
public void verify(TreeLogger logger)
            throws UnableToCompleteException
```
    Throws:
    
    UnableToCompleteException

Class LibraryGroup

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LibraryGroup

Method Detail

formatDuplicateCompilationUnitMessage

fromLibraries

fromZipPaths

close

containsBuildResource

createSubgroup

getBuildResourceByPath

getBuildResourcePaths

getClassFileStream

getCompilationErrorsIndex

getCompilationUnitByTypeBinaryName

getCompilationUnitByTypeSourceName

getCompilationUnitTypeSourceNames

getGeneratedArtifacts

getPermutationResultHandlesInLinkOrder

getProcessedReboundTypeSourceNames

getPublicResourceByPath

getPublicResourcePaths

getReboundTypeSourceNames

getSuperSourceCompilationUnitTypeSourceNames

verify