Package com.e1c.g5.v8.dt.lcore.ui.templates.contentassist.parsing

Interface IVariableOccurrence

All Known Implementing Classes:

VariableOccurrence

public interface IVariableOccurrence

The variable occurrence that can be converted into IVariable by factory. Describes an occurrence of variable in the template by parsing it into parameters

Method Summary

Modifier and Type	Method	Description
String	getName()	Returns name of the variable.
String	getParameter(int i)	Returns the parameter with the given order.
List<String>	getParameters()	Gets all variable invocation parameters
int	getParametersCount()	Returns the number representing the amount of parameters this variable has
org.eclipse.jface.text.IRegion	getRegion()	Returns the region occurrence of this variable
String	getText()	Returns the text of the occurrence

Method Detail

getName

String getName()

Returns name of the variable. Name is variable's ID

Returns:

The name of the variable, cannot be null

getParametersCount

int getParametersCount()

Returns the number representing the amount of parameters this variable has

Returns:

The number of parameters held by this variable

getParameter

String getParameter(int i)

Returns the parameter with the given order. Counts from 0

Parameters:

i - The order of the parameter to be returned

Returns:

The value of the parameter, can be null

getRegion

org.eclipse.jface.text.IRegion getRegion()

Returns the region occurrence of this variable

Returns:

The region of this occurrence, cannot be null

getText

String getText()

Returns the text of the occurrence

Returns:

The text of the occurrence, cannot be null

getParameters

List<String> getParameters()

Gets all variable invocation parameters

Returns:

all variable invocation parameters, never null