com.github.wuic.nut

Class AbstractNut

java.lang.Object

com.github.wuic.nut.AbstractNut

All Implemented Interfaces:

Nut

Direct Known Subclasses:

AbstractConvertibleNut, FilePathNut, HttpNut, NutWrapper, WebappNut

public abstract class AbstractNut
extends Object
implements Nut

Base implementation of the Nut interface. A Nut is often represented by a name and a NutType. This class already manages it.

Since:

0.3.0

Version:

1.6

Author:

Guillaume DROUET

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbstractNut() Default constructor for serialization purpose.
protected	AbstractNut(Nut o) Creates a new instance by copying the given Nut.
protected	AbstractNut(String name, NutType ft, Future<Long> v) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object other)
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.
int	hashCode()
boolean	isDynamic() Indicates if this nut has a dynamic content, meaning that it could be changed each time Nut.openStream() is invoked.
void	setProxyUri(String uri) Sets a proxy URI that allow to access the nut through another way.
protected void	setVersionNumber(Future<Long> vn) Sets internal version number.
String	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

openStream

Constructor Detail

AbstractNut

public AbstractNut()

Default constructor for serialization purpose.

AbstractNut

protected AbstractNut(Nut o)

Creates a new instance by copying the given Nut.

Parameters:

o - the nut to copy

AbstractNut

protected AbstractNut(String name,
           NutType ft,
           Future<Long> v)

Creates a new instance. The nut is actually an original nut because constructor provides a version number of this nut without any original nuts.

Parameters:

name - the nut's name

ft - the nut's type

v - version number

Method Detail

getInitialName

public String getInitialName()

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

Specified by:

getInitialName in interface Nut

Returns:

the nut name

getInitialNutType

public NutType getInitialNutType()

Returns the path type of this nut.

Specified by:

getInitialNutType in interface Nut

Returns:

the path type

getProxyUri

public String getProxyUri()

Gets the proxy URI.

Specified by:

getProxyUri in interface Nut

Returns:

the proxy URI, null if no proxy URI is set

setProxyUri

public void setProxyUri(String uri)

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

Specified by:

setProxyUri in interface Nut

Parameters:

uri - the proxy uri

getVersionNumber

public Future<Long> getVersionNumber()

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

Specified by:

getVersionNumber in interface Nut

Returns:

the nut's version

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

Returns:

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

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

Returns:

true if content is dynamic, false otherwise

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setVersionNumber

protected final void setVersionNumber(Future<Long> vn)

Sets internal version number.

Parameters:

vn - the new version