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

public Class Gap

extends Parameter
Class Inheritance
Imports
net.fortuna.ical4j.model.Content, .Parameter, .ParameterFactory, .TemporalAmountAdapter, java.time.temporal.TemporalAmount

    Purpose:
    This property specifies the length of the gap, positive or negative, between two components with a temporal relationship.
Format Definition:

    This parameter is defined by the following notation, where dur-value is defined in Section 3.3.6 of [RFC5545]. :

  gapparam      = "GAP" "=" dur-value

Description:

    This parameter MAY be specified on the RELATED-TO property and defines the duration of time between the predecessor and successor in an interval. When positive, it defines the lag time between a task and its logical successor. When negative, it defines the lead time.
See Also
rfc9253

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
private final TemporalAmountAdapter
private static final String
Inherited from net.fortuna.ical4j.model.Parameter:
ABBREVALTREPCNCUTYPEDELEGATED_FROMDELEGATED_TODERIVEDDIRDISPLAYEMAILENCODINGEXPERIMENTAL_PREFIXFBTYPEFEATUREFMTTYPELABELLANGUAGEMEMBERORDERPARTSTATRANGERELATEDRELTYPEROLERSVPSCHEDULE_AGENTSCHEDULE_STATUSSCHEMASENT_BYTYPETZIDVALUEVVENUE

Constructor Summary

AccessConstructor and Description
public
Gap(String value)

public
Gap(TemporalAmount temporalAmount)

Method Summary

Modifier and TypeMethod and Description
public TemporalAmountAdapter
public String
Inherited from net.fortuna.ical4j.model.Parameter:
compareToequalsgetNamehashCodetoString

Field Detail

durationback to summary
private final TemporalAmountAdapter duration
PARAM_NAMEback to summary
private static final String PARAM_NAME

Constructor Detail

Gapback to summary
public Gap(String value)
Gapback to summary
public Gap(TemporalAmount temporalAmount)

Method Detail

getDurationback to summary
public TemporalAmountAdapter getDuration()
getValueback to summary
public String getValue()

Implements abstract net.fortuna.ical4j.model.Content.getValue.

Returns:String

Doc from net.fortuna.ical4j.model.Content.getValue.

the content value

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

public Class Gap.Factory

extends Factory
implements ParameterFactory<Gap>
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.ParameterFactory, java.io.Serializable

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Gap
createParameter(String
a value to assign to the returned parameter
value
)

Implements net.fortuna.ical4j.model.ParameterFactory.createParameter.

Returns a parameter instance of the appropriate type with the specified value.

Inherited from net.fortuna.ical4j.model.Content.Factory:
supports

Constructor Detail

Factoryback to summary
public Factory()

Method Detail

createParameterback to summary
public Gap createParameter(String value)

Implements net.fortuna.ical4j.model.ParameterFactory.createParameter.

Doc from net.fortuna.ical4j.model.ParameterFactory.createParameter.

Returns a parameter instance of the appropriate type with the specified value.

Parameters
value:String

a value to assign to the returned parameter

Returns:Gap

a parameter instance, or null if this factory is unable to create an appropriate parameter

Annotations
@Override