Package net.sf.jasperreports.engine.type

Enum EvaluationTimeEnum

java.lang.Object
java.lang.Enum<EvaluationTimeEnum>
net.sf.jasperreports.engine.type.EvaluationTimeEnum
All Implemented Interfaces:
Serializable, Comparable<EvaluationTimeEnum>, java.lang.constant.Constable, NamedEnum
public enum EvaluationTimeEnum extends Enum<EvaluationTimeEnum> implements NamedEnum
Author:
Teodor Danciu (teodord@users.sourceforge.net)

  • Enum Constant Details

    • NOW

      public static final EvaluationTimeEnum NOW
      A constant specifying that an expression should be evaluated at the exact moment in the filling process when it is encountered.

    • REPORT

      public static final EvaluationTimeEnum REPORT
      A constant specifying that an expression should be evaluated at the end of the filling process.

    • PAGE

      public static final EvaluationTimeEnum PAGE
      A constant specifying that an expression should be evaluated after each page is filled.

    • COLUMN

      public static final EvaluationTimeEnum COLUMN
      A constant specifying that an expression should be evaluated after each column is filled.

    • GROUP

      public static final EvaluationTimeEnum GROUP
      A constant specifying that an expression should be evaluated after each group break.

    • BAND

      public static final EvaluationTimeEnum BAND
      The element will be evaluated at band end.

    • AUTO

      public static final EvaluationTimeEnum AUTO
      Evaluation time indicating that each variable participating in the expression should be evaluated at a time decided by the engine.

      Variables will be evaluated at a time corresponding to their reset type. Fields are evaluated "now", i.e. at the time the band the element lies on gets filled.

      This evaluation type should be used when report elements having expressions that combine values evaluated at different times are required (e.g. percentage out of a total).

      NB: avoid using this evaluation type when other types suffice as it can lead to performance loss.

    • MASTER

      public static final EvaluationTimeEnum MASTER
      Used for elements that are evaluated at the moment the master report ends.
      See Also:

  • Method Details

    • values

      public static EvaluationTimeEnum[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static EvaluationTimeEnum valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getName

      public String getName()
      Specified by:
      getName in interface NamedEnum

    • getByName

      public static EvaluationTimeEnum getByName(String name)

    • getValueOrDefault

      public static EvaluationTimeEnum getValueOrDefault(EvaluationTimeEnum value)

    • getDefault

      public EvaluationTimeEnum getDefault()
      Specified by:
      getDefault in interface NamedEnum