Package org.codehaus.groovy.groovydoc

Interface GroovyParameter

All Known Implementing Classes:
SimpleGroovyParameter
public interface GroovyParameter
Describes a parameter declared by a documented executable member.

  • Method Summary

    Modifier and Type
    Method
    Description
    GroovyAnnotationRef[]
    annotations()
    Returns the annotations declared on this parameter.
    String
    defaultValue()
    Returns the default value expression declared for this parameter.
    String
    name()
    Returns the parameter name.
    GroovyType
    type()
    Returns the resolved parameter type.
    String
    typeName()
    Returns the parameter type name as declared in source.

  • Method Details

    • annotations

      GroovyAnnotationRef[] annotations()
      Returns the annotations declared on this parameter.
      Returns:
      the parameter annotations

    • name

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

    • type

      GroovyType type()
      Returns the resolved parameter type.
      Returns:
      the parameter type, or null if it is unavailable

    • typeName

      String typeName()
      Returns the parameter type name as declared in source.
      Returns:
      the declared type name

    • defaultValue

      String defaultValue()
      Returns the default value expression declared for this parameter.
      Returns:
      the default value expression, or null if none is declared