    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.beanutils2.converters;
    018
    019import java.util.Calendar;
    020
    021/**
    022 * {@link DateTimeConverter} implementation that handles conversion to and from <strong>java.util.Calendar</strong> objects.
    023 * <p>
    024 * This implementation can be configured to handle conversion either by using a Locale's default format or by specifying a set of format patterns (note, there
    025 * is no default String conversion for Calendar). See the {@link DateTimeConverter} documentation for further details.
    026 * <p>
    027 * Can be configured to either return a <em>default value</em> or throw a {@code ConversionException} if a conversion error occurs.
    028 *
    029 * @since 1.8.0
    030 */
    031public final class CalendarConverter extends DateTimeConverter<Calendar> {
    032
    033    /**
    034     * Constructs a <strong>java.util.Calendar</strong> <em>Converter</em> that throws a {@code ConversionException} if an error occurs.
    035     */
    036    public CalendarConverter() {
    037    }
    038
    039    /**
    040     * Constructs a <strong>java.util.Calendar</strong> <em>Converter</em> that returns a default value if an error occurs.
    041     *
    042     * @param defaultValue The default value to be returned if the value to be converted is missing or an error occurs converting the value.
    043     */
    044    public CalendarConverter(final Calendar defaultValue) {
    045        super(defaultValue);
    046    }
    047
    048    /**
    049     * Gets the default type this {@code Converter} handles.
    050     *
    051     * @return The default type this {@code Converter} handles.
    052     */
    053    @Override
    054    protected Class<Calendar> getDefaultType() {
    055        return Calendar.class;
    056    }
    057
    058}