DateTime (prosys-opc-ua-sdk-client-server-pubsub 5.6.2-227 API)

java.lang.Object
- com.prosysopc.ua.stack.builtintypes.DateTime

All Implemented Interfaces:

Comparable<DateTime>
```
public class DateTime
extends Object
implements Comparable<DateTime>
```
OPC UA DateTime. The OPC UA dateTime is defined as follows (OPCUA Part 3)
This primitive DataType is used to define Coordinated Universal Time (UTC) values. All time values conveyed between servers and clients in OPC UA are UTC values. Clients must provide any conversions between UTC and local time. This DataType is represented as a 64-bit signed integer which represents the number of 100 nanosecond intervals since January 1, 1601. [UA Part 6] defines details about this DataType.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_STR_FORMAT` The default String format used in toString.
`static DateTime[]`	`EMPTY_ARRAY`
`static NodeId`	`ID` Deprecated. use `Identifiers.DateTime` instead.
`static String`	`ISO_8601_STR_FORMAT` ISO 8601 date format.
`static Instant`	`MAX` Maximum possible time to represent in OPC UA.
`static DateTime`	`MAX_VALUE` Maximum possible time to represent in OPC UA.
`static Instant`	`MIN` Minimum possible time to represent in OPC UA.
`static DateTime`	`MIN_VALUE` Minimum possible time to represent in OPC UA.
`static long`	`OffsetToGregorianCalendarZero` Constant used to convert Java Epoch (1970/1/1) and OPC UA Epoch (1601/1/1) timestamps.

Constructor Summary

Constructors
Constructor and Description
`DateTime()` Deprecated. use `currentTime()` instead
`DateTime(Calendar value)` Deprecated. use `fromInstant(Instant)` instead and Java8 time APIs
`DateTime(int year, int month, int day, int hour, int minute, int second)` Deprecated. use `fromInstant(Instant)` instead and Java8 time APIs
`DateTime(int year, int month, int day, int hour, int minute, int second, int nanosecond)` Deprecated. use `fromInstant(Instant)` instead and Java8 time APIs
`DateTime(int year, int month, int day, int hour, int minute, int second, int nanosecond, TimeZone timeZone)` Deprecated. use `fromInstant(Instant)` instead and Java8 time APIs
`DateTime(long value)` Deprecated. use `valueOf(long)` instead.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`compareTo(DateTime other)`
`static DateTime`	`currentTime()` Returns an instance of `DateTime` that represents the current time.
`boolean`	`equals(Object obj)`
`static DateTime`	`fromInstant(Instant value)` Returns `DateTime` representing the same time as the given `Instant`.
`static DateTime`	`fromMillis(long value)` Create a new DateTime instance from standard Java milliseconds since the beginning of epoch, January 1, 1970 UTC.
`GregorianCalendar`	`getCalendar(TimeZone timezone)` Deprecated. use `toInstant()` and Java 8 Time APIs instead.
`GregorianCalendar`	`getLocalCalendar()` Deprecated. use `toInstant()` and Java 8 Time APIs instead.
`static String`	`getStrFormat()` Get the format used for toString().
`long`	`getTimeInMillis()` Get standard Java milliseconds between the time and midnight, January 1, 1970 UTC.
`GregorianCalendar`	`getUtcCalendar()` Deprecated. use `toInstant()` and Java 8 Time APIs instead.
`long`	`getValue()` Get 1/10 microseconds (1 unit = 100 nanoseconds) between the time and midnight, January 1, 1601 UTC.
`int`	`hashCode()`
`boolean`	`isAfter(DateTime other)` Returns true if this DateTime is after the given DateTime.
`boolean`	`isAfterOrAt(DateTime other)` Returns true if this DateTime is after or at the same time as the given DateTime.
`boolean`	`isBefore(DateTime other)` Returns true if this DateTime is before the given DateTime.
`boolean`	`isBeforeOrAt(DateTime other)` Returns true if this DateTime is before or at the same time as the given DateTime.
`static boolean`	`isUseLocalTimeInToString()` If this is true, then DateTime.toString should print local timestamps and Utc if this is false.
`DateTime`	`minus(long timeToSubtract, TemporalUnit temporalUnit)` Create a new DateTime instance that corresponds to a moment in time before this instance.
`DateTime`	`minus(long timeToSubtract, TimeUnit timeUnits)` Create a new DateTime instance that corresponds to a moment in time a number of timeUnits before this instance.
`DateTime`	`minus(TemporalAmount amountToSubtract)` Create a new DateTime instance that corresponds to a moment in time before this instance.
`DateTime`	`minusMillis(double millisToSubtract)` Create a new DateTime instance that corresponds to a moment in time a number of milliseconds before this instance.
`DateTime`	`minusMillis(long millisToSubtract)` Create a new DateTime instance that corresponds to a moment in time a number of milliseconds before this instance.
`DateTime`	`minusNanos(long nanosToSubtract)` Create a new DateTime instance that corresponds to a moment in time a number of nanoseconds before this instance.
`static DateTime`	`parseDateTime(String string)` Parse a DateTime value from a String.
`DateTime`	`plus(long timeToAdd, TemporalUnit temporalUnit)` Create a new DateTime instance that corresponds to a moment in time after this instance.
`DateTime`	`plus(long timeToAdd, TimeUnit timeUnits)` Create a new DateTime instance that corresponds to a moment in time a number of timeUnits after this instance.
`DateTime`	`plus(TemporalAmount amountToAdd)` Create a new DateTime instance that corresponds to a moment in time before this instance.
`DateTime`	`plusMillis(double millisToAdd)` Create a new DateTime instance that corresponds to a moment in time a number of milliseconds after this instance.
`DateTime`	`plusMillis(long millisToAdd)` Create a new DateTime instance that corresponds to a moment in time a number of milliseconds after this instance.
`DateTime`	`plusNanos(long nanosToAdd)` Create a new DateTime instance that corresponds to a moment in time a number of nanoseconds after this instance.
`static void`	`setStrFormat(String strFormat)` Set the format used for toString().
`static void`	`setUseLocalTimeInToString(boolean useLocalTimeInToString)` If this is true, then DateTime.toString should print local timestamps and Utc if this is false.
`Instant`	`toInstant()` Returns the time as `Instant`.
`String`	`toString()` toString.
`static DateTime`	`valueOf(long uaEpoch100Nanoseconds)` Creates DateTime from the given 100-nanoseconds from 'OPC UA Epoch' (January 1, 1601).

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

- Field Detail
  - DEFAULT_STR_FORMAT
```
public static final String DEFAULT_STR_FORMAT
```
    The default String format used in toString. Constant DEFAULT_STR_FORMAT="%TD %TT.%07d %TZ"
    
    See Also:
    
    Constant Field Values
  - ISO_8601_STR_FORMAT
```
public static final String ISO_8601_STR_FORMAT
```
    ISO 8601 date format. Constant ISO_8601_STR_FORMAT="%TF %TT.%07d %TZ"
    
    See Also:
    
    Constant Field Values
  - EMPTY_ARRAY
```
public static final DateTime[] EMPTY_ARRAY
```
  - ID
```
@Deprecated
public static final NodeId ID
```
    Deprecated. use Identifiers.DateTime instead.
    
    The NodeId for the DataType node DateTime in the UA AddressSpace.
  - OffsetToGregorianCalendarZero
```
public static final long OffsetToGregorianCalendarZero
```
    Constant used to convert Java Epoch (1970/1/1) and OPC UA Epoch (1601/1/1) timestamps.
    Note that value is in OPC UA resolution of 100 nanoseconds. Constant OffsetToGregorianCalendarZero=116444736000000000L
    
    See Also:
    
    Constant Field Values
  - MIN_VALUE
```
public static final DateTime MIN_VALUE
```
    Minimum possible time to represent in OPC UA.
  - MAX_VALUE
```
public static final DateTime MAX_VALUE
```
    Maximum possible time to represent in OPC UA.
  - MIN
```
public static final Instant MIN
```
    Minimum possible time to represent in OPC UA.
    Corresponds to MIN_VALUE
  - MAX
```
public static final Instant MAX
```
    Maximum possible time to represent in OPC UA.
    Corresponds to MAX_VALUE
- Constructor Detail
  - DateTime
```
@Deprecated
public DateTime()
```
    Deprecated. use currentTime() instead
    
    Constructs a new DateTime value, initializing it with the current UTC time.
  - DateTime
```
@Deprecated
public DateTime(Calendar value)
```
    Deprecated. use fromInstant(Instant) instead and Java8 time APIs
    
    Constructs a new DateTime value, is initializing it with a Calendar value.
    
    Parameters:
    
    value - a Calendar object.
  - DateTime
```
@Deprecated
public DateTime(int year,
                             int month,
                             int day,
                             int hour,
                             int minute,
                             int second)
