001/*
002 * Copyright 2010-2018 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.springframework.batch.core;
017
018import org.springframework.lang.Nullable;
019
020/**
021 * Strategy interface for a {@link Job} to use in validating its parameters for
022 * an execution.
023 * 
024 * @author Dave Syer
025 * @author Mahmoud Ben Hassine
026 *
027 */
028public interface JobParametersValidator {
029
030        /**
031         * Check the parameters meet whatever requirements are appropriate, and
032         * throw an exception if not.
033         * 
034         * @param parameters some {@link JobParameters} (can be {@code null})
035         * @throws JobParametersInvalidException if the parameters are invalid
036         */
037        void validate(@Nullable JobParameters parameters) throws JobParametersInvalidException;
038
039}