com.github.robtimus.obfuscation

Class MapObfuscator.StringKeyedBuilder<V>

java.lang.Object

com.github.robtimus.obfuscation.MapObfuscator.StringKeyedBuilder<V>

Type Parameters:

V - The map value type.

Enclosing class:

MapObfuscator<K,V>

public static final class MapObfuscator.StringKeyedBuilder<V>
extends Object

A builder for MapObfuscators that use String keys.

Author:

Rob Spoor

Method Summary

Modifier and Type	Method and Description
MapObfuscator<String,V>	build() Creates a new map obfuscator with the current settings of this builder.
MapObfuscator.StringKeyedBuilder<V>	caseInsensitiveByDefault() Sets the default case sensitivity for new keys to CaseSensitivity.CASE_INSENSITIVE.
MapObfuscator.StringKeyedBuilder<V>	caseSensitiveByDefault() Sets the default case sensitivity for new keys to CaseSensitivity.CASE_SENSITIVE.
<R> R	transform(Function<? super MapObfuscator.StringKeyedBuilder<V>,? extends R> f) This method allows the application of a function to this builder.
MapObfuscator.StringKeyedBuilder<V>	withDefaultObfuscator(Obfuscator obfuscator) Sets the default obfuscator to use, for entries that have no specific obfuscator defined.
MapObfuscator.StringKeyedBuilder<V>	withKey(String key, Obfuscator obfuscator) Adds a key to obfuscate the value for.
MapObfuscator.StringKeyedBuilder<V>	withKey(String key, Obfuscator obfuscator, CaseSensitivity caseSensitivity) Adds a key to obfuscate the value for.

Methods inherited from class java.lang.Object

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

Method Detail

withKey

public MapObfuscator.StringKeyedBuilder<V> withKey(String key,
                                                   Obfuscator obfuscator)

Adds a key to obfuscate the value for. This method is an alias for withKey(String, Obfuscator, CaseSensitivity) with the last specified default case sensitivity using caseSensitiveByDefault() or caseInsensitiveByDefault(). The default is CaseSensitivity.CASE_SENSITIVE.

Parameters:

key - The key to obfuscate the value for.

obfuscator - The obfuscator to use for obfuscating the value.

Returns:

This object.

Throws:

NullPointerException - If the given key or obfuscator is null.

IllegalArgumentException - If the key was already added with the same case sensitivity.

withKey

public MapObfuscator.StringKeyedBuilder<V> withKey(String key,
                                                   Obfuscator obfuscator,
                                                   CaseSensitivity caseSensitivity)

Adds a key to obfuscate the value for.

Parameters:

key - The key to obfuscate the value for.

obfuscator - The obfuscator to use for obfuscating the value.

caseSensitivity - The case sensitivity for the key.

Returns:

This object.

Throws:

NullPointerException - If the given key, obfuscator or case sensitivity is null.

IllegalArgumentException - If the key was already added with the same case sensitivity.

caseSensitiveByDefault

public MapObfuscator.StringKeyedBuilder<V> caseSensitiveByDefault()

Sets the default case sensitivity for new keys to CaseSensitivity.CASE_SENSITIVE. This is the default setting.

Note that this will not change the case sensitivity of any key that was already added.

Returns:

This object.

caseInsensitiveByDefault

public MapObfuscator.StringKeyedBuilder<V> caseInsensitiveByDefault()

Sets the default case sensitivity for new keys to CaseSensitivity.CASE_INSENSITIVE.

Note that this will not change the case sensitivity of any key that was already added.

Returns:

This object.

withDefaultObfuscator

public MapObfuscator.StringKeyedBuilder<V> withDefaultObfuscator(Obfuscator obfuscator)

Sets the default obfuscator to use, for entries that have no specific obfuscator defined. The default is null.

Parameters:

obfuscator - The default obfuscator to use. Use null to only obfuscate specific entries.

Returns:

This object.

transform

public <R> R transform(Function<? super MapObfuscator.StringKeyedBuilder<V>,? extends R> f)

This method allows the application of a function to this builder.

Any exception thrown by the function will be propagated to the caller.

Type Parameters:

R - The type of the result of the function.

Parameters:

f - The function to apply.

Returns:

The result of applying the function to this builder.

build

public MapObfuscator<String,V> build()

Creates a new map obfuscator with the current settings of this builder.

Returns:

A new map obfuscator with the current settings of this builder.