com.github.wuic.nut

Class FilePathNut

java.lang.Object

com.github.wuic.nut.AbstractNut

com.github.wuic.nut.FilePathNut

All Implemented Interfaces:

Nut

public class FilePathNut
extends AbstractNut

Represents a nut on the path system provided or to be managed by the WUIC framework. Thanks to FilePath, the nut could also be a ZIP entry.

Since:

0.1.1

Version:

1.6

Author:

Guillaume DROUET

Constructor Summary

Constructors

Constructor and Description
FilePathNut(FilePath p, String name, NutType ft, Future<Long> versionNumber) Builds a new Nut based on a given path.

Method Summary

Methods

Modifier and Type	Method and Description
String	getParentFile() If the file is stored in a directory on the file system, then this method returns the directory.
InputStream	openStream() Opens and returns an InputStream pointing to the nut.

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

equals, getInitialName, getInitialNutType, getProxyUri, getVersionNumber, hashCode, isDynamic, setProxyUri, setVersionNumber, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FilePathNut

public FilePathNut(FilePath p,
           String name,
           NutType ft,
           Future<Long> versionNumber)

Builds a new Nut based on a given path.

Parameters:

p - the path

name - the nut name

ft - the path type

versionNumber - the nut's version number

Method Detail

openStream

public 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

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