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

public Class Due<T extends Temporal>

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

$Id$

Created: [Apr 6, 2004]

Defines a DUE iCalendar component property.

    4.8.2.3 Date/Time Due

       Property Name: DUE

       Purpose: This property defines the date and time that a to-do is
       expected to be completed.

       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: The property can be specified once in a "VTODO" calendar
       component.

       Description: The value MUST be a date/time equal to or after the
       DTSTART value, if specified.

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

         due        = "DUE" dueparam":" dueval CRLF

         dueparam   = *(
                    ; 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)

                    )



         dueval     = date-time / date
         ;Value MUST match value type
Author
Ben Fortuna

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
Due.Factory<T extends Temporal>

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
public
Due(final String
the DUE value string to parse
value
)

Creates a new instance initialised with the parsed value.

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

public
Due(final T
a date
aDate
)

Constructor.

public
Due(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<Due<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

Dueback to summary
public Due(final String value)

Creates a new instance initialised with the parsed value.

Parameters
value:String

the DUE value string to parse

Exceptions
DateTimeParseException:
where the specified string is not a valid DUE value representation
Dueback to summary
public Due(final ParameterList aList, final String aValue)
Parameters
aList:ParameterList

a list of parameters for this component

aValue:String

a value string for this component

Exceptions
DateTimeParseException:
when the specified string is not a valid date/date-time representation
Dueback to summary
public Due(final T aDate)

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

Parameters
aDate:T

a date

Dueback to summary
public Due(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<Due<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<Due<T>>

a property factory instance

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

public Class Due.Factory<T extends Temporal>

extends Factory
implements PropertyFactory<Due<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 Due<T>
createProperty(final ParameterList
a list of property parameters
parameters
,
final String
a property value
value
)

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

public Due<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 Due<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:Due<T>

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

a new instance of the specified property

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

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

Returns:Due<T>

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

a new instance of the specified property

Annotations
@Override