io.dropwizard.jdbi.args.ZonedDateTimeArgumentFactory Maven / Gradle / Ivy

Go to download
package io.dropwizard.jdbi.args;

import org.skife.jdbi.v2.StatementContext;
import org.skife.jdbi.v2.tweak.Argument;
import org.skife.jdbi.v2.tweak.ArgumentFactory;

import java.time.ZonedDateTime;
import java.util.Calendar;
import java.util.GregorianCalendar;
import java.util.Optional;
import java.util.TimeZone;

/**
 * An {@link ArgumentFactory} for {@link ZonedDateTime} arguments.
 */
public class ZonedDateTimeArgumentFactory implements ArgumentFactory {

    /**
     * {@link Calendar} for representing a database time zone.
     * It's needed when an argument is not represented in a database
     * as {@code TIMESTAMP WITH TIME ZONE}. In this case for correct
     * representing of a timestamp an explicit cast to the database
     * time zone is needed at the JDBC driver level.
     */
    private final Optional calendar;

    public ZonedDateTimeArgumentFactory() {
        calendar = Optional.empty();
    }

    /**
     * Create an argument factory with a custom time zone offset
     *
     * @param timeZone a time zone representing an offset
     */
    public ZonedDateTimeArgumentFactory(Optional timeZone) {
        calendar = timeZone.map(GregorianCalendar::new);
    }

    @Override
    public boolean accepts(final Class expectedType,
                           final Object value,
                           final StatementContext ctx) {
        return value instanceof ZonedDateTime;
    }

    @Override
    public Argument build(final Class expectedType,
                          final ZonedDateTime value,
                          final StatementContext ctx) {
        return new ZonedDateTimeArgument(value, calendar);
    }
}