DateTimeEntity (NetworkParser 4.6.1013 API)

java.lang.Object
- de.uniks.networkparser.DateTimeEntity

public class DateTimeEntity
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.String[]`	`monthOfYear` Month of the Year Default is German
`static long`	`ONE_DAY`
`static int`	`ONE_HOUR`
`static int`	`ONE_MINUTE`
`static int`	`ONE_SECOND`
`static long`	`ONE_WEEK`
`static long`	`ONE_YEAR`
`static long`	`ONE_YEAR_LY`
`static java.lang.String`	`W3CDTF_FORMAT`
`java.lang.String[]`	`weekDays` Days of the week

Constructor Summary

Constructors
Constructor and Description

DateTimeEntity()

Constructors
Constructor and Description
`DateTimeEntity()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(DateField field, int value)`
`DateTimeEntity`	`addTime(long value)`
`void`	`calculate()`
`long`	`get(DateField field)`
`static DateTimeEntity`	`getEasterSunday(int year)` Returns the date of Easter Sunday for a given year.
`int`	`getMonthLength(int month, int year)` Returns the length of the specified month in the specified year.
`long`	`getTime()`
`java.lang.Long`	`getTimeWithTimeZone()` Fix the TimeZone Offset so the Entity is a simpleCalendar item
`byte`	`getTimezone()`
`long`	`getValueInMillisecond(DateField field)` Supported Values are MILLISECOND, MILLISECONDS, MILLISECOND_OF_YEAR, MILLISECOND_OF_DAY,MILLISECONDSREAL SECOND_OF_MINUTE, SECOND_OF_DAY, SECOND_OF_YEAR MINUTE_OF_HOUR HOUR_OF_DAY DAY_OF_WEEK, DAY_OF_MONTH, DAY_OF_YEAR AMPM, WEEK_OF_MONTH, WEEK_OF_YEAR YEAR
`int`	`getYearLength(int year)` Returns the length (in days) of the specified year.
`boolean`	`isDirty()`
`boolean`	`isLeapYear(int year)` Determines if the given year is a leap year.
`void`	`set(DateField field, int value)`
`void`	`set(DateField field, long value)` set to the date the amount value for the field
`void`	`setMidnight()` erase the time of the date
`java.lang.String`	`toString()`
`java.lang.String`	`toString(java.lang.String dateFormat)` format a date with the formatString
`DateTimeEntity`	`withDate(int value)`
`DateTimeEntity`	`withHour(int value)`
`DateTimeEntity`	`withMinute(int value)`
`DateTimeEntity`	`withMonth(int value)` set a new month for the Date
`DateTimeEntity`	`withNewDate(long date)` Set new TimeStamp
`DateTimeEntity`	`withSecond(int value)`
`DateTimeEntity`	`withTextItems(TextItems items)`
`DateTimeEntity`	`withTime(java.lang.Long value)`
`DateTimeEntity`	`withTimezone(java.lang.Byte value)`
`DateTimeEntity`	`withValue(java.util.Date date)` Setter with date
`DateTimeEntity`	`withValue(int year, int month, int day)` Setter with day, month and year
`DateTimeEntity`	`withValue(long milliseconds)` Setter with milliseconds
`DateTimeEntity`	`withValue(java.lang.String date)` Setter with date-String
`DateTimeEntity`	`withYear(int value)` set a new year for the date

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

- Field Detail
  - W3CDTF_FORMAT
```
public static final java.lang.String W3CDTF_FORMAT
```
    See Also:
    
    Constant Field Values
  - monthOfYear
```
public java.lang.String[] monthOfYear
```
    Month of the Year Default is German
  - weekDays
```
public java.lang.String[] weekDays
```
    Days of the week
  - ONE_SECOND
```
public static final int ONE_SECOND
```
    See Also:
    
    Constant Field Values
  - ONE_MINUTE
```
public static final int ONE_MINUTE
```
    See Also:
    
    Constant Field Values
  - ONE_HOUR
```
public static final int ONE_HOUR
```
    See Also:
    
    Constant Field Values
  - ONE_DAY
```
public static final long ONE_DAY
```
    See Also:
    
    Constant Field Values
  - ONE_WEEK
```
public static final long ONE_WEEK
```
    See Also:
    
    Constant Field Values
  - ONE_YEAR
```
public static final long ONE_YEAR
```
    See Also:
    
    Constant Field Values
  - ONE_YEAR_LY
```
public static final long ONE_YEAR_LY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DateTimeEntity
```
public DateTimeEntity()
```
- Method Detail
  - getMonthLength
```
public int getMonthLength(int month,
                          int year)
```
    Returns the length of the specified month in the specified year. The year number must be normalized.
    
    Parameters:
    
    month - month as asking
    
    year - year of asking
    
    Returns:
    
    int day of Month
    
    See Also:
    
    isLeapYear(int)
  - getYearLength
```
public int getYearLength(int year)
```
    Returns the length (in days) of the specified year. The year must be normalized.
    
    Parameters:
    
    year - year for asking
    
    Returns:
    
    day of fullyear
  - isLeapYear
