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 * https://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.parser;
19
20 import java.text.ParseException;
21 import java.util.Calendar;
22
23 /**
24 * This interface specifies the concept of parsing an FTP server's timestamp.
25 *
26 * @since 1.4
27 */
28 public interface FTPTimestampParser {
29
30 /**
31 * the default default date format.
32 */
33 String DEFAULT_SDF = UnixFTPEntryParser.DEFAULT_DATE_FORMAT;
34 /**
35 * the default recent date format.
36 */
37 String DEFAULT_RECENT_SDF = UnixFTPEntryParser.DEFAULT_RECENT_DATE_FORMAT;
38
39 /**
40 * Parses the supplied datestamp parameter. This parameter typically would have been pulled from a longer FTP listing via the regular expression mechanism
41 *
42 * @param timestampStr the timestamp portion of the FTP directory listing to be parsed
43 * @return a {@code java.util.Calendar} object initialized to the date parsed by the parser
44 * @throws ParseException if none of the parser mechanisms belonging to the implementor can parse the input.
45 */
46 Calendar parseTimestamp(String timestampStr) throws ParseException;
47
48 }