mirror of
https://github.com/shaka-project/shaka-player.git
synced 2026-06-17 16:26:39 +03:00
Joey Parrish
f539147d48
This fixes all the license headers in the main library, which corrects the appearance of the main license in the compiled output. It seems that the `!` in the header forces the compiler to keep it in the output. I believe older compiler releases did this purely based on `@license`. Issue #2638 Change-Id: I7f0e918caad10c9af689c9d07672b7fe9be7b2f3
81 lines
2.5 KiB
JavaScript
81 lines
2.5 KiB
JavaScript
/*! @license
|
|
* Shaka Player
|
|
* Copyright 2016 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
goog.provide('shaka.deprecate.Enforcer');
|
|
|
|
goog.require('shaka.deprecate.Version');
|
|
|
|
|
|
/**
|
|
* The enforcer's job is to call the correct callback when a feature will need
|
|
* to be removed later or removed now.
|
|
*
|
|
* The "what should be done" is not part of the enforcer, that must be provided
|
|
* to the enforcer when it is created. This separation was created so that
|
|
* testing and production could be equal users of the enforcer.
|
|
*
|
|
* @final
|
|
*/
|
|
shaka.deprecate.Enforcer = class {
|
|
/**
|
|
* @param {!shaka.deprecate.Version} libraryVersion
|
|
* @param {shaka.deprecate.Listener} onPending
|
|
* @param {shaka.deprecate.Listener} onExpired
|
|
*/
|
|
constructor(libraryVersion, onPending, onExpired) {
|
|
/** @private {!shaka.deprecate.Version} */
|
|
this.libraryVersion_ = libraryVersion;
|
|
|
|
/** @private {shaka.deprecate.Listener} */
|
|
this.onPending_ = onPending;
|
|
/** @private {shaka.deprecate.Listener} */
|
|
this.onExpired_ = onExpired;
|
|
}
|
|
|
|
/**
|
|
* Tell the enforcer that a feature will expire on |expiredOn| and that it
|
|
* should notify the listeners if it is pending or expired.
|
|
*
|
|
* @param {!shaka.deprecate.Version} expiresOn
|
|
* @param {string} name
|
|
* @param {string} description
|
|
*/
|
|
enforce(expiresOn, name, description) {
|
|
// If the expiration version is larger than the library version
|
|
// (compareTo > 0), it means the expiration is in the future, and is still
|
|
// pending.
|
|
const isPending = expiresOn.compareTo(this.libraryVersion_) > 0;
|
|
|
|
// Find the right callback (pending or expired) for this enforcement request
|
|
// call it to handle this features pending/expired removal.
|
|
const callback = isPending ? this.onPending_ : this.onExpired_;
|
|
callback(this.libraryVersion_, expiresOn, name, description);
|
|
}
|
|
};
|
|
|
|
/**
|
|
* A callback for listening to deprecation events.
|
|
*
|
|
* Parameters:
|
|
* libraryVersion: !shaka.deprecate.Version
|
|
* featureVersion: !shaka.deprecate.Version
|
|
* name: string
|
|
* description: string
|
|
*
|
|
* libraryVersion: The current version of the library.
|
|
* featureVersion: The version of the library when the feature should be
|
|
* removed.
|
|
* name: The name of the feature that will/should be removed.
|
|
* description: A description of what is changing.
|
|
*
|
|
* @typedef {function(
|
|
* !shaka.deprecate.Version,
|
|
* !shaka.deprecate.Version,
|
|
* string,
|
|
* string)}
|
|
*/
|
|
shaka.deprecate.Listener;
|