org.eclipse.xtext.util

Class JavaStringConverter

java.lang.Object

org.eclipse.xtext.util.JavaStringConverter

public class JavaStringConverter
extends java.lang.Object

Reusable and customizable implementation of the method pair Strings.convertToJavaString(String) and Strings.convertFromJavaString(String, boolean).

Since:

2.16

Constructor Summary

Constructors

Constructor and Description
JavaStringConverter()

Method Summary

Modifier and Type	Method and Description
protected void	appendRegion(java.lang.String string, int fromInclusive, int toExclusive, java.lang.StringBuilder result)
java.lang.String	convertFromJavaString(java.lang.String string, boolean useUnicode) Resolve Java control character sequences to the actual character value.
protected java.lang.String	convertFromJavaString(java.lang.String string, boolean useUnicode, int index, java.lang.StringBuilder result)
java.lang.String	convertToJavaString(java.lang.String theString) Escapes control characters with a preceding backslash.
java.lang.String	convertToJavaString(java.lang.String input, boolean useUnicode) Escapes control characters with a preceding backslash.
static boolean	doIsHexSequence(char[] in, int off, int chars)
static boolean	doIsHexSequence(java.lang.String in, int off, int chars)
protected int	doUnescapeCharAndAppendTo(java.lang.String string, boolean useUnicode, int index, java.lang.StringBuilder result)
protected void	escapeAndAppendTo(char c, boolean useUnicode, java.lang.StringBuilder result)
protected int	handleInvalidUnicodeEscapeSequence(java.lang.String string, int index, java.lang.StringBuilder result)
protected int	handleUnknownEscapeSequence(java.lang.String string, char c, boolean useUnicode, int index, java.lang.StringBuilder result)
static boolean	isHex(char c)
protected boolean	isHexSequence(char[] in, int off, int chars)
protected boolean	isHexSequence(java.lang.String in, int off, int chars)
protected boolean	isInvalidUnicodeEscapeSequence(java.lang.String string, int index) Return true if the chars starting at index do not appear to be a unicode escape sequence (without the leading backslash u}.
protected boolean	mustEncodeAsEscapeSequence(char next)
char	toHex(int i)
protected int	unescapeCharAndAppendTo(java.lang.String string, boolean useUnicode, int index, java.lang.StringBuilder result)
protected int	unescapeUnicodeSequence(java.lang.String string, int index, java.lang.StringBuilder result)
protected boolean	validate(char c, java.lang.StringBuilder result)
protected void	validateAndAppendChar(char c, java.lang.StringBuilder result)
protected boolean	validateRegion(java.lang.String string, int fromInclusive, int toExclusive, java.lang.StringBuilder result)

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaStringConverter

public JavaStringConverter()

Method Detail

convertFromJavaString

public java.lang.String convertFromJavaString(java.lang.String string,
                                              boolean useUnicode)

Resolve Java control character sequences to the actual character value. Optionally handle unicode escape sequences, too.

appendRegion

protected void appendRegion(java.lang.String string,
                            int fromInclusive,
                            int toExclusive,
                            java.lang.StringBuilder result)

validateRegion

protected boolean validateRegion(java.lang.String string,
                                 int fromInclusive,
                                 int toExclusive,
                                 java.lang.StringBuilder result)

convertFromJavaString

protected java.lang.String convertFromJavaString(java.lang.String string,
                                                 boolean useUnicode,
                                                 int index,
                                                 java.lang.StringBuilder result)

unescapeCharAndAppendTo

protected int unescapeCharAndAppendTo(java.lang.String string,
                                      boolean useUnicode,
                                      int index,
                                      java.lang.StringBuilder result)

validateAndAppendChar

protected void validateAndAppendChar(char c,
                                     java.lang.StringBuilder result)

validate

protected boolean validate(char c,
                           java.lang.StringBuilder result)

doUnescapeCharAndAppendTo

protected int doUnescapeCharAndAppendTo(java.lang.String string,
                                        boolean useUnicode,
                                        int index,
                                        java.lang.StringBuilder result)

handleUnknownEscapeSequence

protected int handleUnknownEscapeSequence(java.lang.String string,
                                          char c,
                                          boolean useUnicode,
                                          int index,
                                          java.lang.StringBuilder result)

unescapeUnicodeSequence

protected int unescapeUnicodeSequence(java.lang.String string,
                                      int index,
                                      java.lang.StringBuilder result)

isInvalidUnicodeEscapeSequence

protected boolean isInvalidUnicodeEscapeSequence(java.lang.String string,
                                                 int index)

Return true if the chars starting at index do not appear to be a unicode escape sequence (without the leading backslash u}.

handleInvalidUnicodeEscapeSequence

protected int handleInvalidUnicodeEscapeSequence(java.lang.String string,
                                                 int index,
                                                 java.lang.StringBuilder result)

convertToJavaString

public java.lang.String convertToJavaString(java.lang.String theString)

Escapes control characters with a preceding backslash. Encodes special chars as unicode escape sequence. The resulting string is safe to be put into a Java string literal between the quotes.

convertToJavaString

public java.lang.String convertToJavaString(java.lang.String input,
                                            boolean useUnicode)

Escapes control characters with a preceding backslash. Optionally encodes special chars as unicode escape sequence. The resulting string is safe to be put into a Java string literal between the quotes.

escapeAndAppendTo

protected void escapeAndAppendTo(char c,
                                 boolean useUnicode,
                                 java.lang.StringBuilder result)

mustEncodeAsEscapeSequence

protected boolean mustEncodeAsEscapeSequence(char next)

toHex

public char toHex(int i)

isHexSequence

protected boolean isHexSequence(java.lang.String in,
                                int off,
                                int chars)

doIsHexSequence

public static boolean doIsHexSequence(java.lang.String in,
                                      int off,
                                      int chars)

isHexSequence

protected boolean isHexSequence(char[] in,
                                int off,
                                int chars)

doIsHexSequence

public static boolean doIsHexSequence(char[] in,
                                      int off,
                                      int chars)

isHex

public static boolean isHex(char c)