Skip to content

Deprecated & Converts

EasyYapi provides built-in extensions for deprecated info and type conversions.

Deprecated Info

The deprecated extension (enabled by default) automatically extracts deprecation information from Java and Kotlin code:

properties
# Java deprecated
method.doc[#deprecated]=groovy:"\n「已废弃」" + it.doc("deprecated")
method.doc[@java.lang.Deprecated]=「已废弃」
field.doc[#deprecated]=groovy:"\n「已废弃」" + it.doc("deprecated")
field.doc[@java.lang.Deprecated]=「已废弃」

# Kotlin deprecated
method.doc[@kotlin.Deprecated]=groovy:"\n「已废弃」" + it.ann("kotlin.Deprecated","message")
field.doc[@kotlin.Deprecated]=groovy:"\n「已废弃」" + it.ann("kotlin.Deprecated","message")

Type Converts

The converts extension (enabled by default) provides automatic type conversions for common Java types:

FromTo
org.bson.types.ObjectIdjava.lang.String
java.util.Datejava.lang.String
java.sql.Datejava.lang.String
java.sql.Timejava.lang.String
java.sql.Timestampjava.lang.String
java.time.LocalDateTimejava.lang.String
java.time.LocalDatejava.lang.String
java.math.BigIntegerjava.lang.Long
java.net.URLjava.lang.String
AtomicBooleanjava.lang.Boolean
AtomicLongjava.lang.Long
AtomicIntegerjava.lang.Integer

Field Utils

The field-utils extension (enabled by default) provides sensible defaults for field handling:

  • Ignore fields from java.lang system classes
  • Ignore transient fields
  • Ignore serialVersionUID
  • Only keep private/protected fields
  • Ignore common system types (Class, ClassLoader, Thread, ThreadLocal, etc.)

Released under the Apache-2.0 License.