```
public boolean isLeapYear(int year)
```
    Determines if the given year is a leap year. Returns true if the given year is a leap year. To specify BC year numbers, 1 - year number must be given. For example, year BC 4 is specified as -3.
    
    Parameters:
    
    year - the given year.
    
    Returns:
    
    success: true if the given year is a leap year; false otherwise.
  - calculate
```
public void calculate()
```
  - get
```
public long get(DateField field)
```
  - getTimeWithTimeZone
```
public java.lang.Long getTimeWithTimeZone()
```
    Fix the TimeZone Offset so the Entity is a simpleCalendar item
    
    Returns:
    
    The CurrentTime with TimeZone
    
    See Also:
    
    Date.getTime()
  - withTime
```
public DateTimeEntity withTime(java.lang.Long value)
```
  - addTime
```
public DateTimeEntity addTime(long value)
```
  - getTimezone
```
public byte getTimezone()
```
  - withTimezone
```
public DateTimeEntity withTimezone(java.lang.Byte value)
```
  - isDirty
```
public boolean isDirty()
```
  - add
```
public void add(DateField field,
                int value)
```
  - set
```
public void set(DateField field,
                int value)
```
  - set
```
public void set(DateField field,
                long value)
```
    set to the date the amount value for the field
    
    Parameters:
    
    field - dateTimeField
    
    value - value of changes
  - withValue
```
public DateTimeEntity withValue(long milliseconds)
```
    Setter with milliseconds
    
    Parameters:
    
    milliseconds - milliseconds since 01.01.1970
    
    Returns:
    
    Itself
  - withValue
```
public DateTimeEntity withValue(int year,
                                int month,
                                int day)
```
    Setter with day, month and year
    
    Parameters:
    
    year - year of the date
    
    month - month of the date
    
    day - day of the date
    
    Returns:
    
    Itself
  - withValue
```
public DateTimeEntity withValue(java.lang.String date)
```
    Setter with date-String
    
    Parameters:
    
    date - date as String
    
    Returns:
    
    Itself
  - withValue
```
public DateTimeEntity withValue(java.util.Date date)
```
    Setter with date
    
    Parameters:
    
    date - with new date
    
    Returns:
    
    Itself
  - withNewDate
```
public DateTimeEntity withNewDate(long date)
```
    Set new TimeStamp
    
    Parameters:
    
    date - a new Date
    
    Returns:
    
    Itself
  - withTextItems
```
public DateTimeEntity withTextItems(TextItems items)
```
    Parameters:
    
    items - The new TextItem for text
    
    Returns:
    
    Itself
  - setMidnight
```
public void setMidnight()
```
    erase the time of the date
  - getEasterSunday
```
public static DateTimeEntity getEasterSunday(int year)
```
    Returns the date of Easter Sunday for a given year.
    
    Parameters:
    
    year - xear that is greater then 1583
    
    Returns:
    
    The date of Easter Sunday for a given year.
  - toString
```
public java.lang.String toString(java.lang.String dateFormat)
```
    format a date with the formatString
    
    Parameters:
    
    dateFormat - The Format
    
    Returns:
    
    a String of Date
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - withYear
```
public DateTimeEntity withYear(int value)
```
    set a new year for the date
    
    Parameters:
    
    value - the newYear
    
    Returns:
    
    Itself
  - withMonth
```
public DateTimeEntity withMonth(int value)
```
    set a new month for the Date
    
    Parameters:
    
    value - The new Month
    
    Returns:
    
    Itself
  - withDate
```
public DateTimeEntity withDate(int value)
```
  - withHour
```
public DateTimeEntity withHour(int value)
```
  - withMinute
```
public DateTimeEntity withMinute(int value)
```
  - withSecond
```
public DateTimeEntity withSecond(int value)
```
  - getTime
```
public long getTime()
```
  - getValueInMillisecond
```
public long getValueInMillisecond(DateField field)
```
    Supported Values are MILLISECOND, MILLISECONDS, MILLISECOND_OF_YEAR, MILLISECOND_OF_DAY,MILLISECONDSREAL SECOND_OF_MINUTE, SECOND_OF_DAY, SECOND_OF_YEAR MINUTE_OF_HOUR HOUR_OF_DAY DAY_OF_WEEK, DAY_OF_MONTH, DAY_OF_YEAR AMPM, WEEK_OF_MONTH, WEEK_OF_YEAR YEAR
    
    Parameters:
    
    field - The Field for get
    
    Returns:
    
    the Value As Milliseconds

Class DateTimeEntity

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

W3CDTF_FORMAT

monthOfYear

weekDays

ONE_SECOND

ONE_MINUTE

ONE_HOUR

ONE_DAY

ONE_WEEK

ONE_YEAR

ONE_YEAR_LY

Constructor Detail

DateTimeEntity

Method Detail

getMonthLength

getYearLength

isLeapYear

calculate

get

getTimeWithTimeZone

withTime

addTime

getTimezone

withTimezone

isDirty

add

set

set

withValue

withValue

withValue

withValue

withNewDate

withTextItems

setMidnight

getEasterSunday

toString

toString

withYear

withMonth

withDate

withHour

withMinute

withSecond

getTime

getValueInMillisecond