aQute.json.naming

Class NameCodec

java.lang.Object

aQute.json.naming.NameCodec

public class NameCodec
extends java.lang.Object

This class encodes and decodes any string to a valid Java Identifier. The rules are simple. If the string is a reserved word in Java then the string is returned with a final '$' to no longer make it a reserved word. Otherwise, each character is inspected. If it is a '$' or not a valid Java Identifier Start/Part then it is encoded with a '$' and a the hex digits of its UTF-8 encoding. The encoding properly handles all code points. Some examples:

                abc                     abc
                default         default$
                abc-def         abc$2Ddef
                _🜐_                    _$F09F9C90_
 

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	RESERVED_JAVA Make sure stays sorted
static java.lang.String[]	RESERVED_JSON

Constructor Summary

Constructors

Constructor and Description
NameCodec()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	decode(java.lang.reflect.Field field) Decode a name that was encoded with the encode method.
static java.lang.String	decode(java.lang.String name) Decode a name that was encoded with the encode method.
static java.lang.String	encode(java.lang.String name) Encode a name to a hex encoded name that is a valid Java identifier

Methods inherited from class java.lang.Object

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

Field Detail

RESERVED_JAVA

public static final java.lang.String[] RESERVED_JAVA

Make sure stays sorted

RESERVED_JSON

public static final java.lang.String[] RESERVED_JSON

Constructor Detail

NameCodec

public NameCodec()

Method Detail

encode

public static java.lang.String encode(java.lang.String name)

Encode a name to a hex encoded name that is a valid Java identifier

Parameters:

name - the unencoded name that can contain any character

Returns:

decode

public static java.lang.String decode(java.lang.reflect.Field field)

Decode a name that was encoded with the encode method.

Parameters:

name - the encoded name that is a valid Java Identifier

Returns:

the decoded name

decode

public static java.lang.String decode(java.lang.String name)

Decode a name that was encoded with the encode method.

Parameters:

name - the encoded name that is a valid Java Identifier

Returns:

the decoded name