biweekly.property

Class Daylight

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.Daylight

public class Daylight
extends ICalProperty

Represents daylight savings time information.

Author:

Michael Angstadt

See Also:

vCal 1.0 p.23

Field Summary

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
Daylight() Creates a daylight savings property which states that the timezone does not observe daylight savings time.
Daylight(boolean daylight, UtcOffset offset, ICalDate start, ICalDate end, String standardName, String daylightName) Creates a daylight savings property.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDaylightName() Gets the name of daylight savings time.
ICalDate	getEnd() Gets the end date of daylight savings time.
UtcOffset	getOffset() Gets the UTC offset of daylight savings time.
String	getStandardName() Gets the name for standard time.
ICalDate	getStart() Gets the start date of dayight savings time.
boolean	isDaylight() Gets whether this timezone observes daylight savings time.
void	setDaylight(boolean daylight) Sets whether this timezone observes daylight savings time.
void	setDaylightName(String name) Sets the name of daylight savings time.
void	setEnd(ICalDate end) Sets the end date of daylight savings time.
void	setOffset(UtcOffset offset) Sets the UTC offset of daylight savings time.
void	setStandardName(String name) Sets the name for standard time.
void	setStart(ICalDate start) Sets the start date of dayight savings time.
protected void	validate(List<ICalComponent> components, ICalVersion version, List<Warning> warnings) Checks the property for data consistency problems or deviations from the spec.

Methods inherited from class biweekly.property.ICalProperty

addParameter, getParameter, getParameters, getParameters, removeParameter, setParameter, setParameter, setParameters, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Daylight

public Daylight()

Creates a daylight savings property which states that the timezone does not observe daylight savings time.

Daylight

public Daylight(boolean daylight,
        UtcOffset offset,
        ICalDate start,
        ICalDate end,
        String standardName,
        String daylightName)

Creates a daylight savings property.

Parameters:

daylight - true if the timezone observes daylight savings time, false if not

offset - the UTC offset of daylight savings time

start - the start date of daylight savings time

end - the end date of daylight savings time

standardName - the timezone's name for standard time (e.g. "EST")

daylightName - the timezone's name for daylight savings time (e.g. "EDT")

Method Detail

isDaylight

public boolean isDaylight()

Gets whether this timezone observes daylight savings time.

Returns:

true if it observes daylight savings time, false if not

setDaylight

public void setDaylight(boolean daylight)

Sets whether this timezone observes daylight savings time.

Parameters:

daylight - true if it observes daylight savings time, false if not

getOffset

public UtcOffset getOffset()

Gets the UTC offset of daylight savings time.

Returns:

the UTC offset

setOffset

public void setOffset(UtcOffset offset)

Sets the UTC offset of daylight savings time.

Parameters:

offset - the UTC offset

getStart

public ICalDate getStart()

Gets the start date of dayight savings time.

Returns:

the start date

setStart

public void setStart(ICalDate start)

Sets the start date of dayight savings time.

Parameters:

start - the start date

getEnd

public ICalDate getEnd()

Gets the end date of daylight savings time.

Returns:

the end date

setEnd

public void setEnd(ICalDate end)

Sets the end date of daylight savings time.

Parameters:

end - the end date

getStandardName

public String getStandardName()

Gets the name for standard time.

Returns:

the name (e.g. "EST")

setStandardName

public void setStandardName(String name)

Sets the name for standard time.

Parameters:

name - the name (e.g. "EST")

getDaylightName

public String getDaylightName()

Gets the name of daylight savings time.

Returns:

the name (e.g. "EDT")

setDaylightName

public void setDaylightName(String name)

Sets the name of daylight savings time.

Parameters:

name - the name (e.g. "EDT")

validate

protected void validate(List<ICalComponent> components,
            ICalVersion version,
            List<Warning> warnings)

Description copied from class: ICalProperty

Checks the property for data consistency problems or deviations from the spec.

This method should be overridden by child classes that wish to provide validation logic. The default implementation of this method does nothing.

Overrides:

validate in class ICalProperty

Parameters:

components - the hierarchy of components that the property belongs to

version - the version to validate against

warnings - the list to add the warnings to