net.sourceforge.stripes.vfs

Class JBoss6VFS

java.lang.Object

net.sourceforge.stripes.vfs.VFS

net.sourceforge.stripes.vfs.JBoss6VFS

public class JBoss6VFS
extends VFS

A VFS implementation that works with the VFS API provided by JBoss 6.

Author:

Ben Gunter

Field Summary

Fields inherited from class net.sourceforge.stripes.vfs.VFS

IMPLEMENTATIONS, USER_IMPLEMENTATIONS

Constructor Summary

Constructors

Constructor and Description
JBoss6VFS()

Method Summary

Methods

Modifier and Type	Method and Description
protected static <T> T	checkNotNull(T object) Verifies that the provided object reference is null.
protected static void	checkReturnType(Method method, Class<?> expected) Verifies that the return type of a method is what it is expected to be.
protected static void	initialize() Find all the classes and methods that are required to access the JBoss 6 VFS.
boolean	isValid() Return true if the VFS implementation is valid for the current environment.
List<String>	list(URL url, String path) Recursively list the full resource path of all the resources that are children of the resource identified by a URL.
protected static void	setInvalid() Mark this VFS as invalid for the current environment.

Methods inherited from class net.sourceforge.stripes.vfs.VFS

addImplClass, getClass, getInstance, getMethod, getResources, invoke, list

Methods inherited from class java.lang.Object

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

Constructor Detail

JBoss6VFS

public JBoss6VFS()

Method Detail

initialize

protected static void initialize()

Find all the classes and methods that are required to access the JBoss 6 VFS.

checkNotNull

protected static <T> T checkNotNull(T object)

Verifies that the provided object reference is null. If it is null, then this VFS is marked as invalid for the current environment.

Parameters:

object - The object reference to check for null.

checkReturnType

protected static void checkReturnType(Method method,
                   Class<?> expected)

Verifies that the return type of a method is what it is expected to be. If it is not, then this VFS is marked as invalid for the current environment.

Parameters:

method - The method whose return type is to be checked.

expected - A type to which the method's return type must be assignable.

See Also:

Class.isAssignableFrom(Class)

setInvalid

protected static void setInvalid()

Mark this VFS as invalid for the current environment.

isValid

public boolean isValid()

Description copied from class: VFS

Return true if the VFS implementation is valid for the current environment.

Specified by:

isValid in class VFS

list

public List<String> list(URL url,
                String path)
                  throws IOException

Description copied from class: VFS

Recursively list the full resource path of all the resources that are children of the resource identified by a URL.

Specified by:

list in class VFS

Parameters:

url - The URL that identifies the resource to list.

path - The path to the resource that is identified by the URL. Generally, this is the value passed to VFS.getResources(String) to get the resource URL.

Returns:

A list containing the names of the child resources.

Throws:

IOException - If I/O errors occur