```
    Deprecated. use fromInstant(Instant) instead and Java8 time APIs
    
    Constructs a new DateTime value, initializing it with the given time value (in UTC timezone).
    Creates a GregorianCalendar using the parameters year..second.
    Note: that month is 0-based, and the values correspond to the constants, Calendar.JANUARY, etc.
    
    Parameters:
    
    year - a int.
    
    month - a int.
    
    day - a int.
    
    hour - a int.
    
    minute - a int.
    
    second - a int.
  - DateTime
```
@Deprecated
public DateTime(int year,
                             int month,
                             int day,
                             int hour,
                             int minute,
                             int second,
                             int nanosecond)
```
    Deprecated. use fromInstant(Instant) instead and Java8 time APIs
    
    Constructs a new DateTime value, initializing it with the given time value (in UTC timezone).
    Creates a GregorianCalendar using the parameters year..second and adds nanoSeconds.
    Note: that month is 0-based, and the values correspond to the constants, Calendar.JANUARY, etc.
    
    Parameters:
    
    year - a int.
    
    month - a int.
    
    day - a int.
    
    hour - a int.
    
    minute - a int.
    
    second - a int.
    
    nanosecond - a int.
  - DateTime
```
@Deprecated
public DateTime(int year,
                             int month,
                             int day,
                             int hour,
                             int minute,
                             int second,
                             int nanosecond,
                             TimeZone timeZone)
