org.jboss.portal.common.net
Interface URLNavigationProvider

All Known Implementing Classes:

FileURLNavigationProvider, JarURLNavigationProvider

public interface URLNavigationProvider

Defines an interface that provides navigation for URLs.

Method Summary

java.util.Iterator	getChildren(java.net.URL url) Returns an iterator over the children of the URL.
boolean	isDir(java.net.URL url) Return true if the url represents a directory.
void	visit(java.net.URL url, URLVisitor visitor) Visit all the children recursively.

Method Detail

isDir

boolean isDir(java.net.URL url)
              throws java.lang.IllegalArgumentException,
                     java.io.IOException

Return true if the url represents a directory.

Parameters:

url - the target url

Returns:

true if this URL reprensents a directory

Throws:

java.lang.IllegalArgumentException - if the url is null or is not accepted

java.io.IOException

getChildren

java.util.Iterator getChildren(java.net.URL url)
                               throws java.lang.IllegalArgumentException,
                                      java.io.IOException

Returns an iterator over the children of the URL.

Parameters:

url - the target url

Returns:

an iterator over the children of the url

Throws:

java.lang.IllegalArgumentException - if the url is null or is not accepted

java.io.IOException

visit

void visit(java.net.URL url,
           URLVisitor visitor)
           throws java.lang.IllegalArgumentException,
                  java.io.IOException

Visit all the children recursively.

Parameters:

url - the target url

visitor - the visitor

Throws:

java.lang.IllegalArgumentException - if an argument is null or if the url is not accepted

java.io.IOException - s