Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: deprecate AvroNamespace, AvroName and AvroInline annotations #184

Closed
wants to merge 1 commit into from
Closed

chore: deprecate AvroNamespace, AvroName and AvroInline annotations #184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/main/kotlin/com/github/avrokotlin/avro4k/AnnotationExtractor.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ class AnnotationExtractor(private val annotations: List<Annotation>) {
}

fun fixed(): Int? = annotations.filterIsInstance<AvroFixed>().firstOrNull()?.size
fun scalePrecision(): Pair<Int, Int>? = annotations.filterIsInstance<ScalePrecision>().firstOrNull()?.let { it.scale to it.precision }
fun scalePrecision(): Pair<Int, Int>? = annotations.filterIsInstance<AvroDecimalLogicalType>().firstOrNull()?.let { it.scale to it.precision } ?: annotations.filterIsInstance<ScalePrecision>().firstOrNull()?.let { it.scale to it.precision }
fun namespace(): String? = annotations.filterIsInstance<AvroNamespace>().firstOrNull()?.value
fun name(): String? = annotations.filterIsInstance<AvroName>().firstOrNull()?.value
fun valueType(): Boolean = annotations.filterIsInstance<AvroInline>().isNotEmpty()
Expand Down
12 changes: 12 additions & 0 deletions src/main/kotlin/com/github/avrokotlin/avro4k/annotations.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,30 @@ annotation class AvroProp(val key: String, val value: String)
annotation class AvroJsonProp(val key: String, @Language("JSON") val jsonValue: String)

@SerialInfo
@Deprecated(message = "Will be removed in the next major release in favour of @SerialName. For overriding namespace on fields, use @AvroNamespaceOverride", replaceWith = ReplaceWith("@SerialName(\"namespace.YourClass\")"))
@Target(AnnotationTarget.PROPERTY, AnnotationTarget.CLASS)
annotation class AvroNamespace(val value: String)

@SerialInfo
@Target(AnnotationTarget.PROPERTY)
annotation class AvroNamespaceOverride(val value: String)

@SerialInfo
@Deprecated(message = "Will be removed in the next major release in favour of @SerialName", replaceWith = ReplaceWith("@SerialName(\"namespace.YourClass\")"))
@Target(AnnotationTarget.PROPERTY, AnnotationTarget.CLASS)
annotation class AvroName(val value: String)

@SerialInfo
@Deprecated(message = "Will be removed in the next major release in favour of @AvroDecimalLogicalType", replaceWith = ReplaceWith("@AvroDecimalLogicalType(scale, precision)"))
@Target(AnnotationTarget.PROPERTY, AnnotationTarget.CLASS)
annotation class ScalePrecision(val scale: Int, val precision: Int)

@SerialInfo
@Target(AnnotationTarget.PROPERTY)
annotation class AvroDecimalLogicalType(val scale: Int, val precision: Int)

@SerialInfo
@Deprecated(message = "Will be removed in the next major release in favour of kotlin value classes", replaceWith = ReplaceWith("@JvmInline"))
@Target(AnnotationTarget.CLASS)
annotation class AvroInline

Expand Down
Loading