インタフェースSnippetTree

すべてのスーパー・インタフェース:
DocTree, InlineTagTree
public interface SnippetTree extends InlineTagTree
@snippetのインライン・タグのツリー・ノード。 
   {@snippet :
    body
   }

   {@snippet attributes}

   {@snippet attributes :
    body
   }
導入されたバージョン:
18

  • ネストされたクラスのサマリー

    インタフェースで宣言されたネストされたクラス/インタフェース DocTree

    DocTree.Kind

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    List<? extends DocTree>
    getAttributes()
    @snippetタグの属性のリストを返します。
    TextTree
    getBody()
    @snippetタグの本体を返します。本文がない場合はnullを返します。

    インタフェースで宣言されたメソッド DocTree

    accept, getKind

    インタフェースで宣言されたメソッド InlineTagTree

    getTagName

  • メソッドの詳細

    • getAttributes

      List<? extends DocTree> getAttributes()
      @snippetタグの属性のリストを返します。
      戻り値:
      属性のリスト

    • getBody

      TextTree getBody()
      @snippetタグの本体を返します。本文がない場合はnullを返します。
      APIのノート:
      本文が空であるSnippetTreeのインスタンスは、本文のないSnippetTreeのインスタンスとは異なります。 タグに本文がない場合、このメソッドをコールするとnullが返されます。 タグに空の本文がある場合、このメソッドは、TextTree.getBody()が空の文字列を返すTextTreeを返します。
      戻り値:
      タグの本文、または本文がない場合はnull