biweekly.io.text

Class ICalRawWriter

java.lang.Object

biweekly.io.text.ICalRawWriter

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class ICalRawWriter
extends Object
implements Closeable, Flushable

Writes data to an iCalendar data stream.

Author:

Michael Angstadt

See Also:

RFC 5545

Constructor Summary

Constructors

Constructor and Description
ICalRawWriter(Writer writer, ICalVersion version) Creates an iCalendar raw writer.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the underlying Writer object.
void	flush() Flushes the underlying Writer object.
FoldedLineWriter	getFoldedLineWriter() Gets the writer that this object wraps.
ICalVersion	getVersion() Gets the iCalendar version that the writer is adhering to.
boolean	isCaretEncodingEnabled() Gets whether the writer will apply circumflex accent encoding on parameter values (disabled by default).
void	setCaretEncodingEnabled(boolean enable) Sets whether the writer will apply circumflex accent encoding on parameter values (disabled by default).
void	setVersion(ICalVersion version) Sets the iCalendar version that the writer should adhere to.
void	writeBeginComponent(String componentName) Writes a property marking the beginning of a component (in other words, writes a "BEGIN:NAME" property).
void	writeEndComponent(String componentName) Writes a property marking the end of a component (in other words, writes a "END:NAME" property).
void	writeProperty(String propertyName, ICalParameters parameters, String value) Writes a property to the iCalendar data stream.
void	writeProperty(String propertyName, String value) Writes a property to the iCalendar data stream.
void	writeVersion() Writes a "VERSION" property, based on the iCalendar version that the writer is adhering to.

Methods inherited from class java.lang.Object

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

Constructor Detail

ICalRawWriter

public ICalRawWriter(Writer writer,
             ICalVersion version)

Creates an iCalendar raw writer.

Parameters:

writer - the writer to the data stream

version - the version to adhere to

Method Detail

getFoldedLineWriter

public FoldedLineWriter getFoldedLineWriter()

Gets the writer that this object wraps.

Returns:

the folded line writer

isCaretEncodingEnabled

public boolean isCaretEncodingEnabled()

Gets whether the writer will apply circumflex accent encoding on parameter values (disabled by default). This escaping mechanism allows for newlines and double quotes to be included in parameter values.

When disabled, the writer will replace newlines with spaces and double quotes with single quotes.

Character	Replacement (when disabled)	Replacement (when enabled)
"	'	^'
newline	space	^n
^	^	^^

Example:

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

Returns:

true if circumflex accent encoding is enabled, false if not

See Also:

RFC 6868

setCaretEncodingEnabled

public void setCaretEncodingEnabled(boolean enable)

Sets whether the writer will apply circumflex accent encoding on parameter values (disabled by default). This escaping mechanism allows for newlines and double quotes to be included in parameter values.

When disabled, the writer will replace newlines with spaces and double quotes with single quotes.

Character	Replacement (when disabled)	Replacement (when enabled)
"	'	^'
newline	space	^n
^	^	^^

Example:

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

Parameters:

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

See Also:

RFC 6868

getVersion

public ICalVersion getVersion()

Gets the iCalendar version that the writer is adhering to.

Returns:

the version

setVersion

public void setVersion(ICalVersion version)

Sets the iCalendar version that the writer should adhere to.

Parameters:

version - the version

writeBeginComponent

public void writeBeginComponent(String componentName)
                         throws IOException

Writes a property marking the beginning of a component (in other words, writes a "BEGIN:NAME" property).

Parameters:

componentName - the component name (e.g. "VEVENT")

Throws:

IOException - if there's an I/O problem

writeEndComponent

public void writeEndComponent(String componentName)
                       throws IOException

Writes a property marking the end of a component (in other words, writes a "END:NAME" property).

Parameters:

componentName - the component name (e.g. "VEVENT")

Throws:

IOException - if there's an I/O problem

writeVersion

public void writeVersion()
                  throws IOException

Writes a "VERSION" property, based on the iCalendar version that the writer is adhering to.

Throws:

IOException - if there's an I/O problem

writeProperty

public void writeProperty(String propertyName,
                 String value)
                   throws IOException

Writes a property to the iCalendar data stream.

Parameters:

propertyName - the property name (e.g. "VERSION")

value - the property value (e.g. "2.0")

Throws:

IllegalArgumentException - if the property name contains invalid characters

IOException - if there's an I/O problem

writeProperty

public void writeProperty(String propertyName,
                 ICalParameters parameters,
                 String value)
                   throws IOException

Writes a property to the iCalendar data stream.

Parameters:

propertyName - the property name (e.g. "VERSION")

parameters - the property parameters

value - the property value (e.g. "2.0")

Throws:

IllegalArgumentException - if the property name contains invalid characters

IOException - if there's an I/O problem

flush

public void flush()
           throws IOException

Flushes the underlying Writer object.

Specified by:

flush in interface Flushable

Throws:

IOException - if there's a problem flushing the writer

close

public void close()
           throws IOException

Closes the underlying Writer object.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException