Comprehensive Guide to String Date to XMLGregorianCalendar Conversion in Java

Introduction

In Java development, converting string dates to XMLGregorianCalendar is a frequent requirement, particularly in web services and data serialization. This article analyzes a common problem where input “2014-01-07” results in output “2014-01-06T18:30:00:000Z”, highlighting timezone-related pitfalls.

Problem Analysis

The original code employs SimpleDateFormat with the pattern “yyyy-MM-dd HH:mm:ss”, but the input string “2014-01-07” lacks a time component. This causes the formatter to default missing time to 00:00:00 and apply timezone adjustments based on the local settings, leading to unexpected offsets. For instance, the code snippet:

public static Date stringToJavaDate(String sDate) throws OmniException {
    Date date = null;
    date = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss", Locale.ENGLISH).parse(sDate);
    return date;
}

When parsing “2014-01-07”, the system may apply UTC or other timezone corrections, outputting results like 2014-01-06T18:30:00.000Z, which reflects timezone differences.

Solution Based on GregorianCalendar

The optimal solution involves setting the correct timezone or aligning the format with the input string. By explicitly specifying timezone, default behaviors can be avoided. Example code:

DateFormat format = new SimpleDateFormat("yyyy-MM-dd hh:mm:ss");
Date date = format.parse("2014-04-24 11:15:00");
GregorianCalendar cal = new GregorianCalendar();
cal.setTime(date);
XMLGregorianCalendar xmlGregCal = DatatypeFactory.newInstance().newXMLGregorianCalendar(cal);
System.out.println(xmlGregCal);

This method outputs 2014-04-24T11:15:00.000+02:00, correctly capturing timezone information. Key steps include creating a DateFormat instance, parsing the string to a Date object, converting to GregorianCalendar, and finally generating XMLGregorianCalendar.

Alternative Direct String Method

A more elegant alternative, especially in Java 8 or later, is to create XMLGregorianCalendar directly from a string. This simplifies the process but requires the input string to adhere to ISO 8601 format. Example:

XMLGregorianCalendar result = DatatypeFactory.newInstance()
    .newXMLGregorianCalendar("2014-01-07");
System.out.println(result.getDay());
System.out.println(result.getMonth());
System.out.println(result.getYear());

This directly outputs date components, such as 7, 1, and 2014, without intermediate conversion steps, suitable for straightforward scenarios.

Formatting the Output

To achieve specific formats like “2014-01-06T18:30:00” or “2014-01-06T18:30:00Z”, one can adjust properties of the XMLGregorianCalendar or use formatting utilities. For instance, setting the timezone to UTC or removing milliseconds: incorporate timezone handling logic in code or utilize methods like setTimezone to control offsets.

Conclusion

In summary, when handling string date conversions, ensuring timezone consistency is crucial: specify Locale and timezone explicitly with SimpleDateFormat, use GregorianCalendar as an intermediate step, and consider direct string methods for simplification. It is recommended to test with various date formats during development to avoid timezone-related errors, thereby enhancing application reliability.