Interface Parameter

All Known Implementing Classes:
ImmutableParameter
@Immutable public interface Parameter
Information about a single parameter.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ImmutableParameter.Builder
    builder()
    Returns a builder for this type.
    Optional<String>
    description()
    Returns an optional description of the parameter.
    boolean
    isFormParam()
    Returns true if the parameter is a form parameter, otherwise false.
    boolean
    isHeaderParam()
    Returns true if the parameter is a header parameter, otherwise false.
    boolean
    isPathParam()
    Returns true if the parameter is a path parameter, otherwise false.
    boolean
    isQueryParam()
    Returns true if the parameter is a query parameter, otherwise false.
    String
    name()
    Returns parameter name.
    Reference
    reference()
    Returns parameter type.

  • Method Details

    • builder

      static ImmutableParameter.Builder builder()
      Returns a builder for this type.
      Returns:
      a builder for this type

    • name

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

    • reference

      Reference reference()
      Returns parameter type.
      Returns:
      parameter type

    • description

      Optional<String> description()
      Returns an optional description of the parameter.
      Returns:
      an optional description of the parameter

    • isHeaderParam

      boolean isHeaderParam()
      Returns true if the parameter is a header parameter, otherwise false.
      Returns:
      true if the parameter is a header parameter, otherwise false

    • isPathParam

      boolean isPathParam()
      Returns true if the parameter is a path parameter, otherwise false.
      Returns:
      true if the parameter is a path parameter, otherwise false

    • isQueryParam

      boolean isQueryParam()
      Returns true if the parameter is a query parameter, otherwise false.
      Returns:
      true if the parameter is a query parameter, otherwise false

    • isFormParam

      boolean isFormParam()
      Returns true if the parameter is a form parameter, otherwise false.
      Returns:
      true if the parameter is a form parameter, otherwise false