JRGenericElementParameter (JasperReports Library 6.20.0 API)

All Superinterfaces:

Cloneable, JRCloneable

All Known Implementing Classes:

JRBaseGenericElementParameter, JRDesignGenericElementParameter
```
public interface JRGenericElementParameter
extends JRCloneable
```
A generic report element parameter.

Author:

Lucian Chirita ([email protected])

See Also:

JRGenericElement.getParameters()

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getName()`	Returns the name of the parameter.
`JRExpression`	`getValueExpression()`	Returns the expression that provides parameter values.
`boolean`	`isSkipWhenEmpty()`	Decides whether the parameter is skipped when its value evaluates to `null`.

Methods inherited from interface net.sf.jasperreports.engine.JRCloneable
clone

- Method Detail
  - getName
```
String getName()
```
    Returns the name of the parameter.
    The name will be propagated into the generic print element, as in JRGenericPrintElement.setParameterValue(String, Object).
    
    Returns:
    
    the name of the parameter
  - getValueExpression
```
JRExpression getValueExpression()
```
    Returns the expression that provides parameter values.
    The result of the expression evaluation will be propagated into the generic print element as parameter value, as in JRGenericPrintElement.setParameterValue(String, Object).
    
    Returns:
    
    the parameter's value expression
  - isSkipWhenEmpty
```
boolean isSkipWhenEmpty()
```
    Decides whether the parameter is skipped when its value evaluates to null.
    When the parameter's expression evaluates to null and this flag is set and , the parameter is not included in the generated print element. If the flag is not set, the parameter is included with a null value.
    
    Returns:
    
    whether the parameter is skipped when its value is null