Class QuartzEndpoint.TriggerDescriptor

java.lang.Object

org.springframework.boot.quartz.actuate.endpoint.QuartzEndpoint.TriggerDescriptor

Direct Known Subclasses:

QuartzEndpoint.CalendarIntervalTriggerDescriptor, QuartzEndpoint.CronTriggerDescriptor, QuartzEndpoint.CustomTriggerDescriptor, QuartzEndpoint.DailyTimeIntervalTriggerDescriptor, QuartzEndpoint.SimpleTriggerDescriptor

Enclosing class:

QuartzEndpoint

public abstract static class QuartzEndpoint.TriggerDescriptor
extends Object

Base class for descriptions of a Trigger.

Since:

4.0.0

Author:

Vedran Pavic, Stephane Nicoll

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TriggerDescriptor(Trigger trigger, org.springframework.boot.quartz.actuate.endpoint.QuartzEndpoint.TriggerType type)

Method Summary

Modifier and Type	Method	Description
protected abstract void	appendDetails(Map<String,Object> content)	Append trigger-implementation specific details to the specified content.
protected abstract void	appendSummary(Map<String,Object> content)	Append trigger-implementation specific summary items to the specified content.
Map<String,Object>	buildDetails(Trigger.TriggerState triggerState, @Nullable Map<String,Object> sanitizedDataMap)	Build the full details of the trigger.
Map<String,Object>	buildSummary(boolean addTriggerSpecificSummary)	Build the summary of the trigger.
protected Trigger	getTrigger()
protected org.springframework.boot.quartz.actuate.endpoint.QuartzEndpoint.TriggerType	getType()
protected void	putIfNoNull(Map<String,Object> content, String key, @Nullable Object value)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TriggerDescriptor

protected TriggerDescriptor(Trigger trigger,
 org.springframework.boot.quartz.actuate.endpoint.QuartzEndpoint.TriggerType type)

Method Details

buildSummary

public Map<String,Object> buildSummary(boolean addTriggerSpecificSummary)

Build the summary of the trigger.

Parameters:

addTriggerSpecificSummary - whether to add trigger-implementation specific summary.

Returns:

basic properties of the trigger

appendSummary

protected abstract void appendSummary(Map<String,Object> content)

Append trigger-implementation specific summary items to the specified content.

Parameters:

content - the summary of the trigger

buildDetails

public Map<String,Object> buildDetails(Trigger.TriggerState triggerState,
 @Nullable Map<String,Object> sanitizedDataMap)

Build the full details of the trigger.

Parameters:

triggerState - the current state of the trigger

sanitizedDataMap - a sanitized data map or null

Returns:

all properties of the trigger

appendDetails

protected abstract void appendDetails(Map<String,Object> content)

Append trigger-implementation specific details to the specified content.

Parameters:

content - the details of the trigger

putIfNoNull

protected void putIfNoNull(Map<String,Object> content,
 String key,
 @Nullable Object value)

getTrigger

protected Trigger getTrigger()

getType

protected org.springframework.boot.quartz.actuate.endpoint.QuartzEndpoint.TriggerType getType()