AreaMetric

java.lang.Object
- bytemusketeers.heslingtonhustle.metrics.AreaMetric

All Implemented Interfaces:

MetricEntry
```
class AreaMetric
extends java.lang.Object
implements MetricEntry
```
An AreaMetric represents an Area as a MetricEntry to be managed by the MetricController

Author:

ENG1 Team 23 (Cohort 3)

Field Summary

Fields
Modifier and Type Field Description

private Area.Name area
The Area.Name representing the Area embedded within the AreaMetric

Constructor Summary

Constructors
Constructor Description

AreaMetric(Area.Name initialArea)
Instantiates a new AreaMetric with the given initial Area.Name

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getValue()`	Retrieves the `area` associated with the `AreaMetric`
`(package private) void`	`setArea(Area.Name areaName)`	Updates the current `area` with the given `Area.Name`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - area
```
private Area.Name area
```
    The Area.Name representing the Area embedded within the AreaMetric
    
    See Also:
    
    getValue()
- Constructor Detail
  - AreaMetric
```
AreaMetric(Area.Name initialArea)
```
    Instantiates a new AreaMetric with the given initial Area.Name
    
    Parameters:
    
    initialArea - The initial Area.Name
- Method Detail
  - getValue
```
public java.lang.String getValue()
```
    Retrieves the area associated with the AreaMetric
    
    Specified by:
    
    getValue in interface MetricEntry
    
    Returns:
    
    A String representation of the area
  - setArea
```
void setArea(Area.Name areaName)
```
    Updates the current area with the given Area.Name
    
    Parameters:
    
    areaName - The updated Area.Name