DocTree

DocTree (문서 구문 트리 공통 인터페이스)

문서 구문 트리(documentation syntax tree)의 모든 노드가 공통으로 구현하는 인터페이스입니다. 문서 주석을 트리 구조로 파싱했을 때, 모든 노드의 뿌리가 되는 타입이에요.

출처: Java API Reference

본문

public interface DocTree

Java 1.8부터 존재합니다. 이 인터페이스의 알려진 하위 인터페이스는 매우 많아서, 앞서 본 @author 태그의 AuthorTree, @linkLinkTree, HTML 요소의 AttributeTree, 일반 텍스트의 TextTree, 오류 텍스트의 ErroneousTree 등 문서 주석의 거의 모든 노드가 이 타입으로 귀결됩니다.

이 인터페이스 안에는 트리의 종류를 모두 나열하는 열거형도 함께 정의돼 있어요.

static enum DocTree.Kind

DocTree.Kind는 모든 트리 종류를 열거합니다.

getKind()

public DocTree.Kind getKind()

이 트리의 종류를 반환합니다. 어떤 종류의 노드인지를 확인하는 핵심 메서드예요.

accept()

public <R, D> R accept(DocTreeVisitor<R,D> visitor, D data)

비지터(visitor) 패턴을 구현하기 위한 수락 메서드입니다. 트리 위에서 연산을 수행하도록 비지터 패턴을 사용해요.

  • R — 이 연산의 결과 타입
  • D — 추가 데이터의 타입
  • visitor — 호출될 비지터
  • data — 비지터 메서드에 전달될 파라미터 값

비지터 메서드가 반환한 값을 그대로 돌려줍니다.

더 알아보기 (Learn more)

Java 공식 API