Package org.apache.commons.net.ftp.parser

Class FTPTimestampParserImpl

    • Field Detail

      • CALENDAR_UNITS

        private static final int[] CALENDAR_UNITS

      • defaultDateFormat

        private java.text.SimpleDateFormat defaultDateFormat
        The date format for all dates, except possibly recent dates. Assumed to include the year.

      • defaultDateSmallestUnitIndex

        private int defaultDateSmallestUnitIndex

      • recentDateFormat

        private java.text.SimpleDateFormat recentDateFormat
        The format used for recent dates (which don't have the year). May be null.

      • recentDateSmallestUnitIndex

        private int recentDateSmallestUnitIndex

      • lenientFutureDates

        private boolean lenientFutureDates

    • Constructor Detail

      • FTPTimestampParserImpl

        public FTPTimestampParserImpl()
        The only constructor for this class.

    • Method Detail

      • getEntry

        private static int getEntry​(java.text.SimpleDateFormat dateFormat)

      • indexOf

        private static int indexOf​(int calendarUnit)

      • setPrecision

        private static void setPrecision​(int index,
                                 java.util.Calendar working)

      • configure

        public void configure​(FTPClientConfig config)
        Implements the Configurable interface. Configures this FTPTimestampParser according to the following logic:

        Sets up the defaultDateFormat and optionally the recentDateFormat to values supplied in the config based on month names configured as follows:

        • If a shortMonthString has been supplied in the config, use that to parse parse timestamps.
        • Otherwise, if a serverLanguageCode has been supplied in the config, use the month names represented by that language to parse timestamps.
        • otherwise use default English month names

        Finally if a serverTimeZoneId has been supplied via the config, set that into all date formats that have been configured.

        Specified by:
        configure in interface Configurable
        Parameters:
        config - the object containing the configuration data.

      • getDefaultDateFormat

        public java.text.SimpleDateFormat getDefaultDateFormat()
        Gets the defaultDateFormat.
        Returns:
        the defaultDateFormat.

      • getDefaultDateFormatString

        public java.lang.String getDefaultDateFormatString()
        Gets the defaultDateFormat pattern string.
        Returns:
        the defaultDateFormat pattern string.

      • getRecentDateFormat

        public java.text.SimpleDateFormat getRecentDateFormat()
        Gets the recentDateFormat.
        Returns:
        the recentDateFormat.

      • getRecentDateFormatString

        public java.lang.String getRecentDateFormatString()
        Gets the recentDateFormat.
        Returns:
        the recentDateFormat.

      • getServerTimeZone

        public java.util.TimeZone getServerTimeZone()
        Gets the serverTimeZone used by this parser.
        Returns:
        the serverTimeZone used by this parser.

      • getShortMonths

        public java.lang.String[] getShortMonths()
        Gets an array of 12 strings representing the short month names used by this parse.
        Returns:
        an array of 12 strings representing the short month names used by this parse.

      • isLenientFutureDates

        boolean isLenientFutureDates()
        Returns:
        the lenientFutureDates.

      • parseTimestamp

        public java.util.Calendar parseTimestamp​(java.lang.String timestampStr)
                                  throws java.text.ParseException
        Implements the one method in the FTPTimestampParser interface according to this algorithm: If the recentDateFormat member has been defined, try to parse the supplied string with that. If that parse fails, or if the recentDateFormat member has not been defined, attempt to parse with the defaultDateFormat member. If that fails, throw a ParseException. This method assumes that the server time is the same as the local time.
        Specified by:
        parseTimestamp in interface FTPTimestampParser
        Parameters:
        timestampStr - The timestamp to be parsed
        Returns:
        a Calendar with the parsed timestamp
        Throws:
        java.text.ParseException - if none of the parser mechanisms belonging to the implementor can parse the input.
        See Also:
        parseTimestamp(String, Calendar)

      • parseTimestamp

        public java.util.Calendar parseTimestamp​(java.lang.String timestampStr,
                                         java.util.Calendar serverTime)
                                  throws java.text.ParseException
        If the recentDateFormat member has been defined, try to parse the supplied string with that. If that parse fails, or if the recentDateFormat member has not been defined, attempt to parse with the defaultDateFormat member. If that fails, throw a ParseException. This method allows a Calendar instance to be passed in which represents the current (system) time.
        Parameters:
        timestampStr - The timestamp to be parsed
        serverTime - The current time for the server
        Returns:
        the calendar
        Throws:
        java.text.ParseException - if timestamp cannot be parsed
        Since:
        1.5
        See Also:
        FTPTimestampParser.parseTimestamp(String)

      • setDefaultDateFormat

        private void setDefaultDateFormat​(java.lang.String format,
                                  java.text.DateFormatSymbols dfs)
        Parameters:
        format - The defaultDateFormat to be set.
        dfs - the symbols to use (may be null)

      • setLenientFutureDates

        void setLenientFutureDates​(boolean lenientFutureDates)
        Parameters:
        lenientFutureDates - The lenientFutureDates to set.

      • setRecentDateFormat

        private void setRecentDateFormat​(java.lang.String format,
                                 java.text.DateFormatSymbols dfs)
        Parameters:
        format - The recentDateFormat to set.
        dfs - the symbols to use (may be null)

      • setServerTimeZone

        private void setServerTimeZone​(java.lang.String serverTimeZoneId)
        sets a TimeZone represented by the supplied ID string into all the parsers used by this server.
        Parameters:
        serverTimeZoneId - Time Id java.util.TimeZone id used by the ftp server. If null the client's local time zone is assumed.