me.cassayre.florian.hawk.report

Class ReportSettings

java.lang.Object

me.cassayre.florian.hawk.report.ReportSettings

public class ReportSettings
extends Object

Constructor Summary

Constructors

Constructor and Description
ReportSettings(Report report)

Method Summary

Modifier and Type	Method and Description
ReportSettings	disableDamages() Disables the damages tab on the report page.
ReportSettings	disablePlayers() Disables the players tab on the report page.
ReportSettings	disableSummary() Disables the summary tab on the report page.
ReportSettings	displayDate(boolean date)
ReportSettings	displayPlayersCount(boolean playersCount)
ReportSettings	displayWinners(boolean winners)
Report	done()
ReportSettings	enableDamages(boolean perPlayers, boolean perTeams, boolean fromEnvironment, boolean withKiller) Enables the damages tab on the report page.
ReportSettings	enablePlayers(boolean withPlayTime, boolean withGlobalStatistics, boolean withUsed, boolean withMined, boolean withPickedUp) Enables the players tab on the report page, displaying statistics on every players and aggregated global statistics.
ReportSettings	enableSummary(boolean history, boolean players, boolean teams) Enables the summary tab on the report page.
Set<org.bukkit.Material>	getPlayersMinedStatisticsHighlight() Raw access for advanced manipulation.
Set<org.bukkit.Material>	getPlayersMinedStatisticsWhitelist() Raw access for advanced manipulation.
Set<org.bukkit.Material>	getPlayersPickedUpStatisticsHighlight() Raw access for advanced manipulation.
Set<org.bukkit.Material>	getPlayersPickedUpStatisticsWhitelist() Raw access for advanced manipulation.
Set<org.bukkit.Statistic>	getPlayersStatisticsHighlight() Raw access for advanced manipulation.
Set<org.bukkit.Statistic>	getPlayersStatisticsWhitelist() Raw access for advanced manipulation.
Set<org.bukkit.Material>	getPlayersUsedStatisticsHighlight() Raw access for advanced manipulation.
Set<org.bukkit.Material>	getPlayersUsedStatisticsWhitelist() Raw access for advanced manipulation.
ReportSettings	highlightingTheseMinedBlocks(Collection<org.bukkit.Material> highlighted) Highlights these mined blocks in the players tab.
ReportSettings	highlightingTheseMinedBlocks(org.bukkit.Material... highlighted) Highlights these mined blocks in the players tab.
ReportSettings	highlightingThesePickedUpItems(Collection<org.bukkit.Material> highlighted) Highlights these picked-up items in the players tab.
ReportSettings	highlightingThesePickedUpItems(org.bukkit.Material... highlighted) Highlights these picked-up items in the players tab.
ReportSettings	highlightingTheseStatistics(Collection<org.bukkit.Statistic> highlighted) Highlights these global statistics in the players tab.
ReportSettings	highlightingTheseStatistics(org.bukkit.Statistic... highlighted) Highlights these global statistics in the players tab.
ReportSettings	highlightingTheseUsedItems(Collection<org.bukkit.Material> highlighted) Highlights these used items in the players tab.
ReportSettings	highlightingTheseUsedItems(org.bukkit.Material... highlighted) Highlights these used items in the players tab.
com.google.gson.JsonObject	toJSON()
ReportSettings	withGenerator(String name, String url) Adds the name of the plugin, or other generator, responsible for this report's generation.
ReportSettings	withoutGenerator() Removes any credit for the generator.
ReportSettings	withoutGlobalStatisticsWhitelist() Displays all collected statistics in the players tab.
ReportSettings	withoutHighlightingAnyGlobalStatistic() Displays all global statistics equally without hiding anything.
ReportSettings	withoutHighlightingAnyMinedBlock() Displays all mined blocks equally without hiding anything.
ReportSettings	withoutHighlightingAnyPickedUpItem() Displays all picked-up items equally without hiding anything.
ReportSettings	withoutHighlightingAnyUsedItem() Displays all used items equally without hiding anything.
ReportSettings	withoutMinedStatisticsWhitelist() Displays all collected mined blocks in the players tab.
ReportSettings	withoutPickedUpStatisticsWhitelist() Displays all collected picked-up items in the players tab.
ReportSettings	withoutUsedStatisticsWhitelist() Displays all collected used items in the players tab.
ReportSettings	withTheseInGlobalStatisticsWhitelist(Collection<org.bukkit.Statistic> whitelisted) Only display these global statistics in the players tab.
ReportSettings	withTheseInGlobalStatisticsWhitelist(org.bukkit.Statistic... whitelisted) Only display these global statistics in the players tab.
ReportSettings	withTheseInMinedStatisticsWhitelist(Collection<org.bukkit.Material> whitelisted) Only display these mined blocks in the players tab.
ReportSettings	withTheseInMinedStatisticsWhitelist(org.bukkit.Material... whitelisted) Only display these mined blocks in the players tab.
ReportSettings	withTheseInPickedUpStatisticsWhitelist(Collection<org.bukkit.Material> whitelisted) Only display these picked-up items in the players tab.
ReportSettings	withTheseInPickedUpStatisticsWhitelist(org.bukkit.Material... whitelisted) Only display these picked-up items in the players tab.
ReportSettings	withTheseInUsedStatisticsWhitelist(Collection<org.bukkit.Material> whitelisted) Only display these used items in the players tab.
ReportSettings	withTheseInUsedStatisticsWhitelist(org.bukkit.Material... whitelisted) Only display these used items in the players tab.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportSettings

public ReportSettings(Report report)

Method Detail

displayDate

public ReportSettings displayDate(boolean date)

Parameters:

date - true to display the match date on the report page.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

displayPlayersCount

public ReportSettings displayPlayersCount(boolean playersCount)

Parameters:

playersCount - true to display the players count on the report page.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

displayWinners

public ReportSettings displayWinners(boolean winners)

Parameters:

winners - true to display the winners on the report page. If not manually provided, they will be calculated automatically.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

enableSummary

public ReportSettings enableSummary(boolean history,
                                    boolean players,
                                    boolean teams)

Enables the summary tab on the report page.

Parameters:

history - true to enable the history (“timeline”) section of this tab, displaying all recorded events in order.

players - true to display the players' list in this tab.

teams - true to display the teams in this tab. Only displayed if players are also enabled. If disabled players will be listed as there were no team, even if there are teams.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

disableSummary

public ReportSettings disableSummary()

Disables the summary tab on the report page.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

enableDamages

public ReportSettings enableDamages(boolean perPlayers,
                                    boolean perTeams,
                                    boolean fromEnvironment,
                                    boolean withKiller)

Enables the damages tab on the report page.

Parameters:

perPlayers - true to display a per-player summary.

perTeams - true to display a per-team summary.

fromEnvironment - true to display a summary of environmental damages.

withKiller - true to display the killer of each player in the per-player summary.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

disableDamages

public ReportSettings disableDamages()

Disables the damages tab on the report page.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

enablePlayers

public ReportSettings enablePlayers(boolean withPlayTime,
                                    boolean withGlobalStatistics,
                                    boolean withUsed,
                                    boolean withMined,
                                    boolean withPickedUp)

Enables the players tab on the report page, displaying statistics on every players and aggregated global statistics.

SOme statistics can be highlighted (or whitelisted), see other settings methods for that.

Parameters:

withPlayTime - Displays the play time for each player.

withGlobalStatistics - Displays the global statistics of each player (plus an aggregation).

withUsed - Displays used items statistics for each player (plus an aggregation).

withMined - Displays mined blocks statistics for each player (plus an aggregation).

withPickedUp - Displays picked-up items statistics for each player (plus an aggregation).

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

disablePlayers

public ReportSettings disablePlayers()

Disables the players tab on the report page.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

withTheseInGlobalStatisticsWhitelist

