Class ISO8601


  • public class ISO8601
    extends java.lang.Object
    This class provides utility methods for parsing and formatting ISO8601 formatted dates.
    • Constructor Summary

      Constructors 
      Constructor Description
      ISO8601()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String dateOnly​(java.util.Date date)
      Get a string that includes the date only in yyyy-mm-ss format.
      static java.lang.String getTimestamp()
      Get a ISO8601 formatted string for the current date and time.
      static java.lang.String getTimestamp​(boolean withMsec)
      Get a ISO8601formatted string for the current date and time.
      static java.util.Calendar toCalendar​(java.lang.String dateTimeString)
      Parses an ISO8601 formatted string a returns a Calendar instance.
      static java.util.Date toDate​(java.lang.String dateTimeString)
      Parses an ISO8601 formatted string a returns a Date instance.
      static java.time.Instant toInstant​(java.lang.String dateTimeString)
      Parses an ISO8601 formatted string a returns an Instant instance.
      static java.lang.String toString​(java.util.Calendar cal)
      Get a ISO8601 formatted string for the provided Calendar instance.
      static java.lang.String toString​(java.util.Date date)
      Get a ISO8601 formatted string for the provided Date instance.
      static java.lang.String toString​(java.util.Date date, boolean withMsec)
      Get a ISO8601 formatted string for the provided Date instance.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ISO8601

        public ISO8601()
    • Method Detail

      • getTimestamp

        public static java.lang.String getTimestamp()
        Get a ISO8601 formatted string for the current date and time.
        Returns:
        a ISO8601 formatted string for the current date and time
      • getTimestamp

        public static java.lang.String getTimestamp​(boolean withMsec)
        Get a ISO8601formatted string for the current date and time.
        Parameters:
        withMsec - flag indicating whether to include milliseconds
        Returns:
        a ISO8601 formatted string for the current date and time
      • toString

        public static java.lang.String toString​(java.util.Calendar cal)
        Get a ISO8601 formatted string for the provided Calendar instance.
        Parameters:
        cal - the Calendar instance to get the ISO8601 formatted string for
        Returns:
        a ISO8601 formatted string for the provided Calendar instance, or null if call is null
      • toString

        public static java.lang.String toString​(java.util.Date date,
                                                boolean withMsec)
        Get a ISO8601 formatted string for the provided Date instance.
        Parameters:
        date - the Date instance to get the ISO8601 formatted string for
        withMsec - flag indicating whether to include milliseconds
        Returns:
        a ISO8601 formatted string for the provided Date instance, or null if date is null
      • dateOnly

        public static java.lang.String dateOnly​(java.util.Date date)
        Get a string that includes the date only in yyyy-mm-ss format.
        Parameters:
        date - the Date instance to get the date only formatted string for
        Returns:
        a string that includes the date only in yyyy-mm-ss format, or null if date is null
      • toString

        public static java.lang.String toString​(java.util.Date date)
        Get a ISO8601 formatted string for the provided Date instance.
        Parameters:
        date - the Date instance to get the ISO8601 formatted string for
        Returns:
        a ISO8601 formatted string for the provided Date instance, or null if date is null
      • toInstant

        public static java.time.Instant toInstant​(java.lang.String dateTimeString)
                                           throws java.text.ParseException
        Parses an ISO8601 formatted string a returns an Instant instance.
        Parameters:
        dateTimeString - the ISO8601 formatted string
        Returns:
        an Instant instance for the ISO8601 formatted string
        Throws:
        java.text.ParseException - if the provided string is not in the proper format
      • toDate

        public static java.util.Date toDate​(java.lang.String dateTimeString)
                                     throws java.text.ParseException
        Parses an ISO8601 formatted string a returns a Date instance.
        Parameters:
        dateTimeString - the ISO8601 formatted string
        Returns:
        a Date instance for the ISO8601 formatted string
        Throws:
        java.text.ParseException - if the provided string is not in the proper format
      • toCalendar

        public static java.util.Calendar toCalendar​(java.lang.String dateTimeString)
                                             throws java.text.ParseException
        Parses an ISO8601 formatted string a returns a Calendar instance.
        Parameters:
        dateTimeString - the ISO8601 formatted string
        Returns:
        a Calendar instance for the ISO8601 formatted string
        Throws:
        java.text.ParseException - if the provided string is not in the proper format