Package org.apache.camel.model

Class OptionalIdentifiedDefinition<T extends OptionalIdentifiedDefinition<T>>

java.lang.Object

org.apache.camel.model.OptionalIdentifiedDefinition<T>

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.LineNumberAware, org.apache.camel.NamedNode, org.apache.camel.spi.HasId, org.apache.camel.spi.IdAware

Direct Known Subclasses:

FromDefinition, InputTypeDefinition, OutputTypeDefinition, ProcessorDefinition, RestBindingDefinition, RestDefinition, RestsDefinition, RouteConfigurationDefinition, RoutesDefinition, RouteTemplateDefinition, RouteTemplatesDefinition, TemplatedRoutesDefinition, ThreadPoolProfileDefinition, VerbDefinition

public abstract class OptionalIdentifiedDefinition<T extends OptionalIdentifiedDefinition<T>>
extends Object
implements org.apache.camel.NamedNode, org.apache.camel.spi.IdAware, org.apache.camel.CamelContextAware

Allows an element to have an optional ID specified

Constructor Summary

Constructors

Constructor	Description
OptionalIdentifiedDefinition()

Method Summary

Modifier and Type	Method	Description
T	description(String text)	Sets the description of this node
T	description(String id, String text, String lang)	Deprecated.
org.apache.camel.CamelContext	getCamelContext()
Boolean	getCustomId()
DescriptionDefinition	getDescription()
String	getDescriptionText()	Returns the description text or null if there is no description text associated with this node
String	getId()
int	getLineNumber()
String	getLocation()
org.apache.camel.NamedNode	getParent()
boolean	hasCustomIdAssigned()	Returns whether a custom id has been assigned
T	id(String id)	Sets the id of this node.
String	idOrCreate(org.apache.camel.spi.NodeIdFactory factory)	Gets the node id, creating one if not already set.
void	setCamelContext(org.apache.camel.CamelContext camelContext)
void	setCustomId(Boolean customId)	Whether the node id was explicit set, or was auto generated by Camel.
void	setDescription(DescriptionDefinition description)	Sets the description of this node
void	setGeneratedId(String id)
void	setId(String id)	Sets the id of this node
void	setLineNumber(int lineNumber)
void	setLocation(String location)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.NamedNode

getLabel, getShortName

Constructor Detail

OptionalIdentifiedDefinition

public OptionalIdentifiedDefinition()

Method Detail

getCamelContext

public org.apache.camel.CamelContext getCamelContext()

Specified by:

getCamelContext in interface org.apache.camel.CamelContextAware

setCamelContext

public void setCamelContext(org.apache.camel.CamelContext camelContext)

Specified by:

setCamelContext in interface org.apache.camel.CamelContextAware

getId

public String getId()

Specified by:

getId in interface org.apache.camel.spi.HasId

Specified by:

getId in interface org.apache.camel.NamedNode

setId

@Metadata(description="The id of this node")
public void setId(String id)

Sets the id of this node

Specified by:

setId in interface org.apache.camel.spi.IdAware

setGeneratedId

public void setGeneratedId(String id)

Specified by:

setGeneratedId in interface org.apache.camel.spi.IdAware

getDescription

public DescriptionDefinition getDescription()

setDescription

@Metadata(description="The description for this node")
public void setDescription(DescriptionDefinition description)

Sets the description of this node

Parameters:

description - sets the text description, use null to not set a text

getParent

public org.apache.camel.NamedNode getParent()

Specified by:

getParent in interface org.apache.camel.NamedNode

getLineNumber

public int getLineNumber()

Specified by:

getLineNumber in interface org.apache.camel.LineNumberAware

setLineNumber

public void setLineNumber(int lineNumber)

Specified by:

setLineNumber in interface org.apache.camel.LineNumberAware

getLocation

public String getLocation()

Specified by:

getLocation in interface org.apache.camel.LineNumberAware

setLocation

public void setLocation(String location)

Specified by:

setLocation in interface org.apache.camel.LineNumberAware

description

public T description(String text)

Sets the description of this node

Parameters:

text - sets the text description, use null to not set a text

Returns:

the builder

description

@Deprecated
public T description(String id,
                     String text,
                     String lang)

Deprecated.

Sets the description of this node

Parameters:

id - sets the id, use null to not set an id

text - sets the text description, use null to not set a text

lang - sets the language for the description, use null to not set a language

Returns:

the builder

id

public T id(String id)

Sets the id of this node.

Important: If you want to set the id of the route, then you must use routeId(String) instead.

Parameters:

id - the id

Returns:

the builder

idOrCreate

public String idOrCreate(org.apache.camel.spi.NodeIdFactory factory)

Gets the node id, creating one if not already set.

getCustomId

public Boolean getCustomId()

setCustomId

public void setCustomId(Boolean customId)

Whether the node id was explicit set, or was auto generated by Camel.

hasCustomIdAssigned

public boolean hasCustomIdAssigned()

Returns whether a custom id has been assigned

getDescriptionText

public String getDescriptionText()

Returns the description text or null if there is no description text associated with this node

Specified by:

getDescriptionText in interface org.apache.camel.NamedNode