parameter
=========

.. include:: /ref/targets/autogen/descriptions/parameter.txt

.. contents::


Configuration options
---------------------

type
~~~~

Checks the type of the parameter.

.. code-block:: yaml

   search:
     parameter:
       type: "String"

.. code-block:: java
   :emphasize-lines: 2

    public void userFunction(
       String input,
       Object... args,
    ) {
        // ...
    }

.. seealso::

   The examples above use shorthands, see :doc:`type` target for more advanced configurations


annotation
~~~~~~~~~~

Checks if the parameter has an :doc:`annotation`.

.. code-block:: yaml

   search:
     parameter:
       annotation:
         type: "Deprecated"

.. code-block:: java
   :emphasize-lines: 2

    public void userFunction(
       @Deprecated String input,
       Object... args,
    ) {
        // ...
    }

name
~~~~

Checks the name of the parameter.

.. code-block:: yaml

   search:
     parameter:
       name: "input"

.. code-block:: java
   :emphasize-lines: 2

    public void userFunction(
       String input,
       Object... args,
    ) {
        // ...
    }

.. seealso::

   The examples above use shorthands, see :doc:`string` target for more advanced configurations


modifier
--------

Checks if the parameter has a modifier that matches :doc:`string` target. All modifiers are matched
separately. To match multiple modifiers, use ``allOf`` or ``anyOf``.

.. code-block:: yaml

    search:
      parameter:
        modifier: "final"

.. code-block:: java
    :emphasize-lines: 2
    
    class SomeClass {
        void myMethod(final String s) {
            // ...
        }
    }


.. include:: /ref/targets/partials/searcher.txt