    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one or more
    003 * contributor license agreements.  See the NOTICE file distributed with
    004 * this work for additional information regarding copyright ownership.
    005 * The ASF licenses this file to You under the Apache License, Version 2.0
    006 * (the "License"); you may not use this file except in compliance with
    007 * the License.  You may obtain a copy of the License at
    008 *
    009 *      http://www.apache.org/licenses/LICENSE-2.0
    010 *
    011 * Unless required by applicable law or agreed to in writing, software
    012 * distributed under the License is distributed on an "AS IS" BASIS,
    013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014 * See the License for the specific language governing permissions and
    015 * limitations under the License.
    016 */
    017package org.apache.commons.beanutils.converters;
    018
    019import java.util.Calendar;
    020
    021/**
    022 * {@link DateTimeConverter} implementation that handles conversion to
    023 * and from <strong>java.util.Calendar</strong> objects.
    024 * <p>
    025 * This implementation can be configured to handle conversion either
    026 * by using a Locale's default format or by specifying a set of format
    027 * patterns (note, there is no default String conversion for Calendar).
    028 * See the {@link DateTimeConverter} documentation for further details.
    029 * <p>
    030 * Can be configured to either return a <em>default value</em> or throw a
    031 * <code>ConversionException</code> if a conversion error occurs.
    032 *
    033 * @since 1.8.0
    034 */
    035public final class CalendarConverter extends DateTimeConverter {
    036
    037    /**
    038     * Construct a <strong>java.util.Calendar</strong> <em>Converter</em> that throws
    039     * a <code>ConversionException</code> if an error occurs.
    040     */
    041    public CalendarConverter() {
    042    }
    043
    044    /**
    045     * Construct a <strong>java.util.Calendar</strong> <em>Converter</em> that returns
    046     * a default value if an error occurs.
    047     *
    048     * @param defaultValue The default value to be returned
    049     * if the value to be converted is missing or an error
    050     * occurs converting the value.
    051     */
    052    public CalendarConverter(final Object defaultValue) {
    053        super(defaultValue);
    054    }
    055
    056    /**
    057     * Return the default type this <code>Converter</code> handles.
    058     *
    059     * @return The default type this <code>Converter</code> handles.
    060     */
    061    @Override
    062    protected Class<?> getDefaultType() {
    063        return Calendar.class;
    064    }
    065
    066}