Package org.springframework.boot.actuate.endpoint

Class EndpointId

java.lang.Object
org.springframework.boot.actuate.endpoint.EndpointId
public final class EndpointId extends Object
An identifier for an actuator endpoint. Endpoint IDs may contain only letters and numbers. They must begin with a lower-case letter. Case and syntax characters are ignored when comparing endpoint IDs.
Since:
2.0.6
Author:
Phillip Webb

  • Method Details

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toLowerCaseString

      public String toLowerCaseString()
      Return a lower-case version of the endpoint ID.
      Returns:
      the lower-case endpoint ID

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • of

      public static EndpointId of(String value)
      Factory method to create a new EndpointId of the specified value.
      Parameters:
      value - the endpoint ID value
      Returns:
      an EndpointId instance

    • of

      public static EndpointId of(Environment environment, String value)
      Factory method to create a new EndpointId of the specified value. This variant will respect the management.endpoints.migrate-legacy-names property if it has been set in the Environment.
      Parameters:
      environment - the Spring environment
      value - the endpoint ID value
      Returns:
      an EndpointId instance
      Since:
      2.2.0

    • fromPropertyValue

      public static EndpointId fromPropertyValue(String value)
      Factory method to create a new EndpointId from a property value. More lenient than of(String) to allow for common "relaxed" property variants.
      Parameters:
      value - the property value to convert
      Returns:
      an EndpointId instance