Package bytemusketeers.heslingtonhustle.metrics

Class MetricController

java.lang.Object

bytemusketeers.heslingtonhustle.metrics.MetricController

public class MetricController
extends java.lang.Object

A MetricController stores and manages many MetricEntry items and their associated MetricController.Metric keys, providing a unified interface through which higher-level controllers may manipulate the values of MetricEntry objects and post runtime alteration updates to the MetricUpdater.

Author:

ENG1 Team 23 (Cohort 3)

See Also:

MetricEntry, MetricUpdater

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetricController.Metric	Distinguish between the standard metrics represented in the MetricEntry objects

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Map<MetricController.Metric,MetricEntry>	metrics	The associative key-value map between MetricController.Metric identifiers and MetricEntry storage classes
private MetricUpdater	updateAction	The callback to execute following any MetricEntry value updates

Constructor Summary

Constructors

Constructor	Description
MetricController(MetricUpdater updateAction)	Instantiates a new MetricController and populates the metrics with sensible defaults

Method Summary

Modifier and Type	Method	Description
void	advanceDOWMetric()	Advances the day-of-the-week metric: the MetricEntry associated with MetricController.Metric.Day
void	changeAreaMetric(Area.Name areaName)	Updates the area metric with the given Area.Name: the MetricEntry associated with MetricController.Metric.Area
void	decrementPlayerMetric(MetricController.Metric metric, int multiplier)	Decrements the specified PlayerMetric with the given integral multiplier
private MetricEntry	getDynamicMetricEntry(java.lang.Class<? extends MetricEntry> metricType, MetricController.Metric metric)	Retrieves a MetricEntry of the given variety associated with the given MetricController.Metric key
java.lang.String	getMetricStringValue(MetricController.Metric metric)	Retrieves the String value of the MetricEntry associated with the given MetricController.Metric key
void	incrementPlayerMetric(MetricController.Metric metric, int multiplier)	Increments the specified PlayerMetric with the given integral multiplier
boolean	isFinalDay()	Does the DOWMetric entry suggested that the end is nigh?

Methods inherited from class java.lang.Object

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

Field Detail

updateAction

private final MetricUpdater updateAction

The callback to execute following any MetricEntry value updates

See Also:

MetricUpdater

metrics

private final java.util.Map<MetricController.Metric,MetricEntry> metrics

The associative key-value map between MetricController.Metric identifiers and MetricEntry storage classes

Constructor Detail

MetricController

public MetricController(MetricUpdater updateAction)

Instantiates a new MetricController and populates the metrics with sensible defaults

See Also:

MetricEntry

Method Detail

getDynamicMetricEntry

private MetricEntry getDynamicMetricEntry(java.lang.Class<? extends MetricEntry> metricType,
                                          MetricController.Metric metric)

Retrieves a MetricEntry of the given variety associated with the given MetricController.Metric key

Parameters:

metricType - The expected received value-type from metrics

metric - The MetricController.Metric associated with the desired MetricEntry, of the given type

Returns:

The requested MetricEntry, or null if there was a type mismatch or nonexistent key

incrementPlayerMetric

public void incrementPlayerMetric(MetricController.Metric metric,
                                  int multiplier)

Increments the specified PlayerMetric with the given integral multiplier

Parameters:

metric - The key associated with the target PlayerMetric

multiplier - The integral multiplier

See Also:

PlayerMetric.incrementMetric(int)

decrementPlayerMetric

public void decrementPlayerMetric(MetricController.Metric metric,
                                  int multiplier)

Decrements the specified PlayerMetric with the given integral multiplier

Parameters:

metric - The key associated with the target PlayerMetric

multiplier - The integral multiplier

See Also:

PlayerMetric.decrementMetric(int)

advanceDOWMetric

public void advanceDOWMetric()

Advances the day-of-the-week metric: the MetricEntry associated with MetricController.Metric.Day

See Also:

DOWMetric.nextDay()

isFinalDay

public boolean isFinalDay()

Does the DOWMetric entry suggested that the end is nigh?

Returns:

Is the game on the final day?

changeAreaMetric

public void changeAreaMetric(Area.Name areaName)

Updates the area metric with the given Area.Name: the MetricEntry associated with MetricController.Metric.Area

Parameters:

areaName - The updated Area.Name

See Also:

AreaMetric.setArea(Area.Name)

getMetricStringValue

public java.lang.String getMetricStringValue(MetricController.Metric metric)

Retrieves the String value of the MetricEntry associated with the given MetricController.Metric key

Parameters:

metric - The MetricController.Metric key associated with the desired MetricEntry

Returns:

A human-readable formatted String representing the value of the requested MetricEntry

See Also:

MetricEntry.getValue()