Top Description Inners Fields Constructors Methods
net.fortuna.ical4j.model.property

public Class DtEnd<T extends Temporal>

extends DateProperty<T extends Temporal>
Class Inheritance
Imports
net.fortuna.ical4j.model.Content, .ParameterList, .PropertyFactory, java.time.temporal.Temporal

$Id$

Created: [Apr 6, 2004]

Defines a DTEND iCalendar component property.

    4.8.2.2 Date/Time End

       Property Name: DTEND

       Purpose: This property specifies the date and time that a calendar
       component ends.

       Value Type: The default value type is DATE-TIME. The value type can
       be set to a DATE value type.

       Property Parameters: Non-standard, value data type, time zone
       identifier property parameters can be specified on this property.

       Conformance: This property can be specified in "VEVENT" or
       "VFREEBUSY" calendar components.

       Description: Within the "VEVENT" calendar component, this property
       defines the date and time by which the event ends. The value MUST be
       later in time than the value of the "DTSTART" property.

       Within the "VFREEBUSY" calendar component, this property defines the
       end date and time for the free or busy time information. The time
       MUST be specified in the UTC time format. The value MUST be later in
       time than the value of the "DTSTART" property.

       Format Definition: The property is defined by the following notation:

         dtend      = "DTEND" dtendparam":" dtendval CRLF

         dtendparam = *(

                    ; the following are optional,
                    ; but MUST NOT occur more than once

                    (";" "VALUE" "=" ("DATE-TIME" / "DATE")) /
                    (";" tzidparam) /

                    ; the following is optional,
                    ; and MAY occur more than once

                    (";" xparam)

                    )



         dtendval   = date-time / date
         ;Value MUST match value type

Examples:

     // construct an end date from a start date and a duration..
     DtStart start = ...
     Dur oneWeek = new Dur("1W");
     DtEnd end = new DtEnd(oneWeek.getTime(start.getDate());
Author
Ben Fortuna

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
public
DtEnd()

Default constructor.

public
DtEnd(final String
the DTEND value string to parse
value
)

Creates a new instance initialised with the parsed value.

public
DtEnd(final ParameterList
a list of parameters for this component
aList
,
final String
a value string for this component
aValue
)

public
DtEnd(final T
a date
aDate
)

Constructor.

public
DtEnd(final T
the time of the DtEnd
time
,
final boolean
specifies whether time is UTC
utc
)
Deprecated UTC time is now specified via the generic type (i.e. java.time.Instant)

Constructs a new DtEnd with the specified time.

public
DtEnd(final ParameterList
a list of parameters for this component
aList
,
final T
a date
aDate
)

Constructor.

Method Summary

Modifier and TypeMethod and Description
protected PropertyFactory<DtEnd<T>>
newFactory()

Implements abstract net.fortuna.ical4j.model.Property.newFactory.

Returns a new property factory used to create deep copies.

Inherited from net.fortuna.ical4j.model.property.DateProperty:
compareTogetDategetValuehashCodeisUtcrefreshParameterssetDatesetDefaultTimeZonesetTimeZoneRegistrysetValuevalidate

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides net.fortuna.ical4j.model.property.DateProperty.serialVersionUID.

Constructor Detail

DtEndback to summary
public DtEnd()

Default constructor. The time value is initialised to the time of instantiation.

DtEndback to summary
public DtEnd(final String value)

Creates a new instance initialised with the parsed value.

Parameters
value:String

the DTEND value string to parse

DtEndback to summary
public DtEnd(final ParameterList aList, final String aValue)
Parameters
aList:ParameterList

a list of parameters for this component

aValue:String

a value string for this component

DtEndback to summary
public DtEnd(final T aDate)

Constructor. Date or Date-Time format is determined based on the presence of a VALUE parameter.

Parameters
aDate:T

a date

DtEndback to summary
public DtEnd(final T time, final boolean utc)

Deprecated

UTC time is now specified via the generic type (i.e. java.time.Instant)

Constructs a new DtEnd with the specified time.

Parameters
time:T

the time of the DtEnd

utc:boolean

specifies whether time is UTC

Annotations
@Deprecated
DtEndback to summary
public DtEnd(final ParameterList aList, final T aDate)

Constructor. Date or Date-Time format is determined based on the presence of a VALUE parameter.

Parameters
aList:ParameterList

a list of parameters for this component

aDate:T

a date

Method Detail

newFactoryback to summary
protected PropertyFactory<DtEnd<T>> newFactory()

Implements abstract net.fortuna.ical4j.model.Property.newFactory.

Doc from net.fortuna.ical4j.model.Property.newFactory.

Returns a new property factory used to create deep copies.

Returns:PropertyFactory<DtEnd<T>>

a property factory instance

Annotations
@Override
net.fortuna.ical4j.model.property back to summary

public Class DtEnd.Factory<T extends Temporal>

extends Factory
implements PropertyFactory<DtEnd<T extends Temporal>>
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.PropertyFactory, java.io.Serializable

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public DtEnd<T>
createProperty(final ParameterList
a list of property parameters
parameters
,
final String
a property value
value
)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

public DtEnd<T>
Inherited from net.fortuna.ical4j.model.Content.Factory:
supports

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

Factoryback to summary
public Factory()

Method Detail

createPropertyback to summary
public DtEnd<T> createProperty(final ParameterList parameters, final String value)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Parameters
parameters:ParameterList

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a list of property parameters

value:String

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a property value

Returns:DtEnd<T>

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override
createPropertyback to summary
public DtEnd<T> createProperty()

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Returns:DtEnd<T>

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override