com.github.wuic.nut

Interface ConvertibleNut

All Superinterfaces:

Nut

All Known Implementing Classes:

AbstractConvertibleNut, ByteArrayNut, CompositeNut, ImageNut, NotReachableNut, NutWrapper, PipedConvertibleNut, PrefixedNut, TransformedNut

public interface ConvertibleNut
extends Nut

A convertible nut has a content which can be transformed with a chain of transformers. During transformation, the state of the nut can change and not only its content. For instance, the nut becomes compressed or refers new nuts.

Transformation process should change the state once. The implementation has to deal with this to not let the transformers add duplicated data to the nut's state.

Since:

0.5.0

Version:

1.0

Author:

Guillaume DROUET

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	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.
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 interface com.github.wuic.nut.Nut

getInitialName, getInitialNutType, getParentFile, getProxyUri, getVersionNumber, isDynamic, openStream, setProxyUri

Method Detail

getOriginalNuts

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.

Returns:

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

getName

String getName()

Returns the name potentially altered by other components like transformers.

Returns:

the nut name

getNutType

NutType getNutType()

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

Returns:

the path type

setNutName

void setNutName(String nutName)

Sets the nut name.

Parameters:

nutName - the name

setNutType

void setNutType(NutType nutType)

Sets the nut type.

Parameters:

nutType - the new nut type

transform

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.

Parameters:

onReady - the callback

Throws:

IOException - if an I/O error occurs

onReady

void onReady(Pipe.OnReady onReady)

Adds the given callback to be invoked once transformation occurs.

Parameters:

onReady - the callback to add

getReadyCallbacks

List<Pipe.OnReady> getReadyCallbacks()

Gets the callbacks notified when transformation has been done.

Returns:

the callbacks

addTransformer

void addTransformer(Pipe.Transformer<ConvertibleNut> transformer)

Adds a Pipe.Transformer.

Parameters:

transformer - the transformer

getTransformers

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

Gets the registered transformers. The set must be ordered.

Returns:

the transformers

addReferencedNut

void addReferencedNut(ConvertibleNut referenced)

Adds a new nut referenced by this nut.

Parameters:

referenced - the referenced nut

getReferencedNuts

List<ConvertibleNut> getReferencedNuts()

Gets the nuts referenced by this nut.

Returns:

the referenced nuts, null if no nut is referenced

isTransformed

boolean isTransformed()

Indicates if this nut is transformed or not.

Returns:

true if transformed, false otherwise

setIsCompressed

void setIsCompressed(Boolean c)

Indicates if the nut is compressed.

Parameters:

c - true if the nut is compressed, false otherwise

isCompressed

Boolean isCompressed()

Indicates if the nut is compressed.

Returns:

true if the nut is compressed, false otherwise

isSubResource

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.

Returns:

true if the nut is a sub resource, false otherwise

setIsSubResource

void setIsSubResource(boolean subResource)

Mark this nut as a sub resource or not.

Parameters:

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