Class PiiEntityMask.Builder

    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • maskingCharacter

        public PiiEntityMask.Builder maskingCharacter​(String maskingCharacter)
        Masking character.

        By default, the character is an asterisk (*)

        Parameters:
        maskingCharacter - the value to set
        Returns:
        this builder
      • leaveCharactersUnmasked

        public PiiEntityMask.Builder leaveCharactersUnmasked​(Integer leaveCharactersUnmasked)
        Number of characters to leave unmasked.

        By default, the whole entity is masked.

        Parameters:
        leaveCharactersUnmasked - the value to set
        Returns:
        this builder
      • isUnmaskedFromEnd

        public PiiEntityMask.Builder isUnmaskedFromEnd​(Boolean isUnmaskedFromEnd)
        Unmask from the end.

        By default, the whole entity is masked. This field works in concert with leaveCharactersUnmasked. For example, leaveCharactersUnmasked is 3 and isUnmaskedFromEnd is true, then if the entity is India the masked entity/result is **dia.

        Parameters:
        isUnmaskedFromEnd - the value to set
        Returns:
        this builder