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.
Daylight(Daylight original) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Daylight	copy() Creates a copy of this property object.
boolean	equals(Object obj)
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.
int	hashCode()
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 Map<String,Object>	toStringValues() Gets string representations of the class's fields for the ICalProperty.toString() method.
protected void	validate(List<ICalComponent> components, ICalVersion version, List<ValidationWarning> warnings) Checks the property for data consistency problems or deviations from the specifications.

Methods inherited from class biweekly.property.ICalProperty

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, 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")

Daylight

public Daylight(Daylight original)

Copy constructor.

Parameters:

original - the property to make a copy of

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<ValidationWarning> warnings)

Description copied from class: ICalProperty

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

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

toStringValues

protected Map<String,Object> toStringValues()

Description copied from class: ICalProperty

Gets string representations of the class's fields for the ICalProperty.toString() method.

Meant to be overridden by child classes. The default implementation returns an empty map.

Overrides:

toStringValues in class ICalProperty

Returns:

the values of the class's fields (key = field name, value = field value)

copy

public Daylight copy()

Description copied from class: ICalProperty

Creates a copy of this property object.

The default implementation of this method uses reflection to look for a copy constructor. Child classes SHOULD override this method to avoid the performance overhead involved in using reflection.

The child class's copy constructor, if present, MUST invoke the ICalProperty.ICalProperty(ICalProperty) super constructor to ensure that the parameters are also copied.

This method MUST be overridden by the child class if the child class does not have a copy constructor. Otherwise, an UnsupportedOperationException will be thrown when an attempt is made to copy the property (such as in the ICalendar class's copy constructor ).

Overrides:

copy in class ICalProperty

Returns:

the copy

hashCode

public int hashCode()

Overrides:

hashCode in class ICalProperty

equals

public boolean equals(Object obj)

Overrides:

equals in class ICalProperty