XExecutableElement.kt
/*
* Copyright (C) 2020 The Android Open Source Project
*
* 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
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package androidx.room.compiler.processing
/**
* Represents a method, constructor or initializer.
*
* @see [javax.lang.model.element.ExecutableElement]
*/
interface XExecutableElement : XHasModifiers, XElement {
/**
* The element that declared this executable.
*
* For methods declared as top level functions in Kotlin:
* * When running with KAPT, the value will be an [XTypeElement].
* * When running with KSP, if this function is coming from the classpath, the value will
* be an [XTypeElement].
* * When running with KSP, if this function is in source, the value will **NOT** be an
* [XTypeElement]. If you need the generated synthetic java class name, you can use
* [XMemberContainer.className] property.
*/
val enclosingElement: XMemberContainer
/**
* The list of parameters that should be passed into this method.
*
* @see [isVarArgs]
*/
val parameters: List<XExecutableParameterElement>
/**
* The list of `Throwable`s that are declared in this executable's signature.
*/
val thrownTypes: List<XType>
/**
* Returns true if this method receives a vararg parameter.
*/
fun isVarArgs(): Boolean
/**
* The type representation of the method where more type parameters might be resolved.
*/
val executableType: XExecutableType
/**
* Returns the method as if it is declared in [other].
*
* This is specifically useful if you have a method that has type arguments and there is a
* subclass ([other]) where type arguments are specified to actual types.
*/
fun asMemberOf(other: XType): XExecutableType
}