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.HasCamelContext
,org.apache.camel.spi.HasId
,org.apache.camel.spi.IdAware
- Direct Known Subclasses:
FromDefinition
,InputTypeDefinition
,OutputTypeDefinition
,ProcessorDefinition
,RestBindingDefinition
,RestDefinition
,RestsDefinition
,RouteConfigurationDefinition
,RouteConfigurationsDefinition
,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
-
Method Summary
Modifier and TypeMethodDescriptiondescription
(String description) Sets the description of this nodeorg.apache.camel.CamelContext
Returns the description text or null if there is no description text associated with this nodegetId()
int
org.apache.camel.NamedNode
boolean
Returns whether a custom id has been assignedSets the id of this node.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
(String description) Sets the description of this nodevoid
setGeneratedId
(String id) void
Sets the id of this nodevoid
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 Details
-
OptionalIdentifiedDefinition
public OptionalIdentifiedDefinition()
-
-
Method Details
-
getCamelContext
public org.apache.camel.CamelContext getCamelContext()- Specified by:
getCamelContext
in interfaceorg.apache.camel.spi.HasCamelContext
-
setCamelContext
public void setCamelContext(org.apache.camel.CamelContext camelContext) - Specified by:
setCamelContext
in interfaceorg.apache.camel.CamelContextAware
-
getId
- Specified by:
getId
in interfaceorg.apache.camel.spi.HasId
- Specified by:
getId
in interfaceorg.apache.camel.NamedNode
-
getNodePrefixId
- Specified by:
getNodePrefixId
in interfaceorg.apache.camel.NamedNode
-
setId
Sets the id of this node- Specified by:
setId
in interfaceorg.apache.camel.spi.IdAware
-
setGeneratedId
- Specified by:
setGeneratedId
in interfaceorg.apache.camel.spi.IdAware
-
getDescription
-
setDescription
@Metadata(description="The description for this node") public void setDescription(String 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 interfaceorg.apache.camel.NamedNode
-
getLineNumber
public int getLineNumber()- Specified by:
getLineNumber
in interfaceorg.apache.camel.LineNumberAware
-
setLineNumber
public void setLineNumber(int lineNumber) - Specified by:
setLineNumber
in interfaceorg.apache.camel.LineNumberAware
-
getLocation
- Specified by:
getLocation
in interfaceorg.apache.camel.LineNumberAware
-
setLocation
- Specified by:
setLocation
in interfaceorg.apache.camel.LineNumberAware
-
description
Sets the description of this node- Parameters:
description
- sets the text description, use null to not set a text- Returns:
- the builder
-
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
Gets the node id, creating one if not already set. -
getCustomId
-
setCustomId
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
Returns the description text or null if there is no description text associated with this node- Specified by:
getDescriptionText
in interfaceorg.apache.camel.NamedNode
-