Class SanitizableData

java.lang.Object

org.springframework.boot.actuate.endpoint.SanitizableData

public final class SanitizableData
extends Object

Value object that represents the data that can be used by a SanitizingFunction.

Since:

2.6.0

Author:

Madhura Bhave, Rohan Goyal

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SANITIZED_VALUE	Represents a sanitized value.

Constructor Summary

Constructors

Constructor	Description
SanitizableData(@Nullable PropertySource<?> propertySource, String key, @Nullable Object value)	Create a new SanitizableData instance.

Method Summary

Modifier and Type	Method	Description
String	getKey()	Return the key of the data.
String	getLowerCaseKey()	Return the key as a lowercase value.
@Nullable PropertySource<?>	getPropertySource()	Return the property source that provided the data or null If the data was not from a PropertySource.
@Nullable Object	getValue()	Return the value of the data.
SanitizableData	withSanitizedValue()	Return a new SanitizableData instance with sanitized value.
SanitizableData	withValue(@Nullable Object value)	Return a new SanitizableData instance with a different value.

Methods inherited from class Object

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

Field Details

SANITIZED_VALUE

public static final String SANITIZED_VALUE

Represents a sanitized value.

See Also:

• Constant Field Values

Constructor Details

SanitizableData

public SanitizableData(@Nullable PropertySource<?> propertySource,
 String key,
 @Nullable Object value)

Create a new SanitizableData instance.

Parameters:

propertySource - the property source that provided the data or null.

key - the data key

value - the data value

Method Details

getPropertySource

public @Nullable PropertySource<?> getPropertySource()

Return the property source that provided the data or null If the data was not from a PropertySource.

Returns:

the property source that provided the data

getKey

public String getKey()

Return the key of the data.

Returns:

the data key

getLowerCaseKey

public String getLowerCaseKey()

Return the key as a lowercase value.

Returns:

the key as a lowercase value

Since:

3.5.0

getValue

public @Nullable Object getValue()

Return the value of the data.

Returns:

the data value

withSanitizedValue

public SanitizableData withSanitizedValue()

Return a new SanitizableData instance with sanitized value.

Returns:

a new sanitizable data instance.

Since:

3.1.0

withValue

public SanitizableData withValue(@Nullable Object value)

Return a new SanitizableData instance with a different value.

Parameters:

value - the new value (often SANITIZED_VALUE

Returns:

a new sanitizable data instance