Package org.hippoecm.hst.core

Interface ResourceVisitor

public interface ResourceVisitor
ResourceVisitor

Generic resource visitor interface for resource traversals.

Version:
$Id$

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Object
    CONTINUE_TRAVERSAL
    Value to return to continue a traversal.
    static final Object
    STOP_TRAVERSAL
    A generic value to return to stop a traversal.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    resource(Object resource)
    Called at each resource in a traversal.

  • Field Details

    • 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 Details

    • 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.