org.springframework.boot.actuate.health

Class AdditionalHealthEndpointPath

java.lang.Object

org.springframework.boot.actuate.health.AdditionalHealthEndpointPath

public final class AdditionalHealthEndpointPath
extends Object

Value object that represents an additional path for a HealthEndpointGroup.

Since:

2.6.0

Author:

Phillip Webb, Madhura Bhave

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static AdditionalHealthEndpointPath	from(String value) Creates an AdditionalHealthEndpointPath from the given input.
WebServerNamespace	getNamespace() Returns the WebServerNamespace associated with this path.
String	getValue() Returns the value corresponding to this path.
int	hashCode()
boolean	hasNamespace(WebServerNamespace webServerNamespace) Returns true if this path has the given WebServerNamespace.
static AdditionalHealthEndpointPath	of(WebServerNamespace webServerNamespace, String value) Creates an AdditionalHealthEndpointPath from the given WebServerNamespace and value.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getNamespace

public WebServerNamespace getNamespace()

Returns the WebServerNamespace associated with this path.

Returns:

the server namespace

getValue

public String getValue()

Returns the value corresponding to this path.

Returns:

the path

hasNamespace

public boolean hasNamespace(WebServerNamespace webServerNamespace)

Returns true if this path has the given WebServerNamespace.

Parameters:

webServerNamespace - the server namespace

Returns:

the new instance

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

from

public static AdditionalHealthEndpointPath from(String value)

Creates an AdditionalHealthEndpointPath from the given input. The input must contain a prefix and value separated by a `:`. The value must be limited to one path segment. For example, `server:/healthz`.

Parameters:

value - the value to parse

Returns:

the new instance

of

public static AdditionalHealthEndpointPath of(WebServerNamespace webServerNamespace,
                                              String value)

Creates an AdditionalHealthEndpointPath from the given WebServerNamespace and value.

Parameters:

webServerNamespace - the server namespace

value - the value

Returns:

the new instance