com.github.robtimus.obfuscation

Class Obfuscator.PortionBuilder

java.lang.Object

com.github.robtimus.obfuscation.Obfuscator.PortionBuilder

Enclosing class:

Obfuscator

public static final class Obfuscator.PortionBuilder
extends Object

A builder for obfuscators that obfuscate a specific portion of their input. An obfuscator created with keepAtStart(x) and keepAtEnd(y) will, for input s, obfuscate all characters in the range x (inclusive) to s.length()- y (exclusive). If this range is empty, such an obfuscator will not obfuscate anything, unless if withFixedTotalLength(int) or withFixedLength(int) is specified.

Author:

Rob Spoor

Method Summary

Modifier and Type	Method and Description
Obfuscator.PortionBuilder	atLeastFromEnd(int count) Sets the minimum number of characters from the end that need to be obfuscated.
Obfuscator.PortionBuilder	atLeastFromStart(int count) Sets the minimum number of characters from the start that need to be obfuscated.
Obfuscator	build() Creates an immutable obfuscator with the current settings of this builder.
Obfuscator.PortionBuilder	keepAtEnd(int count) Sets the number of characters at the end that created obfuscators will skip when obfuscating.
Obfuscator.PortionBuilder	keepAtStart(int count) Sets the number of characters at the start that created obfuscators will skip when obfuscating.
<R> R	transform(Function<? super Obfuscator.PortionBuilder,? extends R> f) This method allows the application of a function to this builder.
Obfuscator.PortionBuilder	withDefaults() Specifies that the default settings should be restored.
Obfuscator.PortionBuilder	withFixedLength(int fixedObfuscatedLength) Deprecated. The total length of obfuscated contents can vary when using this setting, making it possible in certain cases to find the original value that was obfuscated. Use withFixedTotalLength(int) instead.
Obfuscator.PortionBuilder	withFixedTotalLength(int fixedTotalLength) Sets or removes the fixed total length to use for obfuscated contents.
Obfuscator.PortionBuilder	withMaskChar(char maskChar) Sets the char that created obfuscators use for obfuscating.

Methods inherited from class java.lang.Object

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

Method Detail

keepAtStart

public Obfuscator.PortionBuilder keepAtStart(int count)

Sets the number of characters at the start that created obfuscators will skip when obfuscating.

Parameters:

count - The number of characters to skip. The default is 0.

Returns:

This builder.

Throws:

IllegalArgumentException - If the count is negative.

keepAtEnd

public Obfuscator.PortionBuilder keepAtEnd(int count)

Sets the number of characters at the end that created obfuscators will skip when obfuscating.

Parameters:

count - The number of characters to skip. The default is 0.

Returns:

This builder.

Throws:

IllegalArgumentException - If the count is negative.

atLeastFromStart

public Obfuscator.PortionBuilder atLeastFromStart(int count)

Sets the minimum number of characters from the start that need to be obfuscated. This will overrule any value set with keepAtStart(int) or keepAtEnd(int).

Parameters:

count - The minimum number of characters to obfuscate. The default is 0.

Returns:

This builder.

Throws:

IllegalArgumentException - If the count is negative.

atLeastFromEnd

public Obfuscator.PortionBuilder atLeastFromEnd(int count)

Sets the minimum number of characters from the end that need to be obfuscated. This will overrule any value set with keepAtStart(int) or keepAtEnd(int).

Parameters:

count - The minimum number of characters to obfuscate. The default is 0.

Returns:

This builder.

Throws:

IllegalArgumentException - If the count is negative.

withFixedTotalLength

public Obfuscator.PortionBuilder withFixedTotalLength(int fixedTotalLength)

Sets or removes the fixed total length to use for obfuscated contents. When obfuscating, the result will have mask characters added until this total length has been reached.

Note: when used in combination with keepAtStart(int) and/or keepAtEnd(int), this total length must be at least the sum of both other values. When used in combination with both, parts of the input may be repeated in the obfuscated content if the input's length is less than the combined number of characters to keep.

Parameters:

fixedTotalLength - The fixed total length for obfuscated contents, or a negative value to use the actual length of the input. The default is -1.

Returns:

This builder.

Since:

1.2

withFixedLength

@Deprecated
public Obfuscator.PortionBuilder withFixedLength(int fixedObfuscatedLength)

Deprecated. The total length of obfuscated contents can vary when using this setting, making it possible in certain cases to find the original value that was obfuscated. Use withFixedTotalLength(int) instead.

Sets or removes the fixed number of mask characters to use for obfuscating.

This setting will be ignored if the fixed total length is set.

Parameters:

fixedObfuscatedLength - The fixed number of mask characters, or a negative value to use the actual length of the input. The default is -1.

Returns:

This builder.

withMaskChar

public Obfuscator.PortionBuilder withMaskChar(char maskChar)

Sets the char that created obfuscators use for obfuscating.

Parameters:

maskChar - The mask character. The default is *.

Returns:

This builder.

withDefaults

public Obfuscator.PortionBuilder withDefaults()

Specifies that the default settings should be restored. Calling this method is similar to calling the following:

• keepAtStart(0)
• keepAtEnd(0)
• atLeastFromStart(0)
• atLeastFromEnd(0)
• withFixedTotalLength(-1)
• withFixedLength(-1)
• withMaskChar('*')

Returns:

This builder.

transform

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

Creates an immutable obfuscator with the current settings of this builder.

Returns:

An obfuscator with the current settings of this builder object.

Throws:

IllegalStateException - If this builder is in an invalid state, for example if withFixedTotalLength(int) is smaller than keepAtStart(int) and keepAtEnd(int) combined.