com.microsoft.thrifty.schema.UserElement.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of thrifty-schema Show documentation
A simple Thrift IDL parser and validator
There is a newer version: 3.1.0
/*
 * Thrifty
 *
 * Copyright (c) Microsoft Corporation
 *
 * All rights reserved.
 *
 * 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
 *
 * THIS CODE IS PROVIDED ON AN  *AS IS* BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING
 * WITHOUT LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE,
 * FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABLITY OR NON-INFRINGEMENT.
 *
 * See the Apache Version 2.0 License for specific language governing permissions and limitations under the License.
 */
package com.microsoft.thrifty.schema

import java.util.UUID

/**
 * Represents data common to user-defined elements of a Thrift program.
 */
interface UserElement {

    /**
     * Gets a value indicating whether the element has been marked as
     * deprecated; this may or may not be meaningful, depending on the
     * particular type of element.
     *
     * @return true if this element has been marked as deprecated.
     */
    val isDeprecated: Boolean

    /**
     * A globally unique ID for this element. This is useful for cases where you newBuilder() an element to change it
     * (such as in a Schema preprocessor) and want to update references from other objects in a deterministic way that
     * matches IDs. If you want a new instance of an object that is unrelated, you should change this value.
     *
     * @return the uuid of this element.
     */
    val uuid: UUID

    /**
     * Gets the name of the element.
     *
     * @return the name of this element.
     */
    val name: String

    /**
     * Gets the [Location] where the element is defined.
     *
     * @return the Location where this element is defined.
     */
    val location: Location

    /**
     * Gets the documentation comments of the element, or an empty string.
     *
     * @return the documentation present on this element, or an empty string.
     */
    val documentation: String

    /**
     * Gets a value indicating whether the element contains non-empty Javadoc.
     *
     * @return true if this element contains non-empty Javadoc.
     */
    val hasJavadoc: Boolean
        get() = isNonEmptyJavadoc(documentation)

    /**
     * Gets an immutable map containing any annotations present on the element.
     *
     * @return all annotations present on this element.
     */
    val annotations: Map

    /**
     * A map of namespaces to which this element belongs.
     */
    val namespaces: Map

    /**
     * Gets the first namespace found for the given list of scopes.
     *
     * Iterates over the scopes in the order provided, returning the first
     * non-null namespace found for this element.
     *
     * @param scopes The list of scopes to search.
     * @return the first namespace found corresponding to one of the given
     *         [scopes], or null.
     */
    fun getNamespaceFor(vararg scopes: NamespaceScope): String? {
        for (s in scopes) {
            namespaces[s]?.let { return it }
        }
        return null
    }
}

/**
 * Returns `true` if `doc` is non-empty Javadoc, otherwise
 * `false`.
 */
fun isNonEmptyJavadoc(doc: String?): Boolean {
    if (doc == null) return false
    if (doc.isEmpty()) return false

    return doc.any { !Character.isWhitespace(it) }
}