Class RegexFTPFileEntryParserImpl
- java.lang.Object
-
- org.apache.commons.net.ftp.FTPFileEntryParserImpl
-
- org.apache.commons.net.ftp.parser.RegexFTPFileEntryParserImpl
-
- All Implemented Interfaces:
FTPFileEntryParser
- Direct Known Subclasses:
ConfigurableFTPFileEntryParserImpl
,EnterpriseUnixFTPEntryParser
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 class for all regular expression based FTPFileEntryParser classes
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.regex.Matcher
_matcher_
Internal PatternMatcher object used by the parser.
-
Constructor Summary
Constructors Constructor Description RegexFTPFileEntryParserImpl(java.lang.String regex)
The constructor for a RegexFTPFileEntryParserImpl object.RegexFTPFileEntryParserImpl(java.lang.String regex, int flags)
The constructor for a RegexFTPFileEntryParserImpl object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getGroupCnt()
Convenience methodjava.lang.String
getGroupsAsString()
For debugging purposes - returns a string shows each match group by number.java.lang.String
group(int matchnum)
Convenience method delegates to the internal MatchResult's group() method.boolean
matches(java.lang.String s)
Convenience method delegates to the internal MatchResult's matches() method.boolean
setRegex(java.lang.String regex)
Alter the current regular expression being utilised for entry parsing and create a newPattern
instance.boolean
setRegex(java.lang.String regex, int flags)
Alter the current regular expression being utilised for entry parsing and create a newPattern
instance.-
Methods inherited from class org.apache.commons.net.ftp.FTPFileEntryParserImpl
preParse, readNextEntry
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.commons.net.ftp.FTPFileEntryParser
parseFTPEntry
-
-
-
-
Constructor Detail
-
RegexFTPFileEntryParserImpl
public RegexFTPFileEntryParserImpl(java.lang.String regex)
The constructor for a RegexFTPFileEntryParserImpl object. The expression is compiled with flags = 0.- Parameters:
regex
- The regular expression with which this object is initialized.- Throws:
java.lang.IllegalArgumentException
- Thrown if the regular expression is unparseable. Should not be seen in normal conditions. It it is seen, this is a sign that a subclass has been created with a bad regular expression. Since the parser must be created before use, this means that any bad parser subclasses created from this will bomb very quickly, leading to easy detection.
-
RegexFTPFileEntryParserImpl
public RegexFTPFileEntryParserImpl(java.lang.String regex, int flags)
The constructor for a RegexFTPFileEntryParserImpl object.- Parameters:
regex
- The regular expression with which this object is initialized.flags
- the flags to apply, seePattern.compile(String, int)
. Use 0 for none.- Throws:
java.lang.IllegalArgumentException
- Thrown if the regular expression is unparseable. Should not be seen in normal conditions. It it is seen, this is a sign that a subclass has been created with a bad regular expression. Since the parser must be created before use, this means that any bad parser subclasses created from this will bomb very quickly, leading to easy detection.- Since:
- 3.4
-
-
Method Detail
-
matches
public boolean matches(java.lang.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.
-
getGroupCnt
public int getGroupCnt()
Convenience method- Returns:
- the number of groups() in the internal MatchResult.
-
group
public java.lang.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.
-
getGroupsAsString
public java.lang.String getGroupsAsString()
For debugging purposes - returns a string shows each match group by number.- Returns:
- a string shows each match group by number.
-
setRegex
public boolean setRegex(java.lang.String regex)
Alter the current regular expression being utilised for entry parsing and create a newPattern
instance.- Parameters:
regex
- The new regular expression- Returns:
- true
- Throws:
java.lang.IllegalArgumentException
- if the regex cannot be compiled- Since:
- 2.0
-
setRegex
public boolean setRegex(java.lang.String regex, int flags)
Alter the current regular expression being utilised for entry parsing and create a newPattern
instance.- Parameters:
regex
- The new regular expressionflags
- the flags to apply, seePattern.compile(String, int)
. Use 0 for none.- Returns:
- true
- Throws:
java.lang.IllegalArgumentException
- if the regex cannot be compiled- Since:
- 3.4
-
-