- All Superinterfaces:
Prototype.Api
,Prototype.Factory<FixedRate>
,TaskConfig
- All Known Implementing Classes:
FixedRateConfig.BuilderBase.FixedRateConfigImpl
Interface generated from definition. Please add javadoc to the definition interface.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic class
Fluent API builder forFixedRate
.static class
FixedRateConfig.BuilderBase<BUILDER extends FixedRateConfig.BuilderBase<BUILDER,
PROTOTYPE>, PROTOTYPE extends FixedRateConfig> Fluent API builder base forFixedRate
. -
Method Summary
Modifier and TypeMethodDescriptionstatic FixedRateConfig.Builder
builder()
Create a new fluent API builder to customize configuration.static FixedRateConfig.Builder
builder
(FixedRateConfig instance) Create a new fluent API builder from an existing instance.static FixedRateConfig
Deprecated.static FixedRateConfig
Create a new instance from configuration.long
delay()
Deprecated.useinterval()
insteaddelayBy()
Initial delay of the first invocation.Configure whether the interval between the invocations should be calculated from the time when previous task started or ended.long
Deprecated.usedelayBy()
insteadinterval()
Fixed interval between each invocation.task()
Task to be scheduled for execution.timeUnit()
Deprecated.as duration is used for new options, this option is not neededMethods inherited from interface io.helidon.builder.api.Prototype.Factory
build
Methods inherited from interface io.helidon.scheduling.TaskConfig
executor, id, taskManager
-
Method Details
-
builder
Create a new fluent API builder to customize configuration.- Returns:
- a new builder
-
builder
Create a new fluent API builder from an existing instance.- Parameters:
instance
- an existing instance used as a base for the builder- Returns:
- a builder based on an instance
-
create
Create a new instance from configuration.- Parameters:
config
- used to configure the new instance- Returns:
- a new instance configured from configuration
-
create
Deprecated.Create a new instance from configuration.- Parameters:
config
- used to configure the new instance- Returns:
- a new instance configured from configuration
-
initialDelay
long initialDelay()Deprecated.usedelayBy()
insteadInitial delay of the first invocation. Time unit is by defaultTimeUnit.SECONDS
, can be specified withtimeUnit()
.- Returns:
- initial delay value
-
delay
long delay()Deprecated.useinterval()
insteadFixed rate delay between each invocation. Time unit is by defaultTimeUnit.SECONDS
, can be specified withFixedRateConfig.BuilderBase.timeUnit(java.util.concurrent.TimeUnit)
.- Returns:
- delay between each invocation
-
timeUnit
TimeUnit timeUnit()Deprecated.as duration is used for new options, this option is not neededTimeUnit
used for interpretation of values provided withFixedRateConfig.BuilderBase.delay(long)
andFixedRateConfig.BuilderBase.initialDelay(long)
.- Returns:
- time unit for interpreting values
in
FixedRateConfig.BuilderBase.delay(long)
andFixedRateConfig.BuilderBase.initialDelay(long)
-
delayBy
Duration delayBy()Initial delay of the first invocation.- Returns:
- initial delay duration
-
interval
Duration interval()Fixed interval between each invocation.- Returns:
- interval between each invocation
-
delayType
FixedRate.DelayType delayType()Configure whether the interval between the invocations should be calculated from the time when previous task started or ended. Delay type is by defaultFixedRate.DelayType.SINCE_PREVIOUS_START
.- Returns:
- delay type
-
task
ScheduledConsumer<FixedRateInvocation> task()Task to be scheduled for execution.- Returns:
- scheduled for execution
-
create(io.helidon.config.Config)