```
    Deprecated. use fromInstant(Instant) instead and Java8 time APIs
    
    Constructs a new DateTime value, initializing it with the given time value (in the defined timezone).
    Creates a GregorianCalendar using the parameters year..second; sets the TimeZone and adds nanoSeconds.
    Note: that month is 0-based, and the values correspond to the constants, Calendar.JANUARY, etc.
    
    Parameters:
    
    year - a int.
    
    month - a int.
    
    day - a int.
    
    hour - a int.
    
    minute - a int.
    
    second - a int.
    
    nanosecond - a int.
    
    timeZone - a TimeZone object.
  - DateTime
```
@Deprecated
public DateTime(long value)
```
    Deprecated. use valueOf(long) instead.
    
    Constructs a new DateTime value, initializing it with an OPC UA time value with a resolution of 100 nanoseconds. Note that this uses "OPC UA Epoch", not "Java Epoch".
- Method Detail
  - currentTime
```
public static DateTime currentTime()
```
    Returns an instance of DateTime that represents the current time.
  - fromInstant
```
public static DateTime fromInstant(Instant value)
```
    Returns DateTime representing the same time as the given Instant.
    Note that the resolution of DateTime is in 100 nanoseconds (from the OPC UA Epoch) and thus cannot fully represent all Instants. The value is truncated to 100 nanosecond resolution. Additionally values outside of MIN-MAX are clamped to the boundary values.
    Returns null if given null.
  - fromMillis
```
public static DateTime fromMillis(long value)
```
    Create a new DateTime instance from standard Java milliseconds since the beginning of epoch, January 1, 1970 UTC.
    
    Parameters:
    
    value - a long.
    
    Returns:
    
    a DateTime object.
  - getStrFormat
```
public static String getStrFormat()
```
    Get the format used for toString().
  - isUseLocalTimeInToString
```
public static boolean isUseLocalTimeInToString()
```
    If this is true, then DateTime.toString should print local timestamps and Utc if this is false. Default is false.
    
    Returns:
    
    a boolean.
  - parseDateTime
```
public static DateTime parseDateTime(String string)
                              throws ParseException
