DateFormatValidator.java

/**
 *  Copyright 2012-2017 Gunnar Morling (http://www.gunnarmorling.de/)
 *  and/or other contributors as indicated by the @authors tag. See the
 *  copyright.txt file in the distribution for a full listing of all
 *  contributors.
 *
 *  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 org.mapstruct.ap.internal.model.common;

/**
 * An abstraction for validating {@link ConversionContext#getDateFormat()}. There are implementers for different date
 * types such as Joda Time, Java8 Time and java.util.Date.
 */
interface DateFormatValidator {

    /**
     * Validate the given dateFormat.
     *
     * @param dateFormat string supposed to be used for date formatting and parsing.
     *
     * @return {@link DateFormatValidationResult} representing the validation result.
     */
    DateFormatValidationResult validate(String dateFormat);

}