Package megamek.common

Interface FullGameReport<T extends ReportEntry>

Type Parameters:

T - The type of individual report entry used

All Superinterfaces:

Serializable

All Known Implementing Classes:

GameReports, SBFFullGameReport

public interface FullGameReport<T extends ReportEntry>
extends Serializable

This interface is implemented by objects that represent a collection of reports representing the course of a game.

See Also:

• ReportEntry

Method Summary

Modifier and Type	Method	Description
void	add(int round, List<T> reports)	Adds the given list of report entries for the given game round to this FullGameReport.
default void	add(int round, T report)	Adds the given report entry for the given game round to this FullGameReport.
void	clear()	Clears this FullGameReport, removing all present reports for all rounds.
List<T>	get(int round)	Returns the reports for the given game round.
boolean	hasReportsforRound(int round)	Returns false when no reports have been added for the given round at all.

Method Details

add

void add(int round,
 List<T> reports)

Adds the given list of report entries for the given game round to this FullGameReport. Note that in the present implementation GameReports, rounds 0 (deployment) and 1 are lumped together as round 1.

Parameters:

round - The round the report is for

reports - The list of reports to add

See Also:

• add(int, ReportEntry)

add

default void add(int round,
 T report)

Adds the given report entry for the given game round to this FullGameReport. Note that in the present implementation GameReports, rounds 0 (deployment) and 1 are lumped together as round 1.

Parameters:

round - The round the report is for

report - The report to add

See Also:

• add(int, List)

hasReportsforRound

boolean hasReportsforRound(int round)

Returns false when no reports have been added for the given round at all. Returns true when at least one report for the given round is present even if it is empty.

Parameters:

round - The game round to test

Returns:

False when no report has been added for the given round, true otherwise

get

List<T> get(int round)

Returns the reports for the given game round. Note that this method should not return null but rather an empty list.

Parameters:

round - The game round to get the reports for

See Also:

• hasReportsforRound(int)

clear

void clear()

Clears this FullGameReport, removing all present reports for all rounds.