com.github.robtimus.obfuscation

Class Obfuscated<T>

java.lang.Object

com.github.robtimus.obfuscation.Obfuscated<T>

Type Parameters:

T - The obfuscated value type.

public abstract class Obfuscated<T>
extends Object

An object that provides obfuscation for another value. This obfuscation is performed when toString() is called, and can be used to prevent leaking the obfuscated value's string presentation by accident, e.g. by logging it.

Author:

Rob Spoor

Method Summary

Modifier and Type	Method and Description
abstract Obfuscated<T>	cached() Returns an obfuscated object that caches the results of obfuscating.
boolean	equals(Object o)
int	hashCode()
<U> Obfuscated<U>	map(Function<? super T,? extends U> mapper) Applies a mapping function to the obfuscated value.
<U> Obfuscated<U>	map(Function<? super T,? extends U> mapper, Supplier<? extends CharSequence> representation) Applies a mapping function to the obfuscated value.
abstract <U> Obfuscated<U>	mapWithSameRepresentation(Function<? super T,? extends U> mapper) Applies a mapping function to the obfuscating value.
abstract String	toString()
T	value() Returns the obfuscated value.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

value

public final T value()

Returns the obfuscated value.

Returns:

The obfuscated value.

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public abstract String toString()

Overrides:

toString in class Object

map

public final <U> Obfuscated<U> map(Function<? super T,? extends U> mapper)

Applies a mapping function to the obfuscated value. The result is similar to calling Obfuscator.obfuscateObject(Object) on the obfuscator that created this object, passing the result of applying the given mapping function to the obfuscated value.

Type Parameters:

U - The result type of the mapping function.

Parameters:

mapper - The mapping function to apply.

Returns:

An Obfuscated object wrapping the result of applying the given mapping function to this object's value.

Throws:

NullPointerException - If the mapping function is null, or if the mapping function returns a null value when applied to this object's value.

Since:

1.1

map

public final <U> Obfuscated<U> map(Function<? super T,? extends U> mapper,
                                   Supplier<? extends CharSequence> representation)

Applies a mapping function to the obfuscated value. The result is similar to calling Obfuscator.obfuscateObject(Object, Supplier) on the obfuscator that created this object, passing the result of applying the given mapping function to the obfuscated value.

Type Parameters:

U - The result type of the mapping function.

Parameters:

mapper - The mapping function to apply.

representation - A supplier for the character representation that will be used to obfuscate the value. This can be used for values that don't have a sensible string representation of their own.

Returns:

An Obfuscated object wrapping the result of applying the given mapping function to this object's value.

Throws:

NullPointerException - If the mapping function or supplier is null, or if the mapping function returns a null value when applied to this object's value.

Since:

1.1

mapWithSameRepresentation

public abstract <U> Obfuscated<U> mapWithSameRepresentation(Function<? super T,? extends U> mapper)

Applies a mapping function to the obfuscating value. Unlike map(Function) and map(Function, Supplier), the result will use the same representation to obfuscate as this object. If this object caches the results of obfuscating, so will the result.

Type Parameters:

U - The result type of the mapping function.

Parameters:

mapper - The mapping function to apply.

Returns:

An Obfuscated object wrapping the result of applying the given mapping function to this object's value.

Throws:

NullPointerException - If the mapping function is null, or if the mapping function returns a null value when applied to this object's value.

Since:

1.1

cached

public abstract Obfuscated<T> cached()

Returns an obfuscated object that caches the results of obfuscating. This can be used when the result of obfuscation never changes, for example when obfuscating immutable objects.

Returns:

An obfuscated object that caches the results of obfuscating.