cn.sissors.hummingbird.runtime.report

Class ExecutionReport

java.lang.Object

cn.sissors.hummingbird.runtime.report.ExecutionReport

All Implemented Interfaces:

Serializable

public class ExecutionReport
extends Object
implements Serializable

ExecutionReport is a tool to store status through running of program. It's in key-value format, like Map. Besides, it provides a series of operations, such as regex search and lambda forEach to improve convenience.

Version:

2018-10-25

Author:

zyz

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static @NotNull ExecutionReport	create() Create a new empty report.
static @NotNull ExecutionReport	create(Map<String,Object> reports) Create a new report which contains given values.
void	forEach(BiConsumer<String,Object> action) Performs the given action for each entry in this map until all entries have been processed or the action throws an exception.
Object	get(String key) Get the value associated with the specified key.
<T> T	get(String key, Class<T> clazz) Get the value associated with the specified key in generic T type.
ExecutionReport	getCategory(String category) Get a sub-report which only contains the given category.
Double	getDouble(String key) Get the value associated with the specified key in Double type.
Integer	getInt(String key) Get the value associated with the specified key in Integer type.
Long	getLong(String key) Get the value associated with the specified key in Long type.
String	getString(String key) Get the value associated with the specified key in String type.
ExecutionReport	merge(ExecutionReport other) Merge another report into this one.
String	print() Print the container to the console.
void	put(Map<String,Object> reports) Add a series of key-value pairs in the report.
void	put(String key, Object value) Associate the specified value with the specified key in the report.
ExecutionReport	search(String pattern) Get a sub-report matches the given regex pattern.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@NotNull
 @Contract(value=" -> new")
public static @NotNull ExecutionReport create()

Create a new empty report.

Returns:

a new report object

create

@NotNull
 @Contract(value="_ -> new")
public static @NotNull ExecutionReport create(Map<String,Object> reports)

Create a new report which contains given values.

Parameters:

reports - the given values

Returns:

a new report object

put

public void put(String key,
                Object value)

Associate the specified value with the specified key in the report.

Parameters:

key - key with which the specified value is to be associated

value - value to be associated with the specified key

put

public void put(Map<String,Object> reports)

Add a series of key-value pairs in the report.

Parameters:

reports - a series of key-value pairs

get

public Object get(String key)

Get the value associated with the specified key.

Parameters:

key - the specified key

Returns:

value associated with the specified key

getString

public String getString(String key)

Get the value associated with the specified key in String type.

Parameters:

key - the specified key

Returns:

value associated with the specified key

getInt

public Integer getInt(String key)

Get the value associated with the specified key in Integer type.

Parameters:

key - the specified key

Returns:

value associated with the specified key

getLong

public Long getLong(String key)

Get the value associated with the specified key in Long type.

Parameters:

key - the specified key

Returns:

value associated with the specified key

getDouble

public Double getDouble(String key)

Get the value associated with the specified key in Double type.

Parameters:

key - the specified key

Returns:

value associated with the specified key

get

public <T> T get(String key,
                 Class<T> clazz)

Get the value associated with the specified key in generic T type.

Type Parameters:

T - target object type

Parameters:

key - the specified key

clazz - target type class

Returns:

value associated with the specified key

getCategory

public ExecutionReport getCategory(String category)

Get a sub-report which only contains the given category.

For example, origin report contains (A, 1), (A.a, 2), (A.b, 3), (B, 4), (B.a, 5). Then, through getCategory("A"), we will get a sub-report which only contains (A, 1), (A.a, 2), (A.b, 3).

Parameters:

category - the specified category

Returns:

a sub-report

search

public ExecutionReport search(String pattern)

Get a sub-report matches the given regex pattern.

For example, origin report contains (T.u.a, 1), (T.u.b, 2), (T.v.a, 3), (T.v.b, 4). Then, through search("T\\..+\\.a"), we will get a sub-report which only contains (T.u.a, 1), (T.v.a, 3).

Parameters:

pattern - the regex formula

Returns:

a sub-report

merge

public ExecutionReport merge(ExecutionReport other)

Merge another report into this one.

Notice: If there exists duplicate key, the value in another report will override the value in current report.

Parameters:

other - another report

Returns:

report after mergence

print

public String print()

Print the container to the console.

Returns:

the string for printing

forEach

public void forEach(BiConsumer<String,Object> action)

Performs the given action for each entry in this map until all entries have been processed or the action throws an exception. Unless otherwise specified by the implementing class, actions are performed in the order of entry set iteration (if an iteration order is specified.) Exceptions thrown by the action are relayed to the caller.

Parameters:

action - The action to be performed for each entry