org.beanio.types.xml.XmlDateTimeTypeHandler Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of beanio Show documentation
The BeanIO Project
There is a newer version: 2.1.0
/*
 * Copyright 2011 Kevin Seim
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.beanio.types.xml;

import java.util.*;

import javax.xml.datatype.*;
import javax.xml.namespace.QName;

/**
 * A java.util.Date type handler implementation for parsing date-time values based on
 * the W3C XML Schema dateTime datatype
 * specification.
 * 
 * @author Kevin Seim
 * @since 1.1
 */
public class XmlDateTimeTypeHandler extends AbstractXmlDateTypeHandler {

    private boolean outputMilliseconds = false;
    
    @Override
    public String format(Object value) {
        if (value == null) {
            return null;
        }
        
        Date date = (Date) value;
        
        Calendar cal = newCalendar();
        cal.setTime(date);
        
        int ms = DatatypeConstants.FIELD_UNDEFINED;
        if (outputMilliseconds) {
            ms = cal.get(Calendar.MILLISECOND);
        }
        
        XMLGregorianCalendar xcal = dataTypeFactory.newXMLGregorianCalendar(
            cal.get(Calendar.YEAR), 
            cal.get(Calendar.MONTH) + 1, 
            cal.get(Calendar.DATE), 
            cal.get(Calendar.HOUR_OF_DAY), 
            cal.get(Calendar.MINUTE), 
            cal.get(Calendar.SECOND),
            ms,
            getTimeZoneOffset(date));
        
        return xcal.toXMLFormat();
    }

    @Override
    protected QName getDatatypeQName() {
        return DatatypeConstants.DATETIME;
    }
    
    /**
     * Returns whether milliseconds are included when formatting the time.
     * @return true if milliseconds are included when formatting the time
     */
    public boolean isOutputMilliseconds() {
        return outputMilliseconds;
    }

    /**
     * Sets whether milliseconds are included when formatting the time.  Set
     * to false by default.
     * @param b set to true to include milliseconds when formatting the time
     */
    public void setOutputMilliseconds(boolean b) {
        this.outputMilliseconds = b;
    }
}