Package ro.sync.exml.workspace.api.util

Class EditorVariablesResolver

java.lang.Object

ro.sync.exml.workspace.api.util.EditorVariablesResolver

@API(type=EXTENDABLE,
     src=PUBLIC)
public abstract class EditorVariablesResolver
extends Object

Such a resolver can be registered via the "ro.sync.exml.workspace.api.util.UtilAccess" API and is called to resolve custom editor variables in a string.

Since:

16.1

Constructor Summary

Constructors

Constructor	Description
EditorVariablesResolver()

Method Summary

Modifier and Type	Method	Description
List<EditorVariableDescription>	getCustomResolverEditorVariableDescriptions()	Get a list with all editor variables which are custom resolved by this resolver.
String	resolveEditorVariables(String contentWithEditorVariables, String currentEditedFileURL)	Resolve editor variables in the received content.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EditorVariablesResolver

public EditorVariablesResolver()

Method Details

resolveEditorVariables

public String resolveEditorVariables(String contentWithEditorVariables,
 String currentEditedFileURL)

Resolve editor variables in the received content.

Parameters:

contentWithEditorVariables - The initial content which possibly contains unresolved editor variables.

currentEditedFileURL - The current edited file URL, can be used if the editor variable depends on the current edited file.

Returns:

The processed content with certain editor variables replaced with developer-specific values or the original content. Can also return null to let the default processing occur.

getCustomResolverEditorVariableDescriptions

public List<EditorVariableDescription> getCustomResolverEditorVariableDescriptions()

Get a list with all editor variables which are custom resolved by this resolver.

Returns:

a list with all editor variables which are custom resolved by this resolver.

Since:

18.1