public ReportSettings withTheseInGlobalStatisticsWhitelist(org.bukkit.Statistic... whitelisted)

Only display these global statistics in the players tab.

Parameters:

whitelisted - The whitelist.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

withTheseInUsedStatisticsWhitelist

public ReportSettings withTheseInUsedStatisticsWhitelist(org.bukkit.Material... whitelisted)

Only display these used items in the players tab.

Parameters:

whitelisted - The whitelist.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

withTheseInMinedStatisticsWhitelist

public ReportSettings withTheseInMinedStatisticsWhitelist(org.bukkit.Material... whitelisted)

Only display these mined blocks in the players tab.

Parameters:

whitelisted - The whitelist.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

withTheseInPickedUpStatisticsWhitelist

public ReportSettings withTheseInPickedUpStatisticsWhitelist(org.bukkit.Material... whitelisted)

Only display these picked-up items in the players tab.

Parameters:

whitelisted - The whitelist.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

withTheseInGlobalStatisticsWhitelist

public ReportSettings withTheseInGlobalStatisticsWhitelist(Collection<org.bukkit.Statistic> whitelisted)

Only display these global statistics in the players tab.

Parameters:

whitelisted - The whitelist.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

withTheseInUsedStatisticsWhitelist

public ReportSettings withTheseInUsedStatisticsWhitelist(Collection<org.bukkit.Material> whitelisted)

Only display these used items in the players tab.

Parameters:

whitelisted - The whitelist.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

withTheseInMinedStatisticsWhitelist

public ReportSettings withTheseInMinedStatisticsWhitelist(Collection<org.bukkit.Material> whitelisted)

Only display these mined blocks in the players tab.

Parameters:

whitelisted - The whitelist.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

withTheseInPickedUpStatisticsWhitelist

public ReportSettings withTheseInPickedUpStatisticsWhitelist(Collection<org.bukkit.Material> whitelisted)

Only display these picked-up items in the players tab.

Parameters:

whitelisted - The whitelist.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

withoutGlobalStatisticsWhitelist

public ReportSettings withoutGlobalStatisticsWhitelist()

Displays all collected statistics in the players tab.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

withoutUsedStatisticsWhitelist

public ReportSettings withoutUsedStatisticsWhitelist()

Displays all collected used items in the players tab.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

withoutMinedStatisticsWhitelist

public ReportSettings withoutMinedStatisticsWhitelist()

Displays all collected mined blocks in the players tab.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

withoutPickedUpStatisticsWhitelist

public ReportSettings withoutPickedUpStatisticsWhitelist()

Displays all collected picked-up items in the players tab.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

highlightingTheseStatistics

public ReportSettings highlightingTheseStatistics(org.bukkit.Statistic... highlighted)

Highlights these global statistics in the players tab.

Other statistics will still be accessible, but hidden by default. Because there is usually a lot of statistics collected, this can help make the report clearer.

Parameters:

highlighted - The highlighted statistics.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

highlightingTheseUsedItems

public ReportSettings highlightingTheseUsedItems(org.bukkit.Material... highlighted)

Highlights these used items in the players tab.

Other items will still be accessible, but hidden by default. Because there is usually a lot of statistics collected, this can help make the report clearer.

Parameters:

highlighted - The highlighted items.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

highlightingTheseMinedBlocks

public ReportSettings highlightingTheseMinedBlocks(org.bukkit.Material... highlighted)

Highlights these mined blocks in the players tab.

Other blocks will still be accessible, but hidden by default. Because there is usually a lot of statistics collected, this can help make the report clearer.

Parameters:

highlighted - The highlighted blocks.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

highlightingThesePickedUpItems

public ReportSettings highlightingThesePickedUpItems(org.bukkit.Material... highlighted)

Highlights these picked-up items in the players tab.

Other items will still be accessible, but hidden by default. Because there is usually a lot of statistics collected, this can help make the report clearer.

Parameters:

highlighted - The highlighted items.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

highlightingTheseStatistics

