1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
/*
* Copyright (C) 2018 Square, Inc.
*
* 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
*
* https://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.
*/
@file:JvmName("JvmAnnotations")
package com.squareup.kotlinpoet.jvm
import com.squareup.kotlinpoet.AnnotationSpec
import com.squareup.kotlinpoet.AnnotationSpec.UseSiteTarget.FILE
import com.squareup.kotlinpoet.FileSpec
import com.squareup.kotlinpoet.FunSpec
import com.squareup.kotlinpoet.FunSpec.Companion.isAccessor
import com.squareup.kotlinpoet.FunSpec.Companion.isConstructor
import com.squareup.kotlinpoet.PropertySpec
import com.squareup.kotlinpoet.TypeName
import com.squareup.kotlinpoet.TypeSpec
import com.squareup.kotlinpoet.asTypeName
import java.lang.reflect.Type
import kotlin.reflect.KClass
public fun FileSpec.Builder.jvmName(name: String): FileSpec.Builder = addAnnotation(
AnnotationSpec.builder(JvmName::class)
.useSiteTarget(FILE)
.addMember("%S", name)
.build(),
)
public fun FileSpec.Builder.jvmMultifileClass(): FileSpec.Builder = addAnnotation(
AnnotationSpec.builder(JvmMultifileClass::class)
.useSiteTarget(FILE)
.build(),
)
public fun TypeSpec.Builder.jvmSuppressWildcards(suppress: Boolean = true): TypeSpec.Builder =
addAnnotation(jvmSuppressWildcardsAnnotation(suppress))
private fun jvmSuppressWildcardsAnnotation(suppress: Boolean = true) =
AnnotationSpec.builder(JvmSuppressWildcards::class)
.apply { if (!suppress) addMember("suppress = false") }
.build()
public fun TypeSpec.Builder.jvmInline(): TypeSpec.Builder = addAnnotation(JvmInline::class)
public fun TypeSpec.Builder.jvmRecord(): TypeSpec.Builder = addAnnotation(JvmRecord::class)
public fun FunSpec.Builder.jvmStatic(): FunSpec.Builder = apply {
check(!name.isConstructor) { "Can't apply @JvmStatic to a constructor!" }
addAnnotation(JvmStatic::class)
}
public fun FunSpec.Builder.jvmOverloads(): FunSpec.Builder = apply {
check(!name.isAccessor) {
"Can't apply @JvmOverloads to a " + if (name == FunSpec.GETTER) "getter!" else "setter!"
}
addAnnotation(JvmOverloads::class)
}
public fun FunSpec.Builder.jvmName(name: String): FunSpec.Builder = apply {
check(!this.name.isConstructor) { "Can't apply @JvmName to a constructor!" }
addAnnotation(
AnnotationSpec.builder(JvmName::class)
.addMember("%S", name)
.build(),
)
}
public fun FunSpec.Builder.throws(vararg exceptionClasses: KClass<out Throwable>): FunSpec.Builder =
throws(exceptionClasses.map(KClass<*>::asTypeName))
public fun FunSpec.Builder.throws(vararg exceptionClasses: Type): FunSpec.Builder =
throws(exceptionClasses.map(Type::asTypeName))
public fun FunSpec.Builder.throws(vararg exceptionClasses: TypeName): FunSpec.Builder =
throws(exceptionClasses.toList())
public fun FunSpec.Builder.throws(exceptionClasses: Iterable<TypeName>): FunSpec.Builder =
addAnnotation(
AnnotationSpec.builder(Throws::class)
.apply { exceptionClasses.forEach { addMember("%T::class", it) } }
.build(),
)
public fun FunSpec.Builder.jvmSuppressWildcards(suppress: Boolean = true): FunSpec.Builder = apply {
check(!name.isConstructor) { "Can't apply @JvmSuppressWildcards to a constructor!" }
check(!name.isAccessor) {
"Can't apply @JvmSuppressWildcards to a " + if (name == FunSpec.GETTER) "getter!" else "setter!"
}
addAnnotation(jvmSuppressWildcardsAnnotation(suppress))
}
public fun FunSpec.Builder.synchronized(): FunSpec.Builder = apply {
check(!name.isConstructor) { "Can't apply @Synchronized to a constructor!" }
addAnnotation(Synchronized::class)
}
public fun FunSpec.Builder.strictfp(): FunSpec.Builder = addAnnotation(Strictfp::class)
public fun PropertySpec.Builder.jvmField(): PropertySpec.Builder = addAnnotation(JvmField::class)
public fun PropertySpec.Builder.jvmStatic(): PropertySpec.Builder = addAnnotation(JvmStatic::class)
public fun PropertySpec.Builder.jvmSuppressWildcards(
suppress: Boolean = true,
): PropertySpec.Builder = addAnnotation(jvmSuppressWildcardsAnnotation(suppress))
public fun PropertySpec.Builder.transient(): PropertySpec.Builder = addAnnotation(Transient::class)
public fun PropertySpec.Builder.volatile(): PropertySpec.Builder = addAnnotation(Volatile::class)
public fun TypeName.jvmSuppressWildcards(suppress: Boolean = true): TypeName =
copy(annotations = this.annotations + jvmSuppressWildcardsAnnotation(suppress))
public fun TypeName.jvmWildcard(): TypeName =
copy(annotations = this.annotations + AnnotationSpec.builder(JvmWildcard::class).build())
@Suppress("DEPRECATION")
@Deprecated(
"""
'JvmDefault' is deprecated. Switch to new -Xjvm-default modes: `all` or `all-compatibility`.
In KotlinPoet 1.15.0 and newer, this method is a no-op. It will be deleted in KotlinPoet 2.0.
""",
)
public fun PropertySpec.Builder.jvmDefault(): PropertySpec.Builder = this
@Suppress("DEPRECATION")
@Deprecated(
"""
'JvmDefault' is deprecated. Switch to new -Xjvm-default modes: `all` or `all-compatibility`.
In KotlinPoet 1.15.0 and newer, this method is a no-op. It will be deleted in KotlinPoet 2.0.
""",
)
public fun FunSpec.Builder.jvmDefault(): FunSpec.Builder = this
|
