com.github.wuic.nut

Class AbstractConvertibleNut

java.lang.Object

com.github.wuic.nut.AbstractNut

com.github.wuic.nut.AbstractConvertibleNut

All Implemented Interfaces:

ConvertibleNut, Nut

Direct Known Subclasses:

NotReachableNut, PipedConvertibleNut

public abstract class AbstractConvertibleNut
extends AbstractNut
implements ConvertibleNut

Base class for ConvertibleNut implementation with state management (attributes like transformers or referenced nuts). Transformation is delegated to subclass.

Since:

0.5.0

Version:

1.0

Author:

Guillaume DROUET

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractConvertibleNut(Nut o) Builds a new instance.
protected	AbstractConvertibleNut(String name, NutType ft, Future<Long> v, Boolean c) 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.
boolean	equals(Object other)
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.
String	getParentFile() If the file is stored in a directory on the file system, then this method returns the directory.
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.
int	hashCode()
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.
void	onReady(Pipe.OnReady callback) Adds the given callback to be invoked once transformation occurs.
InputStream	openStream() Opens and returns an InputStream pointing to the nut.
void	setIsCompressed(Boolean compressed) Indicates if the nut is compressed.
void	setIsSubResource(boolean sr) 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.
protected void	setOriginalNuts(List<ConvertibleNut> o) Sets the original nuts.

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.ConvertibleNut

isTransformed, transform

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

getInitialName, getInitialNutType, getProxyUri, getVersionNumber, setProxyUri

Constructor Detail

AbstractConvertibleNut

protected AbstractConvertibleNut(Nut o)

Builds a new instance.

Parameters:

o - the converted nut

AbstractConvertibleNut

protected AbstractConvertibleNut(String name,
                      NutType ft,
                      Future<Long> v,
                      Boolean c)

Builds a new instance.

Parameters:

name - the nut's name

ft - the nut's type

v - version number

c - is compressed or not

Method Detail

setOriginalNuts

protected final void setOriginalNuts(List<ConvertibleNut> o)

Sets the original nuts.

Parameters:

o - the original nuts

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

getReadyCallbacks

public List<Pipe.OnReady> getReadyCallbacks()

Gets the callbacks notified when transformation has been done.

Specified by:

getReadyCallbacks in interface ConvertibleNut

Returns:

the callbacks

isCompressed

public final Boolean isCompressed()

Indicates if the nut is compressed.

Specified by:

isCompressed in interface ConvertibleNut

Returns:

true if the nut is compressed, false otherwise

setIsCompressed

public final void setIsCompressed(Boolean compressed)

Indicates if the nut is compressed.

Specified by:

setIsCompressed in interface ConvertibleNut

Parameters:

compressed - true if the nut is compressed, false otherwise

setNutName

public final void setNutName(String nutName)

Sets the nut name.

Specified by:

setNutName in interface ConvertibleNut

Parameters:

nutName - the name

setNutType

public final void setNutType(NutType nutType)

Sets the nut type.

Specified by:

setNutType in interface ConvertibleNut

Parameters:

nutType - the new nut type

setIsSubResource

public final void setIsSubResource(boolean sr)

Mark this nut as a sub resource or not.

Specified by:

setIsSubResource in interface ConvertibleNut

Parameters:

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

isSubResource

public final boolean isSubResource()

Description copied from interface: ConvertibleNut

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

addTransformer

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

Adds a Pipe.Transformer.

Specified by:

addTransformer in interface ConvertibleNut

Parameters:

transformer - the transformer

onReady

public void onReady(Pipe.OnReady callback)

Adds the given callback to be invoked once transformation occurs.

Specified by:

onReady in interface ConvertibleNut

Parameters:

callback - the callback to add

getName

public String getName()

Returns the name potentially altered by other components like transformers.

Specified by:

getName in interface ConvertibleNut

Returns:

the nut name

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

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

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

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

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

getParentFile

public String getParentFile()

If the file is stored in a directory on the file system, then this method returns the directory.

Specified by:

getParentFile in interface Nut

Overrides:

getParentFile in class AbstractNut

Returns:

the parent directory, null if the nut is not directly accessible on the file system

equals

public boolean equals(Object other)

Overrides:

equals in class AbstractNut

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractNut