/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.apache.flink.graph.drivers.parameter;
import org.apache.flink.api.java.utils.ParameterTool;
import org.apache.flink.client.program.ProgramParametrizationException;
/**
* A configurable command-line choice, such as an input or algorithm.
*/
public interface Parameterized {
/**
* A unique, human-readable identifier. Presented to the user as the
* name of a selectable choice.
*
* @return parameter name
*/
String getName();
/**
* Human-readable format for the command-line usage string.
*
* @return command-line documentation string
*/
String getUsage();
/**
* Read parameter values from the command-line arguments.
*
* @param parameterTool parameter parser
* @throws ProgramParametrizationException when configuration is invalid
*/
void configure(ParameterTool parameterTool) throws ProgramParametrizationException;
}