SimpleDocTreeVisitor

SimpleDocTreeVisitor (간단한 문서 트리 방문자)

문서 주석 트리 노드를 위한 간단한 방문자입니다. 모든 DocTreeVisitor 메서드에 대해 기본 동작을 제공해 주어서, 필요한 메서드만 골라 오버라이드할 수 있어요.

출처: Java API Reference

본문

DocTreeVisitor<R,P>의 모든 visitXXX 메서드가 기본적으로 defaultAction을 호출하도록 구현해 둔 편의 방문자 클래스입니다. defaultAction은 기본 값(DEFAULT_VALUE)을 반환합니다. 덕분에 특정 노드만 처리하고 싶을 때 관련 visitXXX만 오버라이드하면 나머지 노드들은 자동으로 기본 값으로 처리돼요.

방문자의 동작을 사용자가 직접 지정하려면 두 생성자 중 하나를 사용해요. 기본 생성자는 DEFAULT_VALUEnull이고, SimpleDocTreeVisitor(R defaultValue)처럼 값을 넘기면 모든 오버라이드하지 않은 노드가 그 값을 반환합니다.

핵심 메서드

  • visit(DocTree node, P p) — 노드의 타입에 맞는 방문 메서드를 호출해 실행합니다. 디스패치(dispatch)의 입구 역할이에요.

  • visit(Iterable<? extends DocTree> nodes, P p) — 노드들의 연속 각각에 대해 알맞은 방문 메서드를 호출하고, 마지막 방문 메서드의 결과를 반환합니다. 호출된 것이 없으면 null이에요.

  • defaultAction(DocTree node, P p) — 오버라이드하지 않은 모든 방문 메서드가 사용하는 기본 동작입니다. DEFAULT_VALUE를 돌려줍니다.

  • DEFAULT_VALUE 필드 — 기본 동작이 반환하는 값입니다.

  • visitXXX 메서드visitAttribute, visitAuthor, visitComment, visitDocComment, visitLink, visitParam, visitReturn, visitSee, visitThrows, visitText 등 문서 주석의 모든 노드 종류에 대응하며, 기본적으로 defaultAction을 호출합니다.

제네릭 R은 반환 타입, P는 추가 매개변수 타입이고, 필요 없으면 Void를 쓰면 돼요.

더 알아보기

Java 공식 API