001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.commons.net.ftp;
019import java.io.BufferedReader;
020import java.io.IOException;
021import java.util.List;
022
023/**
024 * This abstract class implements both the older FTPFileListParser and
025 * newer FTPFileEntryParser interfaces with default functionality.
026 * All the classes in the parser subpackage inherit from this.
027 *
028 */
029public abstract class FTPFileEntryParserImpl
030    implements FTPFileEntryParser
031{
032    /**
033     * The constructor for a FTPFileEntryParserImpl object.
034     */
035    public FTPFileEntryParserImpl()
036    {
037    }
038
039    /**
040     * Reads the next entry using the supplied BufferedReader object up to
041     * whatever delimits one entry from the next.  This default implementation
042     * simply calls BufferedReader.readLine().
043     *
044     * @param reader The BufferedReader object from which entries are to be
045     * read.
046     *
047     * @return A string representing the next ftp entry or null if none found.
048     * @throws java.io.IOException thrown on any IO Error reading from the reader.
049     */
050    @Override
051    public String readNextEntry(BufferedReader reader) throws IOException
052    {
053        return reader.readLine();
054    }
055    /**
056     * This method is a hook for those implementors (such as
057     * VMSVersioningFTPEntryParser, and possibly others) which need to
058     * perform some action upon the FTPFileList after it has been created
059     * from the server stream, but before any clients see the list.
060     *
061     * This default implementation does nothing.
062     *
063     * @param original Original list after it has been created from the server stream
064     *
065     * @return <code>original</code> unmodified.
066     */
067    @Override
068    public List<String> preParse(List<String> original) {
069         return original;
070     }
071}
072
073/* Emacs configuration
074 * Local variables:        **
075 * mode:             java  **
076 * c-basic-offset:   4     **
077 * indent-tabs-mode: nil   **
078 * End:                    **
079 */