org.apache.commons.net.ftp.parser

Class RegexFTPFileEntryParserImpl

Implemented Interfaces:
FTPFileEntryParser, FTPFileListParser
Known Direct Subclasses:
EnterpriseUnixFTPEntryParser, FTPFileListParserImpl, NTFTPEntryParser, OS2FTPEntryParser, OS400FTPEntryParser, UnixFTPEntryParser, VMSFTPEntryParser

public abstract class RegexFTPFileEntryParserImpl
extends FTPFileEntryParserImpl

This abstract class implements both the older FTPFileListParser and newer FTPFileEntryParser interfaces with default functionality. All the classes in the parser subpackage inherit from this. This is the base for all regular based FTPFileEntryParser

Field Summary

protected PatternMatcher
_matcher_
Internal PatternMatcher object used by the parser.

Constructor Summary

RegexFTPFileEntryParserImpl(String regex)
The constructor for a RegexFTPFileEntryParserImpl object.

Method Summary

int
getGroupCnt()
Convenience method delegates to the internal MatchResult's groups() method.
String
getGroupsAsString()
For debugging purposes - returns a string shows each match group by number.
String
group(int matchnum)
Convenience method delegates to the internal MatchResult's group() method.
boolean
matches(String s)
Convenience method delegates to the internal MatchResult's matches() method.

Methods inherited from class org.apache.commons.net.ftp.FTPFileEntryParserImpl

parseFileList, parseFileList, preParse, readNextEntry

Field Details

_matcher_

protected PatternMatcher _matcher_
Internal PatternMatcher object used by the parser. It has protected scope in case subclasses want to make use of it for their own purposes.

Constructor Details

RegexFTPFileEntryParserImpl

public RegexFTPFileEntryParserImpl(String regex)
The constructor for a RegexFTPFileEntryParserImpl object.
Parameters:
regex - The regular expression with which this object is initialized.

Method Details

getGroupCnt

public int getGroupCnt()
Convenience method delegates to the internal MatchResult's groups() method.
Returns:
the number of groups() in the internal MatchResult.

getGroupsAsString

public String getGroupsAsString()
For debugging purposes - returns a string shows each match group by number.
Returns:
a string shows each match group by number.

group

public String group(int matchnum)
Convenience method delegates to the internal MatchResult's group() method.
Parameters:
matchnum - match group number to be retrieved
Returns:
the content of the matchnum'th group of the internal match or null if this method is called without a match having been made.

matches

public boolean matches(String s)
Convenience method delegates to the internal MatchResult's matches() method.
Parameters:
s - the String to be matched
Returns:
true if s matches this object's regular expression.