org.apache.slide.macro
Interface CopyRouteRedirector


public interface CopyRouteRedirector

A CopyRouteRedirector may be passed to the Macro helper in order to have more control on the copy operation. A CopyRouteRedirector may either return the given CopyRoute or any (redirected) CopyRoute.

Version:
$Revision: 1.5 $

Nested Class Summary
static class CopyRouteRedirector.CopyRoute
          A CopyRoute defines the source and the destination URI of a copy operation.
 
Method Summary
 CopyRouteRedirector.CopyRoute getRedirectedCopyRoute(CopyRouteRedirector.CopyRoute copyRoute)
          Returns the (redirected) CopyRoute to use.
 

Method Detail

getRedirectedCopyRoute

public CopyRouteRedirector.CopyRoute getRedirectedCopyRoute(CopyRouteRedirector.CopyRoute copyRoute)
                                                     throws SlideException
Returns the (redirected) CopyRoute to use. Must not be null.

Parameters:
copyRoute - the original CopyRoute.
Returns:
the (redirected) CopyRoute to use.
Throws:
SlideException - this Exception will be passed to the caller of the Macro helper (contained in the MacroCopyException).