Package org.springframework.boot.actuate.endpoint.invoke

Interface OperationParameter

public interface OperationParameter
A single operation parameter.
Since:
2.0.0
Author:
Phillip Webb, Moritz Halbritter

  • Method Summary

    Modifier and Type
    Method
    Description
    <T extends Annotation>
    T
    getAnnotation(Class<T> annotation)
    Returns this element's annotation for the specified type if such an annotation is present, else null.
    String
    getName()
    Returns the parameter name.
    Class<?>
    getType()
    Returns the parameter type.
    boolean
    isMandatory()
    Return if the parameter is mandatory (does not accept null values).

  • Method Details

    • getName

      String getName()
      Returns the parameter name.
      Returns:
      the name

    • getType

      Class<?> getType()
      Returns the parameter type.
      Returns:
      the type

    • isMandatory

      boolean isMandatory()
      Return if the parameter is mandatory (does not accept null values).
      Returns:
      if the parameter is mandatory

    • getAnnotation

      <T extends Annotation> T getAnnotation(Class<T> annotation)
      Returns this element's annotation for the specified type if such an annotation is present, else null.
      Type Parameters:
      T - type of the annotation
      Parameters:
      annotation - class of the annotation
      Returns:
      annotation value