biweekly.io.text

Class ICalRawReader

java.lang.Object

biweekly.io.text.ICalRawReader

All Implemented Interfaces:

Closeable, AutoCloseable

public class ICalRawReader
extends Object
implements Closeable

Parses an iCalendar data stream.

Author:

Michael Angstadt

See Also:

RFC 5545

Constructor Summary

Constructors

Constructor and Description
ICalRawReader(Reader reader) Creates a new reader.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the underlying Reader object.
Charset	getEncoding() Gets the character encoding of the reader.
int	getLineNum() Gets the line number of the last line that was read.
ICalVersion	getVersion() Gets the iCalendar version that the reader is currently parsing with.
boolean	isCaretDecodingEnabled() Gets whether the reader will decode parameter values that use circumflex accent encoding (enabled by default).
ICalRawLine	readLine() Parses the next line of the iCalendar file.
void	setCaretDecodingEnabled(boolean enable) Sets whether the reader will decode parameter values that use circumflex accent encoding (enabled by default).

Methods inherited from class java.lang.Object

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

Constructor Detail

ICalRawReader

public ICalRawReader(Reader reader)

Creates a new reader.

Parameters:

reader - the reader to the data stream

Method Detail

getLineNum

public int getLineNum()

Gets the line number of the last line that was read.

Returns:

the line number

getVersion

public ICalVersion getVersion()

Gets the iCalendar version that the reader is currently parsing with.

Returns:

the iCalendar version or null if unknown

readLine

public ICalRawLine readLine()
                     throws IOException

Parses the next line of the iCalendar file.

Returns:

the next line or null if there are no more lines

Throws:

ICalParseException - if a line cannot be parsed

IOException - if there's a problem reading from the input stream

isCaretDecodingEnabled

public boolean isCaretDecodingEnabled()

Gets whether the reader will decode parameter values that use circumflex accent encoding (enabled by default). This escaping mechanism allows newlines and double quotes to be included in parameter values.

Raw Character	Encoded Character
"	^'
newline	^n
^	^^

Example:

 GEO;X-ADDRESS="Pittsburgh Pirates^n115 Federal St^nPitt
  sburgh, PA 15212":40.446816;80.00566
 

Returns:

true if circumflex accent decoding is enabled, false if not

See Also:

RFC 6868

setCaretDecodingEnabled

public void setCaretDecodingEnabled(boolean enable)

Sets whether the reader will decode parameter values that use circumflex accent encoding (enabled by default). This escaping mechanism allows newlines and double quotes to be included in parameter values.

Raw Character	Encoded Character
"	^'
newline	^n
^	^^

Example:

 GEO;X-ADDRESS="Pittsburgh Pirates^n115 Federal St^nPitt
  sburgh, PA 15212":geo:40.446816,-80.00566
 

Parameters:

enable - true to use circumflex accent decoding, false not to

See Also:

RFC 6868

getEncoding

public Charset getEncoding()

Gets the character encoding of the reader.

Returns:

the character encoding or null if none is defined

close

public void close()
           throws IOException

Closes the underlying Reader object.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException