org.apache.sling.commons.compiler.source

Class JavaEscapeHelper

java.lang.Object

org.apache.sling.commons.compiler.source.JavaEscapeHelper

public final class JavaEscapeHelper
extends java.lang.Object

The JavaEscapeHelper class provides various methods which can be used to generate valid Java identifiers or package / class names, especially when generating them from a transcompiler.

Method Summary

Modifier and Type	Method and Description
static @NotNull java.lang.String	escapeChar(char ch) Escapes the provided character so that it's a valid Java identifier character.
static @NotNull java.lang.String	getJavaIdentifier(@NotNull java.lang.String identifier) Converts the given identifier to a legal Java identifier.
static boolean	isJavaKeyword(@NotNull java.lang.String key) Test whether the argument is a Java keyword, according to the Java Language Specification.
static boolean	isJavaLiteral(@NotNull java.lang.String key) Test whether the argument is a Java literal, according to the Java Language Specification..
static boolean	isSpecialIdentifier(@NotNull java.lang.String key) Test whether the argument is a special identifier, according to the Java Language Specification.
static @NotNull java.lang.String	makeJavaPackage(@NotNull java.lang.String path) Converts the given path to a Java package or fully-qualified class name, depending on the path's value.
static char	unescape(@NotNull java.lang.String escapeSequence) Returns the original character that was escaped, given an escapeSequence.
static @NotNull java.lang.String	unescapeAll(@NotNull java.lang.String input) Provided a string which could contain escape sequences generated through escapeChar(char), this method will unescape all such sequences.

Methods inherited from class java.lang.Object

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

Method Detail

getJavaIdentifier

@NotNull
public static @NotNull java.lang.String getJavaIdentifier(@NotNull
                                                                   @NotNull java.lang.String identifier)

Converts the given identifier to a legal Java identifier.

Parameters:

identifier - the identifier to convert

Returns:

legal Java identifier corresponding to the given identifier

escapeChar

@NotNull
public static @NotNull java.lang.String escapeChar(char ch)

Escapes the provided character so that it's a valid Java identifier character. This method does not check if the provided character is valid and will escape any character into a sequence matching the (__[0-9a-f]{4}__) pattern, by using the character's decimal code and converting it to hexadecimal.

Parameters:

ch - the character to escape

Returns:

the escaped character representation

unescape

public static char unescape(@NotNull
                            @NotNull java.lang.String escapeSequence)

Returns the original character that was escaped, given an escapeSequence. The escapeSequence has to match the (__[0-9a-f]{4}__) pattern.

Parameters:

escapeSequence - the escaped string

Returns:

the original character

Throws:

java.lang.IllegalArgumentException - if the escaped string does not match the (__[0-9a-f]{4}__) pattern

unescapeAll

@NotNull
public static @NotNull java.lang.String unescapeAll(@NotNull
                                                             @NotNull java.lang.String input)

Provided a string which could contain escape sequences generated through escapeChar(char), this method will unescape all such sequences.

Parameters:

input - a string containing escaped characters

Returns:

a string with all escaped sequences produced by escapeChar(char) replaced by the original character

makeJavaPackage

@NotNull
public static @NotNull java.lang.String makeJavaPackage(@NotNull
                                                                 @NotNull java.lang.String path)

Converts the given path to a Java package or fully-qualified class name, depending on the path's value.

Parameters:

path - the path to convert

Returns:

Java package / fully-qualified class name corresponding to the given path

isJavaKeyword

public static boolean isJavaKeyword(@NotNull
                                    @NotNull java.lang.String key)

Test whether the argument is a Java keyword, according to the Java Language Specification.

Parameters:

key - the String to test

Returns:

true if the String is a Java keyword, false otherwise

isJavaLiteral

public static boolean isJavaLiteral(@NotNull
                                    @NotNull java.lang.String key)

Test whether the argument is a Java literal, according to the Java Language Specification..

Parameters:

key - the String to test

Returns:

true if the String is a Java literal, false otherwise

isSpecialIdentifier

public static boolean isSpecialIdentifier(@NotNull
                                          @NotNull java.lang.String key)

Test whether the argument is a special identifier, according to the Java Language Specification.

Parameters:

key - the String to test

Returns:

true if the String is a Java special identifier, false otherwise