panda.net.ftp.parser.FTPFileEntryParserFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of panda-core Show documentation

Panda Core is the core module of Panda Framework, it contains commonly used utility classes similar to apache-commons.

There is a newer version: 1.8.0

package panda.net.ftp.parser;

import panda.net.ftp.FTPClientConfig;
import panda.net.ftp.FTPFileEntryParser;

/**
 * The interface describes a factory for creating FTPFileEntryParsers.
 */
public interface FTPFileEntryParserFactory {
	/**
	 * Implementation should be a method that decodes the supplied key and creates an object
	 * implementing the interface FTPFileEntryParser.
	 * 
	 * @param key A string that somehow identifies an FTPFileEntryParser to be created.
	 * @return the FTPFileEntryParser created.
	 * @exception ParserInitializationException Thrown on any exception in instantiation
	 */
	public FTPFileEntryParser createFileEntryParser(String key) throws ParserInitializationException;

	/**
	 * 
	 * Implementation should be a method that extracts a key from the supplied
	 * {@link FTPClientConfig FTPClientConfig} parameter and creates an object implementing the
	 * interface FTPFileEntryParser and uses the supplied configuration to configure it.
	 * 
	 * 
	 * Note that this method will generally not be called in scenarios that call for autodetection
	 * of parser type but rather, for situations where the user knows that the server uses a
	 * non-default configuration and knows what that configuration is.
	 * 
	 * 
	 * @param config A {@link FTPClientConfig FTPClientConfig} used to configure the parser created
	 * @return the @link FTPFileEntryParser FTPFileEntryParser} so created.
	 * @exception ParserInitializationException Thrown on any exception in instantiation
	 */
	public FTPFileEntryParser createFileEntryParser(FTPClientConfig config) throws ParserInitializationException;

}