com.xceptance.xlt.api.engine.PageLoadTimingData Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of xlt Show documentation

XLT (Xceptance LoadTest) is an extensive load and performance test tool developed and maintained by Xceptance.

There is a newer version: 8.1.0

/*
 * Copyright (c) 2005-2022 Xceptance Software Technologies GmbH
 *
 * 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.
 */
package com.xceptance.xlt.api.engine;

/**
 * 
 * The {@link PageLoadTimingData} ...
 * 
 * 
 * The {@link CustomData} should be used only if the intended purpose does not match the semantics of the other data
 * record classes ({@link RequestData}, {@link ActionData}, and {@link TransactionData}). For example, if one wants to
 * measure a certain functionality during client-side processing, a custom timer may suit best.
 * 
 * 
 * Note that {@link PageLoadTimingData} objects have a "P" as their type code.
 * 
 * 
 * @see ActionData
 * @see RequestData
 * @see TransactionData
 */
public class PageLoadTimingData extends TimerData
{
    /**
     * The type code.
     */
    private static final String TYPE_CODE = "P";

    /**
     * Creates a new PageLoadData object.
     */
    public PageLoadTimingData()
    {
        this(null);
    }

    /**
     * Creates a new PageLoadTimingData object and gives it the specified name. Furthermore, the start time attribute is
     * set to the current time.
     * 
     * @param name
     *            the data name
     */
    public PageLoadTimingData(final String name)
    {
        super(name, TYPE_CODE);
    }
}