|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.util.FilterFileReader
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class FilterFileReader
This class provides a mechanism for reading LDAP search filters from a file. The file is expected to have one filter per line. Blank lines and lines beginning with the octothorpe (#) character will be ignored.
Constructor Summary | |
---|---|
FilterFileReader(java.io.File filterFile)
Creates a new filter file reader that will read from the specified file. |
|
FilterFileReader(java.lang.String path)
Creates a new filter file reader that will read from the file with the specified path. |
Method Summary | |
---|---|
void |
close()
Closes this filter file reader. |
Filter |
readFilter()
Reads the next filter from the file. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FilterFileReader(java.lang.String path) throws java.io.IOException
path
- The path to the file to be read. It must not be null
and the file must exist.
java.io.IOException
- If a problem is encountered while opening the file
for reading.public FilterFileReader(java.io.File filterFile) throws java.io.IOException
filterFile
- The file to be read. It must not be null
and
the file must exist.
java.io.IOException
- If a problem is encountered while opening the file
for reading.Method Detail |
---|
public Filter readFilter() throws java.io.IOException, LDAPException
null
if there are no
more filters to be read.
java.io.IOException
- If a problem is encountered while trying to read from
the file.
LDAPException
- If data read from the file can't be parsed as an
LDAP search filter.public void close() throws java.io.IOException
close
in interface java.io.Closeable
java.io.IOException
- If a problem is encountered while closing the reader.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |