com.github.robtimus.obfuscation

Class PropertiesObfuscator.Builder

java.lang.Object

com.github.robtimus.obfuscation.PropertiesObfuscator.Builder

Enclosing class:

PropertiesObfuscator

public static final class PropertiesObfuscator.Builder
extends Object

A builder for PropertiesObfuscators.

Author:

Rob Spoor

Method Summary

Modifier and Type	Method and Description
PropertiesObfuscator	build() Creates a new Properties obfuscator with the current settings of this builder.
PropertiesObfuscator.Builder	caseInsensitiveByDefault() Sets the default case sensitivity for new properties to CaseSensitivity.CASE_INSENSITIVE.
PropertiesObfuscator.Builder	caseSensitiveByDefault() Sets the default case sensitivity for new properties to CaseSensitivity.CASE_SENSITIVE.
<R> R	transform(Function<? super PropertiesObfuscator.Builder,? extends R> f) This method allows the application of a function to this builder.
PropertiesObfuscator.Builder	withDefaultObfuscator(Obfuscator obfuscator) Sets the default obfuscator to use, for properties that have no specific obfuscator defined.
PropertiesObfuscator.Builder	withProperty(String property, Obfuscator obfuscator) Adds a property to obfuscate.
PropertiesObfuscator.Builder	withProperty(String property, Obfuscator obfuscator, CaseSensitivity caseSensitivity) Adds a property to obfuscate.

Methods inherited from class java.lang.Object

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

Method Detail

withProperty

public PropertiesObfuscator.Builder withProperty(String property,
                                                 Obfuscator obfuscator)

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

Parameters:

property - The name of the property.

obfuscator - The obfuscator to use for obfuscating the property.

Returns:

This object.

Throws:

NullPointerException - If the given property name or obfuscator is null.

IllegalArgumentException - If a property with the same name and the same case sensitivity was already added.

withProperty

public PropertiesObfuscator.Builder withProperty(String property,
                                                 Obfuscator obfuscator,
                                                 CaseSensitivity caseSensitivity)

Adds a property to obfuscate.

Parameters:

property - The name of the property.

obfuscator - The obfuscator to use for obfuscating the property.

caseSensitivity - The case sensitivity for the property.

Returns:

This object.

Throws:

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

IllegalArgumentException - If a property with the same name and the same case sensitivity was already added.

caseSensitiveByDefault

public PropertiesObfuscator.Builder caseSensitiveByDefault()

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

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

Returns:

This object.

caseInsensitiveByDefault

public PropertiesObfuscator.Builder caseInsensitiveByDefault()

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

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

Returns:

This object.

withDefaultObfuscator

public PropertiesObfuscator.Builder withDefaultObfuscator(Obfuscator obfuscator)

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

Parameters:

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

Returns:

This object.

transform

public <R> R transform(Function<? super PropertiesObfuscator.Builder,? 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 PropertiesObfuscator build()

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

Returns:

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