```
    Parse a DateTime value from a String. The valid String format is the extended ISO 8601 format, which is also used by XML DateTime data type.
    Omitting just seconds, both minutes and seconds or hours, minutes and seconds are supported. Omitting time zone interprets the time zone as UTC. Omitting 'T' between date and time is not allowed, unless hours, minutes and seconds are omitted.
    Decimal fraction parts are supported only for seconds.
    Examples of valid Strings: '2025-10-10T11:12:13.123+05:00', '2025-10-10T11:12:13+0500', '2025-10-10T11:12+05', '2025-10-10T11+05', '2025-10-10T11Z', '2025-10-10T11', '2025-10-10', '2025-10-10'.
    
    Parameters:
    
    string - the String to parse
    
    Returns:
    
    a new DateTime value, corresponding to the timestamp. Values outside of MIN_VALUE and MAX_VALUE are truncated to the limits.
    
    Throws:
    
    ParseException - if the DateTime cannot be parsed from string
  - setStrFormat
```
public static void setStrFormat(String strFormat)
```
    Set the format used for toString().
    
    Parameters:
    
    strFormat - new format
  - setUseLocalTimeInToString
```
public static void setUseLocalTimeInToString(boolean useLocalTimeInToString)
```
    If this is true, then DateTime.toString should print local timestamps and Utc if this is false. Default is false.
    
    Parameters:
    
    useLocalTimeInToString - a boolean.
  - valueOf
```
public static DateTime valueOf(long uaEpoch100Nanoseconds)
```
    Creates DateTime from the given 100-nanoseconds from 'OPC UA Epoch' (January 1, 1601). Values that are outside of MIN_VALUE and are clamped to the boundary values.
  - compareTo
```
public int compareTo(DateTime other)
```
    Specified by:
    
    compareTo in interface Comparable<DateTime>
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getCalendar
```
@Deprecated
public GregorianCalendar getCalendar(TimeZone timezone)
```
    Deprecated. use toInstant() and Java 8 Time APIs instead.
    
    Return the time as a calendar value.
    
    Parameters:
    
    timezone - The desired TimeZone for the calendar
    
    Returns:
    
    a new GregorianCalendar instance, initialized to the value of the DateTime.
  - getLocalCalendar
```
@Deprecated
public GregorianCalendar getLocalCalendar()
```
    Deprecated. use toInstant() and Java 8 Time APIs instead.
    
    getLocalCalendar.
    
    Returns:
    
    the dateTime converted to a new GregorianCalendar in local TimeZone.
  - getTimeInMillis
```
public long getTimeInMillis()
```
    Get standard Java milliseconds between the time and midnight, January 1, 1970 UTC. This is the same as calling toInstant() and then Instant.toEpochMilli().
  - getUtcCalendar
```
@Deprecated
public GregorianCalendar getUtcCalendar()
```
    Deprecated. use toInstant() and Java 8 Time APIs instead.
    
    getUtcCalendar.
    
    Returns:
    
    the dateTime converted to a new GregorianCalendar in UTC TimeZone.
  - getValue
```
public long getValue()
```
    Get 1/10 microseconds (1 unit = 100 nanoseconds) between the time and midnight, January 1, 1601 UTC. This value is used when encoding this DateTime using OPC UA Binary encoding rules.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isAfter
```
public boolean isAfter(DateTime other)
```
    Returns true if this DateTime is after the given DateTime.
    
    Parameters:
    
    other - the other DateTime
    
    Returns:
    
    true if this DateTime is after the given DateTime, false otherwise
  - isAfterOrAt
```
public boolean isAfterOrAt(DateTime other)
```
    Returns true if this DateTime is after or at the same time as the given DateTime.
    
    Parameters:
    
    other - the other DateTime
    
    Returns:
    
    true if this DateTime is after or at the same time as the given DateTime, false otherwise
  - isBefore
```
public boolean isBefore(DateTime other)
```
    Returns true if this DateTime is before the given DateTime.
    
    Parameters:
    
    other - the other DateTime
    
    Returns:
    
    true if this DateTime is before the given DateTime, false otherwise
  - isBeforeOrAt
```
public boolean isBeforeOrAt(DateTime other)
```
    Returns true if this DateTime is before or at the same time as the given DateTime.
    
    Parameters:
    
    other - the other DateTime
    
    Returns:
    
    true if this DateTime is before or at the same time as the given DateTime, false otherwise
  - minus
```
public DateTime minus(long timeToSubtract,
                      TemporalUnit temporalUnit)
```
    Create a new DateTime instance that corresponds to a moment in time before this instance.
    
    Parameters:
    
    timeToSubtract - time in the specified units to subtract from this time.
    
    temporalUnit - time units to use.
    
    Returns:
    
    a new DateTime instance.
  - minus
```
public DateTime minus(long timeToSubtract,
                      TimeUnit timeUnits)
