net.sf.okapi.common.pipeline.IPipelineReader Maven / Gradle / Ivy

Go to download
/*===========================================================================
  Copyright (C) 2009 by the Okapi Framework contributors
-----------------------------------------------------------------------------
  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 net.sf.okapi.common.pipeline;

/**
 * Facade to read and reconstruct a pipeline from a storage.
 */
public interface IPipelineReader {

	/**
	 * Reads the steps of the pipeline and the parameters of each of its steps
	 * from the implementation-specific storage.
	 * @return a new instance of an object that implements {@link IPipeline}, or
	 * null if the pipeline could not be created. 
	 */
	public IPipeline read ();

}