com.github.wuic.nut

Class NutWrapper

java.lang.Object

com.github.wuic.nut.AbstractNut

com.github.wuic.nut.NutWrapper

All Implemented Interfaces:

ConvertibleNut, Nut

Direct Known Subclasses:

ImageNut, PrefixedNut, TransformedNut

public class NutWrapper
extends AbstractNut
implements ConvertibleNut

This class wraps a Nut and implements Nut interface by delegating method calls. Useful when you need to change only some method behavior.

Since:

0.4.4

Version:

1.0

Author:

Guillaume DROUET

Constructor Summary

Constructors

Constructor and Description
NutWrapper() Default constructor for serialization purpose.
NutWrapper(ConvertibleNut w) Builds a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addReferencedNut(ConvertibleNut referenced) Adds a new nut referenced by this nut.
void	addTransformer(Pipe.Transformer<ConvertibleNut> transformer) Adds a Pipe.Transformer.
String	getName() Returns the name potentially altered by other components like transformers.
NutType	getNutType() Returns the nut type potentially modified by other components like transformers.
List<ConvertibleNut>	getOriginalNuts() When this nut is the result of the transformation of another one, then it is actually a processed nut.
List<Pipe.OnReady>	getReadyCallbacks() Gets the callbacks notified when transformation has been done.
List<ConvertibleNut>	getReferencedNuts() Gets the nuts referenced by this nut.
Set<Pipe.Transformer<ConvertibleNut>>	getTransformers() Gets the registered transformers.
Boolean	isCompressed() Indicates if the nut is compressed.
boolean	isDynamic() Indicates if this nut has a dynamic content, meaning that it could be changed each time Nut.openStream() is invoked.
boolean	isSubResource() Indicates if this nut is a sub resource of the nut referencing it.
boolean	isTransformed() Indicates if this nut is transformed or not.
void	onReady(Pipe.OnReady onReady) Adds the given callback to be invoked once transformation occurs.
InputStream	openStream() Opens and returns an InputStream pointing to the nut.
void	setIsCompressed(Boolean c) Indicates if the nut is compressed.
void	setIsSubResource(boolean subResource) Mark this nut as a sub resource or not.
void	setNutName(String nutName) Sets the nut name.
void	setNutType(NutType nutType) Sets the nut type.
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.AbstractNut

equals, getInitialName, getInitialNutType, getParentFile, getProxyUri, getVersionNumber, hashCode, 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, getParentFile, getProxyUri, getVersionNumber, setProxyUri

Constructor Detail

NutWrapper

public NutWrapper()

Default constructor for serialization purpose.

NutWrapper

public NutWrapper(ConvertibleNut w)

Builds a new instance.

Parameters:

w - teh wrapped nut

Method Detail

isTransformed

public boolean isTransformed()

Indicates if this nut is transformed or not.

Specified by:

isTransformed in interface ConvertibleNut

Returns:

true if transformed, false otherwise

openStream

public InputStream openStream()
                       throws IOException

Opens and returns an InputStream pointing to the nut.

Specified by:

openStream in interface Nut

Returns:

the opened input stream

Throws:

IOException - if an I/O error occurs

getOriginalNuts

public List<ConvertibleNut> getOriginalNuts()

When this nut is the result of the transformation of another one, then it is actually a processed nut. This returns a list of original nuts that have been transformed to obtain this nut. When this nut is actually an non-transformed one, say an original nut, then the returned value should be null.

Specified by:

getOriginalNuts in interface ConvertibleNut

Returns:

the original nuts of this nut, null if this nut is actually original

getName

public String getName()

Returns the name potentially altered by other components like transformers.

Specified by:

getName in interface ConvertibleNut

Returns:

the nut name

setNutName

public void setNutName(String nutName)

Sets the nut name.

Specified by:

setNutName in interface ConvertibleNut

Parameters:

nutName - the name

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 AbstractNut

Returns:

true if content is dynamic, false otherwise

getNutType

public NutType getNutType()

Returns the nut type potentially modified by other components like transformers.

Specified by:

getNutType in interface ConvertibleNut

Returns:

the path type

setNutType

public void setNutType(NutType nutType)

Sets the nut type.

Specified by:

setNutType in interface ConvertibleNut

Parameters:

nutType - the new nut type

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

Parameters:

onReady - the callback

Throws:

IOException - if an I/O error occurs

onReady

public void onReady(Pipe.OnReady onReady)

Adds the given callback to be invoked once transformation occurs.

Specified by:

onReady in interface ConvertibleNut

Parameters:

onReady - the callback to add

getReadyCallbacks

public List<Pipe.OnReady> getReadyCallbacks()

Gets the callbacks notified when transformation has been done.

Specified by:

getReadyCallbacks in interface ConvertibleNut

Returns:

the callbacks

addTransformer

public void addTransformer(Pipe.Transformer<ConvertibleNut> transformer)

Adds a Pipe.Transformer.

Specified by:

addTransformer in interface ConvertibleNut

Parameters:

transformer - the transformer

getTransformers

public Set<Pipe.Transformer<ConvertibleNut>> getTransformers()

Gets the registered transformers. The set must be ordered.

Specified by:

getTransformers in interface ConvertibleNut

Returns:

the transformers

addReferencedNut

public void addReferencedNut(ConvertibleNut referenced)

Adds a new nut referenced by this nut.

Specified by:

addReferencedNut in interface ConvertibleNut

Parameters:

referenced - the referenced nut

getReferencedNuts

public List<ConvertibleNut> getReferencedNuts()

Gets the nuts referenced by this nut.

Specified by:

getReferencedNuts in interface ConvertibleNut

Returns:

the referenced nuts, null if no nut is referenced

setIsCompressed

public void setIsCompressed(Boolean c)

Indicates if the nut is compressed.

Specified by:

setIsCompressed in interface ConvertibleNut

Parameters:

c - true if the nut is compressed, false otherwise

isCompressed

public Boolean isCompressed()

Indicates if the nut is compressed.

Specified by:

isCompressed in interface ConvertibleNut

Returns:

true if the nut is compressed, false otherwise

isSubResource

public boolean isSubResource()

Indicates if this nut is a sub resource of the nut referencing it. If this is true, then this means that the referencer must loads this nut in order to work.

Specified by:

isSubResource in interface ConvertibleNut

Returns:

true if the nut is a sub resource, false otherwise

setIsSubResource

public void setIsSubResource(boolean subResource)

Mark this nut as a sub resource or not.

Specified by:

setIsSubResource in interface ConvertibleNut

Parameters:

subResource - true if the nut is a sub resource, false otherwise