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, 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 Details

    • OptionalIdentifiedDefinition

      public OptionalIdentifiedDefinition()

  • Method Details

    • getCamelContext

      public org.apache.camel.CamelContext getCamelContext()
      Specified by:
      getCamelContext in interface org.apache.camel.spi.HasCamelContext

    • 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 String 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 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 description)
      Sets the description of this node
      Parameters:
      description - sets the text description, use null to not set a text
      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