| // Copyright 2007 The Closure Library Authors. All Rights Reserved. |
| // |
| // 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. |
| |
| /** |
| * @fileoverview Definition the goog.debug.RelativeTimeProvider class. |
| * |
| */ |
| |
| goog.provide('goog.debug.RelativeTimeProvider'); |
| |
| |
| |
| /** |
| * A simple object to keep track of a timestamp considered the start of |
| * something. The main use is for the logger system to maintain a start time |
| * that is occasionally reset. For example, in Gmail, we reset this relative |
| * time at the start of a user action so that timings are offset from the |
| * beginning of the action. This class also provides a singleton as the default |
| * behavior for most use cases is to share the same start time. |
| * |
| * @constructor |
| * @final |
| */ |
| goog.debug.RelativeTimeProvider = function() { |
| /** |
| * The start time. |
| * @type {number} |
| * @private |
| */ |
| this.relativeTimeStart_ = goog.now(); |
| }; |
| |
| |
| /** |
| * Default instance. |
| * @type {goog.debug.RelativeTimeProvider} |
| * @private |
| */ |
| goog.debug.RelativeTimeProvider.defaultInstance_ = |
| new goog.debug.RelativeTimeProvider(); |
| |
| |
| /** |
| * Sets the start time to the specified time. |
| * @param {number} timeStamp The start time. |
| */ |
| goog.debug.RelativeTimeProvider.prototype.set = function(timeStamp) { |
| this.relativeTimeStart_ = timeStamp; |
| }; |
| |
| |
| /** |
| * Resets the start time to now. |
| */ |
| goog.debug.RelativeTimeProvider.prototype.reset = function() { |
| this.set(goog.now()); |
| }; |
| |
| |
| /** |
| * @return {number} The start time. |
| */ |
| goog.debug.RelativeTimeProvider.prototype.get = function() { |
| return this.relativeTimeStart_; |
| }; |
| |
| |
| /** |
| * @return {goog.debug.RelativeTimeProvider} The default instance. |
| */ |
| goog.debug.RelativeTimeProvider.getDefaultInstance = function() { |
| return goog.debug.RelativeTimeProvider.defaultInstance_; |
| }; |