com.ibm.jaggr.core.readers

Class ModuleBuildReader

java.lang.Object

java.io.Reader

com.ibm.jaggr.core.readers.ModuleBuildReader

All Implemented Interfaces:

Closeable, AutoCloseable, Readable

public class ModuleBuildReader
extends Reader

Objects of this class are returned in a Future from IModule.getBuild(HttpServletRequest). This class is merely a wrapper for the items that, taken together, represent a module build.

Field Summary

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor and Description
ModuleBuildReader(Reader reader, boolean isScript) Consturctor for a reader with no cache key generator and no error
ModuleBuildReader(Reader reader, boolean isScript, List<ICacheKeyGenerator> keyGens, String error) Constructor for a Build object specifying a reader, key generator and error flag.
ModuleBuildReader(String str, boolean isScript) Constructor for a build reader from a string

Method Summary

Methods

Modifier and Type	Method and Description
void	addExtraBuild(ModuleBuildFuture future) Adds the specified future to the list of extra builds.
void	close()
List<ICacheKeyGenerator>	getCacheKeyGenerators() Returns the cache key generator for this module
String	getErrorMessage()
List<ModuleBuildFuture>	getExtraBuilds() Returns the list of additional futures that should be processed along with this build this future
SourceMap	getSourceMap()
boolean	isError() Returns the error flag for this build.
boolean	isScript()
int	read(char[] cbuf, int off, int len)
void	setSourceMap(SourceMap sourceMap) Sets the source map object associated with this reader

Methods inherited from class java.io.Reader

mark, markSupported, read, read, read, ready, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleBuildReader

public ModuleBuildReader(Reader reader,
                 boolean isScript,
                 List<ICacheKeyGenerator> keyGens,
                 String error)

Constructor for a Build object specifying a reader, key generator and error flag.

Parameters:

reader - A Reader to the build content

isScript - true if the reader content is executable script code

keyGens - The ICacheKeyGenerator list for this IModule

error - If not null, then an message describing the error

ModuleBuildReader

public ModuleBuildReader(Reader reader,
                 boolean isScript)

Consturctor for a reader with no cache key generator and no error

Parameters:

reader - A Reader to the build content

isScript - true if the reader content is executable script code

ModuleBuildReader

public ModuleBuildReader(String str,
                 boolean isScript)

Constructor for a build reader from a string

Parameters:

str - the string

isScript - true if the string contains executable script code

Method Detail

getCacheKeyGenerators

public List<ICacheKeyGenerator> getCacheKeyGenerators()

Returns the cache key generator for this module

Returns:

The cache key generator

isError

public boolean isError()

Returns the error flag for this build. If true, an error occurred while generating the build. Responses containing build errors are not cached by the layer cache manager, and HTTP responses for layers that include build errors include cache control headers to prevent the response from being cached by the browser or proxy caches.

Returns:

The error flag for the build

getErrorMessage

public String getErrorMessage()

isScript

public boolean isScript()

Returns:

true if the content is scirpt code

read

public int read(char[] cbuf,
       int off,
       int len)
         throws IOException

Specified by:

read in class Reader

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Reader

Throws:

IOException

addExtraBuild

public void addExtraBuild(ModuleBuildFuture future)

Adds the specified future to the list of extra builds.

Parameters:

future - The future to add

getExtraBuilds

public List<ModuleBuildFuture> getExtraBuilds()

Returns the list of additional futures that should be processed along with this build this future

Returns:

The list of extra build futures.

setSourceMap

public void setSourceMap(SourceMap sourceMap)

Sets the source map object associated with this reader

Parameters:

sourceMap - the source map

getSourceMap

public SourceMap getSourceMap()

Returns:

the source map object associated with this reader