Class OriginTrackedValue

java.lang.Object

org.springframework.boot.origin.OriginTrackedValue

All Implemented Interfaces:

OriginProvider

public class OriginTrackedValue
extends Object
implements OriginProvider

A wrapper for an Object value and Origin.

Since:

2.0.0

Author:

Madhura Bhave, Phillip Webb

See Also:

• of(Object)
• of(Object, Origin)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
@Nullable Origin	getOrigin()	Return the source origin or null if the origin is not known.
Object	getValue()	Return the tracked value.
int	hashCode()
static @Nullable OriginTrackedValue	of(@Nullable Object value)
static @Nullable OriginTrackedValue	of(@Nullable Object value, @Nullable Origin origin)	Create an OriginTrackedValue containing the specified value and origin.
@Nullable String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getValue

public Object getValue()

Return the tracked value.

Returns:

the tracked value

getOrigin

public @Nullable Origin getOrigin()

Description copied from interface: OriginProvider

Return the source origin or null if the origin is not known.

Specified by:

getOrigin in interface OriginProvider

Returns:

the origin or null

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public @Nullable String toString()

Overrides:

toString in class Object

of

@Contract("!null -> !null")
public static @Nullable OriginTrackedValue of(@Nullable Object value)

of

@Contract("null, _ -> null; !null, _ -> !null")
public static @Nullable OriginTrackedValue of(@Nullable Object value,
 @Nullable Origin origin)

Create an OriginTrackedValue containing the specified value and origin. If the source value implements CharSequence then so will the resulting OriginTrackedValue.

Parameters:

value - the source value

origin - the origin

Returns:

an OriginTrackedValue or null if the source value was null.