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
package Torello.Browser;

import java.util.*;
import javax.json.*;
import javax.json.stream.*;
import java.io.*;

import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import java.util.function.Function;

import Torello.Java.Additional.*;
import Torello.Java.JSON.*;

import static Torello.Java.JSON.JFlag.*;

import Torello.Java.StrCmpr;
import Torello.JavaDoc.StaticFunctional;
import Torello.JavaDoc.JDHeaderBackgroundImg;
import Torello.JavaDoc.Excuse;

/**
 * <SPAN CLASS=COPIEDJDK><B>Reporting of performance timeline events, as specified in
 * https://w3c.github.io/performance-timeline/#dom-performanceobserver.</B></SPAN>
 * 
 * <EMBED CLASS='external-html' DATA-FILE-ID=CODE_GEN_NOTE>
 */
@StaticFunctional(Excused={"counter"}, Excuses={Excuse.CONFIGURATION})
@JDHeaderBackgroundImg(EmbedTagFileID="WOOD_PLANK_NOTE")
public class PerformanceTimeline
{
    // ********************************************************************************************
    // ********************************************************************************************
    // Class Header Stuff
    // ********************************************************************************************
    // ********************************************************************************************


    // No Pubic Constructors
    private PerformanceTimeline () { }

    // These two Vector's are used by all the "Methods" exported by this class.  java.lang.reflect
    // is used to generate the JSON String's.  It saves thousands of lines of Auto-Generated Code.
    private static final Map<String, Vector<String>>    parameterNames = new HashMap<>();
    private static final Map<String, Vector<Class<?>>>  parameterTypes = new HashMap<>();

    // Some Methods do not take any parameters - for instance all the "enable()" and "disable()"
    // I simply could not get ride of RAW-TYPES and UNCHECKED warnings... so there are now,
    // offically, two empty-vectors.  One for String's, and the other for Classes.

    private static final Vector<String>     EMPTY_VEC_STR = new Vector<>();
    private static final Vector<Class<?>>   EMPTY_VEC_CLASS = new Vector<>();

    static
    {
        for (Method m : PerformanceTimeline.class.getMethods())
        {
            // This doesn't work!  The parameter names are all "arg0" ... "argN"
            // It works for java.lang.reflect.Field, BUT NOT java.lang.reflect.Parameter!
            //
            // Vector<String> parameterNamesList = new Vector<>(); -- NOPE!

            Vector<Class<?>> parameterTypesList = new Vector<>();
        
            for (Parameter p : m.getParameters()) parameterTypesList.add(p.getType());

            parameterTypes.put(
                m.getName(),
                (parameterTypesList.size() > 0) ? parameterTypesList : EMPTY_VEC_CLASS
            );
        }
    }

