org.incendo.cloud.kotlin.extension.CommandComponentBuildingExtensions.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cloud-kotlin-extensions Show documentation
Command framework and dispatcher for the JVM
The newest version!
//
// MIT License
//
// Copyright (c) 2024 Incendo
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//
package org.incendo.cloud.kotlin.extension

import org.incendo.cloud.component.CommandComponent
import org.incendo.cloud.component.DefaultValue
import org.incendo.cloud.description.Description
import org.incendo.cloud.parser.ParserDescriptor
import org.incendo.cloud.suggestion.SuggestionProvider

/**
 * The description of the command component.
 */
public var  CommandComponent.Builder.description: Description
    get() = this.description()
    set(description) {
        this.description(description)
    }

/**
 * The description of the command component.
 */
public var  CommandComponent.Builder.textDescription: String
    get() = this.description().textDescription()
    set(description) {
        this.description(Description.of(description))
    }

/**
 * The suggestion provider of the command component.
 */
public var  CommandComponent.Builder.suggestionProvider: SuggestionProvider
    get() = this.suggestionProvider()
    set(suggestionProvider) {
        this.suggestionProvider(suggestionProvider)
    }

/**
 * The name of the command component.
 */
public var  CommandComponent.Builder.name: String
    get() = this.name()
    set(name) {
        this.name(name)
    }

/**
 * The default value of the command component.
 */
public var  CommandComponent.Builder.defaultValue: DefaultValue?
    get() = this.defaultValue()
    set(defaultValue) {
        this.defaultValue(defaultValue)
    }

/**
 * The parser of the command component.
 */
public var  CommandComponent.Builder.parser: ParserDescriptor
    get() = this.parser()
    set(parser) {
        this.parser(parser)
    }