Kotlin 의 @JvmOverloads 어노테이션

[occidere]

@JvmOverloads

kotlin 함수에 default parameter 가 있는 경우 Java 에서 사용이 용이하도록 기본 인자들이 overload 된 메서드들를 생성한다.

Example

예를들어 아래와 같은 2개의 default parameter 를 지닌 kotlin 함수가 있다고 하자.

class MyElasticClient {
    fun check(query: String, async: Boolean = false, ignoreException: Boolean = false) {
        // 코드 생략
    }
}

그러나 Java 에선 기본 인자 개념이 없기 때문에 모든 인자를 전부 입력해야 한다.

public static void main(String[] args) {
	MyElasticClient client = new MyElasticClient();
	client.check("query"); // compile-error
	client.check("query", false); // compile-error
	client.check("query", false, false); // ok
}

이 때 kotlin 함수에 @JvmOverloads 를 붙이면 자동으로 default methods 를 overloads 한 메서드들을 생성해준다.

class MyElasticClient {
    @JvmOverloads
    fun check(query: String, async: Boolean = false, ignoreException: Boolean = false) {
        // 코드 생략
    }
}

이 후 Java 에서도 원하는대로 인자를 생략해서 사용할 수 있다.

public static void main(String[] args) {
	MyElasticClient client = new MyElasticClient();
	client.check("query"); // ok
	client.check("query", false); // ok
	client.check("query", false, false); // ok
}

참고

• https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/