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:

1.0 specs, RFC 2445, RFC 5545

Constructor Summary

Constructors

Constructor and Description
ICalRawWriter(Writer writer, ICalVersion version)

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, only applies to version 2.0).
void	setCaretEncodingEnabled(boolean enable) Sets whether the writer will apply circumflex accent encoding on parameter values (disabled by default, only applies to version 2.0).
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.
void	writeEndComponent(String componentName) Writes a property marking the end of a component.
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, setting its value to iCalendar version that this 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)

Parameters:

writer - the writer to wrap

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, only applies to version 2.0). This escaping mechanism allows for newlines and double quotes to be included in parameter values.

Note that this encoding mechanism is defined separately from the iCalendar specification and may not be supported by the iCalendar consumer.

Characters encoded by circumflex accent encoding

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

Example:

 GEO;X-ADDRESS="Pittsburgh Pirates^n115 Federal St^nPittsburgh, 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, only applies to version 2.0). This escaping mechanism allows for newlines and double quotes to be included in parameter values.

Note that this encoding mechanism is defined separately from the iCalendar specification and may not be supported by the iCalendar consumer.

Characters encoded by circumflex accent encoding

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

Example:

 GEO;X-ADDRESS="Pittsburgh Pirates^n115 Federal St^nPittsburgh, 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.

Parameters:

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

Throws:

IOException - if there's a problem writing to the data stream

writeEndComponent

public void writeEndComponent(String componentName)
                       throws IOException

Writes a property marking the end of a component.

Parameters:

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

Throws:

IOException - if there's a problem writing to the data stream

writeVersion

public void writeVersion()
                  throws IOException

Writes a "VERSION" property, setting its value to iCalendar version that this writer is adhering to.

Throws:

IOException - if there's a problem writing to the data stream

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. "SUMMARY")

value - the property value

Throws:

IllegalArgumentException - if the property data contains one or more characters which break the iCalendar syntax and which cannot be escaped or encoded

IOException - if there's a problem writing to the data stream

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. "SUMMARY")

parameters - the property parameters

value - the property value

Throws:

IllegalArgumentException - if the property data contains one or more characters which break the iCalendar syntax and which cannot be escaped or encoded

IOException - if there's a problem writing to the data stream

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 - if there's a problem closing the writer