1. /*

  2.  * Copyright 2004 The Apache Software Foundation

  3.  *

  4.  * Licensed under the Apache License, Version 2.0 (the "License");

  5.  * you may not use this file except in compliance with the License.

  6.  * You may obtain a copy of the License at

  7.  *

  8.  *     http://www.apache.org/licenses/LICENSE-2.0

  9.  *

  10.  * Unless required by applicable law or agreed to in writing, software

  11.  * distributed under the License is distributed on an "AS IS" BASIS,

  12.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  13.  * See the License for the specific language governing permissions and

  14.  * limitations under the License.

  15.  */

  16. package org.apache.commons.net.ftp.parser;

  17. import org.apache.commons.net.ftp.FTPFileEntryParser;

  18. 

  19. /**

  20.  * The interface describes a factory for creating FTPFileEntryParsers

  21.  */

  22. public interface FTPFileEntryParserFactory

  23. {

  24.     /**

  25.      * Implementation should be a method that decodes the

  26.      * supplied key and creates an object implementing the

  27.      * interface FTPFileEntryParser.

  28.      *

  29.      * @param key    A string that somehow identifies an

  30.      *               FTPFileEntryParser to be created.

  31.      *

  32.      * @return the FTPFileEntryParser created.

  33.      * @exception ParserInitializationException

  34.      *                   Thrown on any exception in instantiation

  35.      * @see org.apache.commons.net.ftp.parser.ParserInitializationException

  36.      */

  37.     public FTPFileEntryParser createFileEntryParser(String key)

  38.         throws ParserInitializationException;

  39. 

  40. }