Skip to content

Commit 8a80c70

Browse files
authored
Change package names to org.frankframework (#169)
1 parent 1b5b437 commit 8a80c70

File tree

97 files changed

+261
-257
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

97 files changed

+261
-257
lines changed

.editorconfig

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,6 @@ indent_size = 2
1919
[*.md]
2020
max_line_length = off
2121
trim_trailing_whitespace = false
22+
23+
[*.xsd]
24+
trim_trailing_whitespace = false

frank-doc-doclet/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ You see the description in the JavaDoc comment (or [@IbisDoc](https://github.com
181181
## Attribute default value (or Java annotation @Default)
182182

183183
You can document a default value for attributes. The preferred way to do this is using JavaDoc tag `@ff.default` or using
184-
Java annotation `nl.nn.adapterframework.doc.Default`. Using the [@IbisDoc](https://github.com/ibissource/iaf/blob/master/core/src/main/java/nl/nn/adapterframework/doc/IbisDoc.java) Java annotation is deprecated. You document here what value is assumed if the attribute is not set. Only document this value if this default is applied already by the F!F source code. The `@ff.default` JavaDoc annotation does not alter the behavior of the Frank!Framework.
184+
Java annotation `org.frankframework.doc.Default`. Using the [@IbisDoc](https://github.com/ibissource/iaf/blob/master/core/src/main/java/nl/nn/adapterframework/doc/IbisDoc.java) Java annotation is deprecated. You document here what value is assumed if the attribute is not set. Only document this value if this default is applied already by the F!F source code. The `@ff.default` JavaDoc annotation does not alter the behavior of the Frank!Framework.
185185

186186
Here is how it looks like in the Java source code:
187187

@@ -266,11 +266,11 @@ Now we can see the meaning of the `@ff.defaultElement` tag. You can use it to pr
266266

267267
![eclipseIPipe](./picturesForReadme/eclipseIPipe.jpg)
268268

269-
The default value is `nl.nn.adapterframework.pipes.SenderPipe` in this example. The autocomplete function of VSCode can add this default value for the `className` attribute. If it is omitted in a Frank config, then it is assumed to have the default value. You can thus use `<Pipe>` (without `className` attribute) as a synonym of `<SenderPipe>` because `<SenderPipe>` points to Java class [SenderPipe](https://github.com/ibissource/iaf/blob/master/core/src/main/java/nl/nn/adapterframework/pipes/SenderPipe.java).
269+
The default value is `org.frankframework.pipes.SenderPipe` in this example. The autocomplete function of VSCode can add this default value for the `className` attribute. If it is omitted in a Frank config, then it is assumed to have the default value. You can thus use `<Pipe>` (without `className` attribute) as a synonym of `<SenderPipe>` because `<SenderPipe>` points to Java class [SenderPipe](https://github.com/ibissource/iaf/blob/master/core/src/main/java/nl/nn/adapterframework/pipes/SenderPipe.java).
270270

271271
**@ff.mandatory:** JavaDoc tag that applies to attribute setters and config child setters. If an attribute setter has this annotation, then the attribute definition in the strict XSD gets a `use="required"` attribute. Frank developers will see an error in their text editor if they omit the attribute / config child. If the annotation has no arguments, the compatibility XSD is affected in the same way. Configurations in which the attribute or config child is not set will not load. If you give this annotation the value `ignoreInCompatibilityMode`, the attribute or config child will not be mandatory in `FrankConfig-compatibility.xsd`, but will be mandatory in `FrankConfig-strict.xsd`.
272272

273-
**@Mandatory:** Java annotation that does the same as JavaDoc tag `@ff.mandatory`. Full name is `nl.nn.adapterframework.doc.Mandatory`. There is a Boolean field `ignoreInCompatibilityMode` that can make an attribute or config child optional in `FrankConfig-compatibility.xsd` and mandatory in `FrankConfig-strict.xsd`. The Boolean field has default vaue `false`, which means that the modeled attribute or config child is mandatory both in `FrankConfig-strict.xsd` and `FrankConfig-compatibility.xsd`.
273+
**@Mandatory:** Java annotation that does the same as JavaDoc tag `@ff.mandatory`. Full name is `org.frankframework.doc.Mandatory`. There is a Boolean field `ignoreInCompatibilityMode` that can make an attribute or config child optional in `FrankConfig-compatibility.xsd` and mandatory in `FrankConfig-strict.xsd`. The Boolean field has default vaue `false`, which means that the modeled attribute or config child is mandatory both in `FrankConfig-strict.xsd` and `FrankConfig-compatibility.xsd`.
274274

275275
**@ff.optional:** JavaDoc tag that undoes the effect of an inherited `@ff.mandatory` or `@Mandatory`. Makes an attribute or config child optional even if it overrides a mandatory attribute or config child.
276276

@@ -282,4 +282,4 @@ The default value is `nl.nn.adapterframework.pipes.SenderPipe` in this example.
282282

283283
**@ff.reintroduce:** JavaDoc tag that does the same as Java annotation `@Reintroduce`.
284284

285-
**@Label:** Java annotation that appears on other Java annotations, e.g <code>@Category</code>. A target annotation that is itself annotated with meta-annotation `@Label` produces a label in the Frank!Doc webapp when it is applied above a class of the Frank!Framework sources. The value of the label comes from the `value()` field of the target annotation. The name of the label comes from the `@Label` meta-annotation within the definition of the target annotation; attribute `name`. Labels only apply to classes, not child elements and not attributes. You can have enum-valued label values. In this case, the @EnumLabel annotation is supported. The JSON file that feeds the Frank!Doc webapp provides for each label an overview of all possible values. The label values are sorted alphabetically for non-enum values. Enum values are sorted by the order in the enum type.
285+
**@Label:** Java annotation that appears on other Java annotations, e.g <code>@Category</code>. A target annotation that is itself annotated with meta-annotation `@Label` produces a label in the Frank!Doc webapp when it is applied above a class of the Frank!Framework sources. The value of the label comes from the `value()` field of the target annotation. The name of the label comes from the `@Label` meta-annotation within the definition of the target annotation; attribute `name`. Labels only apply to classes, not child elements and not attributes. You can have enum-valued label values. In this case, the @EnumLabel annotation is supported. The JSON file that feeds the Frank!Doc webapp provides for each label an overview of all possible values. The label values are sorted alphabetically for non-enum values. Enum values are sorted by the order in the enum type.

frank-doc-doclet/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@
250250
<dependency>
251251
<groupId>org.apache.commons</groupId>
252252
<artifactId>commons-lang3</artifactId>
253-
<version>3.13.0</version>
253+
<version>3.14.0</version>
254254
</dependency>
255255
<dependency>
256256
<groupId>org.jdom</groupId>

frank-doc-doclet/src/main/java/org/frankframework/frankdoc/DocWriterNew.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ public class DocWriterNew implements AttributeReuseManagerCallback {
144144
outputFileNames.put(XsdVersion.COMPATIBILITY, "compatibility.xsd");
145145
}
146146

147-
private static final String CONFIGURATION = "nl.nn.adapterframework.configuration.Configuration";
147+
private static final String CONFIGURATION = "org.frankframework.configuration.Configuration";
148148
private static final String ELEMENT_ROLE = "elementRole";
149149
private static final String CLASS_NAME = "className";
150150
private static final String ELEMENT_GROUP_BASE = "ElementGroupBase";

frank-doc-doclet/src/main/java/org/frankframework/frankdoc/doclet/FrankDocletOptions.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public class FrankDocletOptions {
4141
private String jsonOutputFilePath = "js/frankdoc.json";
4242
private String elementSummaryPath = "txt/elementSummary.txt";
4343
private URL digesterRulesUrl;
44-
private String rootClass = "nl.nn.adapterframework.configuration.Configuration";
44+
private String rootClass = "org.frankframework.configuration.Configuration";
4545
private String frankFrameworkVersion;
4646

4747
private final Set<Option> options = Set.of(

frank-doc-doclet/src/main/java/org/frankframework/frankdoc/feature/Default.java

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
/*
2-
Copyright 2022, 2023 WeAreFrank!
1+
/*
2+
Copyright 2022, 2023 WeAreFrank!
33
4-
Licensed under the Apache License, Version 2.0 (the "License");
5-
you may not use this file except in compliance with the License.
6-
You may obtain a copy of the License at
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
77
8-
http://www.apache.org/licenses/LICENSE-2.0
8+
http://www.apache.org/licenses/LICENSE-2.0
99
10-
Unless required by applicable law or agreed to in writing, software
11-
distributed under the License is distributed on an "AS IS" BASIS,
12-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13-
See the License for the specific language governing permissions and
14-
limitations under the License.
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
1515
*/
1616

1717
package org.frankframework.frankdoc.feature;
@@ -25,7 +25,7 @@
2525
import org.frankframework.frankdoc.wrapper.FrankMethod;
2626

2727
public class Default {
28-
private static final String ANNOTATION_DEFAULT = "nl.nn.adapterframework.doc.Default";
28+
private static final String ANNOTATION_DEFAULT = "org.frankframework.doc.Default";
2929
private static final String TAG_DEFAULT = "@ff.default";
3030

3131
private static Logger log = LogUtil.getLogger(Default.class);

frank-doc-doclet/src/main/java/org/frankframework/frankdoc/feature/ExcludeFromTypeFeature.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232

3333
public final class ExcludeFromTypeFeature {
3434
private static Logger log = LogUtil.getLogger(ExcludeFromTypeFeature.class);
35-
private static final String ANNOTATION_NAME = "nl.nn.adapterframework.doc.ExcludeFromType";
35+
private static final String ANNOTATION_NAME = "org.frankframework.doc.ExcludeFromType";
3636
private static final String TAG_NAME = "@ff.excludeFromType";
3737

3838
// In practice, this map will have only one member because we work with only one class repository.

frank-doc-doclet/src/main/java/org/frankframework/frankdoc/feature/Mandatory.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public enum Value {
3030
}
3131

3232
private static final String TAG_NAME = "@ff.mandatory";
33-
private static final String ANNOTATION_NAME = "nl.nn.adapterframework.doc.Mandatory";
33+
private static final String ANNOTATION_NAME = "org.frankframework.doc.Mandatory";
3434

3535
private static final String IGNORE_COMPATIBILITY_MODE = "ignoreInCompatibilityMode";
3636

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
/*
2-
Copyright 2022 WeAreFrank!
1+
/*
2+
Copyright 2022 WeAreFrank!
33
4-
Licensed under the Apache License, Version 2.0 (the "License");
5-
you may not use this file except in compliance with the License.
6-
You may obtain a copy of the License at
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
77
8-
http://www.apache.org/licenses/LICENSE-2.0
8+
http://www.apache.org/licenses/LICENSE-2.0
99
10-
Unless required by applicable law or agreed to in writing, software
11-
distributed under the License is distributed on an "AS IS" BASIS,
12-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13-
See the License for the specific language governing permissions and
14-
limitations under the License.
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
1515
*/
1616

1717
package org.frankframework.frankdoc.feature;
@@ -24,6 +24,6 @@ public static final Optional getInstance() {
2424
}
2525

2626
private Optional() {
27-
super("nl.nn.adapterframework.doc.Optional", "@ff.optional");
27+
super("org.frankframework.doc.Optional", "@ff.optional");
2828
}
2929
}
Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
/*
2-
Copyright 2022 WeAreFrank!
1+
/*
2+
Copyright 2022 WeAreFrank!
33
4-
Licensed under the Apache License, Version 2.0 (the "License");
5-
you may not use this file except in compliance with the License.
6-
You may obtain a copy of the License at
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
77
8-
http://www.apache.org/licenses/LICENSE-2.0
8+
http://www.apache.org/licenses/LICENSE-2.0
99
10-
Unless required by applicable law or agreed to in writing, software
11-
distributed under the License is distributed on an "AS IS" BASIS,
12-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13-
See the License for the specific language governing permissions and
14-
limitations under the License.
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
1515
*/
1616

1717
package org.frankframework.frankdoc.feature;
@@ -24,6 +24,6 @@ public static Protected getInstance() {
2424
}
2525

2626
private Protected() {
27-
super("nl.nn.adapterframework.doc.Protected", "@ff.protected");
27+
super("org.frankframework.doc.Protected", "@ff.protected");
2828
}
2929
}

0 commit comments

Comments
 (0)