Data (FlowPDF Groovy Library 1.1.2.0 API)

com.cloudbees.flowpdf.components.reporting.Data

Represents a reporting system data that can be converted to a payload. Transformation can be applied before the converting.

Usage example:

 Data myData = new Data([
   uniqueKeyName    : 'buildNumber',
   reportObjectType : 'build'
   values           : [ buildNumber : 1, buildState : 'SUCCESS' ]
 ])

Properties Summary

Properties
Type	Name and description
`java.util.ArrayList<Data>`	`dependentData` Data can contain dependent data, e.g.
`java.lang.String`	`reportObjectType` Name of the report object type the values are related to
`java.util.Map`	`values` Data of this report object

Constructor Summary

Constructors
Constructor and description
`Data (java.util.Map<java.lang.String, java.lang.Object> initArgs)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`addDependentData(Data dependentData)` Pushes new Data to the dependent data of this instance
	`void`	`addOrUpdateValue(java.lang.String key, java.lang.String value)` Adds a value into current report values.
	`void`	`addValue(java.lang.String key, java.lang.String value)` Adds a value into current report values.
	`java.lang.Object`	`createNewDependentData(java.util.Map dataArgs)` Creates new Data that will be included as a dependent Data for this instance
	`java.lang.String`	`toString()` toString override was made for the debugging purposes
	`java.lang.Object`	`updateValue(java.lang.String key, java.lang.String value)` Updates a value in current report values.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - java.util.ArrayList<Data> dependentData
    
    Data can contain dependent data, e.g. 'build' can contain 'quality' (test results)
  - java.lang.String reportObjectType
    
    Name of the report object type the values are related to
  - java.util.Map values
    
    Data of this report object
- Constructor Detail
  - Data(java.util.Map<java.lang.String, java.lang.Object> initArgs)
- Method Detail
  - void addDependentData(Data dependentData)
    
    Pushes new Data to the dependent data of this instance
    Parameters:
    dependentData - Data that will be saved to this instance.
  - void addOrUpdateValue(java.lang.String key, java.lang.String value)
    
    Adds a value into current report values. Will NOT fail if value exists or is not null
    Parameters:
    key - key to add value to
    value - new value
  - void addValue(java.lang.String key, java.lang.String value)
    
    Adds a value into current report values. Will fail if value exists or is not null
    Parameters:
    key - key to add value to
    value - new value
  - java.lang.Object createNewDependentData(java.util.Map dataArgs)
    
    Creates new Data that will be included as a dependent Data for this instance
  - @java.lang.Override java.lang.String toString()
    
    toString override was made for the debugging purposes
    Returns:
    string representation of current instance
  - java.lang.Object updateValue(java.lang.String key, java.lang.String value)
    
    Updates a value in current report values. Will fail if value DOES NOT exists or is null
    Parameters:
    key - key to add value to
    value - new value

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Data

Usage example:

Data myData = new Data([ uniqueKeyName : 'buildNumber', reportObjectType : 'build' values : [ buildNumber : 1, buildState : 'SUCCESS' ] ])

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.util.ArrayList<Data> dependentData

java.lang.String reportObjectType

java.util.Map values

Constructor Detail

Data(java.util.Map<java.lang.String, java.lang.Object> initArgs)

Method Detail

void addDependentData(Data dependentData)

void addOrUpdateValue(java.lang.String key, java.lang.String value)

void addValue(java.lang.String key, java.lang.String value)

java.lang.Object createNewDependentData(java.util.Map dataArgs)

@java.lang.Override java.lang.String toString()

java.lang.Object updateValue(java.lang.String key, java.lang.String value)

[Groovy] Class Data

Usage example: Data myData = new Data([ uniqueKeyName : 'buildNumber', reportObjectType : 'build' values : [ buildNumber : 1, buildState : 'SUCCESS' ] ])

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.util.ArrayList<Data> dependentData

java.lang.String reportObjectType

java.util.Map values

Constructor Detail

Data(java.util.Map<java.lang.String, java.lang.Object> initArgs)

Method Detail

void addDependentData(Data dependentData)

void addOrUpdateValue(java.lang.String key, java.lang.String value)

void addValue(java.lang.String key, java.lang.String value)

java.lang.Object createNewDependentData(java.util.Map dataArgs)

@java.lang.Override java.lang.String toString()

java.lang.Object updateValue(java.lang.String key, java.lang.String value)

Usage example:

Data myData = new Data([ uniqueKeyName : 'buildNumber', reportObjectType : 'build' values : [ buildNumber : 1, buildState : 'SUCCESS' ] ])