org.xwiki.velocity.tools.nio

Class NIOTool

java.lang.Object

org.xwiki.velocity.tools.nio.NIOTool

public class NIOTool
extends Object

Provides access to some of the static NIO2 Files methods.

Since:

7.4M2

Version:

$Id: aa10ac341242c55ae56e0536210639fa47fe823a $

Constructor Summary

Constructors

Constructor and Description
NIOTool()

Method Summary

Modifier and Type	Method and Description
boolean	exists(Path path, LinkOption... options) See Files.exists(Path, LinkOption...).
Object	getAttribute(Path path, String attribute, LinkOption... options) See Files.getAttribute(Path, String, LinkOption...).
FileTime	getLastModifiedTime(Path path, LinkOption... options) See Files.getLastModifiedTime(Path, LinkOption...).
boolean	isDirectory(Path path, LinkOption... options) See Files.isDirectory(Path, LinkOption...).
boolean	isReadable(Path path) See Files.isReadable(Path).
boolean	isRegularFile(Path path, LinkOption... options) See Files.isRegularFile(Path, LinkOption...).
boolean	isSymbolicLink(Path path) See Files.isSymbolicLink(Path).
BufferedReader	newBufferedReader(Path path, Charset cs) See Files.newBufferedReader(Path, Charset).
DirectoryStream<Path>	newDirectoryStream(Path dir) See Files.newDirectoryStream(Path).
DirectoryStream<Path>	newDirectoryStream(Path dir, DirectoryStream.Filter filter) See Files.newDirectoryStream(Path, DirectoryStream.Filter).
DirectoryStream<Path>	newDirectoryStream(Path dir, String glob) See Files.newDirectoryStream(Path, String).
byte[]	readAllBytes(Path path) See Files.readAllBytes(Path).
List<String>	readAllLines(Path path, Charset cs) See Files.readAllLines(Path, Charset).
Map<String,Object>	readAttributes(Path path, String attributes, LinkOption... options) See Files.readAttributes(Path, String, LinkOption...).
long	size(Path path) See Files.size(Path).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NIOTool

public NIOTool()

Method Detail

newDirectoryStream

public DirectoryStream<Path> newDirectoryStream(Path dir)

See Files.newDirectoryStream(Path).

Velocity Example:

 #set ($dirStream = $niotool.newDirectoryStream("attach:Sandbox.WebHome@vma.txt.zip/"))
 #foreach ($entry in $dirStream)
   * {{{$entry}}}
 #end
 

Parameters:

dir - See Files.newDirectoryStream(Path)

Returns:

See Files.newDirectoryStream(Path)

newDirectoryStream

public DirectoryStream<Path> newDirectoryStream(Path dir,
                                                DirectoryStream.Filter filter)

See Files.newDirectoryStream(Path, DirectoryStream.Filter).

Parameters:

dir - See Files.newDirectoryStream(Path, DirectoryStream.Filter)

filter - See Files.newDirectoryStream(Path, DirectoryStream.Filter)

Returns:

See Files.newDirectoryStream(Path, DirectoryStream.Filter)

newDirectoryStream

public DirectoryStream<Path> newDirectoryStream(Path dir,
                                                String glob)

See Files.newDirectoryStream(Path, String).

Parameters:

dir - See Files.newDirectoryStream(Path, String)

glob - See Files.newDirectoryStream(Path, String)

Returns:

See Files.newDirectoryStream(Path, String)

isDirectory

public boolean isDirectory(Path path,
                           LinkOption... options)

See Files.isDirectory(Path, LinkOption...).

Parameters:

path - See Files.isDirectory(Path, LinkOption...)

options - See Files.isDirectory(Path, LinkOption...)

Returns:

See Files.isDirectory(Path, LinkOption...)

isRegularFile

public boolean isRegularFile(Path path,
                             LinkOption... options)

See Files.isRegularFile(Path, LinkOption...).

Parameters:

path - See Files.isRegularFile(Path, LinkOption...)

options - See Files.isRegularFile(Path, LinkOption...)

Returns:

See Files.isRegularFile(Path, LinkOption...)

isReadable

public boolean isReadable(Path path)

See Files.isReadable(Path).

Parameters:

path - See Files.isReadable(Path)

Returns:

See Files.isReadable(Path)

isSymbolicLink

public boolean isSymbolicLink(Path path)

See Files.isSymbolicLink(Path).

Parameters:

path - See Files.isSymbolicLink(Path)

Returns:

See Files.isSymbolicLink(Path)

exists

public boolean exists(Path path,
                      LinkOption... options)

See Files.exists(Path, LinkOption...).

Parameters:

path - See Files.exists(Path, LinkOption...)

options - See Files.exists(Path, LinkOption...)

Returns:

See Files.exists(Path, LinkOption...)

readAllBytes

public byte[] readAllBytes(Path path)

See Files.readAllBytes(Path).

Velocity Example:

 $stringtool.toString($niotool.readAllBytes("attach:Sandbox.WebHome@vma.txt.zip/vma.txt"), "utf-8")
 

Parameters:

path - See Files.readAllBytes(Path)

Returns:

See Files.readAllBytes(Path)

readAllLines

public List<String> readAllLines(Path path,
                                 Charset cs)

See Files.readAllLines(Path, Charset).

Parameters:

path - See Files.readAllLines(Path, Charset)

cs - See Files.readAllLines(Path, Charset)

Returns:

See Files.readAllLines(Path, Charset)

newBufferedReader

public BufferedReader newBufferedReader(Path path,
                                        Charset cs)

See Files.newBufferedReader(Path, Charset).

Parameters:

path - See Files.newBufferedReader(Path, Charset)

cs - See Files.newBufferedReader(Path, Charset)

Returns:

See Files.newBufferedReader(Path, Charset)

size

public long size(Path path)

See Files.size(Path).

Parameters:

path - See Files.size(Path)

Returns:

See Files.size(Path)

getAttribute

public Object getAttribute(Path path,
                           String attribute,
                           LinkOption... options)

See Files.getAttribute(Path, String, LinkOption...).

Parameters:

path - See Files.getAttribute(Path, String, LinkOption...)

attribute - See Files.getAttribute(Path, String, LinkOption...)

options - See Files.getAttribute(Path, String, LinkOption...)

Returns:

See Files.getAttribute(Path, String, LinkOption...)

readAttributes

public Map<String,Object> readAttributes(Path path,
                                         String attributes,
                                         LinkOption... options)

See Files.readAttributes(Path, String, LinkOption...).

Parameters:

path - See Files.readAttributes(Path, String, LinkOption...)

attributes - See Files.readAttributes(Path, String, LinkOption...)

options - See Files.readAttributes(Path, String, LinkOption...)

Returns:

See Files.readAttributes(Path, String, LinkOption...)

getLastModifiedTime

public FileTime getLastModifiedTime(Path path,
                                    LinkOption... options)

See Files.getLastModifiedTime(Path, LinkOption...).

Parameters:

path - See Files.getLastModifiedTime(Path, LinkOption...)

options - See Files.getLastModifiedTime(Path, LinkOption...)

Returns:

See Files.getLastModifiedTime(Path, LinkOption...)