com.github.robtimus.obfuscation.annotation

Interface CharacterRepresentationProvider

All Known Implementing Classes:

CharacterRepresentationProvider.BooleanArrayToString, CharacterRepresentationProvider.ByteArrayToString, CharacterRepresentationProvider.CharArrayToString, CharacterRepresentationProvider.DoubleArrayToString, CharacterRepresentationProvider.FloatArrayToString, CharacterRepresentationProvider.Identity, CharacterRepresentationProvider.IntArrayToString, CharacterRepresentationProvider.LongArrayToString, CharacterRepresentationProvider.ObjectArrayDeepToString, CharacterRepresentationProvider.ObjectArrayToString, CharacterRepresentationProvider.ShortArrayToString, CharacterRepresentationProvider.ToString, CharacterRepresentationProvider.TypeSpecific

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface CharacterRepresentationProvider

A provider for character representations for objects, that can be used to obfuscate objects using Obfuscator.obfuscateObject(Object, Supplier), Obfuscator.obfuscateCollection(Collection, Function), Obfuscator.obfuscateList(List, Function), Obfuscator.obfuscateSet(Set, Function) or Obfuscator.obfuscateMap(Map, Function).

Since:

2.0

Author:

Rob Spoor

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CharacterRepresentationProvider.BooleanArrayToString A character representation provider that uses Arrays.toString(boolean[]), or Object.toString() for other types.
static class	CharacterRepresentationProvider.ByteArrayToString A character representation provider that uses Arrays.toString(byte[]), or Object.toString() for other types.
static class	CharacterRepresentationProvider.CharArrayToString A character representation provider that uses Arrays.toString(char[]), or Object.toString() for other types.
static class	CharacterRepresentationProvider.DoubleArrayToString A character representation provider that uses Arrays.toString(double[]), or Object.toString() for other types.
static class	CharacterRepresentationProvider.FloatArrayToString A character representation provider that uses Arrays.toString(float[]), or Object.toString() for other types.
static class	CharacterRepresentationProvider.Identity A character representation provider that returns CharSequences unmodified, or Object.toString() for other types.
static class	CharacterRepresentationProvider.IntArrayToString A character representation provider that uses Arrays.toString(int[]), or Object.toString() for other types.
static class	CharacterRepresentationProvider.LongArrayToString A character representation provider that uses Arrays.toString(long[]), or Object.toString() for other types.
static class	CharacterRepresentationProvider.ObjectArrayDeepToString A character representation provider that uses Arrays.deepToString(Object[]), or Object.toString() for other types.
static class	CharacterRepresentationProvider.ObjectArrayToString A character representation provider that uses Arrays.toString(Object[]), or Object.toString() for other types.
static class	CharacterRepresentationProvider.ShortArrayToString A character representation provider that uses Arrays.toString(short[]), or Object.toString() for other types.
static class	CharacterRepresentationProvider.ToString A character representation provider that uses Object.toString().
static class	CharacterRepresentationProvider.TypeSpecific<T> A character representation provider that uses specific character representations for a specific type, or Object.toString() for other types.

Method Summary

Modifier and Type	Method and Description
static CharacterRepresentationProvider	getDefaultInstance(Class<?> type) Returns a default CharacterRepresentationProvider instance for a specific type.
CharSequence	toCharSequence(Object value) Returns a character representation for a value.

Method Detail

toCharSequence

CharSequence toCharSequence(Object value)

Returns a character representation for a value.

Parameters:

value - The value to return the character representation for.

Returns:

A CharSequence containing the value's character representation.

Throws:

NullPointerException - If the given value is null.

getDefaultInstance

static CharacterRepresentationProvider getDefaultInstance(Class<?> type)

Returns a default CharacterRepresentationProvider instance for a specific type. This method will return:

• CharacterRepresentationProvider.BooleanArrayToString.INSTANCE for boolean[]
• CharacterRepresentationProvider.CharArrayToString.INSTANCE for char[]
• CharacterRepresentationProvider.ByteArrayToString.INSTANCE for byte[]
• CharacterRepresentationProvider.ShortArrayToString.INSTANCE for short[]
• CharacterRepresentationProvider.IntArrayToString.INSTANCE for int[]
• CharacterRepresentationProvider.LongArrayToString.INSTANCE for long[]
• CharacterRepresentationProvider.FloatArrayToString.INSTANCE for float[]
• CharacterRepresentationProvider.DoubleArrayToString.INSTANCE for double[]
• CharacterRepresentationProvider.ObjectArrayToString.INSTANCE for Object[] and sub types
• CharacterRepresentationProvider.Identity.INSTANCE for CharSequence and sub types
• CharacterRepresentationProvider.ToString.INSTANCE for all other cases

Parameters:

type - The type for which to return a default CharacterRepresentationProvider instance.

Returns:

A default CharacterRepresentationProvider instance for the given type.

Throws:

NullPointerException - If the given type is null.