Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- apply(T, int) - Method in interface com.maybeitssquid.sensitive.Renderer
-
Renders data with the appropriate redaction.
C
- com.maybeitssquid.sensitive - module com.maybeitssquid.sensitive
-
Core framework for protecting sensitive data from inadvertent disclosure.
- com.maybeitssquid.sensitive - package com.maybeitssquid.sensitive
-
Core framework for protecting sensitive data from accidental disclosure through string formatting.
- concatenate(Renderer<CharSequence>) - Static method in class com.maybeitssquid.sensitive.Renderers
-
Returns a renderer that concatenates an array of CharSequences and applies the given renderer.
D
- DEFAULT_DELIMITER - Static variable in class com.maybeitssquid.sensitive.Renderers
-
Default delimiter character used between segments.
- DEFAULT_MASK - Static variable in class com.maybeitssquid.sensitive.Renderers
-
Default replacement character for masking.
- delimit() - Static method in class com.maybeitssquid.sensitive.Renderers
-
Returns a renderer that joins an array of CharSequences with the
Renderers.DEFAULT_DELIMITERand applies a masking renderer using theRenderers.DEFAULT_MASK. - delimit(char) - Static method in class com.maybeitssquid.sensitive.Renderers
-
Returns a renderer that joins an array of CharSequences with a delimiter and applies a masking renderer using the
Renderers.DEFAULT_MASK. - delimit(char, char) - Static method in class com.maybeitssquid.sensitive.Renderers
-
Returns a renderer that joins an array of CharSequences with a delimiter and applies a masking renderer.
- delimit(int) - Static method in class com.maybeitssquid.sensitive.Renderers
-
Returns a renderer that joins an array of CharSequences with a delimiter and applies a masking renderer using the
Renderers.DEFAULT_MASK. - delimit(int, int) - Static method in class com.maybeitssquid.sensitive.Renderers
-
Returns a renderer that joins an array of CharSequences with a delimiter and applies a masking renderer.
- delimit(int, Renderer<CharSequence>) - Static method in class com.maybeitssquid.sensitive.Renderers
-
Returns a renderer that joins an array of CharSequences with a delimiter and applies the given renderer.
- delimit(Renderer<CharSequence>) - Static method in class com.maybeitssquid.sensitive.Renderers
-
Returns a renderer that joins an array of CharSequences with the
Renderers.DEFAULT_DELIMITERand applies the given renderer. - delimit(Renderer<CharSequence>, char) - Static method in class com.maybeitssquid.sensitive.Renderers
-
Returns a renderer that joins an array of CharSequences with a delimiter and applies the given renderer.
- DoNotSerialize(T) - Constructor for class com.maybeitssquid.sensitive.Sensitive.DoNotSerialize
-
Creates a new instance wrapping the specified value.
E
- empty() - Static method in interface com.maybeitssquid.sensitive.Renderer
-
Returns a renderer that always returns an empty string, ensuring no sensitive data is disclosed.
- equals(Object) - Method in class com.maybeitssquid.sensitive.Segmented
-
Returns true if the types match and the enclosed raw data are equal as indicated by invoking
Arrays.equals(Object[], Object[]). - equals(Object) - Method in class com.maybeitssquid.sensitive.Sensitive
-
Returns true if the types match and the enclosed raw data are equal.
- Example - Search tag in com.maybeitssquid.sensitive.Sensitive.getAltRenderer()
- Section
- Example Subclass - Search tag in class com.maybeitssquid.sensitive.Sensitive
- Section
F
- formatTo(Formatter, int, int, int) - Method in class com.maybeitssquid.sensitive.Sensitive
-
Formats this sensitive value according to the specified flags, width, and precision.
G
- get() - Method in class com.maybeitssquid.sensitive.Sensitive.DoNotSerialize
-
Returns the contained value, or
nullif this instance was deserialized. - getAltRenderer() - Method in class com.maybeitssquid.sensitive.Sensitive
-
Returns the renderer used to format this sensitive value when the alternate form is specified.
- getRenderer() - Method in class com.maybeitssquid.sensitive.Sensitive
-
Returns the renderer used to format this sensitive value.
- getValue() - Method in class com.maybeitssquid.sensitive.Segmented
-
Returns a clone of the contained array to prevent external mutation.
- getValue() - Method in class com.maybeitssquid.sensitive.Sensitive
-
Returns the sensitive value.
- getValue(int) - Method in class com.maybeitssquid.sensitive.Segmented
-
Returns the value of the contained array at the specified index.
H
- hashCode() - Method in class com.maybeitssquid.sensitive.Segmented
-
Returns the hash of the enclosed
rawdata as generated by invokingArrays.hashCode(Object[])on the contained raw data. - hashCode() - Method in class com.maybeitssquid.sensitive.Sensitive
-
Returns the hash of the enclosed
rawdata.
M
- mask() - Static method in class com.maybeitssquid.sensitive.Renderers
-
Convenience function equivalent to
mask(DEFAULT_MASK). - mask(char) - Static method in class com.maybeitssquid.sensitive.Renderers
-
Convenience function equivalent to
mask((int) mask). - mask(int) - Static method in class com.maybeitssquid.sensitive.Renderers
-
Returns a renderer that masks leading characters with the specified mask character.
- mask(IntPredicate) - Static method in class com.maybeitssquid.sensitive.Renderers
-
Convenience function equivalent to
mask(redactable, DEFAULT_MASK. - mask(IntPredicate, char) - Static method in class com.maybeitssquid.sensitive.Renderers
-
Convenience function equivalent to
mask(redactable, (int) mask). - mask(IntPredicate, int) - Static method in class com.maybeitssquid.sensitive.Renderers
-
Returns a renderer that masks only characters matching the predicate, using the specified mask character.
P
- Precision Semantics - Search tag in interface com.maybeitssquid.sensitive.Renderer
- Section
Q
- Quick Start - Search tag in package com.maybeitssquid.sensitive
- Section
R
- redactions(int, int) - Static method in class com.maybeitssquid.sensitive.Renderers
-
Computes the number of symbols to redact.
- Renderer<T> - Interface in com.maybeitssquid.sensitive
-
Renders sensitive data as a
CharSequencewith appropriate redaction. - Renderers - Class in com.maybeitssquid.sensitive
-
Factory methods for creating
Rendererinstances. - Rendering Model - Search tag in class com.maybeitssquid.sensitive.Sensitive
- Section
- residualFormat(int, boolean, boolean) - Method in class com.maybeitssquid.sensitive.Sensitive
-
Generates a format string to apply the parts of the formatting instructions that are not covered by the renderer.
S
- Segmented<T> - Class in com.maybeitssquid.sensitive
-
A
Sensitivevalue that backed by multiple segments of the same type. - Segmented(T[]) - Constructor for class com.maybeitssquid.sensitive.Segmented
-
Creates a new Segmented container with the specified array.
- Sensitive<T> - Class in com.maybeitssquid.sensitive
-
Container for sensitive data to protect it being inadvertently rendered as a plain
String. - Sensitive(Supplier<T>) - Constructor for class com.maybeitssquid.sensitive.Sensitive
-
Creates a new Sensitive container with the specified supplier.
- Sensitive(T) - Constructor for class com.maybeitssquid.sensitive.Sensitive
-
Convenience constructor that wraps the value in a
Sensitive.DoNotSerializesupplier. - Sensitive.DoNotSerialize<T> - Class in com.maybeitssquid.sensitive
-
A
Supplierimplementation that wraps a value in atransientfield, preventing the value from being serialized via standard Java serialization. - Serialization Protection - Search tag in class com.maybeitssquid.sensitive.Sensitive
- Section
- Storage Model - Search tag in class com.maybeitssquid.sensitive.Sensitive
- Section
- Subclassing Guidelines - Search tag in class com.maybeitssquid.sensitive.Sensitive
- Section
- supplier - Variable in class com.maybeitssquid.sensitive.Sensitive
-
The supplier that provides the sensitive value.
T
- Thread Safety - Search tag in class com.maybeitssquid.sensitive.Sensitive
- Section
- Thread Safety - Search tag in class com.maybeitssquid.sensitive.Sensitive.DoNotSerialize
- Section
- toString() - Method in class com.maybeitssquid.sensitive.Sensitive
-
Returns the result of applying default string formatting to this value.
- truncate() - Static method in class com.maybeitssquid.sensitive.Renderers
-
Returns a renderer that truncates the beginning of the value, showing only the trailing characters based on precision.
U
- unredacted() - Static method in class com.maybeitssquid.sensitive.Renderers
-
Returns a renderer that shows the value completely unredacted.
- Usage - Search tag in class com.maybeitssquid.sensitive.Sensitive.DoNotSerialize
- Section
- Usage - Search tag in interface com.maybeitssquid.sensitive.Renderer
- Section
- Usage Examples - Search tag in class com.maybeitssquid.sensitive.Renderers
- Section
All Classes and Interfaces|All Packages|Constant Field Values