com.microsoft.thrifty.schema.UserElementMixin.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 com.microsoft.thrifty.schema.parser.AnnotationElement
import com.microsoft.thrifty.schema.parser.ConstElement
import com.microsoft.thrifty.schema.parser.EnumElement
import com.microsoft.thrifty.schema.parser.EnumMemberElement
import com.microsoft.thrifty.schema.parser.FieldElement
import com.microsoft.thrifty.schema.parser.FunctionElement
import com.microsoft.thrifty.schema.parser.ServiceElement
import com.microsoft.thrifty.schema.parser.StructElement
import com.microsoft.thrifty.schema.parser.TypedefElement

import java.util.Locale
import java.util.UUID

/**
 * A mixin encapsulating a common implementation of [UserElement],
 * which does not conveniently fit in a single base class.
 */
internal data class UserElementMixin(
        override val uuid: UUID,
        override val name: String,
        override val location: Location,
        override val documentation: String,
        override val annotations: Map,
        override val namespaces: Map
) : UserElement {
    override val isDeprecated: Boolean
        get() = hasThriftOrJavadocAnnotation("deprecated")

    constructor(struct: StructElement, namespaces: Map)
            : this(struct.uuid, struct.name, struct.location, struct.documentation, struct.annotations, namespaces)

    constructor(field: FieldElement, namespaces: Map)
            : this(field.uuid, field.name, field.location, field.documentation, field.annotations, namespaces)

    constructor(enumElement: EnumElement, namespaces: Map)
            : this(enumElement.uuid, enumElement.name, enumElement.location, enumElement.documentation, enumElement.annotations, namespaces)

    constructor(member: EnumMemberElement, namespaces: Map)
            : this(member.uuid, member.name, member.location, member.documentation, member.annotations, namespaces)

    constructor(element: TypedefElement, namespaces: Map)
            : this(element.uuid, element.newName, element.location, element.documentation, element.annotations, namespaces)

    constructor(element: ServiceElement, namespaces: Map)
            : this(element.uuid, element.name, element.location, element.documentation, element.annotations, namespaces)

    constructor(element: FunctionElement, namespaces: Map)
            : this(element.uuid, element.name, element.location, element.documentation, element.annotations, namespaces)

    constructor(element: ConstElement, namespaces: Map)
            : this(element.uuid, element.name, element.location, element.documentation, emptyMap(), namespaces)

    constructor(
            uuid: UUID,
            name: String,
            location: Location,
            documentation: String,
            annotationElement: AnnotationElement?,
            namespaces: Map) : this(

            uuid,
            name,
            location,
            documentation,
            annotationElement?.values?.toMap() ?: emptyMap(),
            namespaces
    )

    private constructor(builder: Builder) : this(
            uuid = builder.uuid,
            name = builder.name,
            location = builder.location,
            documentation = builder.documentation,
            annotations = builder.annotations,
            namespaces = builder.namespaces
    )

    /**
     * Checks for the presence of the given annotation name, in several possible
     * varieties.  Returns true if:
     *
     *
     *  * A Thrift annotation matching the exact name is present
     *  * A Thrift annotation equal to the string "thrifty." plus the name is present
     *  * The Javadoc contains "@" plus the annotation name
     *
     *
     * The latter two conditions are officially undocumented, but are present for
     * legacy use.  This behavior is subject to change without notice!
     */
    fun hasThriftOrJavadocAnnotation(name: String): Boolean {
        return (annotations.containsKey(name)
                || annotations.containsKey("thrifty.$name")
                || hasJavadoc && documentation.toLowerCase(Locale.US).contains("@$name"))
    }

    override fun toString(): String {
        return ("UserElementMixin{"
                + "uuid='" + uuid + "'"
                + ", name='" + name + "'"
                + ", location=" + location
                + ", documentation='" + documentation + "'"
                + ", annotations=" + annotations
                + ", namespaces=" + namespaces
                + '}'.toString())
    }

    fun toBuilder(): Builder {
        return Builder(this)
    }

    internal class Builder internal constructor(userElement: UserElement) {
        var uuid: UUID = userElement.uuid
        var name: String = userElement.name
        var location: Location = userElement.location
        var documentation: String = userElement.documentation
        var annotations: Map = userElement.annotations
        var namespaces: Map = userElement.namespaces

        fun uuid(uuid: UUID): Builder = apply {
            this.uuid = uuid
        }

        fun name(name: String): Builder = apply {
            this.name = name
        }

        fun location(location: Location): Builder = apply {
            this.location = location
        }

        fun documentation(documentation: String): Builder = apply {
            this.documentation = if (isNonEmptyJavadoc(documentation)) {
                documentation
            } else {
                ""
            }
        }

        fun annotations(annotations: Map): Builder = apply {
            this.annotations = annotations
        }

        fun namespaces(namespaces: Map): Builder = apply {
            this.namespaces = namespaces
        }

        fun build(): UserElementMixin = UserElementMixin(this)
    }
}