1/*
2 * Copyright (c) 2009, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package sun.net.ftp;
27
28/**
29 * This interface describes a parser for the FtpClient class. Such a parser is
30 * used when listing a remote directory to transform text lines like:
31 *      drwxr-xr-x      1 user01      ftp   512 Jan 29 23:32 prog
32 * into FtpDirEntry instances.
33 *
34 * @see java.net.FtpClient#setFileParser(FtpDirParser)
35 * @since 1.7
36 */
37public interface FtpDirParser {
38
39    /**
40     * Takes one line from a directory listing and returns an FtpDirEntry instance
41     * based on the information contained.
42     *
43     * @param line a <code>String</code>, a line sent by the FTP server as a
44     *        result of the LST command.
45     * @return an <code>FtpDirEntry</code> instance.
46     * @see java.net.FtpDirEntry
47     */
48    public FtpDirEntry parseLine(String line);
49}
50