Date (OpenPatricianModel 0.6.0 API)

java.lang.Object
- ch.sahits.game.openpatrician.model.Date

All Implemented Interfaces:

IInvalidatable
```
@Component
public class Date
extends Object
implements IInvalidatable
```
Representation of the date within the game. This class is thread safe. The Date is implemented as a singleton. However there is no getInstance method to retrieve the once created instance, so it must be referenced elsewhere.

Author:

Andi Hotz, (c) Sahits GmbH, 2011 Created on Sep 16, 2011

Field Summary

Fields
Modifier and Type	Field and Description
`private javafx.beans.property.ObjectProperty<org.joda.time.DateTime>`	`cal` Current date
`private com.google.common.eventbus.AsyncEventBus`	`clientServerEventBus`
`private javafx.beans.binding.StringBinding`	`dayDateBinding`
`static int`	`DEFAULT_INVALID_START_YEAR`
`private Locale`	`locale`
`private static Object`	`lock` Lock for guaranteeing thread safety
`private org.apache.logging.log4j.Logger`	`logger`
`private org.springframework.context.MessageSource`	`messageSource`
`private org.joda.time.DateTime`	`startDate`
`private Integer`	`startYear` Start year
`private int`	`tickUpdate` Tick update in minutes

Constructor Summary

Constructors
Constructor and Description

Date()

Date(org.joda.time.DateTime cal)
Constructor for testing purposes only

Date(int year)
Initialize the date with start year.

Constructors
Constructor and Description
`Date()`
`Date(org.joda.time.DateTime cal)` Constructor for testing purposes only
`Date(int year)` Initialize the date with start year.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private boolean`	`checkStartYear(int startYear)`
`javafx.beans.binding.StringBinding`	`dayDateBinding()` Bind the representation of the day as a String.
`org.joda.time.DateTime`	`getCurrentDate()` Retrieve the immutable DateTime
`javafx.beans.property.ObjectProperty<org.joda.time.DateTime>`	`getCurrentDateProperty()` Retrieve the immutable DateTime
`String`	`getEndOfWeek()` Retrieve the date of the end of the week in the form {Day of month}.
`(package private) org.joda.time.DateTime`	`getEndOfWeekInternal()` Retrieve the date of the of the Sunday of last week
`String`	`getStartOfWeek()` Retrieve the date of the start of the week in the form {Day of month}.
`(package private) org.joda.time.DateTime`	`getStartOfWeekInternal()` Retrieve the date of the start of the last week
`int`	`getWeekdayIndex()` Retrieve an index for the current weekday.
`void`	`invalidate()`
`boolean`	`isSameDay(org.joda.time.DateTime date1, org.joda.time.DateTime date2)` Check if two dates represent the same day
`boolean`	`isToday(org.joda.time.DateTime date)` Check if the date is today.
`void`	`resetStartYear(int startYear)`
`void`	`setStartYear(int startYear)`
`void`	`setTickUpdate(int minutes)` Set the tick update in number of minutes
`String`	`toDisplayString()` Create a string representation for the user interface of the form {Day of month}.
`String`	`todisplayString(int day, int month, int year)`
`String`	`toShortDate(org.joda.time.DateTime c)` Convert the date into the form {Day in month}.
`void`	`updateTime(org.joda.time.DateTime newTime)` Change the time.

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

- Field Detail
  - logger
```
private final org.apache.logging.log4j.Logger logger
```
  - DEFAULT_INVALID_START_YEAR
```
public static final int DEFAULT_INVALID_START_YEAR
```
    See Also:
    
    Constant Field Values
  - tickUpdate
```
private int tickUpdate
```
    Tick update in minutes
  - cal
```
private javafx.beans.property.ObjectProperty<org.joda.time.DateTime> cal
```
    Current date
  - startDate
```
private org.joda.time.DateTime startDate
```
  - startYear
```
private Integer startYear
```
    Start year
  - lock
```
private static Object lock
```
    Lock for guaranteeing thread safety
  - dayDateBinding
```
private javafx.beans.binding.StringBinding dayDateBinding
```
  - clientServerEventBus
```
@Autowired
 @Qualifier(value="serverClientEventBus")
