Package dev.blaauwendraad.masker.json.config

Class KeyMaskingConfig.Builder

java.lang.Object

dev.blaauwendraad.masker.json.config.KeyMaskingConfig.Builder

Enclosing class:

KeyMaskingConfig

public static class KeyMaskingConfig.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
KeyMaskingConfig	build()	Builds the KeyMaskingConfig instance.
KeyMaskingConfig.Builder	maskBooleansWith(boolean value)	Mask all boolean values with the provided value.
KeyMaskingConfig.Builder	maskBooleansWith(ValueMasker.BooleanMasker valueMasker)	Mask all boolean values with the provided ValueMasker.
KeyMaskingConfig.Builder	maskBooleansWith(String value)	Mask all boolean values with the provided value.
KeyMaskingConfig.Builder	maskNumberDigitsWith(int digit)	Mask all digits of numeric values with the provided digit, preserving the length.
KeyMaskingConfig.Builder	maskNumbersWith(int value)	Mask all numeric values with the provided value.
KeyMaskingConfig.Builder	maskNumbersWith(ValueMasker.NumberMasker valueMasker)	Mask all numeric values with the provided ValueMasker.
KeyMaskingConfig.Builder	maskNumbersWith(String value)	Mask all numeric values with the provided value.
KeyMaskingConfig.Builder	maskStringCharactersWith(String value)	Mask all characters of string values with the provided character, preserving the length.
KeyMaskingConfig.Builder	maskStringsWith(ValueMasker.StringMasker valueMasker)	Mask all string values with the provided ValueMasker.
KeyMaskingConfig.Builder	maskStringsWith(String value)	Mask all string values with the provided value.

Methods inherited from class java.lang.Object

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

Method Details

maskStringsWith

public KeyMaskingConfig.Builder maskStringsWith(String value)

Mask all string values with the provided value.

For example, "maskMe": "secret" -> "maskMe": "***".

Masking strings with "***" is the default behaviour if no string masking option is set.

Returns:

the builder instance

See Also:

• maskStringCharactersWith(String)
• maskStringsWith(ValueMasker.StringMasker)

maskStringCharactersWith

public KeyMaskingConfig.Builder maskStringCharactersWith(String value)

Mask all characters of string values with the provided character, preserving the length.

For example, "maskMe": "secret" -> "maskMe": "******".

Returns:

the builder instance

See Also:

• maskStringsWith(String)
• maskStringsWith(ValueMasker.StringMasker)

maskStringsWith

public KeyMaskingConfig.Builder maskStringsWith(ValueMasker.StringMasker valueMasker)

Mask all string values with the provided ValueMasker.

Returns:

the builder instance

See Also:

• maskStringsWith(String)
• maskStringCharactersWith(String)
• for out-of-the-box implementations

maskNumbersWith

public KeyMaskingConfig.Builder maskNumbersWith(String value)

Mask all numeric values with the provided value.

For example, "maskMe": 12345 -> "maskMe": "###".

Masking numbers with "###" is the default behaviour if no number masking option is set.

Returns:

the builder instance

See Also:

• maskNumbersWith(int)
• maskNumberDigitsWith(int)
• maskNumbersWith(ValueMasker.NumberMasker)

maskNumbersWith

public KeyMaskingConfig.Builder maskNumbersWith(int value)

Mask all numeric values with the provided value.

For example, "maskMe": 12345 -> "maskMe": 0.

Returns:

the builder instance

See Also:

• maskNumbersWith(String)
• maskNumberDigitsWith(int)
• maskNumbersWith(ValueMasker.NumberMasker)

maskNumberDigitsWith

public KeyMaskingConfig.Builder maskNumberDigitsWith(int digit)

Mask all digits of numeric values with the provided digit, preserving the length.

For example, "maskMe": 12345 -> "maskMe": 88888.

Returns:

the builder instance

See Also:

• maskNumbersWith(String)
• maskNumbersWith(int)
• maskNumbersWith(ValueMasker.NumberMasker)

maskNumbersWith

public KeyMaskingConfig.Builder maskNumbersWith(ValueMasker.NumberMasker valueMasker)

Mask all numeric values with the provided ValueMasker.

Returns:

the builder instance

See Also:

• maskNumbersWith(String)
• maskNumbersWith(int)
• maskNumberDigitsWith(int)
• for out-of-the-box implementations

maskBooleansWith

public KeyMaskingConfig.Builder maskBooleansWith(String value)

Mask all boolean values with the provided value.

For example, "maskMe": true -> "maskMe": "&&&".

Masking booleans with "&&&" is the default behaviour if no boolean masking option is set.

Returns:

the builder instance

See Also:

• maskBooleansWith(boolean)
• maskBooleansWith(ValueMasker.BooleanMasker)

maskBooleansWith

public KeyMaskingConfig.Builder maskBooleansWith(boolean value)

Mask all boolean values with the provided value.

For example, "maskMe": true -> "maskMe": false.

Returns:

the builder instance

See Also:

• maskBooleansWith(String)
• maskBooleansWith(ValueMasker.BooleanMasker)

maskBooleansWith

public KeyMaskingConfig.Builder maskBooleansWith(ValueMasker.BooleanMasker valueMasker)

Mask all boolean values with the provided ValueMasker.

Returns:

the builder instance

See Also:

• maskBooleansWith(boolean)
• maskBooleansWith(String)
• for out-of-the-box implementations

build

public KeyMaskingConfig build()

Builds the KeyMaskingConfig instance.

Returns:

the KeyMaskingConfig instance