IServerEnvironmentConfigurator.java

/**
 * This file Copyright (c) 2005-2008 Aptana, Inc. This program is
 * dual-licensed under both the Aptana Public License and the GNU General
 * Public license. You may elect to use one or the other of these licenses.
 * 
 * This program is distributed in the hope that it will be useful, but
 * AS-IS and WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, TITLE, or
 * NONINFRINGEMENT. Redistribution, except as permitted by whichever of
 * the GPL or APL you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or modify this
 * program under the terms of the GNU General Public License,
 * Version 3, as published by the Free Software Foundation.  You should
 * have received a copy of the GNU General Public License, Version 3 along
 * with this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 * 
 * Aptana provides a special exception to allow redistribution of this file
 * with certain other free and open source software ("FOSS") code and certain additional terms
 * pursuant to Section 7 of the GPL. You may view the exception and these
 * terms on the web at http://www.aptana.com/legal/gpl/.
 * 
 * 2. For the Aptana Public License (APL), this program and the
 * accompanying materials are made available under the terms of the APL
 * v1.0 which accompanies this distribution, and is available at
 * http://www.aptana.com/legal/apl/.
 * 
 * You may view the GPL, Aptana's exception and additional terms, and the
 * APL in the file titled license.html at the root of the corresponding
 * plugin containing this source file.
 * 
 * Any modifications to this file must keep this entire header intact.
 */
package com.aptana.ide.server.core;

import org.eclipse.core.runtime.IAdaptable;

/**
 * Abstract server environment configurator.
 * 
 * Interface extends IAdapatable for configurator to be able to to adapt 
 * to the ways of getting information.
 * 
 * In example, configurator can be able to represent itself as WizardPage instance
 * and then requires that instance to be passed to {{@link #configure(Object)} method to configure environment.
 * 
 * If configurator does not require additional information to configure environment,
 * there is no need to try adapting configurator and 'null' value
 * should be passed to {{@link #configure(Object)} method.
 * 
 * @author Denis Denisenko
 */
public interface IServerEnvironmentConfigurator extends IAdaptable
{
	/**
	 * Gets whether configurator requires additional information to be able to 
	 * configure server patcher.
	 * @return true if requires additional information, false otherwise. 
	 */
	boolean requiresAdditionalInformation();
	
	/**
	 * Configures patcher.
	 * @param information - information to use.
	 */
	void configure(Object information);
}