Package net.fortuna.ical4j.model.property

Class TzOffsetFrom

java.lang.Object

net.fortuna.ical4j.model.Content

net.fortuna.ical4j.model.Property

net.fortuna.ical4j.model.property.TzOffsetFrom

All Implemented Interfaces:

Serializable, Comparable<Property>, FluentProperty

public class TzOffsetFrom
extends Property

$Id$

Created: [Apr 6, 2004]

Defines a TZOFFSETFROM iCalendar component property.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TzOffsetFrom.Factory

Field Summary

Fields inherited from class net.fortuna.ical4j.model.Property

ACKNOWLEDGED, ACTION, ATTACH, ATTENDEE, BUSYTYPE, CALENDAR_ADDRESS, CALSCALE, CATEGORIES, CLASS, COMMENT, COMPLETED, CONTACT, COUNTRY, CREATED, DESCRIPTION, DTEND, DTSTAMP, DTSTART, DUE, DURATION, EXDATE, EXPERIMENTAL_PREFIX, EXRULE, EXTENDED_ADDRESS, FREEBUSY, GEO, LAST_MODIFIED, LOCALITY, LOCATION, LOCATION_TYPE, METHOD, NAME, ORGANIZER, PARTICIPANT_TYPE, PERCENT_COMPLETE, POSTALCODE, PRIORITY, PRODID, PROXIMITY, RDATE, RECURRENCE_ID, REGION, RELATED_TO, REPEAT, REQUEST_STATUS, RESOURCE_TYPE, RESOURCES, RRULE, SEQUENCE, STATUS, STREET_ADDRESS, STRUCTURED_DATA, STYLED_DESCRIPTION, SUMMARY, TEL, TRANSP, TRIGGER, TZID, TZID_ALIAS_OF, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZUNTIL, TZURL, UID, URL, VERSION, XML

Constructor Summary

Constructors

Constructor	Description
TzOffsetFrom()	Default constructor.
TzOffsetFrom(String aValue)
TzOffsetFrom(ZoneOffset anOffset)
TzOffsetFrom(ParameterList aList, String aValue)
TzOffsetFrom(ParameterList aList, ZoneOffset anOffset)
TzOffsetFrom(ParameterList aList, UtcOffset anOffset)	Deprecated.
TzOffsetFrom(UtcOffset anOffset)	Deprecated.

Method Summary

Modifier and Type	Method	Description
final ZoneOffset	getOffset()
final String	getValue()
final void	setOffset(ZoneOffset offset)
final void	setValue(String aValue)	Sets the current value of the property.
ValidationResult	validate()	Perform validation on a property.

Methods inherited from class net.fortuna.ical4j.model.Property

compareTo, copy, equals, getFluentTarget, getName, getParameter, getParameters, getParameters, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.fortuna.ical4j.model.FluentProperty

withParameter

Constructor Details

TzOffsetFrom

public TzOffsetFrom()

Default constructor.

TzOffsetFrom

public TzOffsetFrom(String aValue)

Parameters:

aValue - a value string for this component

TzOffsetFrom

public TzOffsetFrom(ParameterList aList,
 String aValue)

Parameters:

aList - a list of parameters for this component

aValue - a value string for this component

TzOffsetFrom

@Deprecated
public TzOffsetFrom(UtcOffset anOffset)

Deprecated.

Parameters:

anOffset - a timezone offset in milliseconds

TzOffsetFrom

public TzOffsetFrom(ZoneOffset anOffset)

Parameters:

anOffset - a timezone offset in milliseconds

TzOffsetFrom

@Deprecated
public TzOffsetFrom(ParameterList aList,
 UtcOffset anOffset)

Deprecated.

Parameters:

aList - a list of parameters for this component

anOffset - a timezone offset in milliseconds

TzOffsetFrom

public TzOffsetFrom(ParameterList aList,
 ZoneOffset anOffset)

Parameters:

aList - a list of parameters for this component

anOffset - a timezone offset in milliseconds

Method Details

getOffset

public final ZoneOffset getOffset()

Returns:

Returns the offset.

setValue

public final void setValue(String aValue)

Sets the current value of the property.

Specified by:

setValue in class Property

Parameters:

aValue - a string representation of the property value

getValue

public final String getValue()

Specified by:

getValue in class Content

Returns:

the content value

setOffset

public final void setOffset(ZoneOffset offset)

Parameters:

offset - The offset to set.

validate

public ValidationResult validate()
                          throws ValidationException

Description copied from class: Property

Perform validation on a property.

Specified by:

validate in class Property

Throws:

ValidationException - where the property is not in a valid state