com.github.wuic.nut

Interface Nut

All Known Subinterfaces:

ConvertibleNut

All Known Implementing Classes:

AbstractConvertibleNut, AbstractNut, ByteArrayNut, CompositeNut, FilePathNut, HttpNut, ImageNut, NotReachableNut, NutWrapper, PipedConvertibleNut, PrefixedNut, TransformedNut, WebappNut

public interface Nut

The nut is the fundamental element of WUIC nut. It's represent a nut, generally corresponding to a static (CSS, Javascript, Image). It could be picked thanks to different protocol (FTP, HTTP, cloud, etc).

The name is the path relative to a location specified by a NutDao which is in charge of nut creations.

Since:

0.1.1

Version:

1.4

Author:

Guillaume DROUET

Method Summary

Methods

Modifier and Type	Method and Description
String	getInitialName() Returns the name of the nut.
NutType	getInitialNutType() Returns the path type of this nut.
String	getParentFile() If the file is stored in a directory on the file system, then this method returns the directory.
String	getProxyUri() Gets the proxy URI.
Future<Long>	getVersionNumber() Returns an Long indicating the version of this nut.
boolean	isDynamic() Indicates if this nut has a dynamic content, meaning that it could be changed each time openStream() is invoked.
InputStream	openStream() Opens and returns an InputStream pointing to the nut.
void	setProxyUri(String uri) Sets a proxy URI that allow to access the nut through another way.

Method Detail

openStream

InputStream openStream()
                       throws IOException

Opens and returns an InputStream pointing to the nut.

Returns:

the opened input stream

Throws:

IOException - if an I/O error occurs

getInitialNutType

NutType getInitialNutType()

Returns the path type of this nut.

Returns:

the path type

getInitialName

String getInitialName()

Returns the name of the nut. This is not a path consequently it should not contains any paths.

Returns:

the nut name

setProxyUri

void setProxyUri(String uri)

Sets a proxy URI that allow to access the nut through another way.

Parameters:

uri - the proxy uri

getProxyUri

String getProxyUri()

Gets the proxy URI.

Returns:

the proxy URI, null if no proxy URI is set

getVersionNumber

Future<Long> getVersionNumber()

Returns an Long indicating the version of this nut. This helps to deal with content updates.

Returns:

the nut's version

getParentFile

String getParentFile()

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

Returns:

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

isDynamic

boolean isDynamic()

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

Returns:

true if content is dynamic, false otherwise