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

public Class Completed

extends DateProperty<Instant>
implements UtcProperty
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.property.UtcProperty
Imports
net.fortuna.ical4j.model.*, net.fortuna.ical4j.model.parameter.Value, java.time.Instant, .ZoneId

$Id$

Created: [Apr 6, 2004]

Defines a COMPLETED iCalendar component property.

    4.8.2.1 Date/Time Completed

       Property Name: COMPLETED

       Purpose: This property defines the date and time that a to-do was
       actually completed.

       Value Type: DATE-TIME

       Property Parameters: Non-standard property parameters can be
       specified on this property.

       Conformance: The property can be specified in a "VTODO" calendar
       component.

       Description: The date and time MUST be in a UTC format.

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

         completed  = "COMPLETED" compparam ":" date-time CRLF

         compparam  = *(";" xparam)
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
Completed()

Default constructor.

public
Completed(final String
a value string for this component
aValue
)

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

public
Completed(final Instant
a date
aDate
)

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

Method Summary

Modifier and TypeMethod and Description
protected PropertyFactory<Completed>
newFactory()

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

Returns a new property factory used to create deep copies.

public void
setDefaultTimeZone(ZoneId
a timezone identifier
defaultTimeZone
)

Overrides net.fortuna.ical4j.model.property.DateProperty.setDefaultTimeZone.

Overrides default net.fortuna.ical4j.model.property.UtcProperty.setDefaultTimeZone.

A default timezone may be specified for interpreting floating DATE-TIME values.

public void
Inherited from net.fortuna.ical4j.model.property.DateProperty:
compareTogetDategetValuehashCodeisUtcrefreshParameterssetDatesetValuevalidate

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

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

Constructor Detail

Completedback to summary
public Completed()

Default constructor.

Completedback to summary
public Completed(final String aValue)
Parameters
aValue:String

a value string for this component

Completedback to summary
public Completed(final ParameterList aList, final String aValue)
Parameters
aList:ParameterList

a list of parameters for this component

aValue:String

a value string for this component

Completedback to summary
public Completed(final Instant aDate)
Parameters
aDate:Instant

a date

Completedback to summary
public Completed(final ParameterList aList, final Instant aDate)
Parameters
aList:ParameterList

a list of parameters for this component

aDate:Instant

a date

Method Detail

newFactoryback to summary
protected PropertyFactory<Completed> 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<Completed>

a property factory instance

Annotations
@Override
setDefaultTimeZoneback to summary
public void setDefaultTimeZone(ZoneId defaultTimeZone)

Overrides net.fortuna.ical4j.model.property.DateProperty.setDefaultTimeZone.

Overrides default net.fortuna.ical4j.model.property.UtcProperty.setDefaultTimeZone.

Doc from net.fortuna.ical4j.model.property.DateProperty.setDefaultTimeZone.

A default timezone may be specified for interpreting floating DATE-TIME values. In the absence of a default timezone the system default timezone will be used.

Parameters
defaultTimeZone:ZoneId

a timezone identifier

Annotations
@Override
setTimeZoneRegistryback to summary
public void setTimeZoneRegistry(TimeZoneRegistry timeZoneRegistry)

Overrides net.fortuna.ical4j.model.property.DateProperty.setTimeZoneRegistry.

Overrides default net.fortuna.ical4j.model.property.UtcProperty.setTimeZoneRegistry.

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

public Class Completed.Factory

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

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

public Completed
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 Completed 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:Completed

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

a new instance of the specified property

Annotations
@Override
createPropertyback to summary
public Completed createProperty()

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

Returns:Completed

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

a new instance of the specified property

Annotations
@Override