001/*
002 * Copyright (c) 2009 The openGion Project.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *        http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
013 * either express or implied. See the License for the specific language
014 * governing permissions and limitations under the License.
015 */
016package org.opengion.fukurou.taglet;            // 7.4.4.0 (2021/06/30) openGionV8事前準備(taglet2→taglet)
017
018import static org.opengion.fukurou.system.HybsConst.BUFFER_MIDDLE;      // 6.1.0.0 (2014/12/26) refactoring
019
020import jdk.javadoc.doclet.DocletEnvironment      ;
021// import jdk.javadoc.doclet.Doclet  ;
022// import jdk.javadoc.doclet.Reporter ;
023import javax.lang.model.element.Element ;
024import javax.lang.model.element.Modifier ;
025import javax.lang.model.element.TypeElement;
026import javax.lang.model.element.ElementKind     ;
027import javax.lang.model.element.VariableElement;
028import javax.lang.model.element.ExecutableElement;
029// import javax.lang.model.SourceVersion ;
030import javax.lang.model.type.TypeMirror;
031import javax.lang.model.type.TypeKind;
032import javax.lang.model.util.ElementFilter ;
033import javax.lang.model.util.Elements ;
034import javax.lang.model.util.Types ;
035import javax.tools.Diagnostic.Kind ;
036import com.sun.source.doctree.DocCommentTree ;
037import com.sun.source.util.DocTrees  ;
038// import com.sun.source.util.DocSourcePositions ;
039import com.sun.source.doctree.DocTree  ;
040
041// import java.util.Locale ;
042import java.util.Set;
043import java.util.List;
044import java.util.HashSet;
045import java.util.Arrays;
046// import java.util.stream.Stream;                                                                              // 6.4.3.4 (2016/03/11)
047// import java.util.stream.Collectors;                                                                  // 6.4.3.4 (2016/03/11)
048// import java.util.regex.Pattern;                                                                              // 6.3.9.1 (2015/11/27) final化に伴う整理
049
050// import java.io.IOException;
051// import java.io.File;
052// import java.io.PrintWriter;
053import java.util.stream.Stream;                                                                         // 6.4.3.4 (2016/03/11)
054import java.util.stream.Collectors;                                                                     // 6.4.3.4 (2016/03/11)
055import java.util.Map;
056
057// import org.opengion.fukurou.util.FileUtil;
058// import org.opengion.fukurou.util.StringUtil;
059
060/**
061 * ソースコメントから、パラメータ情報を取り出す Doclet クラスです。
062 * og.paramLevel タグと og.cryptography タグを切り出します。
063 * これらは、システムパラメータとしてGE12テーブルに設定される値をクラスより抽出する
064 * のに使用します。
065 *
066 * @version  7.3
067 * @author      Kazuhiko Hasegawa
068 * @since        JDK11.0,
069 */
070public class DocTreeSpecific extends AbstractDocTree {
071        private static final String  SELECT_PACKAGE     = "org.opengion" ;
072        private static final boolean USE_PRIVATE        = false ;
073
074        private static final String     OG_FOR_SMPL             = "og.formSample";
075        private static final String     OG_REV                  = "og.rev";
076        private static final String     OG_GROUP                = "og.group";
077        private static final String     DOC_VERSION             = "version";
078        private static final String     DOC_AUTHOR              = "author";
079        private static final String     DOC_SINCE               = "since";
080
081//      private static final String OG_TAG_NAME         = "og.tag";                             // 6.1.2.0 (2015/01/24) チェック用
082//      private static final String     DOC_PARAM               = "param";                              // 5.1.9.0 (2010/08/01) チェック用
083//      private static final String     DOC_RETURN              = "return";                             // 5.1.9.0 (2010/08/01) チェック用
084
085        private static final String     CONSTRUCTOR             = "コンストラクタ" ;
086        private static final String     METHOD                  = "メソッド" ;
087
088        private String  version         ;
089        private String  outfile         ;
090        private int             debugLevel      ;               // 0:なし 1:最小チェック 2:日本語化 3:体裁 4:Verチェック 5:taglibラベル
091
092        private final Set<String> mtdClsSet = new HashSet<>();
093
094        // 5.1.9.0 (2010/08/01) ソースチェック用(半角文字+空白文字のみ)
095//      private static final Pattern PTN = Pattern.compile("[\\w\\s]+");                // 6.3.9.1 (2015/11/27)
096
097//      private DocTrees docUtil;
098//      private Elements eleUtil ;
099        private Types    typUtil ;
100
101        /**
102         * デフォルトコンストラクター
103         *
104         * @og.rev 7.3.0.0 (2021/01/06) PMD refactoring. Each class should declare at least one constructor.
105         */
106        public DocTreeSpecific() { super(); }           // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
107
108        /**
109         * Doclet のエントリポイントメソッドです(昔の startメソッド)。
110         *
111         * @og.rev 7.3.0.0 (2021/01/06) 新しいJavaDoc対応
112         *
113         * @param docEnv ドックレットを1回呼び出す操作環境
114         *
115         * @return 正常実行時 true
116         */
117        @Override
118        public boolean run( final DocletEnvironment docEnv ) {
119                try( DocTreeWriter writer = new DocTreeWriter( outfile,ENCODE ) ) {
120                        writer.printTag( "<?xml version=\"1.0\" encoding=\"", ENCODE , "\" ?>" );
121                        writer.printTag( "<javadoc>" );
122                        writer.printTag( "  <version>",version,"</version>" );
123                        writer.printTag( "  <description></description>" );
124                        writeContents( docEnv,writer );
125                        writer.printTag( "</javadoc>" );
126                }
127                catch( final Throwable th ) {
128                        reporter.print(Kind.ERROR, th.getMessage());
129                }
130
131                return true;
132        }
133
134        /**
135         * DocletEnvironmentよりコンテンツを作成します。
136         *
137         * @og.rev 7.3.0.0 (2021/01/06) 新しいJavaDoc対応
138         * @og.rev 8.0.0.0 (2021/07/31) Avoid instantiating new objects inside loops
139         *
140         * @param docEnv        ドックレットの最上位
141         * @param writer        DocTreeWriterオブジェクト
142         */
143        private void writeContents( final DocletEnvironment docEnv, final DocTreeWriter writer ) {
144//              docUtil = docEnv.getDocTrees();
145                final DocTrees docUtil = docEnv.getDocTrees();
146                final Elements eleUtil = docEnv.getElementUtils();
147                typUtil = docEnv.getTypeUtils();
148
149                final StringBuilder modiBuf = new StringBuilder();                      // 8.0.0.0 (2021/07/31) Avoid instantiating new objects inside loops
150                final StringBuilder buf     = new StringBuilder();                      // 8.0.0.0 (2021/07/31) Avoid instantiating new objects inside loops
151
152                // クラス単位にループする。
153                for( final TypeElement typEle : ElementFilter.typesIn(docEnv.getIncludedElements())) {
154                        final String fullName   = String.valueOf( typEle.getQualifiedName() ) ;
155                        writer.setClassName( fullName );
156
157                        final String className = String.valueOf( typEle.getSimpleName() );
158
159//                      final StringBuilder modiBuf = new StringBuilder();
160                        modiBuf.setLength( 0 ) ;                                                                // 8.0.0.0 (2021/07/31)
161                        typEle.getModifiers().forEach( modi -> modiBuf.append( modi ).append( ' ' ) );
162                        final ElementKind eleKind = typEle.getKind();
163                        if( ElementKind.CLASS.equals( eleKind ) ) { modiBuf.append( "class" ); }
164                        final String modifiers = modiBuf.toString().trim();
165
166                        final TypeMirror superType      = typEle.getSuperclass();
167                        final String superClass = TypeKind.NONE.equals( superType.getKind() ) ? "" : superType.toString();
168
169                        final String intFase = Stream.of( typEle.getInterfaces() )
170                                                                                .map( typ -> String.valueOf(typ) )
171                                                                                .collect( Collectors.joining( "," ) );
172
173                        final DocCommentTree docTree = docUtil.getDocCommentTree(typEle);               // ドキュメンテーション・コメントが見つからない場合、null が返る。
174
175                        final List<? extends DocTree> desc      = docTree == null ? EMPTY_LIST : docTree.getFirstSentence();
176                        final List<? extends DocTree> cmnt      = docTree == null ? EMPTY_LIST : docTree.getFullBody();
177
178                        final Map<String,List<String>> blkTagMap = blockTagsMap(docTree);
179                        final String smplTags   = getBlockTag( OG_FOR_SMPL, blkTagMap, ""   );
180                        final String revTags    = getBlockTag( OG_REV     , blkTagMap, "\n" );
181                        final String createVer  = getBlockTag( DOC_VERSION, blkTagMap, ""   );
182                        final String author             = getBlockTag( DOC_AUTHOR , blkTagMap, ""   );
183                        final String since              = getBlockTag( DOC_SINCE  , blkTagMap, ""   );
184                        final String grpTags    = getBlockTag( OG_GROUP   , blkTagMap, ","  );
185
186                        // 5.7.1.1 (2013/12/13) タグのインデントを止める。
187                        writer.printTag( "<classDoc>" );
188                        writer.printTag( "  <fullName>"         ,fullName               ,"</fullName>"          );
189                        writer.printTag( "  <modifiers>"        ,modifiers              ,"</modifiers>"         );
190                        writer.printTag( "  <className>"        ,className              ,"</className>"         );
191                        writer.printTag( "  <superClass>"       ,superClass             ,"</superClass>"        );
192                        writer.printTag( "  <interface>"        ,intFase                ,"</interface>"         );
193                        writer.printTag( "  <createVer>"        ,createVer              ,"</createVer>"         );
194                        writer.printTag( "  <author>"           ,author                 ,"</author>"            );
195                        writer.printTag( "  <since>"            ,since                  ,"</since>"                     );
196                        writer.printTag( "  <description>"      ,desc                   ,"</description>"       );
197                        writer.printTag( "  <contents>"         ,cmnt                   ,"</contents>"          );
198                        writer.printTag( "  <classGroup>"       ,grpTags                ,"</classGroup>"        );
199                        writer.printTag( "  <formSample>"       ,smplTags               ,"</formSample>"        );
200                        writer.printTag( "  <history>"          ,revTags                ,"</history>"           );
201
202                        // 5.1.9.0 (2010/08/01) ソースチェック用(コメントや概要が無い場合。スーパークラスは省く)
203                        if( debugLevel >= 2 && ( cmnt.isEmpty() || desc.isEmpty() ) && superClass.isEmpty() ) {
204        //                      final DocSourcePositions srcPos = docUtil.getSourcePositions();
205        //                      System.err.println( "警告2:コメントC=\t" + srcPos );
206                                System.err.println( "②警告2:コメントC=\t" + typEle );
207                        }
208
209                        int extendFlag = 0;             // 0:オリジナル 1:org.opengion関連Extend 2:Java関連Extend
210
211                        // 6.4.3.0 (2016/02/05) PMDチェックのDocletでのフォロー。
212        //              checkPMD( typEle );
213
214                        // 5.6.6.0 (2013/07/05) VERSION staticフィールドと、@og.rev コメントの比較チェック
215                        // while 以下で、fullName と classDoc を順番に上にさかのぼっているので、先にチェックします。
216        //              checkTag2( typEle );
217
218                        mtdClsSet.clear();
219                        TypeElement loopEle = typEle;
220                        String superName = fullName;
221                        while( loopEle != null ) {
222                                writer.setClassName( superName );
223
224                                // 対象クラスの スーパークラスを取得しておく(メソッド内で使うのと、上位に上がってく時に使う)
225                                final TypeMirror spType = loopEle.getSuperclass();
226
227                                // AbstractObjectPool<java.sql.Connection> の様な型を削除します。
228//                              final StringBuilder buf = new StringBuilder().append(spType);
229                                buf.setLength( 0 ) ;                                                            // 8.0.0.0 (2021/07/31)
230                                buf.append(spType) ;                                                            // 8.0.0.0 (2021/07/31)
231
232                                int st = buf.indexOf("<");
233                                int ed = buf.indexOf(">",st);
234                                while( st > 0 ) {
235                                        buf.delete(st,ed+1);
236                                        st = buf.indexOf("<");
237                                        ed = buf.indexOf(">",st);
238                                }
239                                superName = buf.toString();
240                //              superName = String.valueOf( spType );
241
242                                final String extClass   = ( extendFlag == 0 ) ? "" : superName ;
243
244                                // コンストラクタのみフィルタリングして取得する
245                                for( final ExecutableElement exEle : ElementFilter.constructorsIn(loopEle.getEnclosedElements()) ) {
246                                        final DocCommentTree dct = docUtil.getDocCommentTree(exEle);            // ドキュメンテーション・コメントが見つからない場合、null が返る。
247                                        if( dct != null && isAction( exEle,extendFlag ) ) {
248                //                              checkTag( exEle,dct );                                                                                          // 5.5.4.1 (2012/07/06)  チェックを分離
249                                                menberTag( exEle,dct,CONSTRUCTOR,writer,extendFlag,extClass );
250                                        }
251                                }
252
253                                // メソッドのみフィルタリングして取得する
254                                for( final ExecutableElement exEle : ElementFilter.methodsIn(loopEle.getEnclosedElements())) {
255                                        final DocCommentTree dct = docUtil.getDocCommentTree(exEle);            // ドキュメンテーション・コメントが見つからない場合、null が返る。
256                                        if( dct != null && isAction( exEle,extendFlag ) ) {
257                //                              checkTag( exEle,dct );
258                                                menberTag( exEle,dct,METHOD,writer,extendFlag,extClass );
259                                        }
260                                }
261
262                                // 対象クラス(オリジナル)から、上に上がっていく。
263                                if( superName.startsWith( SELECT_PACKAGE ) ) {
264                                        extendFlag = 1;
265                                }
266                                else {
267                                        break;
268                                }
269
270                                loopEle = eleUtil.getTypeElement(superName);
271                        }
272                        writer.printTag( "</classDoc>" );
273                }
274        }
275
276        /**
277         * メンバークラスのXML化を行うかどうか[true/false]を判定します。
278         *
279         * 以下の条件に合致する場合は、処理を行いません。(false を返します。)
280         *
281         * 1.同一クラスを処理中にEXTENDで継承元をさかのぼる場合、すでに同じシグネチャのメソッドが
282         *     存在している。
283         * 2.USE_PRIVATE が true の時の private メソッド
284         * 3.extendFlag が 0以上(1,2)の時の private メソッド
285         * 4.メソッド名におかしな記号(&lt;など)が含まれている場合
286         *
287         * @og.rev 7.3.0.0 (2021/01/06) 新しいJavaDoc対応
288         *
289         * @param       menber ExecutableMemberDocオブジェクト
290         * @param       extendFlag      継承状態 [0:オリジナル/1:org.opengion関連Extend/2:Java関連Extend]
291         *
292         * @return      XML化を行うかどうか[true/false]
293         */
294        private boolean isAction( final ExecutableElement menber,final int extendFlag ) {
295//              final String menberName = String.valueOf( menber.getSimpleName() ) ;
296                final boolean isPrivate   = menber.getModifiers().contains( Modifier.PRIVATE );
297                final boolean isTypeParam = ! menber.getTypeParameters().isEmpty();
298                final boolean rtn = ! mtdClsSet.add( String.valueOf( menber ) )         // 5.5.4.1 (2012/07/06) メソッドの重複処理判定は、クラス名も含めて行う
299                                                ||      USE_PRIVATE    && isPrivate
300                                                ||      extendFlag > 0 && isPrivate
301                                                ||      isTypeParam;                                                                    // PMD Useless parentheses.
302
303                return ! rtn ;
304        }
305
306//      /**
307//       * param,return 等の整合性をチェックします。
308//       *
309//       * @og.rev 7.3.0.0 (2021/01/06) 新しいJavaDoc対応
310//       *
311//       * @param exEle ExecutableElementオブジェクト
312//       * @param menber DocCommentTreeオブジェクト
313//       */
314//      private void checkTag( final ExecutableElement exEle , final DocCommentTree menber ) {
315//              // 未実装
316//      }
317
318//      /**
319//       * PMDで、チェックしている処理のうち、Docletでフォローできる分をチェックします。
320//       *
321//       * ※ このチェックは、警告レベル5 のみ集約していますので、呼出元で、制限します。
322//       *
323//       * @og.rev 7.3.0.0 (2021/01/06) 新しいJavaDoc対応
324//       *
325//       * @param typEle TypeElementオブジェクト
326//       */
327//      private void checkTag2( final TypeElement typEle ) {
328//              String cnstVar = null ;         // 初期値
329//              String seriUID = null ;
330//              final String src = "\tsrc/" + String.valueOf(typEle).replace('.','/') + ".java:100" ;                   // 行が判らないので、100行目 決め打ち
331//
332//              // フィールドのみフィルタリングして取得する
333//              for( final VariableElement varEle : ElementFilter.fieldsIn(typEle.getEnclosedElements())) {             // フィールドだけに絞る
334//                      final String key = String.valueOf(varEle);
335//                      if( "VERSION".equals( key ) ) {
336//                              cnstVar = String.valueOf( varEle.getConstantValue() );
337//                      }
338//                      else if( "serialVersionUID".equals( key ) ) {
339//                              seriUID = String.valueOf( varEle.getConstantValue() ) + "L";                    // 旧JavaDocと違い、"L" まで取ってこれないみたい
340//                      }
341//              }
342//
343//              if( cnstVar == null ) { return; }                               // VERSION が未定義のクラスは処理しない
344//
345//              String maxRev = cnstVar ;                                               // 5.7.1.1 (2013/12/13) 初期値
346//              boolean isChange = false;                                               // max が入れ替わったら、true
347//
348//              // メソッドのみフィルタリングして取得する
349//              for( final ExecutableElement exEle : ElementFilter.methodsIn(typEle.getEnclosedElements())) {
350//                      final DocCommentTree dct = docUtil.getDocCommentTree(exEle);            // ドキュメンテーション・コメントが見つからない場合、null が返る。
351//                      final Map<String,List<String>> blkTagMap = blockTagsMap(dct);
352//                      final List<String> revTags = blkTagMap.get("og.rev");
353//
354//                      if( revTags != null ) {
355//                              for( final String tag :revTags ) {                                                              // 複数存在しているはず
356//                                      final int idx = tag.indexOf( ' ' );                                                     // 最初のスペース
357//                                      if( idx > 0 ) {
358//                                              final String rev = tag.substring( 0,idx ).trim();
359//                                              if( maxRev.compareTo( rev ) < 0 ) {                                             // revTags の og.rev が大きい場合
360//                                                      maxRev = rev ;
361//                                                      isChange = true;
362//                                              }
363//                                      }
364//                              }
365//                      }
366//              }
367//
368//              // VERSION 文字列 の定義があり、かつ、max の入れ替えが発生した場合のみ、警告4:VERSIONが古い
369//              if( isChange ) {                        // 5.7.1.1 (2013/12/13) 入れ替えが発生した場合
370//                      System.err.println( "警告4:VERSIONが古い=\t" + cnstVar + " ⇒ " + maxRev + src );
371//              }
372//
373//              // serialVersionUID の定義がある。
374//              if( seriUID != null ) {
375//                      final StringBuilder buf = new StringBuilder();
376//                      // maxRev は、最大の Revか、初期のVERSION文字列 例:5.6.6.0 (2013/07/05)
377//                      for( int i=0; i<maxRev.length(); i++ ) {        //
378//                              final char ch = maxRev.charAt( i );
379//                              if( ch >= '0' && ch <= '9' ) { buf.append( ch ); }      // 数字だけ取り出す。 例:566020130705
380//                      }
381//                      buf.append( 'L' );      // 強制的に、L を追加する。
382//                      final String maxSeriUID = buf.toString() ;
383//
384//                      // 5.7.1.1 (2013/12/13) 値の取出し。Long型を表す "L" も含まれている。
385//                      if( !maxSeriUID.equals( seriUID ) ) {   // 一致しない
386//                              System.err.println( "警告4:serialVersionUIDが古い=\t" + seriUID + " ⇒ " + maxSeriUID + src );
387//                      }
388//              }
389//      }
390
391//      /**
392//       * PMDで、チェックしている処理のうち、Docletでフォローできる分をチェックします。
393//       *
394//       * ※ このチェックは、警告レベル5 のみ集約していますので、呼出元で、制限します。
395//       *
396//       * @og.rev 7.3.0.0 (2021/01/06) 新しいJavaDoc対応
397//       *
398//       * @param typEle TypeElementオブジェクト
399//       */
400//      private void checkPMD( final TypeElement typEle ) {
401//              // 未実装
402//      }
403
404        /**
405         * メンバークラス(コンストラクタ、メソッド)をXML化します。
406         *
407         * @og.rev 7.3.0.0 (2021/01/06) 新しいJavaDoc対応
408         *
409         * @param       menber          ExecutableElementオブジェクト
410         * @param       docTree         DocCommentTreeオブジェクト
411         * @param       menberType      メンバータイプ(コンストラクタ、メソッド)
412         * @param       writer          Tagを書き出すWriterオブジェクト
413         * @param       extendFlag      継承状態 [0:オリジナル/1::org.opengion関連Extend/2:Java関連Extend]
414         * @param       extClass        継承クラス(オリジナルの場合は、空文字列)
415         */
416        private void menberTag( final ExecutableElement menber,
417                                                        final DocCommentTree docTree ,
418                                                        final String menberType,
419                                                        final DocTreeWriter writer,
420                                                        final int extendFlag ,
421                                                        final String extClass ) {
422
423                final String modifiers ;
424
425                final StringBuilder buf = new StringBuilder( BUFFER_MIDDLE );
426                menber.getModifiers().forEach( modi -> buf.append( modi ).append( ' ' ) );
427                if( ElementKind.METHOD.equals( menber.getKind() ) ) {           // メソッドの処理。コンストラクタの場合は、返り値がないので処理しない。
428                        buf.append( menber.getReturnType() );
429                }
430                modifiers = buf.toString();
431
432                final String menberName = String.valueOf( menber.getSimpleName() );                     // コンストラクタの場合は、<init> が返る。
433
434                final StringBuilder sigBuf = new StringBuilder().append( menberName ).append( '(' ) ;
435                boolean flag = false;
436                for( final VariableElement valEle : menber.getParameters() ) {
437                        flag = true;
438                        final Element ele = typUtil.asElement( valEle.asType() );               // 型が対応する要素を持たない場合はnullを返します。
439                        final String key = ele == null                                                                  // 配列や、プリミティブ型の場合は、null になっている。
440                                                                        ? String.valueOf( valEle.asType() )
441                                                                        : String.valueOf( ele.getSimpleName() );
442
443                        sigBuf.append( key ).append( ' ' )
444                                        .append( valEle.getSimpleName() ).append( ',' );
445                }
446
447                if( flag ) { sigBuf.deleteCharAt( sigBuf.length()-1 ); }
448                sigBuf.append( ')' );
449                final String signature = sigBuf.toString();
450//              final String signature = String.valueOf( menber );
451
452                final List<? extends DocTree> desc      = docTree == null ? EMPTY_LIST : docTree.getFirstSentence();
453                final List<? extends DocTree> cmnt      = docTree == null ? EMPTY_LIST : docTree.getFullBody();
454
455                final Map<String,List<String>> blkTagMap = blockTagsMap(docTree);
456                final String revTags = getBlockTag( OG_REV, blkTagMap, "\n" );
457
458                // tags は、OG_REV 以外のすべてで、かつ、キーワードも含む。
459                final StringBuilder tagBuf = new StringBuilder();
460                if( docTree != null ) {
461                        for( final DocTree dt : docTree.getBlockTags() ) {
462                                final String tag = String.valueOf(dt).trim();
463                                if( !tag.contains( OG_REV ) ) { tagBuf.append( tag ).append( '\n' ); }
464                        }
465                }
466                final String tags = tagBuf.toString().trim();
467
468//              final StringBuilder tagBuf = new StringBuilder();
469//              final StringBuilder revBuf = new StringBuilder();
470//              if( docTree != null ) {
471//                      for( final DocTree dt : docTree.getBlockTags() ) {
472//                              final String tag = String.valueOf(dt).trim();
473//                              if( tag.contains( OG_REV ) ) { revBuf.append( cutTag( tag,OG_REV ) ).append( '\n' ); }
474//                              else { tagBuf.append( tag ).append( '\n' ); }
475//                      }
476//              }
477//              final String revTags = revBuf.toString().trim();
478//              final String tags    = tagBuf.toString().trim();
479
480                final String    extend  = String.valueOf( extendFlag );
481
482        //      final DocSourcePositions srcPos = docUtil.getSourcePositions();
483        //      final String    position = String.valueOf( srcPos.getStartPosition( null,docTree,null ) );
484                final String    position = "";
485
486                writer.printTag( "  <menber>" );
487                writer.printTag( "    <type>"           ,menberType     ,"</type>"                      );
488                writer.printTag( "    <name>"           ,menberName     ,"</name>"                      );
489                writer.printTag( "    <modifiers>"      ,modifiers      ,"</modifiers>"         );
490                writer.printTag( "    <signature>"      ,signature      ,"</signature>"         );
491                writer.printTag( "    <position>"       ,position       ,"</position>"          );
492                writer.printTag( "    <extendClass>",extClass   ,"</extendClass>"       );
493                writer.printTag( "    <extendFlag>"     ,extend         ,"</extendFlag>"        );
494                writer.printTag( "    <description>",desc               ,"</description>"       );
495                writer.printTag( "    <contents>"       ,cmnt           ,"</contents>"          );
496                writer.printTag( "    <tagText>"        ,tags           ,"</tagText>"           );
497                writer.printTag( "    <history>"        ,revTags        ,"</history>"           );
498                writer.printTag( "  </menber>");
499        }
500
501        /**
502         * サポートされているすべてのオプションを返します。
503         *
504         * @return サポートされているすべてのオプションを含むセット、存在しない場合は空のセット
505         */
506        @Override
507        public Set<? extends Option> getSupportedOptions() {
508                final Option[] options = {
509                        new AbstractOption( "-outfile", "-version", "-debugLevel" ) {
510
511                                /**
512                                 * 必要に応じてオプションと引数を処理します。
513                                 *
514                                 * @param  opt オプション名
515                                 * @param  arguments 引数をカプセル化したリスト
516                                 * @return 操作が成功した場合はtrue、そうでない場合はfalse
517                                 */
518                                @Override
519                                public boolean process(final String opt, final List<String> arguments) {
520                                        if( "-outfile".equalsIgnoreCase(opt) ) {
521                                                outfile = arguments.get(0);
522                                        }
523                                        else if( "-version".equalsIgnoreCase(opt) ) {
524                                                version = arguments.get(0);
525                                        }
526                                        else if( "-debugLevel".equalsIgnoreCase(opt) ) {
527                                                debugLevel = Integer.parseInt( arguments.get(0) );
528                                        }
529                                        return true;
530                                }
531                        }
532                };
533                return new HashSet<>(Arrays.asList(options));
534        }
535}