ParameterProcessor.java

/*
 * Copyright 2013 Atteo.
 *
 * 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.atteo.moonshine;

import com.beust.jcommander.JCommander;

/**
 * Command line parameters processor.
 *
 * <p>
 * Moonshine parses the parameters using {@link JCommander}.
 * Use {@link Moonshine.Builder#addParameterProcessor(ParameterProcessor)} to register parameter processor.
 * The provided object will be added to the list of parameter processors with {@link JCommander#addObject(Object)}.
 * </p>
 */
public interface ParameterProcessor {
	/**
	 * Checks the parameters and optionally reconfigures {@link Moonshine}.
	 */
	void configure(Moonshine.RestrictedBuilder builder);
}