-
Notifications
You must be signed in to change notification settings - Fork 0
/
AutoGeneration.java
2630 lines (2138 loc) · 111 KB
/
AutoGeneration.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
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
/*
* Copyright 2016 Richard Cartwright
*
* Licensed 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.
*/
/*
* $Log: AutoGeneration.java,v $
* Revision 1.16 2011/10/07 19:40:27 vizigoth
* Stop cloning strong references.
*
* Revision 1.15 2011/10/05 17:14:31 vizigoth
* Added support for application metadata plugins, package markers and dynamic metadictionary extraction from AAF files.
*
* Revision 1.14 2011/07/27 17:11:21 vizigoth
* Minor update to comment on move of meta dictionary generator.
*
* Revision 1.13 2011/02/14 22:33:03 vizigoth
* First commit after major sourceforge outage.
*
* Revision 1.12 2011/01/21 17:35:21 vizigoth
* Refactor to extract common generation code and initial authoring of code to generate JUnit tests.
*
* Revision 1.11 2011/01/13 17:44:31 vizigoth
* Major refactor of the industrial area and improved front-end documentation.
*
* Revision 1.10 2011/01/04 10:42:32 vizigoth
* Refactor all package names to simpler forms more consistent with typical Java usage.
*
* Revision 1.9 2010/12/15 19:09:41 vizigoth
* Be a bit less private to allow for future extension.
*
* Revision 1.8 2010/11/08 16:44:04 vizigoth
* Fixed problem found when no eumeration elements are defined.
*
* Revision 1.7 2010/03/05 14:46:53 vizigoth
* Minor fixes, including making sure factory initialization happens once only and that the property keys are unique in propertyList.
*
* Revision 1.6 2010/03/05 09:35:42 vizigoth
* Minor fixes to add imports for strong and weak references to implementations and fix description formatting.
*
* Revision 1.5 2010/03/04 13:21:45 vizigoth
* First complete auto generation that produces code that compiles OK.
*
*/
package tv.amwa.maj.util;
import java.io.File;
import java.security.NoSuchAlgorithmException;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.SortedMap;
import java.util.Vector;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import tv.amwa.maj.enumeration.TypeCategory;
import tv.amwa.maj.industry.MediaEngine;
import tv.amwa.maj.industry.Warehouse;
import tv.amwa.maj.meta.ClassDefinition;
import tv.amwa.maj.record.AUID;
/*
* TODO When registering extension elements for an existing extendible enumeration, a constants class
* needs to be generated and then the elements added using the factory.
*
* Problem noted on BBC fabric project, file FabricCoreFramework_2.xml
*/
/**
* <p>Generate Java classes, interfaces and tests from meta dictionary extension descriptions. This
* command line utility generates a number of Java files from an XML meta dictionary description that can
* be compiled and used with the {@linkplain tv.amwa.maj.industry.MediaEngine media engine} and
* {@linkplain tv.amwa.maj.industry.Forge forge} to create, serialize and deserialize values of the
* defined types.</p>
*
* <p>The typical usage is described in the following steps:</p>
*
* <ol>
* <li><p>Describe a meta dictionary in XML according to the registered data XML meta dictionary format. The
* namespace is:</p><p><center><code>http://www.smpte-ra.org/schemas/2001-1/2007/metadict</code></center></p>
* <p>(See the file <code>AutoFramework.xml</code> in the MAJ distribution for an example, or generate
* some examples using the {@linkplain tv.amwa.maj.io.xml.MetaDictionaryGenerator#generateMetaDictionary(java.util.Collection, java.util.Collection, AUID, String, String, String, AUID, String, String, String, boolean) media engine's
* meta dictionary generator}.)</p></li>
*
* <li><p>Run this java class as an application, providing a package name and the meta dictionary XML file:</p>
* <p><code> java tv.amwa.maj.util.AutoGeneration </code><<em>package_name</em>><code> </code><<em>meta_dictionary_file</em>></p></li>
*
* <li>This generates a folder called <code>src</code> and a folder called <code>test</code> in the current
* working directory. These new folders contain the generated Java files according to the convention for turning a
* Java package name into a directory hierarchy. (Better configuration of the location will be provided in a future
* versions. Tests are not yet generated.)</li>
*
* <li>Optionally, patch the Java files. An automatic approach like this can never produce the most efficient
* code and may not work in all instances. It is recommended that you use an automatic patch mechanism as part
* of any build process.</li>
*
* <li><p>Compile the generated Java files according to your local build strategy. For example:</p>
* <ul>
* <li><code>cd src/com/portability4media/framework</code></li>
* <li><code>javac -classpath $MAJ_JAR -d $COMPILE_TARGET *.java impl/*.java</code></li>
* </ul>
* <p>Note that this code has been tested with Java 6.</p></li>
*
* <li><p>Initialize the compiled types and classes in your application. A factory is generated as part
* of the auto generation to enable you to safely initalize all the required components in the correct order.
* For example:</p>
* <center><<em>package_name</em>><code>.Factory.initialize();</code></center>
* <p>Remember to {@linkplain tv.amwa.maj.industry.MediaEngine#initializeAAF() initialize the AAF baseline classes}
* first if these are required.</p></li>
*
* <li><p>Create instances of the classes described in the meta dictionary. Either use the generic
* factory methods in the {@linkplain tv.amwa.maj.industry.MediaEngine media engine} or the <code>make</code>
* method provided in the newly created factory. For example, for a class with no required properties:</p>
* <p><code> </code><<em>class_name</em>><code> firstInstance =</code><br>
* <code> </code><<em>package_name</em>><code>.Factory.make("</code><<em>class_name</em>><code>");</code></p></li>
*
* </ol>
*
* <p>Below is a brief summary of what this class does when it runs:</p>
*
* <ul>
* <li>All class definitions create a Java interface and a class that implements that interface. Any inheritance
* described in the parent class specification is followed to create (abstract) Java classes and extension
* relationships.</li>
*
* <li>All classes are cloneable and appropriate clone methods are added to the interfaces and
* implementations in such a way that an application does not have to perform a cast.</li>
*
* <li>All classes can be tested for equality, can generate a hash code and write themselves out as a string.
* The string representation is according to the SMPTE 2001-1 registered data XML format.</li>
*
* <li>All implementations have {@linkplain tv.amwa.maj.industry.MediaClass media class} and
* {@linkplain tv.amwa.maj.industry.MediaProperty media property} annotations, amongst others, added so
* that the MAJ {@linkplain tv.amwa.maj.industry.MediaEngine media engine} can be used to manage instances of
* the extension class. At runtime, definitions of the classes can be accessed through the
* {@linkplain tv.amwa.maj.industry.Warehouse warehouse}.</li>
*
* <li>All property definitions for a class are added to the interface for that class. This is normally
* achieved by a pair of get and set methods. Properties of set and variable array type have append, add, remove,
* contains etc. methods generated to manage their elements.<li>
* <li><p>All type definitions result in a static instance to represent them in an interface called
* <Code>TypeDefinitions</code>. The following additional files are generated from these definitions:</p>
*
* <ul>
* <li>All {@linkplain tv.amwa.maj.meta.TypeDefinitionEnumeration enumeration types} result in the generation
* of a Java <code>enum</code>. This allows an application developer to manipulate enumeration values in the
* standard Java way.</li>
* <li>All {@linkplain tv.amwa.maj.meta.TypeDefinitionExtendibleEnumeration extendible extendible enumeration types}
* result in a Java interface containing static constants representing each extendible enumeration element. This
* can be used by an application developer to use names to set enumeration values. These interface files can
* be used to seed values into the {@linkplain tv.amwa.maj.industry.Warehouse warehouse}.<li>
* <li><p>All {@linkplain tv.amwa.maj.meta.TypeDefinitionRecord record types} result in the generation of
* an interface and a class that is an implementation of that interface. The interface has get and set
* methods for each member and the implementation provides basic equals, hash code, clone and to string methods.</p>
* <p>The string representation provides an XML representation of the value. A static <em>parse</em> method to read a
* value represented that way and turn it back into a value of the record type is also provided.</p></li>
* <li>Although no additional file is generated, classes that have the potential to be
* {@linkplain tv.amwa.maj.industry.WeakReferenceTarget weak reference targets} have suitable code
* injected so that they can be referenced and dereferenced at runtime.</p>
* </ul>
*
* <p>At runtime, definitions of the types can be accessed through the
* {@linkplain tv.amwa.maj.industry.Warehouse warehouse}.</p></li>
*
* <li>A file of common constants is created, including the symbol space for the extension meta dictionary.</li>
*
* <li><p>A factory class is generated with convenience methods for initializing and creating instances of the
* defined classes and types. The process of initialization includes:</p>
*
* <ul>
* <li>Registering all the extension classes with the {@linkplain tv.amwa.maj.industry.Warehouse warehouse}.</li>
* <li>Registering all of the extendible enumeration values with the
* {@linkplain tv.amwa.maj.industry.Warehouse warehouse}.</li>
* <li>Registering the implementing classes for all record type values.</li>
* <li>Registering all the extension type definitions with the
* {@linkplain tv.amwa.maj.industry.Warehouse warehouse}.</li>
* </ul>
*
* <p>The factory also contains methods to create and parse values of the extension record types.</p></li>
* <ul>
*
*
*
*/
public class AutoGeneration
extends GenerationCore {
static {
MediaEngine.initializeAAF();
}
public final static void main(
String[] args) {
if (args.length < 2) {
System.out.println("Usage: java tv.amwa.maj.util.AutoGeneration <base_package_name> <metadictionary_XML_file>");
System.exit(1);
}
DictionaryContext context = null;
try{
File file = new File(args[1]);
if (file.exists()){
DocumentBuilderFactory fact = DocumentBuilderFactory.newInstance();
DocumentBuilder builder = fact.newDocumentBuilder();
Document doc = builder.parse(args[1]);
Node node = doc.getDocumentElement();
context = processRoot(node);
}
else{
System.out.println("File not found!");
}
}
catch(Exception e){
System.err.println(e.getClass().getName() + " thrown: " + e.getMessage());
e.printStackTrace();
}
context.basePackageName = args[0];
if (makeDirectories(context) == false) {
System.out.println("Unable to create the required directory structure.");
System.exit(1);
}
boolean success = true;
success &= writeFile(context.interfaceDir, "Constants.java", generateConstants(context));
for ( ClassData classData : classList.values() ) {
success &= writeFile(
context.interfaceDir,
classData.name + ".java",
generateInterface(context.basePackageName, classData));
success &= writeFile(
context.implementationDir,
classData.name + "Impl.java",
generateImplementation(context.basePackageName, classData));
}
for ( TypeData typeData : typeList.values() )
if (typeData instanceof TypeDataEnumeration)
success &= writeFile(
context.interfaceDir,
typeData.name + ".java",
generateEnumeration(context.basePackageName, (TypeDataEnumeration) typeData));
for ( TypeData typeData : typeList.values() )
if (typeData instanceof TypeDataExtendibleEnumeration)
success &= writeFile(
context.interfaceDir,
typeData.name + ".java",
generateExtendibleEnumeration(context.basePackageName, typeData.name, typeData.symbol));
for ( TypeData typeData : typeList.values() )
if (typeData instanceof TypeDataRecord) {
success &= writeFile(
context.interfaceDir,
typeData.name + ".java",
generateRecordInterface(context.basePackageName, (TypeDataRecord) typeData));
success &= writeFile(
context.implementationDir,
typeData.name + "Impl.java",
generateRecordImplementation(context.basePackageName, (TypeDataRecord) typeData));
}
success &= writeFile(
context.interfaceDir,
"TypeDefinitions.java",
generateTypeDefinitions(context.basePackageName));
if ((context.preferredPrefix != null) && (context.preferredPrefix.length() > 0))
context.factoryName = upperFirstLetter(context.preferredPrefix) + "Factory";
else
context.factoryName = "Factory";
success &= writeFile(
context.interfaceDir,
context.factoryName + ".java",
generateFactory(context));
if (success)
System.out.println("Successfully generated all files for package " + context.basePackageName + ".");
else
System.out.println("Problem encountered generating files for package " + context.basePackageName + ".");
}
static String generateInterface(
String packageName,
ClassData classData) {
StringIndenter building = new StringIndenter();
building.setPackageName(packageName);
building.startJavadoc();
building.wrapComment("<p>" + classData.description + "</p>", LINE_WIDTH);
building.blankComment();
building.wrapComment("@author Auto generation.", LINE_WIDTH);
building.endComment();
building.addImport("tv.amwa.maj.industry.MediaEntity");
building.append("public interface " + classData.name);
building.increment("extends");
building.append(" MediaEntity,"); // Everything is a media entity
if (weakReferenceTargets.containsKey(classData.name)) {
building.append(" WeakReferenceTarget,");
building.addImport("tv.amwa.maj.industry.WeakReferenceTarget");
}
if ((classData.parentClass == null) || (classData.parentClass.length() == 0))
building.appendNL(" Cloneable {");
else {
building.append(" Cloneable,");
if (classList.containsKey(classData.parentClass)) {
building.appendNL(" " + classData.parentClass + " {");
}
else {
ClassDefinition widerClass = Warehouse.lookForClass(classData.parentClass);
Class<?>[] interfaces = widerClass.getJavaImplementation().getInterfaces();
// TODO check weirder edge cases where Java name is different e.g. Timecode and TimecodeComponent
for (Class<?> iface : interfaces) {
if (iface.getName().contains(classData.parentClass)) {
building.appendNL(" " + classData.parentClass + " {");
building.addImport(iface.getCanonicalName());
break;
}
}
}
}
for ( PropertyData property : propertyList.values() )
if (property.memberOf.equals(classData.name)) {
addInterfaceGetter(building, property);
addInterfaceSetter(building, property);
}
building.startJavadoc();
building.wrapComment("<p>Create a cloned copy of this " + camelToWords(classData.name) + ".</p>", LINE_WIDTH);
building.blankComment();
building.wrapComment("@return Cloned copy of this " + camelToWords(classData.name) + ".", LINE_WIDTH);
building.endComment();
building.appendNL("public " + classData.name + " clone();");
building.reset("}");
return building.toString();
}
static void addInterfaceGetter(
StringIndenter building,
PropertyData property) {
TypeData typeData = typeByName(property.type);
building.addImport(typeData.getImports());
String annotation = typeData.getAnnotation();
if (annotation == null)
annotation = "";
else
annotation = "@" + annotation + " ";
building.startJavadoc();
building.wrapComment("<p>Returns the " + lowerFirstLetter(property.description) + "</p>", LINE_WIDTH);
building.blankComment();
if (property.isOptional) {
building.wrapComment("<p>This is an optional property.</p>", LINE_WIDTH);
building.blankComment();
}
building.wrapComment("@return " + firstSentence(property.description), LINE_WIDTH);
if (property.isOptional) {
building.append(" *");
building.wrapComment("@throws PropertyNotPresentException The optional " + camelToWords(property.name) +
" property is not present for this " + camelToWords(property.memberOf) + ".", LINE_WIDTH);
}
building.endComment();
switch (typeData.getTypeCategory()) {
case VariableArray:
building.append("public List<? extends " + typeByName(property.type).getJavaGetName() +
"> get" + property.name + "()" + (property.isOptional ? "" : ";\n"));
building.addImport("java.util.List");
break;
case FixedArray:
building.append("public " + annotation + typeByName(property.type).getJavaGetName() +
"[] get" + property.name + "()" + (property.isOptional ? "" : ";\n"));
break;
case Set:
building.append("public Set<? extends " + typeByName(property.type).getJavaGetName() +
"> get" + property.name + "()" + (property.isOptional ? "" : ";\n"));
building.addImport("java.util.Set");
break;
default:
building.append("public " + annotation + typeByName(property.type).getJavaGetName() +
" get" + property.name + "()" + (property.isOptional ? "" : ";\n"));
break;
}
if (property.isOptional) {
building.appendNL(" throws PropertyNotPresentException;");
building.addImport("tv.amwa.maj.exception.PropertyNotPresentException");
}
}
static void addInterfaceSetter(
StringIndenter building,
PropertyData property) {
TypeData typeData = typeByName(property.type);
building.addImport(typeData.getImports());
String annotation = typeData.getAnnotation();
if (annotation == null)
annotation = "";
else
annotation = "@" + annotation + " ";
switch (typeData.getTypeCategory()) {
case Set:
setTypeInterfaceMethods(building, property, typeData, annotation);
break;
case VariableArray:
variableArrayInterfaceMethods(building, property, typeData, annotation);
break;
case FixedArray:
fixedArrayInterfaceMethods(building, property, typeData, annotation);
break;
default:
defaultInterfaceSetter(building, property, typeData, annotation);
break;
}
}
private static void defaultInterfaceSetter(
StringIndenter building,
PropertyData property,
TypeData typeData,
String annotation) {
building.startJavadoc();
building.wrapComment("<p>Sets the " + lowerFirstLetter(property.description) + "</p>", LINE_WIDTH);
building.blankComment();
if (property.isOptional) {
building.wrapComment("<p>Set this optional property to <code>null</code> to omit it.</p>", LINE_WIDTH);
building.blankComment();
}
building.wrapComment("@param " + lowerFirstLetter(property.name) + " " + firstSentence(property.description), LINE_WIDTH);
if ((!property.isOptional) && (isNullableType(typeData))) {
building.blankComment();
building.wrapComment("@throws NullPointerException Cannot set the required " + camelToWords(property.name) +
" with a <code>null</code> value.", LINE_WIDTH);
}
if (typeData.getThrowsIllegal()) {
if (property.isOptional) building.blankComment();
building.wrapComment("@throws IllegalArgumentException Cannot set the " + camelToWords(property.name) +
" property with the given value.", LINE_WIDTH);
}
building.endComment();
building.append("public void set" + property.name + "(");
building.append(" " + annotation + typeData.getJavaSetName(property.isOptional) + " " +
lowerFirstLetter(property.name) + ")");
List<String> exceptional = new Vector<String>();
if ((!property.isOptional) && (isNullableType(typeData)))
exceptional.add("NullPointerException");
if (typeData.getThrowsIllegal()) exceptional.add("IllegalArgumentException");
building.addThrowsClause(exceptional, true);
}
private static void setTypeInterfaceMethods(
StringIndenter building,
PropertyData property,
TypeData typeData,
String annotation) {
building.startJavadoc();
building.wrapComment("<p>Add " + aOrAn(camelToWords(typeData.getJavaGetName())) + " to the set of " +
camelToWords(property.name) + " for this " + camelToWords(property.memberOf) + ". This is a " +
lowerFirstLetter(property.description) + "</p>", LINE_WIDTH);
building.blankComment();
if (property.isOptional) {
building.wrapComment("<p>This is an optional property. Adding a value when it is omitted will make it present.</p>",
LINE_WIDTH);
building.blankComment();
}
building.wrapComment("@param " + lowerFirstLetter(makeSingular(property.name)) + " " +
"Element to add to the set of " + camelToWords(property.name) + ".", LINE_WIDTH);
building.blankComment();
building.wrapComment("@throws NullPointerException Cannot add a null " + camelToWords(typeData.getJavaGetName()) +
" to the set of " + camelToWords(property.name) + ".", LINE_WIDTH);
if (typeData.getThrowsIllegal())
building.wrapComment("@throws IllegalArgumentException The given value cannot be set as an element of the set of " +
camelToWords(property.name) + ".", LINE_WIDTH);
building.endComment();
building.append("public void add" + makeSingular(property.name) + "(");
building.append(" " + annotation + typeData.getJavaSetName(property.isOptional) + " " +
lowerFirstLetter(makeSingular(property.name)) + ")");
List<String> exceptional = new Vector<String>();
exceptional.add("NullPointerException");
if (typeData.getThrowsIllegal()) exceptional.add("IllegalArgumentException");
building.addThrowsClause(exceptional, true);
building.startJavadoc();
building.wrapComment("<p>Test to see if the given " + camelToWords(typeData.getJavaGetName()) +
" is contained in this set of " + camelToWords(property.name) + ". Testing for containment in the " +
lowerFirstLetter(property.description) + "</p>", LINE_WIDTH);
building.blankComment();
building.wrapComment("@param " + lowerFirstLetter(makeSingular(property.name)) + " The " +
camelToWords(typeData.getJavaGetName()) + " to test for.", LINE_WIDTH);
building.wrapComment("@return Is the given " + camelToWords(typeData.getJavaGetName()) +
" present in the set of " + camelToWords(property.name) + "?", LINE_WIDTH);
building.blankComment();
building.wrapComment("@throws NullPointerException Cannot check for containment using a <code>null</code> value.",
LINE_WIDTH);
building.endComment();
building.append("public boolean contains" + makeSingular(property.name) + "(");
building.append(" " + typeData.getJavaGetName() + " " + lowerFirstLetter(makeSingular(property.name)) + ")");
exceptional.clear();
exceptional.add("NullPointerException");
building.addThrowsClause(exceptional, true);
building.startJavadoc();
building.wrapComment("<p>Remove a value equal to the given " + camelToWords(typeData.getJavaGetName()) +
" from the set of " + camelToWords(property.name) + ". Element will be removed from the " +
lowerFirstLetter(property.description) + "</p>", LINE_WIDTH);
building.blankComment();
if (!property.isOptional) {
building.wrapComment("<p>This property is required. If the last element is removed, you should add in a new element to satisfy the required constraint.</p>", LINE_WIDTH);
building.blankComment();
}
building.wrapComment("@param " + lowerFirstLetter(makeSingular(property.name)) + " The " +
camelToWords(typeData.getJavaGetName()) + " to remove from the set.", LINE_WIDTH);
building.wrapComment("@return Has the given element been removed from the set of " +
camelToWords(property.name) + "?", LINE_WIDTH);
building.blankComment();
building.wrapComment("@throws NullPointerException Cannot remove a <code>null</code> value from a set.", LINE_WIDTH);
building.endComment();
building.append("public boolean remove" + makeSingular(property.name) + "(");
building.append(" " + typeData.getJavaGetName() + " " + lowerFirstLetter(makeSingular(property.name)) + ")");
exceptional.clear();
exceptional.add("NullPointerException");
building.addThrowsClause(exceptional, true);
sharedInterfaceMethods(building, property, typeData, annotation);
}
private static void variableArrayInterfaceMethods(
StringIndenter building,
PropertyData property,
TypeData typeData,
String annotation) {
// Append
building.startJavadoc();
building.wrapComment("<p>Append " + aOrAn(camelToWords(typeData.getJavaGetName())) + " to the list of " +
camelToWords(property.name) +". The element is appended to the " + lowerFirstLetter(property.description) + "</p>",
LINE_WIDTH);
building.blankComment();
building.wrapComment("@param " + lowerFirstLetter(makeSingular(property.name)) + " The " +
camelToWords(typeData.getJavaGetName()) + " to append to the list of " +
camelToWords(property.name) +".", LINE_WIDTH);
building.blankComment();
building.wrapComment("@throws NullPointerException Cannot append a <code>null</code> to the list of " +
camelToWords(property.name) +".", LINE_WIDTH);
if (typeData.getThrowsIllegal())
building.wrapComment("@throws IllegalArgumentException The given value is outside the acceptable range for this property.",
LINE_WIDTH);
building.blankComment();
building.wrapComment("@see #prepend" + makeSingular(property.name) + "(" + typeData.getJavaGetName() + ")", LINE_WIDTH);
building.wrapComment("@see #insert"+ makeSingular(property.name) + "(int, " + typeData.getJavaGetName() + ")", LINE_WIDTH);
building.endComment();
building.append("public void append" + makeSingular(property.name) + "(");
building.append(" " + annotation + typeData.getJavaGetName() + " " +
lowerFirstLetter(makeSingular(property.name)) + ")");
List<String> exceptional = new Vector<String>();
exceptional.add("NullPointerException");
if (typeData.getThrowsIllegal()) exceptional.add("IllegalArgumentException");
building.addThrowsClause(exceptional, true);
// Prepend
building.startJavadoc();
building.wrapComment("<p>Prepend " + aOrAn(camelToWords(typeData.getJavaGetName())) + " to the list of " +
camelToWords(property.name) +". The element is prepended to the " + lowerFirstLetter(property.description) + "</p>",
LINE_WIDTH);
building.blankComment();
building.wrapComment("@param " + lowerFirstLetter(makeSingular(property.name)) + " The " +
camelToWords(typeData.getJavaGetName()) + " to prepend to the list of " +
camelToWords(property.name) +".", LINE_WIDTH);
building.blankComment();
building.wrapComment("@throws NullPointerException Cannot prepend a <code>null</code> to the list of " +
camelToWords(property.name) +".", LINE_WIDTH);
if (typeData.getThrowsIllegal())
building.wrapComment("@throws IllegalArgumentException The given value is outside the acceptable range for this property.",
LINE_WIDTH);
building.blankComment();
building.wrapComment("@see #append" + makeSingular(property.name) + "(" + typeData.getJavaGetName() + ")", LINE_WIDTH);
building.wrapComment("@see #insert"+ makeSingular(property.name) + "(int, " + typeData.getJavaGetName() + ")", LINE_WIDTH);
building.endComment();
building.append("public void prepend" + makeSingular(property.name) + "(");
building.append(" " + annotation + typeData.getJavaGetName() + " " +
lowerFirstLetter(makeSingular(property.name)) + ")");
exceptional.clear();
exceptional.add("NullPointerException");
if (typeData.getThrowsIllegal()) exceptional.add("IllegalArgumentException");
building.addThrowsClause(exceptional, true);
// Insert
building.startJavadoc();
building.wrapComment("<p>Insert " + aOrAn(camelToWords(typeData.getJavaGetName())) + " into the list of " +
camelToWords(property.name) + " at the given index. The element is prepended to the " +
lowerFirstLetter(property.description) + "</p>", LINE_WIDTH);
building.blankComment();
building.wrapComment("@param index Index in the list of " + camelToWords(property.name) +
" where the element is to be inserted.", LINE_WIDTH);
building.wrapComment("@param " + lowerFirstLetter(makeSingular(property.name)) + " The " +
camelToWords(typeData.getJavaGetName()) + " to insert into the list of " +
camelToWords(property.name) +".", LINE_WIDTH);
building.blankComment();
building.wrapComment("@throws NullPointerException Cannot insert a <code>null</code> to the list of " +
camelToWords(property.name) +".", LINE_WIDTH);
building.wrapComment("@throws IndexOutOfBoundsException The given index is outside the acceptable range for the current list of " +
camelToWords(property.name) + ".", LINE_WIDTH);
if (typeData.getThrowsIllegal())
building.wrapComment("@throws IllegalArgumentException The given value is outside the acceptable range for this property.",
LINE_WIDTH);
building.blankComment();
building.wrapComment("@see #append" + makeSingular(property.name) + "(" + typeData.getJavaGetName() + ")", LINE_WIDTH);
building.wrapComment("@see #prepend"+ makeSingular(property.name) + "(" + typeData.getJavaGetName() + ")", LINE_WIDTH);
building.endComment();
building.append("public void insert" + makeSingular(property.name) + "At(");
building.append(" int index,");
building.append(" " + annotation + typeData.getJavaGetName() + " " +
lowerFirstLetter(makeSingular(property.name)) + ")");
exceptional.clear();
exceptional.add("NullPointerException");
exceptional.add("IndexOutOfBoundsException");
if (typeData.getThrowsIllegal()) exceptional.add("IllegalArgumentException");
building.addThrowsClause(exceptional, true);
// Contains
building.startJavadoc();
building.wrapComment("<p>Determines whether the given " + camelToWords(makeSingular(property.name)) +
" is contained in the list of " + camelToWords(property.name) + ". This is the list of " +
lowerFirstLetter(property.description) + "</p>", LINE_WIDTH);
building.blankComment();
building.wrapComment("@param " + lowerFirstLetter(makeSingular(property.name)) + " The " +
camelToWords(makeSingular(property.name)) + " to test for in the list of " +
camelToWords(property.name) + ".", LINE_WIDTH);
building.wrapComment("@return Is the given " + camelToWords(makeSingular(property.name)) +
" contained in the list of " + camelToWords(property.name) + "?" , LINE_WIDTH);
building.blankComment();
building.wrapComment("@throws NullPointerException Cannot check for the containment of a <code>null</code> value.",
LINE_WIDTH);
building.endComment();
building.append("public boolean contains" + makeSingular(property.name) + "(");
building.append(" " + annotation + typeData.getJavaGetName() + " " +
lowerFirstLetter(makeSingular(property.name)) + ")");
exceptional.clear();
exceptional.add("NullPointerException");
building.addThrowsClause(exceptional, true);
// GetAt
building.startJavadoc();
building.wrapComment("<p>Get the " + camelToWords(makeSingular(property.name)) + " at the given index into the list of " +
camelToWords(property.name) + ". This is the " + lowerFirstLetter(property.description) + "</p>", LINE_WIDTH);
building.blankComment();
building.wrapComment("@param index Index of the element to retrieve from the list of " + camelToWords(property.name) +
".", LINE_WIDTH);
building.wrapComment("@return The " + camelToWords(makeSingular(property.name)) + " at the given index.", LINE_WIDTH);
building.blankComment();
building.wrapComment("@throws IndexOutOfBoundsException The given index is outside the acceptable range for the current list of " +
camelToWords(property.name) + ".", LINE_WIDTH);
building.blankComment();
building.wrapComment("@see #get" + property.name + "()", LINE_WIDTH);
building.endComment();
building.append("public " + annotation + typeData.getJavaGetName() + " get" + makeSingular(property.name) + "At(");
building.append(" int index)");
exceptional.clear();
exceptional.add("IndexOutOfBoundsException");
building.addThrowsClause(exceptional, true);
// Remove
building.startJavadoc();
building.wrapComment("<p>Remove the " + camelToWords(makeSingular(property.name)) + " at the given index into the list of " +
camelToWords(property.name) + ". This is the " + lowerFirstLetter(property.description) + "</p>", LINE_WIDTH);
building.blankComment();
building.wrapComment("@param index Index of the element to remove from the list of " + camelToWords(property.name) +
".", LINE_WIDTH);
building.blankComment();
building.wrapComment("@throws IndexOutOfBoundsException The given index is outside the acceptable range for the current list of " +
camelToWords(property.name) + ".", LINE_WIDTH);
building.endComment();
building.append("public void remove" + makeSingular(property.name) + "At(");
building.append(" int index)");
exceptional.clear();
exceptional.add("IndexOutOfBoundsException");
building.addThrowsClause(exceptional, true);
sharedInterfaceMethods(building, property, typeData, annotation);
}
private static void fixedArrayInterfaceMethods(
StringIndenter building,
PropertyData property,
TypeData typeData,
String annotation) {
building.startJavadoc();
building.wrapComment("<p>Sets the " + lowerFirstLetter(property.description) + "</p>", LINE_WIDTH);
building.blankComment();
if (property.isOptional) {
building.wrapComment("<p>Set this optional property to <code>null</code> to omit it.</p>", LINE_WIDTH);
building.blankComment();
}
building.wrapComment("@param " + lowerFirstLetter(property.name) + " " + firstSentence(property.description), LINE_WIDTH);
building.blankComment();
building.wrapComment("@throws NullPointerException Cannot set the required " + camelToWords(property.name) +
" with a <code>null</code> value or one of the elements of the given array is <code>null</code>.", LINE_WIDTH);
if (typeData.getThrowsIllegal()) {
if (property.isOptional) building.blankComment();
building.wrapComment("@throws IllegalArgumentException Cannot set the " + camelToWords(property.name) +
" property with the given value.", LINE_WIDTH);
}
building.endComment();
building.append("public void set" + property.name + "(");
building.append(" " + annotation + typeData.getJavaSetName(property.isOptional) + " " +
lowerFirstLetter(property.name) + "[])");
List<String> exceptional = new Vector<String>();
exceptional.add("NullPointerException");
if (typeData.getThrowsIllegal()) exceptional.add("IllegalArgumentException");
building.addThrowsClause(exceptional, true);
}
private static void sharedInterfaceMethods(
StringIndenter building,
PropertyData property,
TypeData typeData,
String annotation) {
building.startJavadoc();
building.wrapComment("<p>Clears the set of " + camelToWords(property.name) + ", which is a " +
lowerFirstLetter(property.description) + "</p>", LINE_WIDTH);
building.blankComment();
if (!property.isOptional)
building.wrapComment("<p>This is a required property. Elements should be added back in directly after calling this method to satisfy the required constraint.</p>", LINE_WIDTH);
else
building.wrapComment("<p>Calling this method will omit this optional property.</p>", LINE_WIDTH);
building.endComment();
building.appendNL("public void clear" + property.name + "();");
building.startJavadoc();
building.wrapComment("<p>Counts the number of elements in the set of " + camelToWords(property.name) + ". This set is a " +
lowerFirstLetter(property.description) + "</p>", LINE_WIDTH);
building.blankComment();
building.wrapComment("@return Number of elements in the set of " + camelToWords(property.name) + ".", LINE_WIDTH);
building.endComment();
building.appendNL("public int count" + property.name + "();");
}
static String generateImplementation(
String basePackageName,
ClassData classData) {
StringIndenter building = new StringIndenter();
building.setPackageName(basePackageName + ".impl");
building.startJavadoc();
building.wrapComment("<p>" + classData.description + " Implementation.</p>", LINE_WIDTH);
building.blankComment();
building.wrapComment("@author Auto generation.", LINE_WIDTH);
building.endComment();
building.addImport("tv.amwa.maj.industry.MediaClass");
building.addImport(basePackageName + ".Constants");
building.append("@MediaClass(");
building.increment("definedName = \"" + classData.name + "\",");
building.append("uuid1 = 0x" + padHexTo8(classData.identification.getData1()) +
", uuid2 = (short) 0x" + padHexTo4(classData.identification.getData2()) +
", uuid3 = (short) 0x" + padHexTo4(classData.identification.getData3()) + ",");
building.append("uuid4 = { " + bytesToText(classData.identification.getData4()) + " },");
if (classData.description != null)
building.append("description = \"" + classData.description.replace("\"", "\\\"") + "\",");
else
building.append("description = \"\",");
building.append("namespace = Constants.XML_NAMESPACE,");
building.append("prefix = Constants.XML_PREFIX,");
building.append("symbol = \"" + classData.symbol + "\")");
building.reset("public " + (classData.isConcrete ? "" : "abstract ") + "class " + classData.name + "Impl");
if ((classData.parentClass != null) && (classData.parentClass.length() > 0)) {
building.append(" extends");
if (classList.containsKey(classData.parentClass))
building.append(" " + classData.parentClass + "Impl");
else {
ClassDefinition widerClass = Warehouse.lookForClass(classData.parentClass);
building.append(" " + classData.parentClass + "Impl");
building.addImport(widerClass.getJavaImplementation().getCanonicalName());
}
}
building.addImport(basePackageName + "." + classData.name);
building.addImport("tv.amwa.maj.io.xml.XMLSerializable");
building.addImport("tv.amwa.maj.constant.CommonConstants");
building.addImport("java.io.Serializable");
building.increment("implements");
building.append(" " + classData.name + ",");
building.append(" CommonConstants,");
building.append(" Serializable,");
building.append(" XMLSerializable,");
if (weakReferenceTargets.containsKey(classData.name)) {
building.addImport("tv.amwa.maj.industry.WeakReferenceTarget");
building.append(" WeakReferenceTarget,");
}
building.appendNL(" Cloneable {");
java.security.MessageDigest messageDigest;
try {
messageDigest = java.security.MessageDigest.getInstance("MD5");
} catch (NoSuchAlgorithmException e) {
throw new InternalError("Unable to find MD5 checksum algorithm.");
}
messageDigest.update(classData.identification.getAUIDValue());
for ( PropertyData property : propertyList.values() )
if (property.memberOf.equals(classData.name))
messageDigest.update(property.identification.getAUIDValue());
byte[] uidBytes = messageDigest.digest();
long uid = ((long) uidBytes[0]) << 56 ^ ((long) uidBytes[1]) << 48 ^ ((long) uidBytes[2]) << 40 ^ ((long) uidBytes[3]) << 32 ^
((long) uidBytes[4]) << 24 ^ ((long) uidBytes[5]) << 16 ^ ((long) uidBytes[6]) << 8 ^ ((long) uidBytes[7]);
building.appendNL("private static final long serialVersionUID = " + uid + "l;");
for ( PropertyData property : propertyList.values() ) {
if (property.memberOf.equals(classData.name)) {
TypeData typeData = typeByName(property.type);
building.addImport(typeData.getImports());
String annotation = typeData.getAnnotation();
if (annotation == null)
annotation = "";
else
annotation = "@" + annotation + " ";
switch (typeData.getTypeCategory()) {
case WeakObjRef:
building.append("private WeakReference<" + typeData.getJavaGetName() + "> " +
lowerFirstLetter(property.name) + ";");
building.addImport("tv.amwa.maj.industry.WeakReference");
String weakRefType = ((TypeDataWeakObjectReference) typeData).referencedType;
if (classList.containsKey(weakRefType))
building.addImport(basePackageName + "." + weakRefType);
else
building.addImport(typeData.getImports());
break;
case Set:
TypeDataSet setType = (TypeDataSet) typeData;
TypeData setElementType = typeByName(setType.elementType);
building.addImport("java.util.Set");
switch (setElementType.getTypeCategory()) {
case WeakObjRef:
building.append("private WeakReferenceSet<" + typeData.getJavaGetName() + "> " +
lowerFirstLetter(property.name) + " =");
building.append(" new WeakReferenceSet<" + typeData.getJavaGetName() + ">();");
building.addImport("tv.amwa.maj.industry.WeakReferenceSet");
if (classList.containsKey(((TypeDataWeakObjectReference) setElementType).referencedType))
building.addImport(basePackageName + "." + typeData.getJavaGetName());
else
building.addImport(setElementType.getImports());
break;
default:
building.append("private Set<" + typeData.getJavaSetName(true) + "> " +
lowerFirstLetter(property.name) + " =");
building.append(" Collections.synchronizedSet(new HashSet<" + typeData.getJavaSetName(true) + ">());");
building.addImport("tv.amwa.maj.industry.StrongReferenceSet");
building.addImport("java.util.Collections");
building.addImport("java.util.HashSet");
if ((setElementType instanceof TypeDataStrongObjectReference)
&& (classList.containsKey(((TypeDataStrongObjectReference) setElementType).referencedType)))
building.addImport(basePackageName + "." + typeData.getJavaSetName(true));
else
building.addImport(setElementType.getImports());
break;
}
break;
case VariableArray:
TypeDataVariableArray varialbeArrayType = (TypeDataVariableArray) typeData;
TypeData arrayElementType = typeByName(varialbeArrayType.elementType);
switch (arrayElementType.getTypeCategory()) {
case WeakObjRef:
building.append("private WeakReferenceVector<" + typeData.getJavaGetName() + "> " +
lowerFirstLetter(property.name) + " =");
building.append(" new WeakReferenceVector<" + typeData.getJavaGetName() + ">();");
building.addImport("tv.amwa.maj.industry.WeakReferenceVector");
if (classList.containsKey(((TypeDataWeakObjectReference) arrayElementType).referencedType))
building.addImport(basePackageName + "." + typeData.getJavaGetName());
else
building.addImport(arrayElementType.getImports());
break;
default:
building.append("private List<" + typeData.getJavaSetName(true) + "> " +
lowerFirstLetter(property.name) + " =");
building.append(" Collections.synchronizedList(new Vector<" + typeData.getJavaSetName(true) + ">());");
building.addImport("tv.amwa.maj.industry.StrongReferenceVector");
building.addImport("java.util.Collections");
building.addImport("java.util.List");
building.addImport("java.util.Vector");
if ((arrayElementType instanceof TypeDataStrongObjectReference)
&& (classList.containsKey(((TypeDataStrongObjectReference) arrayElementType).referencedType)))
building.addImport(basePackageName + "." + typeData.getJavaSetName(true));
else
building.addImport(arrayElementType.getImports());
break;
}
break;
case StrongObjRef:
building.append("private " + annotation + typeData.getJavaSetName(property.isOptional) + " " +