jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/internal/toolkit/WriterFactory.java@ccbe7ffdd867

7112427: The doclet needs to be able to generate JavaFX documentation.
Reviewed-by: jjg
Contributed-by: jan.valenta@oracle.com

     1 /*

     2  * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    26 package com.sun.tools.doclets.internal.toolkit;

    28 import com.sun.javadoc.*;

    29 import com.sun.tools.javac.jvm.Profile;

    30 import com.sun.tools.doclets.internal.toolkit.util.*;

    32 /**

    33  * The interface for a factory creates writers.

    34  *

    35  *  <p><b>This is NOT part of any supported API.

    36  *  If you write code that depends on this, you do so at your own risk.

    37  *  This code and its internal interfaces are subject to change or

    38  *  deletion without notice.</b>

    39  *

    40  * @author Jamie Ho

    41  * @since 1.4

    42  */

    44 public interface WriterFactory {

    46     /**

    47      * Return the writer for the constant summary.

    48      *

    49      * @return the writer for the constant summary.  Return null if this

    50      * writer is not supported by the doclet.

    51      */

    52     public abstract ConstantsSummaryWriter getConstantsSummaryWriter()

    53         throws Exception;

    55     /**

    56      * Return the writer for the package summary.

    57      *

    58      * @param packageDoc the package being documented.

    59      * @param prevPkg the previous package that was documented.

    60      * @param nextPkg the next package being documented.

    61      * @return the writer for the package summary.  Return null if this

    62      * writer is not supported by the doclet.

    63      */

    64     public abstract PackageSummaryWriter getPackageSummaryWriter(PackageDoc

    65         packageDoc, PackageDoc prevPkg, PackageDoc nextPkg)

    66     throws Exception;

    68     /**

    69      * Return the writer for the profile summary.

    70      *

    71      * @param profile the profile being documented.

    72      * @param prevProfile the previous profile that was documented.

    73      * @param nextProfile the next profile being documented.

    74      * @return the writer for the profile summary.  Return null if this

    75      * writer is not supported by the doclet.

    76      */

    77     public abstract ProfileSummaryWriter getProfileSummaryWriter(Profile

    78         profile, Profile prevProfile, Profile nextProfile)

    79     throws Exception;

    81     /**

    82      * Return the writer for the profile package summary.

    83      *

    84      * @param packageDoc the profile package being documented.

    85      * @param prevPkg the previous profile package that was documented.

    86      * @param nextPkg the next profile package being documented.

    87      * @param profile the profile being documented.

    88      * @return the writer for the profile package summary.  Return null if this

    89      * writer is not supported by the doclet.

    90      */

    91     public abstract ProfilePackageSummaryWriter getProfilePackageSummaryWriter(

    92             PackageDoc packageDoc, PackageDoc prevPkg, PackageDoc nextPkg,

    93             Profile profile) throws Exception;

    95     /**

    96      * Return the writer for a class.

    97      *

    98      * @param classDoc the class being documented.

    99      * @param prevClass the previous class that was documented.

   100      * @param nextClass the next class being documented.

   101      * @param classTree the class tree.

   102      * @return the writer for the class.  Return null if this

   103      * writer is not supported by the doclet.

   104      */

   105     public abstract ClassWriter getClassWriter(ClassDoc classDoc,

   106         ClassDoc prevClass, ClassDoc nextClass, ClassTree classTree)

   107             throws Exception;

   109     /**

   110      * Return the writer for an annotation type.

   111      *

   112      * @param annotationType the type being documented.

   113      * @param prevType the previous type that was documented.

   114      * @param nextType the next type being documented.

   115      * @return the writer for the annotation type.  Return null if this

   116      * writer is not supported by the doclet.

   117      */

   118     public abstract AnnotationTypeWriter getAnnotationTypeWriter(

   119         AnnotationTypeDoc annotationType, Type prevType, Type nextType)

   120             throws Exception;

   122     /**

   123      * Return the method writer for a given class.

   124      *

   125      * @param classWriter the writer for the class being documented.

   126      * @return the method writer for the give class.  Return null if this

   127      * writer is not supported by the doclet.

   128      */

   129     public abstract MethodWriter getMethodWriter(ClassWriter classWriter)

   130             throws Exception;

   132     /**

   133      * Return the annotation type optional member writer for a given annotation

   134      * type.

   135      *

   136      * @param annotationTypeWriter the writer for the annotation type

   137      *        being documented.

   138      * @return the member writer for the given annotation type.  Return null if

   139      *         this writer is not supported by the doclet.

   140      */

   141     public abstract AnnotationTypeOptionalMemberWriter

   142             getAnnotationTypeOptionalMemberWriter(

   143         AnnotationTypeWriter annotationTypeWriter) throws Exception;

   145     /**

   146      * Return the annotation type required member writer for a given annotation type.

   147      *

   148      * @param annotationTypeWriter the writer for the annotation type

   149      *        being documented.

   150      * @return the member writer for the given annotation type.  Return null if

   151      *         this writer is not supported by the doclet.

   152      */

   153     public abstract AnnotationTypeRequiredMemberWriter

   154             getAnnotationTypeRequiredMemberWriter(

   155         AnnotationTypeWriter annotationTypeWriter) throws Exception;

   157     /**

   158      * Return the enum constant writer for a given class.

   159      *

   160      * @param classWriter the writer for the class being documented.

   161      * @return the enum constant writer for the give class.  Return null if this

   162      * writer is not supported by the doclet.

   163      */

   164     public abstract EnumConstantWriter getEnumConstantWriter(

   165         ClassWriter classWriter) throws Exception;

   167     /**

   168      * Return the field writer for a given class.

   169      *

   170      * @param classWriter the writer for the class being documented.

   171      * @return the field writer for the give class.  Return null if this

   172      * writer is not supported by the doclet.

   173      */

   174     public abstract FieldWriter getFieldWriter(ClassWriter classWriter)

   175             throws Exception;

   177     /**

   178      * Return the property writer for a given class.

   179      *

   180      * @param classWriter the writer for the class being documented.

   181      * @return the property writer for the give class.  Return null if this

   182      * writer is not supported by the doclet.

   183      */

   184     public abstract PropertyWriter getPropertyWriter(ClassWriter classWriter)

   185             throws Exception;

   187     /**

   188      * Return the constructor writer for a given class.

   189      *

   190      * @param classWriter the writer for the class being documented.

   191      * @return the method writer for the give class.  Return null if this

   192      * writer is not supported by the doclet.

   193      */

   194     public abstract ConstructorWriter getConstructorWriter(

   195         ClassWriter classWriter)

   196     throws Exception;

   198     /**

   199      * Return the specified member summary writer for a given class.

   200      *

   201      * @param classWriter the writer for the class being documented.

   202      * @param memberType  the {@link VisibleMemberMap} member type indicating

   203      *                    the type of member summary that should be returned.

   204      * @return the summary writer for the give class.  Return null if this

   205      * writer is not supported by the doclet.

   206      *

   207      * @see VisibleMemberMap

   208      * @throws IllegalArgumentException if memberType is unknown.

   209      */

   210     public abstract MemberSummaryWriter getMemberSummaryWriter(

   211         ClassWriter classWriter, int memberType)

   212     throws Exception;

   214     /**

   215      * Return the specified member summary writer for a given annotation type.

   216      *

   217      * @param annotationTypeWriter the writer for the annotation type being

   218      *                             documented.

   219      * @param memberType  the {@link VisibleMemberMap} member type indicating

   220      *                    the type of member summary that should be returned.

   221      * @return the summary writer for the give class.  Return null if this

   222      * writer is not supported by the doclet.

   223      *

   224      * @see VisibleMemberMap

   225      * @throws IllegalArgumentException if memberType is unknown.

   226      */

   227     public abstract MemberSummaryWriter getMemberSummaryWriter(

   228         AnnotationTypeWriter annotationTypeWriter, int memberType)

   229     throws Exception;

   231     /**

   232      * Return the writer for the serialized form.

   233      *

   234      * @return the writer for the serialized form.

   235      */

   236     public SerializedFormWriter getSerializedFormWriter() throws Exception;

   237 }

Mercurial > jdk8-mips64-public > langtools / file revision

src/share/classes/com/sun/tools/doclets/internal/toolkit/WriterFactory.java@ccbe7ffdd867

src/share/classes/com/sun/tools/doclets/internal/toolkit/WriterFactory.java