Source/WebInspectorUI/UserInterface/Controllers/DiagnosticEventRecorder.js

/*
 * Copyright (C) 2019 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

WI.DiagnosticEventRecorder = class DiagnosticEventRecorder
{
    constructor(name, controller)
    {
        console.assert(controller instanceof WI.DiagnosticController, controller);

        this._name = name;
        this._active = false;
        this._controller = controller;
    }

    // Public

    get name() { return this._name; }

    get active()
    {
        return this._active;
    }

    set active(value)
    {
        if (this._active === value)
            return;

        this._active = value;

        if (this._active)
            this.setup();
        else
            this.teardown();
    }

    // Protected

    logDiagnosticEvent(eventName, payload)
    {
        if (this._active)
            this._controller.logDiagnosticEvent(eventName, payload);
    }

    setup()
    {
        throw WI.NotImplementedError.subclassMustOverride();
    }

    teardown()
    {
        throw WI.NotImplementedError.subclassMustOverride();
    }
};