NamedProvider.java

/*
 * Copyright 2011-2012 the original author or authors.
 * 
 * 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.springframework.shell.plugin;

/**
 * Returns the name of the provider.  Providers customize features of the shell such as the banner and command line prompt.
 *  
 * 
 * @author Jarred Li
 * @author Mark Pollack
 * @see BannerProvider
 * @see PromptProvider
 * @see HistoryFileNameProvider
 */
public interface NamedProvider {

	/**
	 * Return the name of the provider.
	 */
	String getProviderName();
}