org.springframework.boot.actuate.endpoint

Class SanitizableData

java.lang.Object

org.springframework.boot.actuate.endpoint.SanitizableData

public final class SanitizableData
extends java.lang.Object

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

Since:

2.6.0

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
SanitizableData(org.springframework.core.env.PropertySource<?> propertySource, java.lang.String key, java.lang.Object value) Create a new SanitizableData instance.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getKey() Return the key of the data.
org.springframework.core.env.PropertySource<?>	getPropertySource() Return the property source that provided the data or null If the data was not from a PropertySource.
java.lang.Object	getValue() Return the value of the data.
SanitizableData	withValue(java.lang.Object value) Return a new SanitizableData instance with a different value.

Methods inherited from class java.lang.Object

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

Field Detail

SANITIZED_VALUE

public static final java.lang.String SANITIZED_VALUE

Represents a sanitized value.

See Also:

Constant Field Values

Constructor Detail

SanitizableData

public SanitizableData(org.springframework.core.env.PropertySource<?> propertySource,
                       java.lang.String key,
                       java.lang.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 Detail

getPropertySource

public org.springframework.core.env.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 java.lang.String getKey()

Return the key of the data.

Returns:

the data key

getValue

public java.lang.Object getValue()

Return the value of the data.

Returns:

the data value

withValue

public SanitizableData withValue(java.lang.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