org.eclipse.xtext.conversion.impl

Class AbstractIDValueConverter

java.lang.Object

org.eclipse.xtext.conversion.impl.AbstractValueConverter<T>

org.eclipse.xtext.conversion.impl.AbstractLexerBasedConverter<String>

org.eclipse.xtext.conversion.impl.AbstractIDValueConverter

All Implemented Interfaces:

IValueConverter<String>, IValueConverter.RuleSpecific

Direct Known Subclasses:

IDValueConverter, IgnoreCaseIDValueConverter

public abstract class AbstractIDValueConverter
extends AbstractLexerBasedConverter<String>

Abstract implementation of a value converter that escapes a string based on a set of values. The strategy to compute this values and how the the string is found in this set is the responsibility of the concrete implementation. A common use-case is to collect the keywords in a grammar and match the string against these keywords or to use some ignore-case matching algorithm against the list of normalized keywords.

Author:

Sebastian Zarnekow - Initial contribution and API

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.xtext.conversion.IValueConverter

IValueConverter.RuleSpecific

Field Summary

Fields inherited from interface org.eclipse.xtext.conversion.IValueConverter

NO_OP_CONVERTER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractIDValueConverter()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	assertValidValue(String value)
protected Set<Character>	collectInvalidCharacters(String value)
protected abstract Set<String>	computeValuesToEscape(Grammar grammar)
protected ValueConverterException	createTokenContentMismatchException(String value, String escapedString, org.antlr.runtime.Token token)
protected IGrammarAccess	getGrammarAccess()
protected String	getInvalidCharactersMessage(String value, Set<Character> invalidChars)
protected Set<String>	getValuesToEscape()
protected abstract boolean	mustEscape(String value)
void	setGrammarAccess(IGrammarAccess grammarAccess)
protected String	toEscapedString(String value)
String	toValue(String string, INode node) Creates a value from the given input.

Methods inherited from class org.eclipse.xtext.conversion.impl.AbstractLexerBasedConverter

assertTokens, assertTokens, createTokenTypeMismatchException, getLexer, getLexerProvider, getRule, getRuleName, getRuleName, getTokenDefMap, getTokenDefProvider, getTokenSource, setLexerProvider, setRule, setTokenDefProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractIDValueConverter

protected AbstractIDValueConverter()

Method Detail

computeValuesToEscape

protected abstract Set<String> computeValuesToEscape(Grammar grammar)

getValuesToEscape

protected Set<String> getValuesToEscape()

mustEscape

protected abstract boolean mustEscape(String value)

toEscapedString

protected String toEscapedString(String value)

Overrides:

toEscapedString in class AbstractLexerBasedConverter<String>

assertValidValue

protected void assertValidValue(String value)

Overrides:

assertValidValue in class AbstractLexerBasedConverter<String>

createTokenContentMismatchException

protected ValueConverterException createTokenContentMismatchException(String value,
                                                          String escapedString,
                                                          org.antlr.runtime.Token token)

Overrides:

createTokenContentMismatchException in class AbstractLexerBasedConverter<String>

getInvalidCharactersMessage

protected String getInvalidCharactersMessage(String value,
                                 Set<Character> invalidChars)

collectInvalidCharacters

protected Set<Character> collectInvalidCharacters(String value)

toValue

public String toValue(String string,
             INode node)

Description copied from interface: IValueConverter

Creates a value from the given input. The input is conformant to a data type or terminal rule.

The given string or node may be null but not both of them.

Parameters:

string - the string that was inferred from the node. Usually the node's text but may be reduced to the parts of the node that are not hidden.

node - the parsed node including hidden parts.

Returns:

the new value or null.

getGrammarAccess

protected IGrammarAccess getGrammarAccess()

setGrammarAccess

public void setGrammarAccess(IGrammarAccess grammarAccess)