org.hippoecm.hst.core
Interface ResourceVisitor

public interface ResourceVisitor

ResourceVisitor

Generic resource visitor interface for resource traversals.

Version:

$Id: ResourceVisitor.java 21361 2010-01-19 14:47:28Z wko $

Field Summary

static Object	CONTINUE_TRAVERSAL Value to return to continue a traversal.
static Object	STOP_TRAVERSAL A generic value to return to stop a traversal.

Method Summary

Object

resource(Object resource) Called at each resource in a traversal.

Field Detail

CONTINUE_TRAVERSAL

static final Object CONTINUE_TRAVERSAL

Value to return to continue a traversal.

STOP_TRAVERSAL

static final Object STOP_TRAVERSAL

A generic value to return to stop a traversal.

Method Detail

resource

Object resource(Object resource)

Called at each resource in a traversal.

Parameters:

resource - The resource

Returns:

CONTINUE_TRAVERSAL (null) if the traversal should continue, or a non-null return value for the traversal method if it should stop. If no return value is useful, the generic non-null value STOP_TRAVERSAL can be used.