com.github.wuic.nut

Class ByteArrayNut

java.lang.Object

com.github.wuic.nut.AbstractNut

com.github.wuic.nut.AbstractConvertibleNut

com.github.wuic.nut.PipedConvertibleNut

com.github.wuic.nut.ByteArrayNut

All Implemented Interfaces:

ConvertibleNut, Nut, Serializable

public final class ByteArrayNut
extends PipedConvertibleNut
implements Serializable

Represents an in-memory nut which can be created on the fly in any context.

This class also aims to provide a fully Serializable Nut. Since the Future implementation which provides the version number could is not always a Serializable, then the version number must be directly provided.

Since:

0.2.0

Version:

1.7

Author:

Guillaume DROUET

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ByteArrayNut(byte[] bytes, String name, NutType nt, ConvertibleNut originalNut) Builds a new Nut transformed nut based on a given byte array and only one original nut.
ByteArrayNut(byte[] bytes, String name, NutType nt, List<ConvertibleNut> originalNuts, Long version) Builds a new Nut transformed nut based on a specified byte array.
ByteArrayNut(byte[] bytes, String name, NutType nt, Long version, boolean dynamicContent) Builds a new Nut original nut based on a given byte array.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isDynamic() Indicates if this nut has a dynamic content, meaning that it could be changed each time Nut.openStream() is invoked.
InputStream	openStream() Opens and returns an InputStream pointing to the nut.
void	setByteArray(byte[] bytes) Sets the content.
static ConvertibleNut	toByteArrayNut(ConvertibleNut nut) Converts the given nut and its referenced nuts into nuts wrapping an in memory byte array.
static List<ConvertibleNut>	toByteArrayNut(List<ConvertibleNut> nuts) Converts the given nuts list and its referenced nuts into nuts wrapping an in memory byte array.

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

isTransformed, setTransformed, transform, 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

ByteArrayNut

public ByteArrayNut(byte[] bytes,
            String name,
            NutType nt,
            ConvertibleNut originalNut)

Builds a new Nut transformed nut based on a given byte array and only one original nut.

Parameters:

bytes - the byte array

name - the nut name

nt - the NutType

originalNut - the original nut

ByteArrayNut

public ByteArrayNut(byte[] bytes,
            String name,
            NutType nt,
            List<ConvertibleNut> originalNuts,
            Long version)

Builds a new Nut transformed nut based on a specified byte array. Content will be static and call to setByteArray(byte[]) will be avoided.

Parameters:

bytes - the byte array

name - the nut name

nt - the NutType

originalNuts - the original nuts

version - the version number

ByteArrayNut

public ByteArrayNut(byte[] bytes,
            String name,
            NutType nt,
            Long version,
            boolean dynamicContent)

Builds a new Nut original nut based on a given byte array.

Parameters:

bytes - the byte array

name - the nut name

nt - the NutType

version - the version number

dynamicContent - true if you will call setByteArray(byte[]) in the future

Method Detail

toByteArrayNut

public static List<ConvertibleNut> toByteArrayNut(List<ConvertibleNut> nuts)
                                           throws IOException

Converts the given nuts list and its referenced nuts into nuts wrapping an in memory byte array.

Returns:

the byte array nut

Throws:

IOException - if any I/O error occurs

toByteArrayNut

public static ConvertibleNut toByteArrayNut(ConvertibleNut nut)
                                     throws IOException

Converts the given nut and its referenced nuts into nuts wrapping an in memory byte array.

Parameters:

nut - the nut to convert

Returns:

the byte array nut

Throws:

IOException - if any I/O error occurs

setByteArray

public void setByteArray(byte[] bytes)

Sets the content.

Parameters:

bytes - the new content

openStream

public InputStream openStream()

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

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