HostTxtIterator

java.lang.Object

net.i2p.addressbook.HostTxtIterator

All Implemented Interfaces:: Closeable, AutoCloseable, Iterator<Map.Entry<String, HostTxtEntry>>

class HostTxtIteratorextends Object implements Iterator<Map.Entry<String, HostTxtEntry>>, Closeable

A class to iterate through a hosts.txt or config file without reading the whole thing into memory. Keys are always converted to lower case.

Callers should iterate all the way through or call close() to ensure the underlying stream is closed.

This is not used for config files. It is only used for subscriptions.

Nested Class Summary
Nested Classes
Modifier and Type
Class
Description
private static class
HostTxtIterator.MapEntry
The object returned by the iterator.
Field Summary
Fields
Modifier and Type
Field
Description
private static final Log
_log
The addressbook's own log.
private BufferedReader
input
The hosts.txt file being read.
private HostTxtIterator.MapEntry
next
The entry read ahead of the current position.
Constructor Summary
Constructors
Constructor
Description
HostTxtIterator()
A dummy iterator in which hasNext() is always false.
HostTxtIterator(File file)
An iterator over the key/value pairs in the file.
Method Summary
All Methods
Modifier and Type
Method
Description
void
close()
Close the underlying stream.
boolean
hasNext()
Return true if there is another entry to return.
Map.Entry<String, HostTxtEntry>
next()
Return the next entry.
void
remove()
Not supported.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface Iterator
forEachRemaining

Field Details
- _log
  private static final Log _log
  The addressbook's own log.
- input
  private BufferedReader input
  The hosts.txt file being read.
- next
  private HostTxtIterator.MapEntry next
  The entry read ahead of the current position.
Constructor Details
- HostTxtIterator
  public HostTxtIterator()
  A dummy iterator in which hasNext() is always false.
- HostTxtIterator
  public HostTxtIterator(File file) throws IOException
  An iterator over the key/value pairs in the file.
  Parameters:
  file - the hosts.txt or subscription file to read, opened as UTF-8
  Throws:
  IOException - if the file cannot be opened or read
Method Details
- hasNext
  public boolean hasNext()
  Return true if there is another entry to return.
  Specified by:
  hasNext in interface Iterator<Map.Entry<String, HostTxtEntry>>
  Returns:
  true if there is another entry
- next
  public Map.Entry<String, HostTxtEntry> next()
  Return the next entry. 'remove' entries will be returned with a null key, and the value will contain a null name, null dest, and non-null props.
  Specified by:
  next in interface Iterator<Map.Entry<String, HostTxtEntry>>
  Returns:
  the next entry
  Throws:
  NoSuchElementException - if there is no next entry
- remove
  public void remove()
  Not supported.
  Specified by:
  remove in interface Iterator<Map.Entry<String, HostTxtEntry>>
  Throws:
  UnsupportedOperationException - always; this iterator cannot remove
- close
  public void close()
  Close the underlying stream.
  Specified by:
  close in interface AutoCloseable
  Specified by:
  close in interface Closeable

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Methods inherited from interface Iterator

Field Details

_log

input

next

Constructor Details

HostTxtIterator

Method Details

hasNext

next

remove

close