-
Notifications
You must be signed in to change notification settings - Fork 4.9k
/
OptionalIdentifiedDefinition.java
220 lines (191 loc) · 6.05 KB
/
OptionalIdentifiedDefinition.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.camel.model;
import jakarta.xml.bind.annotation.XmlAccessType;
import jakarta.xml.bind.annotation.XmlAccessorType;
import jakarta.xml.bind.annotation.XmlAttribute;
import jakarta.xml.bind.annotation.XmlTransient;
import jakarta.xml.bind.annotation.XmlType;
import org.apache.camel.CamelContext;
import org.apache.camel.CamelContextAware;
import org.apache.camel.NamedNode;
import org.apache.camel.spi.IdAware;
import org.apache.camel.spi.Metadata;
import org.apache.camel.spi.NodeIdFactory;
/**
* Allows an element to have an optional ID specified
*/
@XmlType(name = "optionalIdentifiedDefinition")
@XmlAccessorType(XmlAccessType.PROPERTY)
// must use XmlAccessType.PROPERTY which is required by camel-spring / camel-blueprint for their namespace parsers
public abstract class OptionalIdentifiedDefinition<T extends OptionalIdentifiedDefinition<T>>
implements NamedNode, IdAware, CamelContextAware {
private CamelContext camelContext;
private String id;
private Boolean customId;
private String description;
private int lineNumber = -1;
private String location;
public OptionalIdentifiedDefinition() {
}
protected OptionalIdentifiedDefinition(OptionalIdentifiedDefinition source) {
this.camelContext = source.camelContext;
this.id = source.id;
this.customId = source.customId;
this.description = source.description;
this.lineNumber = source.lineNumber;
this.location = source.location;
}
@Override
public CamelContext getCamelContext() {
return camelContext;
}
@Override
@XmlTransient
public void setCamelContext(CamelContext camelContext) {
this.camelContext = camelContext;
}
@Override
public String getId() {
return id;
}
/**
* Sets the id of this node
*/
@XmlAttribute
@Metadata(description = "The id of this node")
public void setId(String id) {
this.id = id;
customId = true;
}
@Override
public void setGeneratedId(String id) {
this.id = id;
customId = null;
}
public String getDescription() {
return description;
}
/**
* Sets the description of this node
*
* @param description sets the text description, use null to not set a text
*/
@XmlAttribute
@Metadata(description = "The description for this node")
public void setDescription(String description) {
this.description = description;
}
@Override
public NamedNode getParent() {
return null;
}
@Override
public int getLineNumber() {
return lineNumber;
}
@Override
@XmlTransient
public void setLineNumber(int lineNumber) {
this.lineNumber = lineNumber;
}
@Override
public String getLocation() {
return location;
}
@Override
@XmlTransient
public void setLocation(String location) {
this.location = location;
}
// Fluent API
// -------------------------------------------------------------------------
/**
* Sets the description of this node
*
* @param description sets the text description, use null to not set a text
* @return the builder
*/
@SuppressWarnings("unchecked")
public T description(String description) {
this.description = description;
return (T) this;
}
/**
* Sets the id of this node.
* <p/>
* <b>Important:</b> If you want to set the id of the route, then you <b>must</b> use <tt>routeId(String)</tt>
* instead.
*
* @param id the id
* @return the builder
*/
@SuppressWarnings("unchecked")
public T id(String id) {
setId(id);
return (T) this;
}
/**
* Gets the node id, creating one if not already set.
*/
public String idOrCreate(NodeIdFactory factory) {
// prefix is only for nodes in the route (not the route id)
String prefix = null;
boolean iAmRoute = this instanceof RouteDefinition;
boolean allowPrefix = !iAmRoute && this instanceof ProcessorDefinition;
if (allowPrefix) {
RouteDefinition route = ProcessorDefinitionHelper.getRoute(this);
if (route != null) {
prefix = route.getNodePrefixId();
}
}
if (id == null) {
setGeneratedId(factory.createId(this));
}
// return with prefix
if (prefix != null) {
return prefix + id;
} else {
return id;
}
}
public Boolean getCustomId() {
return customId;
}
/**
* Whether the node id was explicit set, or was auto generated by Camel.
*/
@XmlAttribute
public void setCustomId(Boolean customId) {
this.customId = customId;
}
/**
* Returns whether a custom id has been assigned
*/
public boolean hasCustomIdAssigned() {
return customId != null && customId;
}
/**
* Returns the description text or null if there is no description text associated with this node
*/
@Override
public String getDescriptionText() {
return description;
}
// Implementation methods
// -------------------------------------------------------------------------
}