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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
KeyMaskingConfig	build()	Builds the KeyMaskingConfig instance.
KeyMaskingConfig.Builder	disableBooleanMasking()	Disables boolean masking.
KeyMaskingConfig.Builder	disableNumberMasking()	Disables number masking.
KeyMaskingConfig.Builder	maskBooleansWith(boolean value)	Mask all boolean values with the provided value.
KeyMaskingConfig.Builder	maskBooleansWith(String value)	Mask all boolean values with the provided value.
KeyMaskingConfig.Builder	maskNumberDigitsWith(int digit)	Mask all digits of number values with the provided digit, preserving the length.
KeyMaskingConfig.Builder	maskNumbersWith(int value)	Mask all number values with the provided value.
KeyMaskingConfig.Builder	maskNumbersWith(String value)	Mask all number 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(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

Constructor Details

Builder

public Builder()

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)

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)

disableNumberMasking

public KeyMaskingConfig.Builder disableNumberMasking()

Disables number masking.

Returns:

the builder instance

See Also:

• maskNumbersWith(String)
• maskNumbersWith(int)
• maskNumberDigitsWith(int)

maskNumbersWith

public KeyMaskingConfig.Builder maskNumbersWith(String value)

Mask all number 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:

• disableBooleanMasking()
• maskNumbersWith(int)
• maskNumberDigitsWith(int)

maskNumbersWith

public KeyMaskingConfig.Builder maskNumbersWith(int value)

Mask all number values with the provided value. For example, "maskMe": 12345 -> "maskMe": 0.

Returns:

the builder instance

See Also:

• disableBooleanMasking()
• maskNumbersWith(String)
• maskNumberDigitsWith(int)

maskNumberDigitsWith

public KeyMaskingConfig.Builder maskNumberDigitsWith(int digit)

Mask all digits of number values with the provided digit, preserving the length. For example, "maskMe": 12345 -> "maskMe": 88888.

Returns:

the builder instance

See Also:

• disableBooleanMasking()
• maskNumbersWith(int)
• maskNumbersWith(String)

disableBooleanMasking

public KeyMaskingConfig.Builder disableBooleanMasking()

Disables boolean masking.

Returns:

the builder instance

See Also:

• maskBooleansWith(String)
• maskBooleansWith(boolean)

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:

• disableBooleanMasking()
• maskBooleansWith(boolean)

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:

• disableBooleanMasking()
• maskBooleansWith(String)

build

public KeyMaskingConfig build()

Builds the KeyMaskingConfig instance.

Returns:

the KeyMaskingConfig instance