```
    Create a new DateTime instance that corresponds to a moment in time a number of timeUnits before this instance.
    
    Parameters:
    
    timeToSubtract - time in timeUnits to subtract from this time.
    
    timeUnits - time units.
    
    Returns:
    
    a new DateTime instance.
  - minus
```
public DateTime minus(TemporalAmount amountToSubtract)
```
    Create a new DateTime instance that corresponds to a moment in time before this instance.
    
    Parameters:
    
    amountToSubtract - the amount to subtract from this time.
    
    Returns:
    
    a new DateTime instance.
  - minusMillis
```
public DateTime minusMillis(double millisToSubtract)
```
    Create a new DateTime instance that corresponds to a moment in time a number of milliseconds before this instance.
    The method is provided, since OPC UA handles duration as double and this method enables direct use of those in context of DateTime that enables 100 nanosecond accuracy in practice.
    
    Parameters:
    
    millisToSubtract - milliseconds to subtract from this time. Fractions are used to provide 100 ns accuracy that is native to DateTime.
    
    Returns:
    
    a new DateTime instance.
  - minusMillis
```
public DateTime minusMillis(long millisToSubtract)
```
    Create a new DateTime instance that corresponds to a moment in time a number of milliseconds before this instance.
    
    Parameters:
    
    millisToSubtract - milliseconds to subtract from this time.
    
    Returns:
    
    a new DateTime instance.
  - minusNanos
```
public DateTime minusNanos(long nanosToSubtract)
```
    Create a new DateTime instance that corresponds to a moment in time a number of nanoseconds before this instance.
    Note that the actual resolution of DateTime is 100 nanoseconds, so the given value is truncated to 100 nanosecond accuracy in practice.
    
    Parameters:
    
    nanosToSubtract - nanoseconds to subtract from this time.
    
    Returns:
    
    a new DateTime instance.
  - plus
```
public DateTime plus(long timeToAdd,
                     TemporalUnit temporalUnit)
```
    Create a new DateTime instance that corresponds to a moment in time after this instance.
    This is a convenience method that is implemented using Instant as follows
```
 return fromInstant(toInstant().plus(timeToAdd, temporalUnit));
 
```
    See the documentation for Instant for other options that you can use to work with the Instant timestamps.
    Parameters:
    
    timeToAdd - time in the specified units to add to this time.
    
    temporalUnit - time units to use.
    
    Returns:
    
    a new DateTime instance.
  - plus
```
public DateTime plus(long timeToAdd,
                     TimeUnit timeUnits)
```
    Create a new DateTime instance that corresponds to a moment in time a number of timeUnits after this instance.
    
    Parameters:
    
    timeToAdd - time in the specified units to add to this time.
    
    timeUnits - time units to use.
    
    Returns:
    
    a new DateTime instance.
  - plus
```
public DateTime plus(TemporalAmount amountToAdd)
```
    Create a new DateTime instance that corresponds to a moment in time before this instance.
    
    Parameters:
    
    amountToAdd - the temporal amount to add to this time.
    
    Returns:
    
    a new DateTime instance.
  - plusMillis
```
public DateTime plusMillis(double millisToAdd)
```
    Create a new DateTime instance that corresponds to a moment in time a number of milliseconds after this instance.
    The method is provided, since OPC UA handles duration as double and this method enables direct use of those in context of DateTime that enables 100 nanosecond accuracy in practice.
    
    Parameters:
    
    millisToAdd - milliseconds to add to this time. Fractions are used to provide 100 ns accuracy that is native to DateTime.
    
    Returns:
    
    a new DateTime instance.
  - plusMillis
```
public DateTime plusMillis(long millisToAdd)
```
    Create a new DateTime instance that corresponds to a moment in time a number of milliseconds after this instance.
    
    Parameters:
    
    millisToAdd - milliseconds to add to this time.
    
    Returns:
    
    a new DateTime instance.
  - plusNanos
```
public DateTime plusNanos(long nanosToAdd)
```
    Create a new DateTime instance that corresponds to a moment in time a number of nanoseconds after this instance.
    Note that the actual resolution of DateTime is 100 nanoseconds, so the given value is truncated to 100 nanosecond accuracy in practice.
    
    Parameters:
    
    nanosToAdd - nanoseconds to add to this time.
    
    Returns:
    
    a new DateTime instance.
  - toInstant
```
public Instant toInstant()
```
    Returns the time as Instant.
  - toString
```
public String toString()
```
    toString.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a String object.

Class DateTime

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_STR_FORMAT

ISO_8601_STR_FORMAT

EMPTY_ARRAY

ID

OffsetToGregorianCalendarZero

MIN_VALUE

MAX_VALUE

MIN

MAX

Constructor Detail

DateTime

DateTime

DateTime

DateTime

DateTime

DateTime

Method Detail

currentTime

fromInstant

fromMillis

getStrFormat

isUseLocalTimeInToString

parseDateTime

setStrFormat

setUseLocalTimeInToString

valueOf

compareTo

equals

getCalendar

getLocalCalendar

getTimeInMillis

getUtcCalendar

getValue

hashCode

isAfter

isAfterOrAt

isBefore

isBeforeOrAt

minus

minus

minus

minusMillis

minusMillis

minusNanos

plus

plus

plus

plusMillis

plusMillis

plusNanos

toInstant

toString