com.github.wuic.nut

Class CompositeNut

java.lang.Object

com.github.wuic.nut.AbstractNut

com.github.wuic.nut.AbstractConvertibleNut

com.github.wuic.nut.PipedConvertibleNut

com.github.wuic.nut.CompositeNut

All Implemented Interfaces:

ConvertibleNut, Nut

public class CompositeNut
extends PipedConvertibleNut

A composite Nut is able to chain all the stream provided by each element of the composition. We consider that all the nuts of the composition should have the same state (name, etc).

Since:

0.4.2

Version:

1.2

Author:

Guillaume DROUET

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompositeNut.Combiner This class combines different sets of nuts as specified by mergeNuts(ProcessContext, List) It ensures that every names will be unique in returned lists during the entire lifecycle of its instance.
class	CompositeNut.CompositeInputStream This class keeps the position of each nut in the read content.

Constructor Summary

Constructors

Constructor and Description
CompositeNut(Boolean avn, String specificName, byte[] separator, ProcessContext processContext, ConvertibleNut... composition) Builds a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	getAsynchronousVersionNumber() Indicates if version number is computed asynchronously.
boolean	isDynamic() Indicates if this nut has a dynamic content, meaning that it could be changed each time Nut.openStream() is invoked.
static List<ConvertibleNut>	mergeNuts(ProcessContext processContext, List<ConvertibleNut> nuts) Merges all sequences nuts with the same name into one CompositeNut.
InputStream	openStream() Opens and returns an InputStream pointing to the nut.
void	transform(Pipe.OnReady... onReady) Transforms the source stream with all registered transformers and calls the given callback in addition to callbacks previously registered.

Methods inherited from class com.github.wuic.nut.PipedConvertibleNut

isTransformed, setTransformed, transform

Methods inherited from class com.github.wuic.nut.AbstractConvertibleNut

addReferencedNut, addTransformer, equals, getName, getNutType, getOriginalNuts, getParentFile, getReadyCallbacks, getReferencedNuts, getTransformers, hashCode, isCompressed, isSubResource, onReady, setIsCompressed, setIsSubResource, setNutName, setNutType, setOriginalNuts

Methods inherited from class com.github.wuic.nut.AbstractNut

getInitialName, getInitialNutType, getProxyUri, getVersionNumber, setProxyUri, setVersionNumber, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.github.wuic.nut.Nut

getInitialName, getInitialNutType, getProxyUri, getVersionNumber, setProxyUri

Constructor Detail

CompositeNut

public CompositeNut(Boolean avn,
            String specificName,
            byte[] separator,
            ProcessContext processContext,
            ConvertibleNut... composition)

Builds a new instance.

Parameters:

avn - indicates if version computation is done asynchronously or not

composition - the nuts of this composition

separator - the bytes between each stream, null if nothing

specificName - the name of the composition

processContext - the process context

Method Detail

getAsynchronousVersionNumber

public Boolean getAsynchronousVersionNumber()

Indicates if version number is computed asynchronously.

Returns:

true if asynchronous operation is performed, false otherwise

isDynamic

public boolean isDynamic()

Indicates if this nut has a dynamic content, meaning that it could be changed each time Nut.openStream() is invoked. In this case the nut should not be added to any cache and transformation chain should be applied.

Specified by:

isDynamic in interface Nut

Overrides:

isDynamic in class AbstractConvertibleNut

Returns:

true if content is dynamic, false otherwise

transform

public void transform(Pipe.OnReady... onReady)
               throws IOException

Transforms the source stream with all registered transformers and calls the given callback in addition to callbacks previously registered. The method also writes the result to the given output stream.

Specified by:

transform in interface ConvertibleNut

Overrides:

transform in class PipedConvertibleNut

Parameters:

onReady - the callback

Throws:

IOException - if an I/O error occurs

openStream

public InputStream openStream()
                       throws IOException

Opens and returns an InputStream pointing to the nut.

Specified by:

openStream in interface Nut

Overrides:

openStream in class AbstractConvertibleNut

Returns:

the opened input stream

Throws:

IOException - if an I/O error occurs

mergeNuts

public static List<ConvertibleNut> mergeNuts(ProcessContext processContext,
                             List<ConvertibleNut> nuts)

Merges all sequences nuts with the same name into one CompositeNut. When a stream is read in a composite object, a composite InputStream is returned and will read each stream in the order of the list. When a composition is created, its name is prefixed with the its position in the given list.

For instance, ['foo.js', 'foo.js', 'bar.css', 'baz.js', 'foo.js'] => ['0foo.js', 'bar.css', 'baz.js', 'foo.js'] where the first element is a composition and where "prefixCountStart" equals to 0.

Parameters:

processContext - the process context

nuts - the nuts to merge

Returns:

a list containing all the nuts with some compositions