org.apache.camel.model
Class ChoiceDefinition

java.lang.Object
  org.apache.camel.model.OptionalIdentifiedDefinition<Type>
      org.apache.camel.model.ProcessorDefinition<ChoiceDefinition>
          org.apache.camel.model.ChoiceDefinition

All Implemented Interfaces:

Block, NamedNode

public class ChoiceDefinition
extends ProcessorDefinition<ChoiceDefinition>

Represents an XML <choice/> element

Version:

Field Summary

Fields inherited from class org.apache.camel.model.ProcessorDefinition

inheritErrorHandler, log

Constructor Summary

ChoiceDefinition()

Method Summary

void	configureChild(ProcessorDefinition<?> output) Strategy for children to do any custom configuration
Processor	createProcessor(RouteContext routeContext) Override this in definition class and implement logic to create the processor based on the definition model.
String	getLabel() Returns a label to describe this node such as the expression if some kind of expression node
OtherwiseDefinition	getOtherwise()
List<ProcessorDefinition<?>>	getOutputs()
String	getShortName() Returns a short name for this node which can be useful for ID generation or referring to related resources like images
List<WhenDefinition>	getWhenClauses()
boolean	isOutputSupported()
ChoiceDefinition	otherwise() Sets the otherwise node
void	setId(String value) Sets the value of the id property.
void	setOtherwise(OtherwiseDefinition otherwise)
void	setWhenClauses(List<WhenDefinition> whenClauses)
String	toString()
ExpressionClause<ChoiceDefinition>	when() Creates an expression for the when node
ChoiceDefinition	when(Predicate predicate) Sets the predicate for the when node

Methods inherited from class org.apache.camel.model.ProcessorDefinition

addInterceptStrategies, addInterceptStrategy, addOutput, addRoutes, aggregate, aggregate, aggregate, aggregate, aop, attribute, bean, bean, bean, bean, bean, bean, beanRef, beanRef, beanRef, beanRef, beanRef, choice, clearOutput, convertBodyTo, convertBodyTo, createChannel, createChildProcessor, createCompositeProcessor, createOutputsProcessor, createOutputsProcessor, createProcessor, delay, delay, delay, doTry, dynamicRouter, dynamicRouter, end, endChoice, endDoTry, endParent, endRest, enrich, enrich, enrichRef, filter, filter, filter, filter, getIndex, getInterceptStrategies, getOtherAttributes, getParent, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, inOut, isAbstract, isInheritErrorHandler, isTopLevelOnly, loadBalance, loadBalance, log, log, log, log, log, log, loop, loop, loop, makeProcessor, markRollbackOnly, markRollbackOnlyLast, marshal, marshal, marshal, marshal, multicast, multicast, multicast, onCompletion, onException, onException, pipeline, pipeline, pipeline, pipeline, placeholder, policy, policy, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrichRef, preCreateProcessor, process, processRef, recipientList, recipientList, recipientList, recipientList, removeFaultHeader, removeHeader, removeHeaders, removeHeaders, removeProperty, resequence, resequence, resolveKnownConstantFields, resolvePropertyPlaceholders, rollback, rollback, routeId, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, sample, sample, sample, setBody, setBody, setExchangePattern, setFaultBody, setFaultHeader, setHeader, setHeader, setInheritErrorHandler, setOtherAttributes, setOutHeader, setOutHeader, setParent, setProperty, setProperty, sort, sort, sort, split, split, split, startupOrder, stop, threads, threads, threads, threads, throttle, throttle, throwException, to, to, to, to, to, to, to, to, to, to, toF, transacted, transacted, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wrapChannel, wrapInErrorHandler, wrapProcessor

Methods inherited from class org.apache.camel.model.OptionalIdentifiedDefinition

description, description, getDescription, getDescriptionText, getId, hasCustomIdAssigned, idOrCreate, isCustomId, setCustomId, setDescription

Methods inherited from class java.lang.Object

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

Constructor Detail

ChoiceDefinition

public ChoiceDefinition()

Method Detail

getOutputs

public List<ProcessorDefinition<?>> getOutputs()

Specified by:

getOutputs in class ProcessorDefinition<ChoiceDefinition>

isOutputSupported

public boolean isOutputSupported()

Specified by:

isOutputSupported in class ProcessorDefinition<ChoiceDefinition>

toString

public String toString()

Overrides:

toString in class Object

getShortName

public String getShortName()

Description copied from class: OptionalIdentifiedDefinition

Returns a short name for this node which can be useful for ID generation or referring to related resources like images

Specified by:

getShortName in interface NamedNode

Overrides:

getShortName in class OptionalIdentifiedDefinition<ChoiceDefinition>

Returns:

defaults to "node" but derived nodes should overload this to provide a unique name

createProcessor

public Processor createProcessor(RouteContext routeContext)
                          throws Exception

Description copied from class: ProcessorDefinition

Override this in definition class and implement logic to create the processor based on the definition model.

Overrides:

createProcessor in class ProcessorDefinition<ChoiceDefinition>

Throws:

Exception

when

public ChoiceDefinition when(Predicate predicate)

Sets the predicate for the when node

Parameters:

predicate - the predicate

Returns:

the builder

when

public ExpressionClause<ChoiceDefinition> when()

Creates an expression for the when node

Returns:

expression to be used as builder to configure the when node

otherwise

public ChoiceDefinition otherwise()

Sets the otherwise node

Returns:

the builder

setId

public void setId(String value)

Description copied from class: OptionalIdentifiedDefinition

Sets the value of the id property.

Overrides:

setId in class OptionalIdentifiedDefinition<ChoiceDefinition>

getLabel

public String getLabel()

Description copied from class: ProcessorDefinition

Returns a label to describe this node such as the expression if some kind of expression node

Specified by:

getLabel in interface NamedNode

Overrides:

getLabel in class ProcessorDefinition<ChoiceDefinition>

getWhenClauses

public List<WhenDefinition> getWhenClauses()

setWhenClauses

public void setWhenClauses(List<WhenDefinition> whenClauses)

getOtherwise

public OtherwiseDefinition getOtherwise()

setOtherwise

public void setOtherwise(OtherwiseDefinition otherwise)

configureChild

public void configureChild(ProcessorDefinition<?> output)

Description copied from class: ProcessorDefinition

Strategy for children to do any custom configuration

Overrides:

configureChild in class ProcessorDefinition<ChoiceDefinition>

Parameters:

output - the child to be added as output to this