org.bml.util.time.DateFormatFactory.java Source code

Introduction

Here is the source code for org.bml.util.time.DateFormatFactory.java

Source

package org.bml.util.time;

/*
 * #%L
 * org.bml
 * %%
 * Copyright (C) 2006 - 2014 Brian M. Lima
 * %%
 * This file is part of ORG.BML.
 * 
 *     ORG.BML is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 * 
 *     ORG.BML is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU Lesser General Public License for more details.
 * 
 *     You should have received a copy of the GNU Lesser General Public License
 *     along with ORG.BML.  If not, see <http://www.gnu.org/licenses/>.
 * #L%
 */

import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.TimeZone;
import org.apache.commons.pool.BasePoolableObjectFactory;

/**
 * The Java Specification states clearly that DateFormat is not thread safe. As
 * a result we see odd behavior from DateFormat in a threaded environment. The
 * higher concurrency the greater the effect. As a result we use a pool whenever
 * we are in a threaded environment.
 * 
 * There are also situations where concurrency may be low but a specific format 
 * is necessary repeatedly enough to make this type of pooling a simple 
 * alternative to repeated creation, in effect reducing resource usage.
 *
 * @author Brian M. Lima
 */
public class DateFormatFactory extends BasePoolableObjectFactory<DateFormat> {

    /**
     * Store the origin format definition.
     */
    private String stringFormat = null;
    /**
     * The default time zone
     */
    private TimeZone defaultTimeZone = null;

    /**
     * @param stringFormat a SimpleDateFormat string
     */
    public DateFormatFactory(final String stringFormat, final TimeZone defaultTimeZone) {
        super();
        this.stringFormat = stringFormat.intern();
        this.defaultTimeZone = defaultTimeZone;
    }

    @Override
    public DateFormat makeObject() {
        DateFormat df = new SimpleDateFormat(stringFormat);
        df.setTimeZone(defaultTimeZone);
        return df;
    }

    @Override
    public void passivateObject(DateFormat aDateFormat) {
        //nothing necessary here
    }
}