com.openshift.restclient.model.template.IParameter Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (c) 2015 Red Hat, Inc. Distributed under license by Red Hat, Inc.
 * All rights reserved. This program is made available under the terms of the
 * Eclipse Public License v1.0 which accompanies this distribution, and is
 * available at http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors: Red Hat, Inc.
 ******************************************************************************/
package com.openshift.restclient.model.template;

/**
 * A parameter for a template
 * 
 * @author Jeff Cantrill
 */
public interface IParameter {
	
	/**
	 * Returns the name of the parameter that is substituted
	 * in the template
	 * @return
	 */
	String getName();
	
	/**
	 * Returns the description
	 * @return
	 */
	String getDescription();
	
	/**
	 * Returns the value to use
	 * @return
	 */
	String getValue();
	
	/**
	 * Sets the value to use
	 * @param value
	 */
	void setValue(String value);
	
	/**
	 * Returns the generator name which will use the value
	 * from 'getFrom' if set
	 * @return
	 */
	String getGeneratorName();
	
	/**
	 * Returns the input to the generator
	 * @return
	 */
	String getFrom();
	
	/**
	 * Returns true if parameter is required; false otherwise
	 * @return
	 */
	boolean isRequired();
}