Package de.xima.fc.interfaces.plugin.retval.replacer

Interface IPluginTemplateReplacerRetVal

All Superinterfaces:

IPluginGenericReplacerRetVal, IPluginReturnValue

All Known Implementing Classes:

PluginGenericReplacerRetVal

public interface IPluginTemplateReplacerRetVal
extends IPluginGenericReplacerRetVal

Interface for the return value of a template replacer plugin.

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
String	getReplacedValue()	The value that should be used as the replacement for the placeholder.

Methods inherited from interface de.xima.fc.interfaces.plugin.retval.replacer.IPluginGenericReplacerRetVal

getReplacementStatus

Method Details

getReplacedValue

String getReplacedValue()

Description copied from interface: IPluginGenericReplacerRetVal

The value that should be used as the replacement for the placeholder. This must be just the value, without any placeholder-specific prefixes or suffixes.

Also, a plugin may not want to handle all placeholders and delegate some placeholders to other plugins or to the default placeholder replacer. Return the name of the placeholder as the replaced value to indicate that the plugin cannot (or does not with to) handle that placeholder.

Specified by:

getReplacedValue in interface IPluginGenericReplacerRetVal

Returns:

The value to be used as the replacement for the placeholder. When this returns null: The placeholder is considered not resolved if IPluginGenericReplacerRetVal.getReplacementStatus() is LEGACY; otherwise null is treated as the empty string.