DateHour (root 0.2-SNAPSHOT API)

java.lang.Object
- xyz.cofe.time.DateHour

All Implemented Interfaces:

Comparable<DateHour>
```
public class DateHour
extends Object
implements Comparable<DateHour>
```
Описывает значение Дата - Час

Author:

gocha

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DateHour.ComparatorType
Тип сравнения

Nested Classes
Modifier and Type	Class and Description
`static class`	`DateHour.ComparatorType` Тип сравнения

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`day` День от начала года (0..364/365)
`protected Integer`	`dayOfMonth`
`protected Integer`	`dayOfWeek`
`protected int`	`hour` Час
`protected Integer`	`month`
`protected Integer`	`totalDays`
`protected Integer`	`week`
`protected int`	`year` Год

Constructor Summary

Constructors
Constructor and Description
`DateHour()` Конструктор по умолчанию - Нулевая дата
`DateHour(int year, int month, int day, int hour)` Конструктор

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DateHour`	`addDays(int days)` Добавляет к дате указанное число дней
`DateHour`	`addHours(int hours)` Добавляет указанное кол-во часов к текущей дате и возвращает новую дату
`DateHour`	`addMonths(int month)` Сдвигает дату на указанное кол-во месяцев
`int`	`compareTo(DateHour o)` Сравнивает даты
`static DateHour`	`create(int days, int hour)` Создает объект DateHour
`static DateHour`	`create(int year, int dayOfYear, int hour)` Создает объект DateHour
`static Comparator`	`createComparator(DateHour.ComparatorType cmpType, Integer defaultValue)` Создает обхект для сравнения
`static DateHour`	`createWeek(int year, int week)` Создает объект на начало недели, понедельник - начало недели
`static Pair<DateHour,DateHour>`	`createWeekRange(int year, int week)` Создает две даты: на начало указанной недели и на начало след. недели.
`DateHour`	`diff(DateHour t)` Вычисляет разницу между датами
`boolean`	`equals(Object obj)`
`int`	`getDay()` Возвращает номер дня месяца
`int`	`getDayOfWeek()` День недели 0 - пн; 1 - вт; ... 6 - вс.
`int`	`getDayOfYear()` Номер дня в году (1..366)
`static int`	`getDaysOfYear(int year)` Возвращает кол-во дней в году с учетем високосного года
`int`	`getHour()` Час от 0 до 23
`int`	`getMonth()` Возвращает номер месяця в году (1..12)
`static int`	`getMonthLength(int year, int month)` Возвращает кол-во дней в месяце
`String`	`getShortNameDayOfWeek()` Возвращает короткое имя (две буквы) дня недели
`static String`	`getShortNameDayOfWeek(int d)` Возвращает короткое имя (две буквы) дня недели
`int`	`getTotalDays()` Возвращает сколко дней прошло всего с нулевой даты
`int`	`getWeek()` Номер недели начиная с 0.
`int`	`getYear()` Год
`int`	`hashCode()`
`static boolean`	`isLeapYear(int year)` Возвращает признак год високосный год.
`DateHour`	`subDays(int days)` Отнимает от даты указанное число дней
`DateHour`	`subHours(int hours)` Отнимает указанное кол-во часов от тек. даты и возвращает новую дате
`DateHour`	`subMonths(int month)` Сдвигает дату назад на указанное кол-во месяцев
`String`	`toString()`

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

- Field Detail
  - year
```
protected int year
```
    Год
  - day
```
protected int day
```
    День от начала года (0..364/365)
  - hour
```
protected int hour
```
    Час
  - month
```
protected Integer month
```
  - dayOfMonth
```
protected Integer dayOfMonth
```
  - dayOfWeek
```
protected Integer dayOfWeek
```
  - week
```
protected Integer week
```
  - totalDays
```
protected Integer totalDays
```
- Constructor Detail
  - DateHour
```
public DateHour()
```
    Конструктор по умолчанию - Нулевая дата
  - DateHour
```
public DateHour(int year,
                int month,
                int day,
                int hour)
```
    Конструктор
    
    Parameters:
    
    year - Год
    
    month - Месяц (1-12)
    
    day - День (1-31)
    
    hour - Час (0-23)
- Method Detail
  - create
```
public static DateHour create(int year,
                              int dayOfYear,
                              int hour)
```
    Создает объект DateHour
    
    Parameters:
    
    year - Номер года
    
    dayOfYear - Номер дня в году (1..365/366)
    
    hour - Час (0..23)
    
    Returns:
    
    Объект DateHour
  - create
```
public static DateHour create(int days,
                              int hour)
```
    Создает объект DateHour
    
    Parameters:
    
    days - Кол-во дней с нулевой даты
    
    hour - Час (00..23)
    
    Returns:
    
    Объект DateHour
  - createWeek
```
public static DateHour createWeek(int year,
                                  int week)
```
    Создает объект на начало недели, понедельник - начало недели
    
    Parameters:
    
    year - Год
    
    week - Номер недели от нуля и больше
    
    Returns:
    
    Дата на начало указанной недели
  - createWeekRange
```
public static Pair<DateHour,DateHour> createWeekRange(int year,
                                                      int week)
