biweekly.io.scribe.property

Class ICalPropertyScribe.DateWriter

java.lang.Object

biweekly.io.scribe.property.ICalPropertyScribe.DateWriter

Enclosing class:

ICalPropertyScribe<T extends ICalProperty>

protected static class ICalPropertyScribe.DateWriter
extends Object

Factory class for writing dates.

Constructor Summary

Constructors

Constructor and Description
ICalPropertyScribe.DateWriter(ICalDate date) Creates a new date writer object.

Method Summary

Methods

Modifier and Type	Method and Description
ICalPropertyScribe.DateWriter	extended(boolean extended) Sets whether to use extended format or basic.
ICalPropertyScribe.DateWriter	observance(boolean observance) Sets whether the property is within an observance or not.
ICalPropertyScribe.DateWriter	tz(boolean floating, TimeZone timezone) Sets the timezone.
ICalPropertyScribe.DateWriter	utc(boolean utc) Sets whether to write the value in UTC or not.
String	write() Creates the date string.

Methods inherited from class java.lang.Object

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

Constructor Detail

ICalPropertyScribe.DateWriter

public ICalPropertyScribe.DateWriter(ICalDate date)

Creates a new date writer object.

Parameters:

date - the date to format

Method Detail

observance

public ICalPropertyScribe.DateWriter observance(boolean observance)

Sets whether the property is within an observance or not.

Parameters:

observance - true if it's in an observance, false if not (defaults to false)

Returns:

this

utc

public ICalPropertyScribe.DateWriter utc(boolean utc)

Sets whether to write the value in UTC or not.

Parameters:

utc - true to write in UTC, false not to

Returns:

this

tz

public ICalPropertyScribe.DateWriter tz(boolean floating,
                               TimeZone timezone)

Sets the timezone.

Parameters:

floating - true to use floating time, false not to

timezone - the timezone

Returns:

this

extended

public ICalPropertyScribe.DateWriter extended(boolean extended)

Sets whether to use extended format or basic.

Parameters:

extended - true to use extended format, false to use basic (defaults to "false")

Returns:

this

write

public String write()

Creates the date string.

Returns:

the date string