com.canoo.dp.impl.validation.AbstractDateAndCalendarValidator Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2015-2018 Canoo Engineering AG.
 *
 * 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 com.canoo.dp.impl.validation;

import org.apiguardian.api.API;

import javax.validation.ConstraintValidatorContext;
import javax.validation.ValidationException;
import java.lang.annotation.Annotation;
import java.util.Calendar;
import java.util.Date;

import static org.apiguardian.api.API.Status.INTERNAL;

/**
 * Utility abstract class to minimize {@link Date}-{@link Calendar} type checking.
 * 
 * Note: using plain {@code Object} as data type because {@link Date} and {@link Calendar} have no common ancestor.
 *
 * @param  defines the annotation of the constraints
 */
@API(since = "0.19.0", status = INTERNAL)
public abstract class AbstractDateAndCalendarValidator extends AbstractPropertyValidator {

    /**
     * Constructor
     */
    public AbstractDateAndCalendarValidator() {
        super(Object.class);
    }

    /**
     * A validation hook to mask type checks.
     *
     * @param date - the date, guaranteed non-null
     * @param context - validation context
     * @return true if {@code date} is valid, false otherwise
     */
    protected abstract boolean checkValidDate(Date date, ConstraintValidatorContext context);

    /**
     * Template method to mask type checks.
     *
     * @param calendar - the calendar object, guaranteed non-null
     * @param context - validation context
     * @return true if {@code calendar} is valid, false otherwise
     */
    protected abstract boolean checkValidCalendar(Calendar calendar, ConstraintValidatorContext context);

    @Override
    protected boolean checkValid(final Object value, final ConstraintValidatorContext context) {
        if (value instanceof Date) {
            return checkValidDate((Date) value, context);
        } else if (value instanceof Calendar) {
            return checkValidCalendar((Calendar) value, context);
        } else {
            throw new ValidationException("Property contains value of type " + value.getClass() + " whereas only java.util.Date and java.util.Calendar are supported.");
        }
    }
}