com.thunken.beacon.BeaconParser

All Implemented Interfaces:: Closeable, AutoCloseable, Iterator<Optional<BeaconLink>>

public class BeaconParser
extends Object
implements Closeable, Iterator<Optional<BeaconLink>>

Main class to parse BEACON dumps.

Note: the current Javadoc for this project is incomplete. We rely on Lombok to generate boilerplate code, and Lombok does not plug into Javadoc. Generated methods and constructors are not included, and the Javadoc for other methods and constructors may be incomplete. See delombok and beacon#1 for more information.

See Also:: BeaconLink, BeaconMetaFields, https://gbv.github.io/beaconspec/beacon.html#beacon-format

Constructor Summary

Constructors
Constructor	Description
`BeaconParser(Reader reader)`	Creates a BEACON parser that uses the specified `Reader`, and initializes the parser's `BeaconMetaFields` from the meta lines.
`BeaconParser(Reader reader, BeaconMetaFields defaults)`	Creates a BEACON parser that uses the specified `Reader` and default `BeaconMetaFields`, and further initializes the parser's `BeaconMetaFields` from the meta lines.

Method Summary

Modifier and Type	Method	Description
`void`	`close()`
`int`	`getLineNo()`
`int`	`getLinkNo()`	Returns the current link number.
`BeaconMetaFields`	`getMetaFields()`
`boolean`	`hasNext()`	Returns `true` if the underlying BEACON dump has more links.
`Optional<BeaconLink>`	`next()`	Returns an `Optional` describing the next `BeaconLink` in the underlying BEACON dump, or `Optional.empty()` if the corresponding line cannot be parsed.
`static Optional<BeaconLink>`	`parseLine(String linkLine, BeaconMetaFields metaFields)`	Parses a BEACON link line and returns an `Optional` describing the corresponding `BeaconLink`, or `Optional.empty()` if the line cannot be parsed into a valid link.
`void`	`remove()`	`BeaconParser` provides read-only access to a BEACON dump, so `Iterator.remove()` is not supported.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Details
- BeaconParser
  
  public BeaconParser(Reader reader) throws IOException
  
  Creates a BEACON parser that uses the specified Reader, and initializes the parser's BeaconMetaFields from the meta lines.
  
  Parameters:
  
  reader - A character stream reader.
  
  Throws:
  
  BeaconFormatException - If the parser encounters data that violates the BEACON specification.
  
  IOException - If an I/O error occurs.
  
  NullPointerException - If reader is null.
  
  See Also:
  
  https://gbv.github.io/beaconspec/beacon.html#beacon-format
- BeaconParser
  
  public BeaconParser(Reader reader, BeaconMetaFields defaults) throws IOException
  
  Creates a BEACON parser that uses the specified Reader and default BeaconMetaFields, and further initializes the parser's BeaconMetaFields from the meta lines.
  
  Parameters:
  
  reader - A character stream reader.
  
  defaults - Default values for BEACON meta fields. Overwritten by meta fields parsed from the reader, if any.
  
  Throws:
  
  BeaconFormatException - If the parser encounters data that violates the BEACON specification.
  
  IOException - If an I/O error occurs.
  
  NullPointerException - If reader is null.
  
  See Also:
  
  https://gbv.github.io/beaconspec/beacon.html#beacon-format
Method Details
- close
  
  public void close() throws IOException
  
  Specified by:
  
  close in interface AutoCloseable
  
  Specified by:
  
  close in interface Closeable
  
  Throws:
  
  IOException
- getLineNo
  
  public int getLineNo()
- getLinkNo
  
  public int getLinkNo()
  
  Returns the current link number.
  
  Returns:
  
  The current link number.
- getMetaFields
  
  public BeaconMetaFields getMetaFields()
- hasNext
  
  public boolean hasNext()
  
  Returns true if the underlying BEACON dump has more links. (In other words, returns true if next() would return an Optional rather than throwing an exception.)
  
  Specified by:
  
  hasNext in interface Iterator<Optional<BeaconLink>>
  
  Returns:
  
  true if the underlying BEACON dump has more links.
- next
  
  public Optional<BeaconLink> next()
  
  Returns an Optional describing the next BeaconLink in the underlying BEACON dump, or Optional.empty() if the corresponding line cannot be parsed.
  
  Specified by:
  
  next in interface Iterator<Optional<BeaconLink>>
  
  Returns:
  
  An Optional describing the next BeaconLink in the underlying BEACON dump, or Optional.empty() if the corresponding line cannot be parsed.
  
  Throws:
  
  NoSuchElementException - If the underlying BEACON dump has no more links.
  
  See Also:
  
  parseLine(String, BeaconMetaFields)
- remove
  
  public final void remove()
  
  BeaconParser provides read-only access to a BEACON dump, so Iterator.remove() is not supported.
  
  Specified by:
  
  remove in interface Iterator<Optional<BeaconLink>>
  
  Throws:
  
  UnsupportedOperationException
- parseLine
  
  public static Optional<BeaconLink> parseLine(String linkLine, BeaconMetaFields metaFields)
  
  Parses a BEACON link line and returns an Optional describing the corresponding BeaconLink, or Optional.empty() if the line cannot be parsed into a valid link.
  
  Parameters:
  
  linkLine - The BEACON link line to parse.
  
  metaFields - The BeaconMetaFields specifying link construction rules.
  
  Returns:
  
  An Optional describing the corresponding BeaconLink, or Optional.empty() if the line cannot be parsed into a valid link
  
  Throws:
  
  NullPointerException - If linkLine or metaFields is null.
  
  See Also:
  
  https://gbv.github.io/beaconspec/beacon.html#links, https://gbv.github.io/beaconspec/beacon.html#link-construction

Class BeaconParser

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Iterator

Constructor Details

BeaconParser

BeaconParser

Method Details

close

getLineNo

getLinkNo

getMetaFields

hasNext

next

remove

parseLine