    static
    {
        Vector<String> v = null;

        v = new Vector<String>(1);
        parameterNames.put("enable", v);
        Collections.addAll(v, new String[]
        { "eventTypes", });
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Types - Static Inner Classes
    // ********************************************************************************************
    // ********************************************************************************************

    /** See https://github.com/WICG/LargestContentfulPaint and largest_contentful_paint.idl */
    public static class LargestContentfulPaint
        extends BaseType
        implements java.io.Serializable
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, false, false, true, true, true, }; }
        
        /** <CODE>[No Description Provided by Google]</CODE> */
        public final Number renderTime;
        
        /** <CODE>[No Description Provided by Google]</CODE> */
        public final Number loadTime;
        
        /** The number of pixels being painted. */
        public final Number size;
        
        /**
         * The id attribute of the element, if available.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final String elementId;
        
        /**
         * The URL of the image (may be trimmed).
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final String url;
        
        /**
         * <CODE>[No Description Provided by Google]</CODE>
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Integer nodeId;
        
        /**
         * Constructor
         *
         * @param renderTime -
         * 
         * @param loadTime -
         * 
         * @param size The number of pixels being painted.
         * 
         * @param elementId The id attribute of the element, if available.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param url The URL of the image (may be trimmed).
         * <BR /><B>OPTIONAL</B>
         * 
         * @param nodeId -
         * <BR /><B>OPTIONAL</B>
         */
        public LargestContentfulPaint(
                Number renderTime, Number loadTime, Number size, String elementId, String url, 
                Integer nodeId
            )
        {
            // Exception-Check(s) to ensure that if any parameters which are not declared as
            // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
            
            if (renderTime == null) BRDPC.throwNPE("renderTime");
            if (loadTime == null)   BRDPC.throwNPE("loadTime");
            if (size == null)       BRDPC.throwNPE("size");
            
            this.renderTime  = renderTime;
            this.loadTime    = loadTime;
            this.size        = size;
            this.elementId   = elementId;
            this.url         = url;
            this.nodeId      = nodeId;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'LargestContentfulPaint'}.
         */
        public LargestContentfulPaint (JsonObject jo)
        {
            this.renderTime  = ReadNumberJSON.get(jo, "renderTime", false, true);
            this.loadTime    = ReadNumberJSON.get(jo, "loadTime", false, true);
            this.size        = ReadNumberJSON.get(jo, "size", false, true);
            this.elementId   = ReadJSON.getString(jo, "elementId", true, false);
            this.url         = ReadJSON.getString(jo, "url", true, false);
            this.nodeId      = ReadBoxedJSON.getInteger(jo, "nodeId", true);
        }
        
        
        /** Checks whether {@code 'this'} equals an input Java-{@code Object} */
        public boolean equals(Object other)
        {
            if (other == null)                       return false;
            if (other.getClass() != this.getClass()) return false;
        
            LargestContentfulPaint o = (LargestContentfulPaint) other;
        
            return
                    Objects.equals(this.renderTime, o.renderTime)
                &&  Objects.equals(this.loadTime, o.loadTime)
                &&  Objects.equals(this.size, o.size)
                &&  Objects.equals(this.elementId, o.elementId)
                &&  Objects.equals(this.url, o.url)
                &&  Objects.equals(this.nodeId, o.nodeId);
        }
        
        /** Generates a Hash-Code for {@code 'this'} instance */
        public int hashCode()
        {
            return
                    Objects.hashCode(this.renderTime)
                +   Objects.hashCode(this.loadTime)
                +   Objects.hashCode(this.size)
                +   Objects.hashCode(this.elementId)
                +   Objects.hashCode(this.url)
                +   Objects.hashCode(this.nodeId);
        }
    }
    
    /** <CODE>[No Description Provided by Google]</CODE> */
    public static class LayoutShiftAttribution
        extends BaseType
        implements java.io.Serializable
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, false, true, }; }
        
        /** <CODE>[No Description Provided by Google]</CODE> */
        public final DOM.Rect previousRect;
        
        /** <CODE>[No Description Provided by Google]</CODE> */
        public final DOM.Rect currentRect;
        
        /**
         * <CODE>[No Description Provided by Google]</CODE>
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Integer nodeId;
        
        /**
         * Constructor
         *
         * @param previousRect -
         * 
         * @param currentRect -
         * 
         * @param nodeId -
         * <BR /><B>OPTIONAL</B>
         */
        public LayoutShiftAttribution
            (DOM.Rect previousRect, DOM.Rect currentRect, Integer nodeId)
        {
            // Exception-Check(s) to ensure that if any parameters which are not declared as
            // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
            
            if (previousRect == null) BRDPC.throwNPE("previousRect");
            if (currentRect == null)  BRDPC.throwNPE("currentRect");
            
            this.previousRect  = previousRect;
            this.currentRect   = currentRect;
            this.nodeId        = nodeId;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'LayoutShiftAttribution'}.
         */
        public LayoutShiftAttribution (JsonObject jo)
        {
            this.previousRect  = ReadJSON.getObject(jo, "previousRect", DOM.Rect.class, false, true);
            this.currentRect   = ReadJSON.getObject(jo, "currentRect", DOM.Rect.class, false, true);
            this.nodeId        = ReadBoxedJSON.getInteger(jo, "nodeId", true);
        }
        
        
        /** Checks whether {@code 'this'} equals an input Java-{@code Object} */
        public boolean equals(Object other)
        {
            if (other == null)                       return false;
            if (other.getClass() != this.getClass()) return false;
        
            LayoutShiftAttribution o = (LayoutShiftAttribution) other;
        
            return
                    Objects.equals(this.previousRect, o.previousRect)
                &&  Objects.equals(this.currentRect, o.currentRect)
                &&  Objects.equals(this.nodeId, o.nodeId);
        }
        
        /** Generates a Hash-Code for {@code 'this'} instance */
        public int hashCode()
        {
            return
                    this.previousRect.hashCode()
                +   this.currentRect.hashCode()
                +   Objects.hashCode(this.nodeId);
        }
    }
    
    /** See https://wicg.github.io/layout-instability/#sec-layout-shift and layout_shift.idl */
    public static class LayoutShift
        extends BaseType
        implements java.io.Serializable
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, false, false, false, }; }
        
        /** Score increment produced by this event. */
        public final Number value;
        
        /** <CODE>[No Description Provided by Google]</CODE> */
        public final boolean hadRecentInput;
        
        /** <CODE>[No Description Provided by Google]</CODE> */
        public final Number lastInputTime;
        
        /** <CODE>[No Description Provided by Google]</CODE> */
        public final PerformanceTimeline.LayoutShiftAttribution[] sources;
        
        /**
         * Constructor
         *
         * @param value Score increment produced by this event.
         * 
         * @param hadRecentInput -
         * 
         * @param lastInputTime -
         * 
         * @param sources -
         */
        public LayoutShift(
                Number value, boolean hadRecentInput, Number lastInputTime, 
                PerformanceTimeline.LayoutShiftAttribution[] sources
            )
        {
            // Exception-Check(s) to ensure that if any parameters which are not declared as
            // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
            
            if (value == null)         BRDPC.throwNPE("value");
            if (lastInputTime == null) BRDPC.throwNPE("lastInputTime");
            if (sources == null)       BRDPC.throwNPE("sources");
            
            this.value           = value;
            this.hadRecentInput  = hadRecentInput;
            this.lastInputTime   = lastInputTime;
            this.sources         = sources;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'LayoutShift'}.
         */
        public LayoutShift (JsonObject jo)
        {
            this.value           = ReadNumberJSON.get(jo, "value", false, true);
            this.hadRecentInput  = ReadPrimJSON.getBoolean(jo, "hadRecentInput");
            this.lastInputTime   = ReadNumberJSON.get(jo, "lastInputTime", false, true);
            this.sources = (jo.getJsonArray("sources") == null)
                ? null
                : ReadArrJSON.DimN.objArr(jo.getJsonArray("sources"), null, 0, PerformanceTimeline.LayoutShiftAttribution[].class);
        
        }
        
        
        /** Checks whether {@code 'this'} equals an input Java-{@code Object} */
        public boolean equals(Object other)
        {
            if (other == null)                       return false;
            if (other.getClass() != this.getClass()) return false;
        
            LayoutShift o = (LayoutShift) other;
        
            return
                    Objects.equals(this.value, o.value)
                &&  (this.hadRecentInput == o.hadRecentInput)
                &&  Objects.equals(this.lastInputTime, o.lastInputTime)
                &&  Arrays.deepEquals(this.sources, o.sources);
        }
        
        /** Generates a Hash-Code for {@code 'this'} instance */
        public int hashCode()
        {
            return
                    Objects.hashCode(this.value)
                +   (this.hadRecentInput ? 1 : 0)
                +   Objects.hashCode(this.lastInputTime)
                +   Arrays.deepHashCode(this.sources);
        }
    }
    
    /** <CODE>[No Description Provided by Google]</CODE> */
    public static class TimelineEvent
        extends BaseType
        implements java.io.Serializable
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, false, false, false, true, true, true, }; }
        
        /** Identifies the frame that this event is related to. Empty for non-frame targets. */
        public final String frameId;
        
        /**
         * The event type, as specified in https://w3c.github.io/performance-timeline/#dom-performanceentry-entrytype
         * This determines which of the optional "details" fiedls is present.
         */
        public final String type;
        
        /** Name may be empty depending on the type. */
        public final String name;
        
        /** Time in seconds since Epoch, monotonically increasing within document lifetime. */
        public final Number time;
        
        /**
         * Event duration, if applicable.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Number duration;
        
        /**
         * <CODE>[No Description Provided by Google]</CODE>
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final PerformanceTimeline.LargestContentfulPaint lcpDetails;
        
        /**
         * <CODE>[No Description Provided by Google]</CODE>
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final PerformanceTimeline.LayoutShift layoutShiftDetails;
        
        /**
         * Constructor
         *
         * @param frameId Identifies the frame that this event is related to. Empty for non-frame targets.
         * 
         * @param type 
         * The event type, as specified in https://w3c.github.io/performance-timeline/#dom-performanceentry-entrytype
         * This determines which of the optional "details" fiedls is present.
         * 
         * @param name Name may be empty depending on the type.
         * 
         * @param time Time in seconds since Epoch, monotonically increasing within document lifetime.
         * 
         * @param duration Event duration, if applicable.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param lcpDetails -
         * <BR /><B>OPTIONAL</B>
         * 
         * @param layoutShiftDetails -
         * <BR /><B>OPTIONAL</B>
         */
        public TimelineEvent(
                String frameId, String type, String name, Number time, Number duration, 
                PerformanceTimeline.LargestContentfulPaint lcpDetails, 
                PerformanceTimeline.LayoutShift layoutShiftDetails
            )
        {
            // Exception-Check(s) to ensure that if any parameters which are not declared as
            // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
            
            if (frameId == null) BRDPC.throwNPE("frameId");
            if (type == null)    BRDPC.throwNPE("type");
            if (name == null)    BRDPC.throwNPE("name");
            if (time == null)    BRDPC.throwNPE("time");
            
            this.frameId             = frameId;
            this.type                = type;
            this.name                = name;
            this.time                = time;
            this.duration            = duration;
            this.lcpDetails          = lcpDetails;
            this.layoutShiftDetails  = layoutShiftDetails;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'TimelineEvent'}.
         */
        public TimelineEvent (JsonObject jo)
        {
            this.frameId             = ReadJSON.getString(jo, "frameId", false, true);
            this.type                = ReadJSON.getString(jo, "type", false, true);
            this.name                = ReadJSON.getString(jo, "name", false, true);
            this.time                = ReadNumberJSON.get(jo, "time", false, true);
            this.duration            = ReadNumberJSON.get(jo, "duration", true, false);
            this.lcpDetails          = ReadJSON.getObject(jo, "lcpDetails", PerformanceTimeline.LargestContentfulPaint.class, true, false);
            this.layoutShiftDetails  = ReadJSON.getObject(jo, "layoutShiftDetails", PerformanceTimeline.LayoutShift.class, true, false);
        }
        
        
        /** Checks whether {@code 'this'} equals an input Java-{@code Object} */
        public boolean equals(Object other)
        {
            if (other == null)                       return false;
            if (other.getClass() != this.getClass()) return false;
        
            TimelineEvent o = (TimelineEvent) other;
        
            return
                    Objects.equals(this.frameId, o.frameId)
                &&  Objects.equals(this.type, o.type)
                &&  Objects.equals(this.name, o.name)
                &&  Objects.equals(this.time, o.time)
                &&  Objects.equals(this.duration, o.duration)
                &&  Objects.equals(this.lcpDetails, o.lcpDetails)
                &&  Objects.equals(this.layoutShiftDetails, o.layoutShiftDetails);
        }
        
        /** Generates a Hash-Code for {@code 'this'} instance */
        public int hashCode()
        {
            return
                    Objects.hashCode(this.frameId)
                +   Objects.hashCode(this.type)
                +   Objects.hashCode(this.name)
                +   Objects.hashCode(this.time)
                +   Objects.hashCode(this.duration)
                +   this.lcpDetails.hashCode()
                +   this.layoutShiftDetails.hashCode();
        }
    }
    
    /** Sent when a performance timeline event is added. See reportPerformanceTimeline method. */
    public static class timelineEventAdded
        extends BrowserEvent
        implements java.io.Serializable
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, }; }
        
        /** <CODE>[No Description Provided by Google]</CODE> */
        public final PerformanceTimeline.TimelineEvent event;
        
        /**
         * Constructor
         *
         * @param event -
         */
        public timelineEventAdded(PerformanceTimeline.TimelineEvent event)
        {
            super("PerformanceTimeline", "timelineEventAdded", 1);
            
            // Exception-Check(s) to ensure that if any parameters which are not declared as
            // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
            
            if (event == null) BRDPC.throwNPE("event");
            
            this.event  = event;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'timelineEventAdded'}.
         */
        public timelineEventAdded (JsonObject jo)
        {
            super("PerformanceTimeline", "timelineEventAdded", 1);
        
            this.event  = ReadJSON.getObject(jo, "event", PerformanceTimeline.TimelineEvent.class, false, true);
        }
        
        
        /** Checks whether {@code 'this'} equals an input Java-{@code Object} */
        public boolean equals(Object other)
        {
            if (other == null)                       return false;
            if (other.getClass() != this.getClass()) return false;
        
            timelineEventAdded o = (timelineEventAdded) other;
        
            return
                    Objects.equals(this.event, o.event);
        }
        
        /** Generates a Hash-Code for {@code 'this'} instance */
        public int hashCode()
        {
            return
                    this.event.hashCode();
        }
    }
    
    
    // Counter for keeping the WebSocket Request ID's distinct.
    private static int counter = 1;
    
    /**
     * Previously buffered events would be reported before method returns.
     * See also: timelineEventAdded
     * 
     * @param eventTypes 
     * The types of event to report, as specified in
     * https://w3c.github.io/performance-timeline/#dom-performanceentry-entrytype
     * The specified filter overrides any previous filters, passing empty
     * filter disables recording.
     * Note that not all types exposed to the web platform are currently supported.
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR />This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> enable(String[] eventTypes)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (eventTypes == null) BRDPC.throwNPE("eventTypes");
        
        final int       webSocketID = 34000000 + counter++;
        final boolean[] optionals   = { false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("enable"),
            parameterNames.get("enable"),
            optionals, webSocketID,
            "PerformanceTimeline.enable",
            (Object) eventTypes
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
}