public ReportSettings highlightingTheseStatistics(Collection<org.bukkit.Statistic> highlighted)

Highlights these global statistics in the players tab.

Other statistics will still be accessible, but hidden by default. Because there is usually a lot of statistics collected, this can help make the report clearer.

Parameters:

highlighted - The highlighted statistics.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

highlightingTheseUsedItems

public ReportSettings highlightingTheseUsedItems(Collection<org.bukkit.Material> highlighted)

Highlights these used items in the players tab.

Other items will still be accessible, but hidden by default. Because there is usually a lot of statistics collected, this can help make the report clearer.

Parameters:

highlighted - The highlighted items.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

highlightingTheseMinedBlocks

public ReportSettings highlightingTheseMinedBlocks(Collection<org.bukkit.Material> highlighted)

Highlights these mined blocks in the players tab.

Other blocks will still be accessible, but hidden by default. Because there is usually a lot of statistics collected, this can help make the report clearer.

Parameters:

highlighted - The highlighted blocks.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

highlightingThesePickedUpItems

public ReportSettings highlightingThesePickedUpItems(Collection<org.bukkit.Material> highlighted)

Highlights these picked-up items in the players tab.

Other items will still be accessible, but hidden by default. Because there is usually a lot of statistics collected, this can help make the report clearer.

Parameters:

highlighted - The highlighted items.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

withoutHighlightingAnyGlobalStatistic

public ReportSettings withoutHighlightingAnyGlobalStatistic()

Displays all global statistics equally without hiding anything.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

withoutHighlightingAnyUsedItem

public ReportSettings withoutHighlightingAnyUsedItem()

Displays all used items equally without hiding anything.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

withoutHighlightingAnyMinedBlock

public ReportSettings withoutHighlightingAnyMinedBlock()

Displays all mined blocks equally without hiding anything.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

withoutHighlightingAnyPickedUpItem

public ReportSettings withoutHighlightingAnyPickedUpItem()

Displays all picked-up items equally without hiding anything.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

withGenerator

public ReportSettings withGenerator(String name,
                                    String url)

Adds the name of the plugin, or other generator, responsible for this report's generation. It will be credited in the report's footer, with a link if one is provided and non-null.

Parameters:

name - The generator's name.

url - The generator's URL (may be null).

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

withoutGenerator

public ReportSettings withoutGenerator()

Removes any credit for the generator. Credits for this tool (the reports plugin/API + website) will still be displayed.

Returns:

The current ReportSettings instance, for method chaining. Use done() to end.

done

public Report done()

Returns:

The Report instance these settings are linked to, to come back to it without breaking the methods chaining.

getPlayersStatisticsWhitelist

public Set<org.bukkit.Statistic> getPlayersStatisticsWhitelist()

Raw access for advanced manipulation.

getPlayersStatisticsHighlight

public Set<org.bukkit.Statistic> getPlayersStatisticsHighlight()

Raw access for advanced manipulation.

getPlayersUsedStatisticsWhitelist

public Set<org.bukkit.Material> getPlayersUsedStatisticsWhitelist()

Raw access for advanced manipulation.

getPlayersUsedStatisticsHighlight

public Set<org.bukkit.Material> getPlayersUsedStatisticsHighlight()

Raw access for advanced manipulation.

getPlayersMinedStatisticsWhitelist

public Set<org.bukkit.Material> getPlayersMinedStatisticsWhitelist()

Raw access for advanced manipulation.

getPlayersMinedStatisticsHighlight

public Set<org.bukkit.Material> getPlayersMinedStatisticsHighlight()

Raw access for advanced manipulation.

getPlayersPickedUpStatisticsWhitelist

public Set<org.bukkit.Material> getPlayersPickedUpStatisticsWhitelist()

Raw access for advanced manipulation.

getPlayersPickedUpStatisticsHighlight

public Set<org.bukkit.Material> getPlayersPickedUpStatisticsHighlight()

Raw access for advanced manipulation.

toJSON

public com.google.gson.JsonObject toJSON()