Top Description Fields Constructors Methods
org.springframework.scheduling.config

public Class ScheduledTasksBeanDefinitionParser

extends AbstractSingleBeanDefinitionParser
Class Inheritance
Imports
org.w3c.dom.Element, .Node, .NodeList, org.springframework.beans.factory.config.RuntimeBeanReference, org.springframework.beans.factory.parsing.BeanComponentDefinition, org.springframework.beans.factory.support.BeanDefinitionBuilder, .ManagedList, org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser, .ParserContext, org.springframework.util.StringUtils
Parser for the 'scheduled-tasks' element of the scheduling namespace.
Authors
Mark Fisher, Chris Beams
Since
3.0

Field Summary

Modifier and TypeField and Description
private static final String
ELEMENT_SCHEDULED

private static final long
ZERO_INITIAL_DELAY

Constructor Summary

AccessConstructor and Description
public
ScheduledTasksBeanDefinitionParser()

Method Summary

Modifier and TypeMethod and Description
private RuntimeBeanReference
beanReference(Element taskElement, ParserContext parserContext, BeanDefinitionBuilder builder)

private RuntimeBeanReference
cronTaskReference(String runnableBeanName, String cronExpression, Element taskElement, ParserContext parserContext)

protected void
doParse(Element
the XML element being parsed
element, ParserContext
the object encapsulating the current state of the parsing process
parserContext, BeanDefinitionBuilder
used to define the BeanDefinition
builder)

Overrides org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.doParse.

Parse the supplied Element and populate the supplied BeanDefinitionBuilder as required.

protected String
getBeanClassName(Element
the Element that is being parsed
element)

Overrides org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.getBeanClassName.

Determine the bean class name corresponding to the supplied Element.

private RuntimeBeanReference
intervalTaskReference(String runnableBeanName, String initialDelay, String interval, Element taskElement, ParserContext parserContext)

private boolean
isScheduledElement(Node node, ParserContext parserContext)

private RuntimeBeanReference
runnableReference(String ref, String method, Element taskElement, ParserContext parserContext)

protected boolean
shouldGenerateId()

Overrides org.springframework.beans.factory.xml.AbstractBeanDefinitionParser.shouldGenerateId.

Should an ID be generated instead of read from the passed in Element?

private RuntimeBeanReference
triggerTaskReference(String runnableBeanName, String triggerBeanName, Element taskElement, ParserContext parserContext)

Inherited from org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser:
doParsegetBeanClassgetParentNameparseInternal

Field Detail

ELEMENT_SCHEDULEDback to summary
private static final String ELEMENT_SCHEDULED
ZERO_INITIAL_DELAYback to summary
private static final long ZERO_INITIAL_DELAY

Constructor Detail

ScheduledTasksBeanDefinitionParserback to summary
public ScheduledTasksBeanDefinitionParser()

Method Detail

beanReferenceback to summary
private RuntimeBeanReference beanReference(Element taskElement, ParserContext parserContext, BeanDefinitionBuilder builder)
cronTaskReferenceback to summary
private RuntimeBeanReference cronTaskReference(String runnableBeanName, String cronExpression, Element taskElement, ParserContext parserContext)
doParseback to summary
protected void doParse(Element element, ParserContext parserContext, BeanDefinitionBuilder builder)

Overrides org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.doParse.

Doc from org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.doParse.

Parse the supplied Element and populate the supplied BeanDefinitionBuilder as required.

The default implementation delegates to the doParse version without ParserContext argument.

Parameters
element:Element

the XML element being parsed

parserContext:ParserContext

the object encapsulating the current state of the parsing process

builder:BeanDefinitionBuilder

used to define the BeanDefinition

Annotations
@Override
getBeanClassNameback to summary
protected String getBeanClassName(Element element)

Overrides org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.getBeanClassName.

Doc from org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.getBeanClassName.

Determine the bean class name corresponding to the supplied Element.

Parameters
element:Element

the Element that is being parsed

Returns:String

the class name of the bean that is being defined via parsing the supplied Element, or null if none

Annotations
@Override
intervalTaskReferenceback to summary
private RuntimeBeanReference intervalTaskReference(String runnableBeanName, String initialDelay, String interval, Element taskElement, ParserContext parserContext)
isScheduledElementback to summary
private boolean isScheduledElement(Node node, ParserContext parserContext)
runnableReferenceback to summary
private RuntimeBeanReference runnableReference(String ref, String method, Element taskElement, ParserContext parserContext)
shouldGenerateIdback to summary
protected boolean shouldGenerateId()

Overrides org.springframework.beans.factory.xml.AbstractBeanDefinitionParser.shouldGenerateId.

Doc from org.springframework.beans.factory.xml.AbstractBeanDefinitionParser.shouldGenerateId.

Should an ID be generated instead of read from the passed in Element?

Disabled by default; subclasses can override this to enable ID generation. Note that this flag is about always generating an ID; the parser won't even check for an "id" attribute in this case.

Returns:boolean

whether the parser should always generate an id

Annotations
@Override
triggerTaskReferenceback to summary
private RuntimeBeanReference triggerTaskReference(String runnableBeanName, String triggerBeanName, Element taskElement, ParserContext parserContext)