private com.google.common.eventbus.AsyncEventBus clientServerEventBus
```
  - locale
```
@Autowired
private Locale locale
```
  - messageSource
```
@Autowired
private org.springframework.context.MessageSource messageSource
```
- Constructor Detail
  - Date
```
public Date(int year)
```
    Initialize the date with start year. The initial date is 13th July of the start year. The default tick update is 5 minutes.
  - Date
```
public Date()
```
  - Date
```
Date(org.joda.time.DateTime cal)
```
    Constructor for testing purposes only
    
    Parameters:
    
    cal -
- Method Detail
  - resetStartYear
```
public void resetStartYear(int startYear)
```
  - setStartYear
```
public void setStartYear(int startYear)
```
  - checkStartYear
```
private boolean checkStartYear(int startYear)
```
  - updateTime
```
public void updateTime(org.joda.time.DateTime newTime)
```
    Change the time.
    
    Parameters:
    
    newTime -
  - setTickUpdate
```
public void setTickUpdate(int minutes)
```
    Set the tick update in number of minutes
    
    Parameters:
    
    minutes - tick update
  - getStartOfWeek
```
public String getStartOfWeek()
```
    Retrieve the date of the start of the week in the form {Day of month}. {Month}. The week starts with Monday
    
    Returns:
  - getStartOfWeekInternal
```
org.joda.time.DateTime getStartOfWeekInternal()
```
    Retrieve the date of the start of the last week
    
    Returns:
  - toShortDate
```
public String toShortDate(org.joda.time.DateTime c)
```
    Convert the date into the form {Day in month}. {Month}
    
    Parameters:
    
    c -
    
    Returns:
  - getEndOfWeek
```
public String getEndOfWeek()
```
    Retrieve the date of the end of the week in the form {Day of month}. {Month}. The week ends with Sunday
    
    Returns:
  - getEndOfWeekInternal
```
org.joda.time.DateTime getEndOfWeekInternal()
```
    Retrieve the date of the of the Sunday of last week
    
    Returns:
  - toDisplayString
```
public String toDisplayString()
```
    Create a string representation for the user interface of the form {Day of month}. {Month} {Year}.
    
    Returns:
  - dayDateBinding
```
public javafx.beans.binding.StringBinding dayDateBinding()
```
    Bind the representation of the day as a String.
    
    Returns:
  - todisplayString
```
public String todisplayString(int day,
                              int month,
                              int year)
```
  - isSameDay
```
public boolean isSameDay(org.joda.time.DateTime date1,
                         org.joda.time.DateTime date2)
```
    Check if two dates represent the same day
    
    Parameters:
    
    date1 -
    
    date2 -
    
    Returns:
  - isToday
```
public boolean isToday(org.joda.time.DateTime date)
```
    Check if the date is today.
    
    Parameters:
    
    date -
    
    Returns:
  - getCurrentDate
```
public org.joda.time.DateTime getCurrentDate()
```
    Retrieve the immutable DateTime
    
    Returns:
  - getCurrentDateProperty
```
public javafx.beans.property.ObjectProperty<org.joda.time.DateTime> getCurrentDateProperty()
```
    Retrieve the immutable DateTime
    
    Returns:
  - getWeekdayIndex
```
public final int getWeekdayIndex()
```
    Retrieve an index for the current weekday. Mondy is 0.
    
    Returns:
  - invalidate
```
public void invalidate()
```
    Specified by:
    
    invalidate in interface IInvalidatable

Class Date

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

DEFAULT_INVALID_START_YEAR

tickUpdate

cal

startDate

startYear

lock

dayDateBinding

clientServerEventBus

locale

messageSource

Constructor Detail

Date

Date

Date

Method Detail

resetStartYear

setStartYear

checkStartYear

updateTime

setTickUpdate

getStartOfWeek

getStartOfWeekInternal

toShortDate

getEndOfWeek

getEndOfWeekInternal

toDisplayString

dayDateBinding

todisplayString

isSameDay

isToday

getCurrentDate

getCurrentDateProperty

getWeekdayIndex

invalidate