biweekly
Class Biweekly.ParserChainTextString

java.lang.Object
  biweekly.Biweekly.ParserChainTextString

Enclosing class:

Biweekly

public static class Biweekly.ParserChainTextString
extends Object

Chainer class for parsing plain text iCalendar strings.

See Also:

Biweekly.parse(String)

Method Summary

List<ICalendar>	all() Reads all iCalendar objects from the data stream.
Biweekly.ParserChainTextString	caretDecoding(boolean enable) Sets whether the reader will decode parameter values that use circumflex accent encoding (enabled by default).
ICalendar	first() Reads the first iCalendar object from the data stream.
Biweekly.ParserChainTextString	register(ICalComponentMarshaller<? extends ICalComponent> marshaller) Registers a component marshaller.
Biweekly.ParserChainTextString	register(ICalPropertyMarshaller<? extends ICalProperty> marshaller) Registers a property marshaller.
Biweekly.ParserChainTextString	warnings(List<List<String>> warnings) Provides a list for putting the parser warnings into.

Methods inherited from class java.lang.Object

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

Method Detail

register

public Biweekly.ParserChainTextString register(ICalPropertyMarshaller<? extends ICalProperty> marshaller)

Registers a property marshaller.

Parameters:

marshaller - the marshaller

Returns:

this

register

public Biweekly.ParserChainTextString register(ICalComponentMarshaller<? extends ICalComponent> marshaller)

Registers a component marshaller.

Parameters:

marshaller - the marshaller

Returns:

this

warnings

public Biweekly.ParserChainTextString warnings(List<List<String>> warnings)

Provides a list for putting the parser warnings into.

Parameters:

warnings - the list object to populate (it is a "list of lists"--each parsed ICalendar object has its own warnings list)

Returns:

this

caretDecoding

public Biweekly.ParserChainTextString caretDecoding(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.

Parameters:

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

Returns:

this

See Also:

ICalRawReader.setCaretDecodingEnabled(boolean)

first

public ICalendar first()

Reads the first iCalendar object from the data stream.

Returns:

the first iCalendar object or null if there are none

all

public List<ICalendar> all()

Reads all iCalendar objects from the data stream.

Returns:

the parsed iCalendar objects