com.github.robtimus.obfuscation

Class MapObfuscator<K,V>

java.lang.Object

com.github.robtimus.obfuscation.MapObfuscator<K,V>

Type Parameters:

K - The map key type.

V - The map value type.

public final class MapObfuscator<K,V>
extends Object

An immutable object that can obfuscate maps so that some or all of their values are obfuscated when their toString() method is called.

The end result is similar to Obfuscator.obfuscateMap(Map), except this class gives a more fine-grained control over which values to obfuscate and with which obfuscator.

Author:

Rob Spoor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapObfuscator.Builder<K,V> A builder for MapObfuscators.
static class	MapObfuscator.StringKeyedBuilder<V> A builder for MapObfuscators that use String keys.

Method Summary

Modifier and Type	Method and Description
static <K,V> MapObfuscator.Builder<K,V>	builder() Returns a builder that will create MapObfuscators.
boolean	equals(Object o)
int	hashCode()
Map<K,V>	obfuscateMap(Map<K,V> map) Obfuscates a map.
Map<K,V>	obfuscateMap(Map<K,V> map, Function<? super V,? extends CharSequence> valueRepresentation) Obfuscates a map.
static <V> MapObfuscator.StringKeyedBuilder<V>	stringKeyedBuilder() Returns a builder that will create MapObfuscators that support maps with String keys.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

obfuscateMap

public Map<K,V> obfuscateMap(Map<K,V> map)

Obfuscates a map. For each value, the value's string representation will be used to obfuscate the value.

The result will be a map that will behave exactly the same as the given map, except it will obfuscate each value when its toString() method is called. This is different from Obfuscator.obfuscateObject(Object) because it will not obfuscate the map structure or the number of entries.

Parameters:

map - The map to obfuscate.

Returns:

An obfuscating map wrapper around the given map.

Throws:

NullPointerException - If the given map is null.

obfuscateMap

public Map<K,V> obfuscateMap(Map<K,V> map,
                             Function<? super V,? extends CharSequence> valueRepresentation)

Obfuscates a map. For each value, a function will be used to create the element's character representation that will be used to obfuscate the element.

The result will be a map that will behave exactly the same as the given map, except it will obfuscate each value when its toString() method is called. This is different from Obfuscator.obfuscateObject(Object) because it will not obfuscate the map structure or the number of entries.

Parameters:

map - The map to obfuscate.

valueRepresentation - The function to use to create the character representation for each value.

Returns:

An obfuscating map wrapper around the given map.

Throws:

NullPointerException - If the given map or function is null.

Since:

1.3

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static <K,V> MapObfuscator.Builder<K,V> builder()

Returns a builder that will create MapObfuscators.

Type Parameters:

K - The map key type.

V - The map value type.

Returns:

A builder that will create MapObfuscators.

stringKeyedBuilder

public static <V> MapObfuscator.StringKeyedBuilder<V> stringKeyedBuilder()

Returns a builder that will create MapObfuscators that support maps with String keys.

Type Parameters:

V - The map value type.

Returns:

A builder that will create MapObfuscators that support maps with String keys.