< prev index next >

src/jdk.compiler/share/classes/com/sun/source/doctree/DocTreeVisitor.java

Print this page




  40  * details.
  41  *
  42  * <p> <b>WARNING:</b> It is possible that methods will be added to
  43  * this interface to accommodate new, currently unknown, doc comment
  44  * structures added to future versions of the Java&trade; programming
  45  * language.  Therefore, visitor classes directly implementing this
  46  * interface may be source incompatible with future versions of the
  47  * platform.
  48  *
  49  * @param <R> the return type of this visitor's methods.  Use {@link
  50  *            Void} for visitors that do not need to return results.
  51  * @param <P> the type of the additional parameter to this visitor's
  52  *            methods.  Use {@code Void} for visitors that do not need an
  53  *            additional parameter.
  54  *
  55  * @since 1.8
  56  */
  57 public interface DocTreeVisitor<R,P> {
  58 
  59     /**








  60      * Visits an AttributeTree node.
  61      * @param node the node being visited
  62      * @param p a parameter value
  63      * @return a result value
  64      */
  65     R visitAttribute(AttributeTree node, P p);
  66 
  67     /**
  68      * Visits an AuthorTree node.
  69      * @param node the node being visited
  70      * @param p a parameter value
  71      * @return a result value
  72      */
  73     R visitAuthor(AuthorTree node, P p);
  74 
  75     /**
  76      * Visits a CommentTree node.
  77      * @param node the node being visited
  78      * @param p a parameter value
  79      * @return a result value




  40  * details.
  41  *
  42  * <p> <b>WARNING:</b> It is possible that methods will be added to
  43  * this interface to accommodate new, currently unknown, doc comment
  44  * structures added to future versions of the Java&trade; programming
  45  * language.  Therefore, visitor classes directly implementing this
  46  * interface may be source incompatible with future versions of the
  47  * platform.
  48  *
  49  * @param <R> the return type of this visitor's methods.  Use {@link
  50  *            Void} for visitors that do not need to return results.
  51  * @param <P> the type of the additional parameter to this visitor's
  52  *            methods.  Use {@code Void} for visitors that do not need an
  53  *            additional parameter.
  54  *
  55  * @since 1.8
  56  */
  57 public interface DocTreeVisitor<R,P> {
  58 
  59     /**
  60      * Visits an AaccessorTree node.
  61      * @param node the node being visited
  62      * @param p a parameter value
  63      * @return a result value
  64      */
  65     R visitAccessor(AccessorTree node, P p);
  66 
  67     /**
  68      * Visits an AttributeTree node.
  69      * @param node the node being visited
  70      * @param p a parameter value
  71      * @return a result value
  72      */
  73     R visitAttribute(AttributeTree node, P p);
  74 
  75     /**
  76      * Visits an AuthorTree node.
  77      * @param node the node being visited
  78      * @param p a parameter value
  79      * @return a result value
  80      */
  81     R visitAuthor(AuthorTree node, P p);
  82 
  83     /**
  84      * Visits a CommentTree node.
  85      * @param node the node being visited
  86      * @param p a parameter value
  87      * @return a result value


< prev index next >