-
Notifications
You must be signed in to change notification settings - Fork 2.7k
/
Copy pathmaven.mdo
3572 lines (3439 loc) · 131 KB
/
maven.mdo
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8"?>
<!--
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.
-->
<!--
| Improvements:
|
| o add specification element to a field, this would be more a technical description of
| what is allowed in the field.
|
| o validators: there could be several levels of validation. Simple type validation could
| be done with a regex, but we need inter-field validation and rules which could be
| dealt with by something like drools.
|
| o i18n: would be good to be able to have names/descriptions/specifications
| in as many languages as possible. (see MNG-3626)
|
| o annotation mechanism so that changes to the model can be accurately tracked.
|
| o need to clean up all the descriptions, matching anything to the current project-descriptor.xml file and
| improving on that
|
| o use enums where appropriate (eg dependency scope)
|
| o a number of elements have a groupId/artifactId and sometimes version. It would be good to have them all extend one
| definition of these types
|
-->
<model xmlns="http://codehaus-plexus.github.io/MODELLO/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://codehaus-plexus.github.io/MODELLO/2.0.0 https://codehaus-plexus.github.io/modello/xsd/modello-2.0.0.xsd"
xml.namespace="http://maven.apache.org/POM/${version}"
xml.schemaLocation="https://maven.apache.org/xsd/maven-${version}.xsd">
<id>maven</id>
<name>Maven</name>
<description>
<![CDATA[
<p>This is a reference for the Maven project descriptor used in Maven.</p>
<p>An XSD is available at:</p>
<ul>
<li><a href="https://maven.apache.org/xsd/maven-v3_0_0.xsd">https://maven.apache.org/xsd/maven-v3_0_0.xsd</a> for Maven 1.1.</li>
<li><a href="https://maven.apache.org/xsd/maven-4.0.0.xsd">https://maven.apache.org/xsd/maven-4.0.0.xsd</a> for Maven 2.0.</li>
<li><a href="https://maven.apache.org/xsd/maven-4.1.0.xsd">https://maven.apache.org/xsd/maven-4.1.0.xsd</a> for Maven 4.0.</li>
</ul>
]]>
</description>
<defaults>
<default>
<key>package</key>
<value>org.apache.maven.model</value>
</default>
</defaults>
<classes>
<class rootElement="true" xml.tagName="project">
<name>Model</name>
<superClass>ModelBase</superClass>
<description>
The {@code <project>} element is the root of the descriptor.
The following table lists all of the possible child elements.
</description>
<version>3.0.0+</version>
<fields>
<field xml.transient="true">
<name>pomFile</name>
<version>4.1.0+</version>
<required>false</required>
<description>Originating POM file</description>
<type>DOM</type> <!-- This is transformed to a File/Path in the template -->
</field>
<!-- ====================================================================== -->
<!-- Model Version -->
<!-- ====================================================================== -->
<field>
<name>modelVersion</name>
<version>4.0.0+</version>
<required>true</required>
<description>Declares to which version of project descriptor this POM conforms.</description>
<type>String</type>
</field>
<!-- ====================================================================== -->
<!-- Parent Model -->
<!-- ====================================================================== -->
<field xdoc.separator="blank">
<name>parent</name>
<version>4.0.0+</version>
<description>The location of the parent project, if one exists. Values from the parent
project will be the default for this project if they are left unspecified. The location
is given as a group ID, artifact ID and version.</description>
<association>
<type>Parent</type>
</association>
</field>
<!-- ====================================================================== -->
<!-- groupId/artifactId/Version/Packaging -->
<!-- ====================================================================== -->
<field xdoc.separator="blank">
<name>groupId</name>
<version>3.0.0+</version>
<required>true</required>
<description>
A universally unique identifier for a project. It is normal to
use a fully-qualified package name to distinguish it from other
projects with a similar name (eg. {@code org.apache.maven}).
</description>
<type>String</type>
</field>
<field>
<name>artifactId</name>
<version>3.0.0+</version>
<required>true</required>
<description>The identifier for this artifact that is unique within the group given by the
group ID. An artifact is something that is either produced or used by a project.
Examples of artifacts produced by Maven for a project include: JARs, source and binary
distributions, and WARs.</description>
<type>String</type>
</field>
<field>
<name>version</name>
<version>4.0.0+</version>
<required>true</required>
<description>The current version of the artifact produced by this project.</description>
<type>String</type>
</field>
<field>
<name>packaging</name>
<version>4.0.0+</version>
<description>
The type of artifact this project produces, for example {@code jar},
{@code war},
{@code ear},
{@code pom}.
Plugins can create their own packaging, and
therefore their own packaging types,
so this list does not contain all possible types.
</description>
<type>String</type>
<defaultValue>jar</defaultValue>
</field>
<!-- ====================================================================== -->
<!-- Elements which describe a project -->
<!-- ====================================================================== -->
<field xdoc.separator="blank">
<name>name</name>
<version>3.0.0+</version>
<required>true</required>
<description>The full name of the project.</description>
<type>String</type>
</field>
<field>
<name>description</name>
<version>3.0.0+</version>
<description>A detailed description of the project, used by Maven whenever it needs to
describe the project, such as on the website. While this element can be specified as
CDATA to enable the use of HTML tags within the description, it is discouraged to allow
plain text representation. If you need to modify the index page of the generated website,
you are able to specify your own instead of adjusting this text.</description>
<type>String</type>
</field>
<field>
<name>url</name>
<version>3.0.0+</version>
<description>
<![CDATA[
The URL to the project's homepage.
<p><b>Default value is</b>: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if
project's {@code child.project.url.inherit.append.path="false"}</p>
]]>
</description>
<type>String</type>
</field>
<field xml.attribute="true" xml.tagName="child.project.url.inherit.append.path">
<name>childProjectUrlInheritAppendPath</name>
<version>4.0.0+</version>
<description>
<![CDATA[
When children inherit from project's url, append path or not? Note: While the type
of this field is {@code String} for technical reasons, the semantic type is actually
{@code Boolean}
<p><b>Default value is</b>: {@code true}</p>
@since Maven 3.6.1
]]>
</description>
<type>String</type>
</field>
<field xml.attribute="true" xml.tagName="root">
<name>root</name>
<version>4.1.0+</version>
<description>
Indicates that this project is the root project, located in the upper directory of the source tree.
This is the directory which may contain the .mvn directory.
@since Maven 4.0.0
</description>
<type>boolean</type>
<defaultValue>false</defaultValue>
</field>
<field xml.attribute="true" xml.tagName="preserve.model.version">
<name>preserveModelVersion</name>
<version>4.1.0+</version>
<description>
Indicates if the build POM for this project should be preserved or downgraded to the lowest
compatible version.
@since Maven 4.0.0
</description>
<type>boolean</type>
<defaultValue>false</defaultValue>
</field>
<field>
<name>inceptionYear</name>
<version>3.0.0+</version>
<required>true</required>
<description>The year of the project's inception, specified with 4 digits. This value is
used when generating copyright notices as well as being informational.</description>
<type>String</type>
</field>
<field>
<name>organization</name>
<version>3.0.0+</version>
<description>This element describes various attributes of the organization to which the
project belongs. These attributes are utilized when documentation is created (for
copyright notices and links).</description>
<alias>organisation</alias>
<association>
<type>Organization</type>
</association>
</field>
<field>
<name>licenses</name>
<version>3.0.0+</version>
<description>
<![CDATA[
This element describes all the licenses for this project.
Each license is described by a {@code license} element, which
is then described by additional elements.
Projects should only list the license(s) that applies to the project
and not the licenses that apply to dependencies.
If multiple licenses are listed, it is assumed that the user can select
any of them, not that they must accept all.
]]>
</description>
<association>
<type>License</type>
<multiplicity>*</multiplicity>
</association>
</field>
<field xdoc.separator="blank">
<name>developers</name>
<version>3.0.0+</version>
<description>Describes the committers of a project.</description>
<association>
<type>Developer</type>
<multiplicity>*</multiplicity>
</association>
</field>
<field>
<name>contributors</name>
<version>3.0.0+</version>
<description>Describes the contributors to a project that are not yet committers.</description>
<association>
<type>Contributor</type>
<multiplicity>*</multiplicity>
</association>
</field>
<field xdoc.separator="blank">
<name>mailingLists</name>
<version>3.0.0+</version>
<description>Contains information about a project's mailing lists.</description>
<association>
<type>MailingList</type>
<multiplicity>*</multiplicity>
</association>
</field>
<!-- ====================================================================== -->
<!-- Build prerequisites -->
<!-- ====================================================================== -->
<field xdoc.separator="blank">
<name>prerequisites</name>
<version>4.0.0+</version>
<description>Describes the prerequisites in the build environment for this project.</description>
<association>
<type>Prerequisites</type>
</association>
</field>
<!-- ====================================================================== -->
<!-- SCM -->
<!-- ====================================================================== -->
<field xdoc.separator="blank" xml.insertParentFieldsUpTo="subprojects">
<name>scm</name>
<version>4.0.0+</version>
<description>Specification for the SCM used by the project, such as CVS, Subversion, etc.</description>
<association>
<type>Scm</type>
</association>
</field>
<!-- ====================================================================== -->
<!-- Issue Tracking -->
<!-- ====================================================================== -->
<field>
<name>issueManagement</name>
<version>4.0.0+</version>
<description>The project's issue management system information.</description>
<association>
<type>IssueManagement</type>
</association>
</field>
<!-- ====================================================================== -->
<!-- CI Management -->
<!-- ====================================================================== -->
<field>
<name>ciManagement</name>
<version>4.0.0+</version>
<description>The project's continuous integration information.</description>
<association>
<type>CiManagement</type>
</association>
</field>
<!-- ====================================================================== -->
<!-- Build -->
<!-- ====================================================================== -->
<field xdoc.separator="blank" xml.insertParentFieldsUpTo="pluginRepositories">
<name>build</name>
<version>3.0.0+</version>
<required>true</required>
<description>Information required to build the project.</description>
<association>
<type>Build</type>
</association>
</field>
<!-- ====================================================================== -->
<!-- Profiles -->
<!-- ====================================================================== -->
<field xdoc.separator="blank" xml.insertParentFieldsUpTo="reporting">
<name>profiles</name>
<version>4.0.0+</version>
<description>A listing of project-local build profiles which will modify the build process
when activated.</description>
<association>
<type>Profile</type>
<multiplicity>*</multiplicity>
</association>
</field>
</fields>
<codeSegments>
<codeSegment>
<version>4.0.0/4.0.99</version>
<code>
<![CDATA[
/**
* Gets the POM file for the corresponding project (if any).
*
* @return The POM file from which this model originated or {@code null} if this model does not belong to a local
* project (e.g. describes the metadata of some artifact from the repository).
*/
@Deprecated
public java.io.File getPomFile() {
return (getDelegate().getPomFile() != null) ? getDelegate().getPomFile().toFile() : null;
}
@Deprecated
public void setPomFile(java.io.File pomFile) {
update( getDelegate().withPomFile(pomFile != null ? pomFile.toPath() : null));
}
/**
* Gets the POM file for the corresponding project (if any).
*
* @return The POM file from which this model originated or {@code null} if this model does not belong to a local
* project (e.g. describes the metadata of some artifact from the repository).
*/
public java.nio.file.Path getPomPath() {
return (getDelegate().getPomFile() != null) ? getDelegate().getPomFile() : null;
}
public void setPomPath(java.nio.file.Path pomPath) {
update( getDelegate().withPomFile(pomPath));
}
public void setModelEncoding(String modelEncoding) {
update(getDelegate().with().modelEncoding(modelEncoding).build());
}
/**
* Gets the base directory for the corresponding project (if any).
*
* @return The base directory for the corresponding project or {@code null} if this model does not belong to a local
* project (e.g. describes the metadata of some artifact from the repository).
*/
@Deprecated
public java.io.File getProjectDirectory() {
return (getDelegate().getProjectDirectory() != null) ? getDelegate().getProjectDirectory().toFile() : null;
}
/**
* Gets the base directory for the corresponding project (if any).
*
* @return The base directory for the corresponding project or {@code null} if this model does not belong to a local
* project (e.g. describes the metadata of some artifact from the repository).
*/
public java.nio.file.Path getProjectDirectoryPath() {
return getDelegate().getProjectDirectory();
}
/**
* @return the model id as {@code groupId:artifactId:packaging:version}
*/
public String getId() {
StringBuilder id = new StringBuilder( 64 );
id.append( ( getGroupId() == null ) ? "[inherited]" : getGroupId() );
id.append( ":" );
id.append( getArtifactId() );
id.append( ":" );
id.append( getPackaging() );
id.append( ":" );
id.append( ( getVersion() == null ) ? "[inherited]" : getVersion() );
return id.toString();
}
@Override
public String toString() {
return getId();
}
public boolean isChildProjectUrlInheritAppendPath() {
return getDelegate().isChildProjectUrlInheritAppendPath();
}
public void setChildProjectUrlInheritAppendPath(boolean childProjectUrlInheritAppendPath) {
delegate = getDelegate().withChildProjectUrlInheritAppendPath(String.valueOf(childProjectUrlInheritAppendPath));
}
]]>
</code>
</codeSegment>
<codeSegment>
<version>4.1.0+</version>
<code>
<![CDATA[
/**
* Gets the base directory for the corresponding project (if any).
*
* @return The base directory for the corresponding project or {@code null} if this model does not belong to a local
* project (e.g. describes the metadata of some artifact from the repository).
*/
public Path getProjectDirectory() {
return (pomFile != null) ? pomFile.getParent() : null;
}
/**
* @return the model id as {@code groupId:artifactId:packaging:version}
*/
public String getId()
{
StringBuilder id = new StringBuilder( 64 );
id.append( ( getGroupId() == null ) ? "[inherited]" : getGroupId() );
id.append( ":" );
id.append( getArtifactId() );
id.append( ":" );
id.append( getPackaging() );
id.append( ":" );
id.append( ( getVersion() == null ) ? "[inherited]" : getVersion() );
return id.toString();
}
@Override
public String toString()
{
return getId();
}
public boolean isChildProjectUrlInheritAppendPath()
{
return ( getChildProjectUrlInheritAppendPath() != null ) ? Boolean.parseBoolean( getChildProjectUrlInheritAppendPath() ) : true;
}
]]>
</code>
</codeSegment>
</codeSegments>
</class>
<class>
<name>ModelBase</name>
<version>3.0.0+</version>
<description>
Base class for the {@code Model} and the {@code Profile} objects.
</description>
<fields>
<field xdoc.separator="blank">
<name>modules</name>
<version>4.0.0/4.1.0</version>
<description>
@deprecated Use {@link #subprojects} instead.
</description>
<association>
<type>String</type>
<multiplicity>*</multiplicity>
</association>
<annotations>
<annotation>@Deprecated(since = "4.0.0")</annotation>
</annotations>
</field>
<field xdoc.separator="blank">
<name>subprojects</name>
<version>4.1.0</version>
<description>The subprojects (formerly called modules) to build as a part of this
project. Each subproject listed is a relative path to the directory containing the subproject.
To be consistent with the way default URLs are calculated from parent, it is recommended
to have subproject names match artifact ids.</description>
<association>
<type>String</type>
<multiplicity>*</multiplicity>
</association>
</field>
<field xdoc.separator="blank">
<name>distributionManagement</name>
<version>4.0.0+</version>
<description>Distribution information for a project that enables deployment of the site
and artifacts to remote web servers and repositories respectively.</description>
<association>
<type>DistributionManagement</type>
</association>
</field>
<field xdoc.separator="blank">
<name>properties</name>
<version>4.0.0+</version>
<description>
Properties that can be used throughout the POM as a substitution, and
are used as filters in resources if enabled.
The format is {@code <name>value</name>}.
</description>
<type>Properties</type>
<association xml.mapStyle="inline">
<type>String</type>
<multiplicity>*</multiplicity>
</association>
</field>
<field xdoc.separator="blank">
<name>dependencyManagement</name>
<version>4.0.0+</version>
<required>false</required>
<description>Default dependency information for projects that inherit from this one. The
dependencies in this section are not immediately resolved. Instead, when a POM derived
from this one declares a dependency described by a matching groupId and artifactId, the
version and other values from this section are used for that dependency if they were not
already specified.</description>
<association>
<type>DependencyManagement</type>
</association>
</field>
<field>
<name>dependencies</name>
<version>3.0.0+</version>
<description>
This element describes all the dependencies associated with a project.
These dependencies are used to construct a classpath for your
project during the build process. They are automatically downloaded from the
repositories defined in this project.
@see <a href="https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html">Dependency mechanism</a>
</description>
<association>
<type>Dependency</type>
<multiplicity>*</multiplicity>
</association>
</field>
<field xdoc.separator="blank">
<name>repositories</name>
<version>4.0.0+</version>
<description>The lists of the remote repositories for discovering dependencies and
extensions.</description>
<association>
<type>Repository</type>
<multiplicity>*</multiplicity>
</association>
</field>
<field>
<name>pluginRepositories</name>
<version>4.0.0+</version>
<description>The lists of the remote repositories for discovering plugins for builds and
reports.</description>
<association>
<type>Repository</type>
<multiplicity>*</multiplicity>
</association>
</field>
<field xdoc.separator="blank">
<name>reports</name>
<version>4.0.0</version>
<description>
@deprecated Now ignored by Maven.
</description>
<type>DOM</type>
<annotations>
<annotation>@Deprecated(since = "4.0.0")</annotation>
</annotations>
</field>
<field>
<name>reporting</name>
<version>4.0.0+</version>
<description>
This element includes the specification of report plugins to use
to generate the reports on the Maven-generated site.
These reports will be run when a user executes {@code mvn site}.
All the reports will be included in the navigation bar for browsing.
</description>
<association>
<type>Reporting</type>
</association>
</field>
</fields>
</class>
<class>
<name>PluginContainer</name>
<version>3.0.0+</version>
<description>Contains the plugins information for the project.</description>
<fields>
<field>
<name>plugins</name>
<version>4.0.0+</version>
<description>The list of plugins to use.</description>
<association>
<type>Plugin</type>
<multiplicity>*</multiplicity>
</association>
</field>
</fields>
<codeSegments>
<codeSegment>
<version>4.0.0/4.0.99</version>
<code>
<![CDATA[
/**
* Reset the {@code pluginsMap} field to {@code null}
*/
public void flushPluginMap() {
}
/**
* @return a Map of plugins field with {@code Plugins#getKey()} as key
* @see Plugin#getKey()
*/
public Map<String, Plugin> getPluginsAsMap() {
return getPlugins().stream().collect(Collectors.toMap(plugin -> plugin.getKey(), plugin -> plugin));
}
]]>
</code>
</codeSegment>
<codeSegment>
<version>4.1.0+</version>
<code>
<![CDATA[
volatile Map<String, Plugin> pluginMap;
/**
* @return a Map of plugins field with {@code Plugins#getKey()} as key
* @see Plugin#getKey()
*/
public Map<String, Plugin> getPluginsAsMap() {
if (pluginMap == null) {
synchronized (this) {
if (pluginMap == null) {
pluginMap = ImmutableCollections.copy(plugins.stream().collect(
java.util.stream.Collectors.toMap(
Plugin::getKey, java.util.function.Function.identity())));
}
}
}
return pluginMap;
}
]]>
</code>
</codeSegment>
<codeSegment>
<version>4.0.0+</version>
<code>
<![CDATA[
@Override
public String toString()
{
return "PluginContainer {}";
}
]]>
</code>
</codeSegment>
</codeSegments>
</class>
<class>
<name>PluginConfiguration</name>
<version>3.0.0+</version>
<superClass>PluginContainer</superClass>
<description>Contains the plugins management information for the project.</description>
<fields>
<!-- [ jdcasey:06-Mar-2005 ] Added to handle version management, etc. for
| plugins to be used in sub-projects. -->
<field>
<name>pluginManagement</name>
<version>4.0.0+</version>
<required>false</required>
<description>Default plugin information to be made available for reference by projects
derived from this one. This plugin configuration will not be resolved or bound to the
lifecycle unless referenced. Any local configuration for a given plugin will override
the plugin's entire definition here.</description>
<association>
<type>PluginManagement</type>
</association>
</field>
</fields>
<codeSegments>
<codeSegment>
<version>4.0.0+</version>
<code>
<![CDATA[
/**
* @see java.lang.Object#toString()
*/
public String toString()
{
return "PluginConfiguration {" + super.toString() + "}";
}
]]>
</code>
</codeSegment>
</codeSegments>
</class>
<class xdoc.anchorName="profile_build">
<name>BuildBase</name>
<version>3.0.0+</version>
<superClass>PluginConfiguration</superClass>
<description>Build configuration in a profile.</description>
<fields>
<field>
<name>defaultGoal</name>
<version>3.0.0+</version>
<description>The default goal (or phase in Maven 2) to execute when none is specified for
the project. Note that in case of a build with subprojects, only the default goal of the top-level
project is relevant, i.e. the default goals of subprojects are ignored. Since Maven 3,
multiple goals/phases can be separated by whitespace.</description>
<type>String</type>
</field>
<field>
<name>resources</name>
<version>3.0.0+</version>
<description>
This element describes all the classpath resources such as properties
files associated with a project. These resources are often included in the final
package.
The default value is {@code src/main/resources}.
@deprecated Replaced by {@code <Source>} with {@code main} scope and {@code resources} language.
</description>
<association>
<type>Resource</type>
<multiplicity>*</multiplicity>
</association>
<annotations>
<annotation>@Deprecated(since = "4.0.0")</annotation>
</annotations>
</field>
<field>
<name>testResources</name>
<version>4.0.0+</version>
<description>
This element describes all the classpath resources such as properties
files associated with a project's unit tests.
The default value is {@code src/test/resources}.
@deprecated Replaced by {@code <Source>} with {@code test} scope and {@code resources} language.
</description>
<association>
<type>Resource</type>
<multiplicity>*</multiplicity>
</association>
<annotations>
<annotation>@Deprecated(since = "4.0.0")</annotation>
</annotations>
</field>
<field>
<name>directory</name>
<version>4.0.0+</version>
<description>
The directory where all files generated by the build are placed.
The default value is {@code target}.
</description>
<type>String</type>
</field>
<field>
<name>finalName</name>
<version>4.0.0+</version>
<description>
The filename (excluding the extension, and with no path information) that
the produced artifact will be called.
The default value is {@code ${artifactId}-${version}}.
</description>
<type>String</type>
</field>
<field>
<name>filters</name>
<version>4.0.0+</version>
<description>The list of filter properties files that are used when filtering is enabled.</description>
<association>
<type>String</type>
<multiplicity>*</multiplicity>
</association>
</field>
</fields>
<codeSegments>
<codeSegment>
<version>4.0.0+</version>
<code>
<![CDATA[
/**
* @see java.lang.Object#toString()
*/
public String toString()
{
return "BuildBase {" + super.toString() + "}";
}
]]>
</code>
</codeSegment>
</codeSegments>
</class>
<class>
<name>Build</name>
<version>3.0.0+</version>
<superClass>BuildBase</superClass>
<description>
The {@code <build>} element contains information required to build the project.
Default values are defined in Super POM.
</description>
<fields>
<field>
<name>sources</name>
<version>4.1.0+</version>
<description>
All the sources to compile and resources files to copy for a project or it's unit tests.
The sources can be Java source files, generated source files, scripts, or resources for examples.
Each source is specified by a {@code directory} element, which is relative to the POM.
The kind of sources (source files to compile or resources to copy) and their usage (for the main code
or for the tests) is specified by the {@code scope} element together with each source directory.
</description>
<association>
<type>Source</type>
<multiplicity>*</multiplicity>
</association>
</field>
<field>
<name>sourceDirectory</name>
<version>3.0.0+</version>
<required>true</required>
<description>
This element specifies a directory containing the source of the project. The
generated build system will compile the sources from this directory when the project is
built. The path given is relative to the project descriptor.
The default value is {@code src/main/java}.
@deprecated Replaced by {@code <Source>} with {@code main} scope.
</description>
<type>String</type>
<annotations>
<annotation>@Deprecated(since = "4.0.0")</annotation>
</annotations>
</field>
<field>
<name>scriptSourceDirectory</name>
<version>4.0.0+</version>
<required>true</required>
<description>
This element specifies a directory containing the script sources of the
project. This directory is meant to be different from the sourceDirectory, in that its
contents will be copied to the output directory in most cases (since scripts are
interpreted rather than compiled).
The default value is {@code src/main/scripts}.
@deprecated Replaced by {@code <Source>} with {@code script} language.
</description>
<type>String</type>
<annotations>
<annotation>@Deprecated(since = "4.0.0")</annotation>
</annotations>
</field>
<field>
<name>testSourceDirectory</name>
<version>4.0.0+</version>
<required>true</required>
<description>
This element specifies a directory containing the unit test source of the
project. The generated build system will compile these directories when the project is
being tested. The path given is relative to the project descriptor.
The default value is {@code src/test/java}.
@deprecated Replaced by {@code <Source>} with {@code test} scope.
</description>
<type>String</type>
<annotations>
<annotation>@Deprecated(since = "4.0.0")</annotation>
</annotations>
</field>
<field>
<name>outputDirectory</name>
<version>4.0.0+</version>
<description>
The directory where compiled application classes are placed.
The default value is {@code target/classes}.
</description>
<type>String</type>
</field>
<field>
<name>testOutputDirectory</name>
<version>4.0.0+</version>
<description>
The directory where compiled test classes are placed.
The default value is {@code target/test-classes}.
</description>
<type>String</type>
</field>
<field>
<name>extensions</name>
<version>4.0.0+</version>
<description>A set of build extensions to use from this project.</description>
<association>
<type>Extension</type>
<multiplicity>*</multiplicity>
</association>
</field>
</fields>
<codeSegments>
<codeSegment>
<version>4.0.0+</version>
<code>
<![CDATA[
/**
* @see java.lang.Object#toString()
*/
public String toString()
{
return "Build {" + super.toString() + "}";
}
]]>
</code>
</codeSegment>
</codeSegments>
</class>
<class>
<name>CiManagement</name>
<version>4.0.0+</version>
<description>
<![CDATA[
The {@code <ciManagement>} element contains information required to the
continuous integration system of the project.
]]>
</description>
<fields>
<field>
<name>system</name>
<version>4.0.0+</version>
<description>
The name of the continuous integration system, e.g. {@code continuum}.
</description>
<type>String</type>