DocletEnvironment
DocletEnvironment (독렛 실행 환경 표현)
독렛의 단일 실행에 대한 운영 환경을 나타내는 인터페이스입니다. 프로그램 구조, 각종 유틸리티, 명령줄에서 사용자가 지정한 요소에 접근할 수 있게 해 줍니다.
본문
DocletEnvironment는 독렛이 한 번 실행되는 동안 사용할 수 있는 모든 환경 정보를 제공합니다. 문서화 대상인 모듈·패키지·클래스의 구조(getIncludedElements(), getSpecifiedElements() 등)와 그 요소에 대한 상세 정보에 접근할 수 있습니다.
또한 소스 파일, 문서 주석 처리, 유틸리티 접근 등 문서 생성에 필요한 여러 기능을 노출합니다. 명령줄에서 지정된 사용자 요소도 이 환경 객체를 통해 조회할 수 있습니다.
Doclet.run(DocletEnvironment)에 전달되어, 독렛이 환경을 조회해 어떤 요소를 어떤 방식으로 문서화할지 결정하게 됩니다. 독렛 개발의 핵심 진입점이며 표준 문서화 흐름을 커스터마이즈하는 기반이 됩니다.