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 018 package org.apache.commons.net.ftp.parser; 019 020 import java.text.ParseException; 021 import java.util.Calendar; 022 023 /** 024 * This interface specifies the concept of parsing an FTP server's 025 * timestamp. 026 * @since 1.4 027 */ 028 public interface FTPTimestampParser { 029 030 /** 031 * the default default date format. 032 */ 033 public static final String DEFAULT_SDF = UnixFTPEntryParser.DEFAULT_DATE_FORMAT; 034 /** 035 * the default recent date format. 036 */ 037 public static final String DEFAULT_RECENT_SDF = UnixFTPEntryParser.DEFAULT_RECENT_DATE_FORMAT; 038 039 /** 040 * Parses the supplied datestamp parameter. This parameter typically would 041 * have been pulled from a longer FTP listing via the regular expression 042 * mechanism 043 * @param timestampStr - the timestamp portion of the FTP directory listing 044 * to be parsed 045 * @return a <code>java.util.Calendar</code> object initialized to the date 046 * parsed by the parser 047 * @throws ParseException if none of the parser mechanisms belonging to 048 * the implementor can parse the input. 049 */ 050 public Calendar parseTimestamp(String timestampStr) throws ParseException; 051 052 }