State

java.lang.Object
- com.SIMRacingApps.Util.State

```
public class State
extends java.lang.Object
```
The State class track any state oriented content. It time stamps each state change with a time you give it, so that you can get the amount of time you were in a particular state. It also keeps track of the previous state, so even after changing the state, you can see the state you were in before the change.

Since:

1.0

Author:

Jeffrey Gilliam

Copyright:

Copyright (C) 2015 - 2024 Jeffrey Gilliam

License:

Apache License 2.0

Constructor Summary

Constructors
Constructor and Description
`State(State state)` Copy constructor for creating a duplicate a state
`State(java.lang.String state, double time)` Constructor for creating an initial state and time.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(boolean state)`
`boolean`	`equals(int state)`
`boolean`	`equals(long state)`
`boolean`	`equals(State state)` Returns true if the current state equals the specified state object.
`boolean`	`equals(java.lang.String state)` Returns true if the current state equals the specified state.
`boolean`	`equalsPrevious(State state)` Returns true if the previous state equals the specified state object.
`boolean`	`equalsPrevious(java.lang.String state)` Returns true if the previous state equals the specified state.
`double`	`getPrevStartingTime()` Returns the starting time of the current state.
`double`	`getPrevStartingTime(java.lang.String state)` Returns the starting time of the specified state.
`java.lang.String`	`getPrevState()` Returns the previous state.
`double`	`getPrevTime()` Returns the amount of time you were in the previous state.
`double`	`getStartingTime()` Returns the starting time of the current state.
`double`	`getStartingTime(java.lang.String state)` Returns the starting time of the specified state.
`java.lang.String`	`getState()` Returns the current state.
`double`	`getTime(double current)` Returns the amount of time you have been in the current state.
`double`	`getTime(java.lang.String state, double current)` Returns the amount of time you were in the specified state.
`void`	`setState(boolean state, double time)`
`void`	`setState(int state, double time)`
`void`	`setState(long state, double time)`
`void`	`setState(State state)` Changes to the specified state using the starting time of the last time the state was started.
`void`	`setState(java.lang.String state, double time)` Changes to the specified state.
`java.lang.String`	`toString()` Returns a printable string of the current and previous states.

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

- Constructor Detail
  - State
```
public State(java.lang.String state,
             double time)
```
    Constructor for creating an initial state and time.
    
    Parameters:
    
    state - The initial state.
    
    time - The time to track this state against.
  - State
```
public State(State state)
```
    Copy constructor for creating a duplicate a state
    
    Parameters:
    
    state - The state to duplicate
- Method Detail
  - getState
```
public java.lang.String getState()
```
    Returns the current state.
    
    Returns:
    
    The current state.
  - getTime
```
public double getTime(double current)
```
    Returns the amount of time you have been in the current state.
    
    Parameters:
    
    current - The current time.
    
    Returns:
    
    The current time minus the starting time of the state.
  - getStartingTime
```
public double getStartingTime()
```
    Returns the starting time of the current state.
    
    Returns:
    
    The starting time of the current state.
  - getStartingTime
```
public double getStartingTime(java.lang.String state)
```
    Returns the starting time of the specified state.
    
    Parameters:
    
    state - The state to lookup.
    
    Returns:
    
    The starting time, 0.0 if state is not found.
  - getTime
```
public double getTime(java.lang.String state,
                      double current)
```
    Returns the amount of time you were in the specified state.
    
    Parameters:
    
    state - The state to lookup.
    
    current - The current time.
    
    Returns:
    
    The amount of time.
  - setState
```
public void setState(java.lang.String state,
                     double time)
```
    Changes to the specified state.
    NOTE: If called subsequently with the same state, the starting time is only recorded the first time.
    
    Parameters:
    
    state - The state to change to.
    
    time - The time to record as the starting time you changed to this state
  - setState
```
public void setState(int state,
                     double time)
```
  - setState
```
public void setState(long state,
                     double time)
```
  - setState
```
public void setState(boolean state,
                     double time)
```
  - setState
```
public void setState(State state)
```
    Changes to the specified state using the starting time of the last time the state was started.
    
    Parameters:
    
    state - The state to change to.
  - equals
```
public boolean equals(java.lang.String state)
```
    Returns true if the current state equals the specified state.
    
    Parameters:
    
    state - The state to compare to.
    
    Returns:
    
    true if equal
  - equals
```
public boolean equals(State state)
```
    Returns true if the current state equals the specified state object.
    
    Parameters:
    
    state - The state to compare to.
    
    Returns:
    
    true if equal
  - equals
```
public boolean equals(int state)
```
  - equals
```
public boolean equals(long state)
```
  - equals
```
public boolean equals(boolean state)
```
  - getPrevState
```
public java.lang.String getPrevState()
```
    Returns the previous state.
    
    Returns:
    
    The pervious state.
  - getPrevStartingTime
```
public double getPrevStartingTime(java.lang.String state)
```
    Returns the starting time of the specified state.
    
    Parameters:
    
    state - The state to lookup.
    
    Returns:
    
    The starting time.
  - getPrevStartingTime
```
public double getPrevStartingTime()
```
    Returns the starting time of the current state.
    
    Returns:
    
    The starting time.
  - getPrevTime
```
public double getPrevTime()
```
    Returns the amount of time you were in the previous state.
    
    Returns:
    
    The amount of time.
  - equalsPrevious
```
public boolean equalsPrevious(java.lang.String state)
```
    Returns true if the previous state equals the specified state.
    
    Parameters:
    
    state - The state to compare to.
    
    Returns:
    
    true if equal
  - equalsPrevious
```
public boolean equalsPrevious(State state)
```
    Returns true if the previous state equals the specified state object.
    
    Parameters:
    
    state - The state to compare to.
    
    Returns:
    
    true if equal
  - toString
```
public java.lang.String toString()
```
    Returns a printable string of the current and previous states.
    
    Overrides:
    
    toString in class java.lang.Object

Class State

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

State

State

Method Detail

getState

getTime

getStartingTime

getStartingTime

getTime

setState

setState

setState

setState

setState

equals

equals

equals

equals

equals

getPrevState

getPrevStartingTime

getPrevStartingTime

getPrevTime

equalsPrevious

equalsPrevious

toString