com.gw2tb.apigen.ir.LowLevelApiGenApi.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.schema.SchemaRecord

/**
 * Denotes that the annotated API is part of the low-level API of this library.
 *
 * Low-level APIs are wrapped by higher level abstractions and, usually, should
 * not be used outside the generator itself. However, in some cases, the
 * additional information available in the low-level API might be necessary.
 *
 * For example, [SchemaRecord] is a higher-level representation of [IRRecord].
 * It provides a simpler API by abstracting away knowledge about schema
 * versions.
 *
 * @since   0.7.0
 */
@RequiresOptIn
public annotation class LowLevelApiGenApi