public class FHX2_Event
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_EVENT_FIRST_YEAR |
static int |
DEFAULT_EVENT_LAST_YEAR |
private char |
eventType |
private int |
eventYear |
private static long |
serialVersionUID |
Constructor and Description |
---|
FHX2_Event()
Default constructor; makes the event a dormant season fire scar that sets at DEFAULT_FIRST_YEAR.
|
FHX2_Event(char inEventType,
int inEventYear)
Creates an event with the given parameters as passed by the user which is updating the event type and the event year
|
FHX2_Event(int inEventYear)
Creates an event with the given parameters; assumes event type to be the default event type, which is the dormant season fire scar
and sets the event year as the year selected by the user
|
Modifier and Type | Method and Description |
---|---|
boolean |
containsYear(int inYear)
Returns true if the event has inYear between its firstYear and lastYear, inclusive
|
char |
getEventType()
Returns a value representing the event's type which could be 'D', 'E', 'M','L','A'
|
int |
getEventYear()
Gets the year of the event's occurrence.
|
void |
setEventType(char inEventType)
The parameter inEventType passed must be set to the eventType.
|
void |
setEventYear(int inEventYear)
The parameter inEventYear passed must be set to the eventYear of the event.
|
private static final long serialVersionUID
public static int DEFAULT_EVENT_FIRST_YEAR
public static int DEFAULT_EVENT_LAST_YEAR
private char eventType
private int eventYear
public FHX2_Event()
public FHX2_Event(int inEventYear)
inEventYear
- year of eventpublic FHX2_Event(char inEventType, int inEventYear)
inEventType
- type of Event (Earlywood, Middlewood, etc)inEventtYear
- year of eventpublic char getEventType()
public void setEventType(char inEventType)
inEventType
- public int getEventYear()
public void setEventYear(int inEventYear)
inEventYear
- public boolean containsYear(int inYear)
inYear
-