oracle.as.scheduler.substitution
Interface Substitutor

All Known Implementing Classes:

SubstitutorImpl

public interface Substitutor

Since:

release specific (what release of product did this appear in)

Version:

$Header: ess/src/oracle/as/scheduler/substitution/Substitutor.java /main/3 2008/07/15 12:10:43 cfuentes Exp $

cfuentes

See Also:

SubstitutionHandler

Method Summary

void	close() Cleanup substitutor state and release all handlers.
void	setSubstitutionHandlers(java.util.List<SubstitutionHandler> subsHandlers) Set the list of SubstitutionHandlers to use for substitution.
void	setSubstitutionHandlers(java.lang.String subsHandlerNames) Set the list of SubstitutionHandlers to use for substitution.
java.lang.String	substitute(java.lang.String original) Recursively replaces all tokens in the string original with the results from matching handlers.

Method Detail

setSubstitutionHandlers

void setSubstitutionHandlers(java.lang.String subsHandlerNames)

Set the list of SubstitutionHandlers to use for substitution.

Parameters:

subsHandlerNames - Comma-separated list substitution handler class names.

setSubstitutionHandlers

void setSubstitutionHandlers(java.util.List<SubstitutionHandler> subsHandlers)

Set the list of SubstitutionHandlers to use for substitution.

Parameters:

subsHandlers - List of handler instances.

substitute

java.lang.String substitute(java.lang.String original)
                            throws SubstitutionException

Recursively replaces all tokens in the string original with the results from matching handlers. Any tokens that are not recognized by any handlers will remain in the string.

Parameters:

original - String with tokens to be substituted.

Returns:

String with substitutions performed.

Throws:

SubstitutionException - if an error occurs during substitution

close

void close()

Cleanup substitutor state and release all handlers.