1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.net.ftp;
19
20 import java.io.BufferedReader;
21 import java.io.IOException;
22 import java.util.List;
23
24 /**
25 * This abstract class implements both the older FTPFileListParser and newer FTPFileEntryParser interfaces with default functionality. All the classes in the
26 * parser subpackage inherit from this.
27 */
28 public abstract class FTPFileEntryParserImpl implements FTPFileEntryParser {
29 /**
30 * The constructor for a FTPFileEntryParserImpl object.
31 */
32 public FTPFileEntryParserImpl() {
33 }
34
35 /**
36 * This method is a hook for those implementors (such as VMSVersioningFTPEntryParser, and possibly others) which need to perform some action upon the
37 * FTPFileList after it has been created from the server stream, but before any clients see the list.
38 *
39 * This default implementation does nothing.
40 *
41 * @param original Original list after it has been created from the server stream
42 *
43 * @return <code>original</code> unmodified.
44 */
45 @Override
46 public List<String> preParse(final List<String> original) {
47 return original;
48 }
49
50 /**
51 * Reads the next entry using the supplied BufferedReader object up to whatever delimits one entry from the next. This default implementation simply calls
52 * BufferedReader.readLine().
53 *
54 * @param reader The BufferedReader object from which entries are to be read.
55 *
56 * @return A string representing the next ftp entry or null if none found.
57 * @throws IOException thrown on any IO Error reading from the reader.
58 */
59 @Override
60 public String readNextEntry(final BufferedReader reader) throws IOException {
61 return reader.readLine();
62 }
63 }