/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to you 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 org.apache.jmeter.threads

import org.apache.jmeter.testelement.schema.BooleanPropertyDescriptor
import org.apache.jmeter.testelement.schema.IntegerPropertyDescriptor
import org.apache.jmeter.testelement.schema.LongPropertyDescriptor
import org.apiguardian.api.API

/**
 * Lists properties of a [ThreadGroup].
 * @see ThreadGroup
 * @since 5.6
 */
@API(status = API.Status.EXPERIMENTAL, since = "5.6")
public abstract class ThreadGroupSchema : AbstractThreadGroupSchema() {
    public companion object INSTANCE : ThreadGroupSchema()

    /** Whether thread startup is delayed until required */
    public val delayedStart: BooleanPropertyDescriptor<ThreadGroupSchema>
        by boolean("ThreadGroup.delayedStart", default = false)

    /** Ramp-up time */
    public val rampTime: IntegerPropertyDescriptor<ThreadGroupSchema>
        by int("ThreadGroup.ramp_time")

    /** Whether scheduler is being used */
    public val useScheduler: BooleanPropertyDescriptor<ThreadGroupSchema>
        by boolean("ThreadGroup.scheduler")

    /** Scheduler start delay, overrides start time */
    public val delay: LongPropertyDescriptor<ThreadGroupSchema>
        by long("ThreadGroup.delay")

    /** Scheduler duration, overrides end time */
    public val duration: LongPropertyDescriptor<ThreadGroupSchema>
        by long("ThreadGroup.duration")
}