```
    Создает две даты: на начало указанной недели и на начало след. недели. Понедельник - начало недели
    
    Parameters:
    
    year - Год
    
    week - Номер недели от нуля
    
    Returns:
    
    Пара: начало указанной недели / начало след. недели.
  - getYear
```
public int getYear()
```
    Год
    
    Returns:
    
    год
  - getDayOfYear
```
public int getDayOfYear()
```
    Номер дня в году (1..366)
    
    Returns:
    
    Номер дня в году
  - getHour
```
public int getHour()
```
    Час от 0 до 23
    
    Returns:
    
    час (0..23)
  - getMonth
```
public int getMonth()
```
    Возвращает номер месяця в году (1..12)
    
    Returns:
    
    номер месяця в году
  - getDay
```
public int getDay()
```
    Возвращает номер дня месяца
    
    Returns:
    
    номер дня месяца
  - getDayOfWeek
```
public int getDayOfWeek()
```
    День недели 0 - пн; 1 - вт; ... 6 - вс.
    
    Returns:
    
    День недели
  - isLeapYear
```
public static boolean isLeapYear(int year)
```
    Возвращает признак год високосный год. Согласно Григорианскому (c 1583) / Юлианскому (до 1583) календарю.
    
    Parameters:
    
    year - Год
    
    Returns:
    
    true - високосный год
  - getDaysOfYear
```
public static int getDaysOfYear(int year)
```
    Возвращает кол-во дней в году с учетем високосного года
    
    Parameters:
    
    year - Год
    
    Returns:
    
    Кол-во дней в году
  - getMonthLength
```
public static int getMonthLength(int year,
                                 int month)
```
    Возвращает кол-во дней в месяце
    
    Parameters:
    
    year - Год
    
    month - Месяц (1 - январь;)
    
    Returns:
    
    Кол-во дней или -1 если не правильно указан месяц
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getWeek
```
public int getWeek()
```
    Номер недели начиная с 0. Понедельний - первый день недели
    
    Returns:
    
    Номер недели
  - compareTo
```
public int compareTo(DateHour o)
```
    Сравнивает даты
    
    Specified by:
    
    compareTo in interface Comparable<DateHour>
    
    Parameters:
    
    o - Дата
    
    Returns:
    
    0 - идентичны; 1 - текущая дата позже указанной; -1 - текущая дата раньше указанной
  - createComparator
```
public static Comparator createComparator(DateHour.ComparatorType cmpType,
                                          Integer defaultValue)
```
    Создает обхект для сравнения
    
    Parameters:
    
    cmpType - Тип сравнения
    
    defaultValue - Значение по умолчанию если типы не приводятся ко времени; или null - будет сгенерировано искл. ClassCastException
    
    Returns:
    
    Объект для сравнивания дат
  - addDays
```
public DateHour addDays(int days)
```
    Добавляет к дате указанное число дней
    
    Parameters:
    
    days - Кол-во дней которое необходимо добавить
    
    Returns:
    
    Новая дата
  - addHours
```
public DateHour addHours(int hours)
```
    Добавляет указанное кол-во часов к текущей дате и возвращает новую дату
    
    Parameters:
    
    hours - Кол-во часов
    
    Returns:
    
    Новая дата
  - addMonths
```
public DateHour addMonths(int month)
```
    Сдвигает дату на указанное кол-во месяцев
    
    Parameters:
    
    month - Кол-во месяцев
    
    Returns:
    
    Новая дата
  - subMonths
```
public DateHour subMonths(int month)
```
    Сдвигает дату назад на указанное кол-во месяцев
    
    Parameters:
    
    month - Кол-во месяцев
    
    Returns:
    
    Новая дата
  - subHours
```
public DateHour subHours(int hours)
```
    Отнимает указанное кол-во часов от тек. даты и возвращает новую дате
    
    Parameters:
    
    hours - Кол-во часов
    
    Returns:
    
    Новая дата
  - subDays
```
public DateHour subDays(int days)
```
    Отнимает от даты указанное число дней
    
    Parameters:
    
    days - Кол-во дней которое необходимо отнять
    
    Returns:
    
    Новая дата
  - getShortNameDayOfWeek
```
public static String getShortNameDayOfWeek(int d)
```
    Возвращает короткое имя (две буквы) дня недели
    
    Parameters:
    
    d - 0 - пн; 1 - вт; ...
    
    Returns:
    
    День недели
  - getShortNameDayOfWeek
```
public String getShortNameDayOfWeek()
```
    Возвращает короткое имя (две буквы) дня недели
    
    Returns:
    
    День недели
  - getTotalDays
```
public int getTotalDays()
```
    Возвращает сколко дней прошло всего с нулевой даты
    
    Returns:
    
    Сколько дней с нулевой даты, возможные значения также и отрицательные значения
  - diff
```
public DateHour diff(DateHour t)
```
    Вычисляет разницу между датами
    
    Parameters:
    
    t - Дата скоторой происходит сравнение
    
    Returns:
    
    Дата - разница (возможно отрицательное значение)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class DateHour

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

year

day

hour

month

dayOfMonth

dayOfWeek

week

totalDays

Constructor Detail

DateHour

DateHour

Method Detail

create

create

createWeek

createWeekRange

getYear

getDayOfYear

getHour

getMonth

getDay

getDayOfWeek

isLeapYear

getDaysOfYear

getMonthLength

hashCode

equals

getWeek

compareTo

createComparator

addDays

addHours

addMonths

subMonths

subHours

subDays

getShortNameDayOfWeek

getShortNameDayOfWeek

getTotalDays

diff

toString