com.gw2tb.apigen.ir.IREnum.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api-generator Show documentation
A library for generating programs that interface with the official Guild Wars 2 API.
The newest version!
/*
 * Copyright (c) 2019-2024 Leon Linhart
 *
 * 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 com.gw2tb.apigen.ir

import com.gw2tb.apigen.model.v2.SchemaVersion
import com.gw2tb.apigen.model.Name
import com.gw2tb.apigen.schema.SchemaEnum

/**
 * A low-level representation of a [SchemaEnum].
 *
 * @param name          the name of the enum
 * @param type          the type of the enum's values
 * @param values        the enum's values
 * @param description   a description of the enum
 *
 * @since   0.7.0
 */
@LowLevelApiGenApi
public data class IREnum internal constructor(
    public override val name: Name,
    public val type: IRPrimitiveOrAlias,
    public val values: Set,
    public val description: String
) : IRTypeDeclaration() {

    override fun resolve(resolverContext: ResolverContext, v2SchemaVersion: SchemaVersion?): SchemaEnum {
        val type = type.resolve(resolverContext, v2SchemaVersion)
        val values = values.map { it.resolve(resolverContext, v2SchemaVersion) }.toSet()

        return SchemaEnum(
            name = name,
            type = type,
            values = values,
            description = description
        )
    }

    /**
     * A low-level representation of a [SchemaEnum.Value].
     *
     * @param name          the name of the value
     * @param value         the serial representation of the value
     * @param description   a description of the value
     *
     * @since   0.7.0
     */
    public data class Value internal constructor(
        public val name: Name,
        public val value: String,
        public val description: String
    ) {

        internal fun resolve(
            @Suppress("UNUSED_PARAMETER") resolverContext: ResolverContext,
            @Suppress("UNUSED_PARAMETER") v2SchemaVersion: SchemaVersion?
        ): SchemaEnum.Value {
            return SchemaEnum.Value(
                name = name,
                value = value,
                description = description
            )
        }

    }

}