| /* |
| * Copyright (c) 2003, 2016, Oracle and/or its affiliates. All rights reserved. |
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| * |
| * This code is free software; you can redistribute it and/or modify it |
| * under the terms of the GNU General Public License version 2 only, as |
| * published by the Free Software Foundation. Oracle designates this |
| * particular file as subject to the "Classpath" exception as provided |
| * by Oracle in the LICENSE file that accompanied this code. |
| * |
| * This code is distributed in the hope that it will be useful, but WITHOUT |
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| * version 2 for more details (a copy is included in the LICENSE file that |
| * accompanied this code). |
| * |
| * You should have received a copy of the GNU General Public License version |
| * 2 along with this work; if not, write to the Free Software Foundation, |
| * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| * |
| * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| * or visit www.oracle.com if you need additional information or have any |
| * questions. |
| */ |
| |
| package jdk.javadoc.internal.doclets.toolkit; |
| |
| import javax.lang.model.element.ModuleElement; |
| import javax.lang.model.element.PackageElement; |
| import javax.lang.model.element.TypeElement; |
| import javax.lang.model.type.TypeMirror; |
| |
| import jdk.javadoc.internal.doclets.toolkit.util.ClassTree; |
| import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberMap; |
| |
| /** |
| * The interface for a factory creates writers. |
| * |
| * <p><b>This is NOT part of any supported API. |
| * If you write code that depends on this, you do so at your own risk. |
| * This code and its internal interfaces are subject to change or |
| * deletion without notice.</b> |
| * |
| * @author Jamie Ho |
| */ |
| |
| public interface WriterFactory { |
| |
| /** |
| * Return the writer for the constant summary. |
| * |
| * @return the writer for the constant summary. Return null if this |
| * writer is not supported by the doclet. |
| */ |
| public abstract ConstantsSummaryWriter getConstantsSummaryWriter() |
| throws Exception; |
| |
| /** |
| * Return the writer for the package summary. |
| * |
| * @param packageElement the package being documented. |
| * @param prevPkg the previous package that was documented. |
| * @param nextPkg the next package being documented. |
| * @return the writer for the package summary. Return null if this |
| * writer is not supported by the doclet. |
| */ |
| public abstract PackageSummaryWriter getPackageSummaryWriter(PackageElement |
| packageElement, PackageElement prevPkg, PackageElement nextPkg) |
| throws Exception; |
| |
| /** |
| * Return the writer for the module summary. |
| * |
| * @param mdle the module being documented. |
| * @param prevModule the previous module that was documented. |
| * @param nextModule the next module being documented. |
| * @return the writer for the module summary. Return null if this |
| * writer is not supported by the doclet. |
| */ |
| public abstract ModuleSummaryWriter getModuleSummaryWriter( |
| ModuleElement mdle, ModuleElement prevModule, ModuleElement nextModule) |
| throws Exception; |
| |
| /** |
| * Return the writer for a class. |
| * |
| * @param typeElement the class being documented. |
| * @param prevClass the previous class that was documented. |
| * @param nextClass the next class being documented. |
| * @param classTree the class tree. |
| * @return the writer for the class. Return null if this |
| * writer is not supported by the doclet. |
| */ |
| public abstract ClassWriter getClassWriter(TypeElement typeElement, |
| TypeElement prevClass, TypeElement nextClass, ClassTree classTree) |
| throws Exception; |
| |
| /** |
| * Return the writer for an annotation type. |
| * |
| * @param annotationType the type being documented. |
| * @param prevType the previous type that was documented. |
| * @param nextType the next type being documented. |
| * @return the writer for the annotation type. Return null if this |
| * writer is not supported by the doclet. |
| */ |
| public abstract AnnotationTypeWriter getAnnotationTypeWriter( |
| TypeElement annotationType, TypeMirror prevType, TypeMirror nextType) |
| throws Exception; |
| |
| /** |
| * Return the method writer for a given class. |
| * |
| * @param classWriter the writer for the class being documented. |
| * @return the method writer for the give class. Return null if this |
| * writer is not supported by the doclet. |
| */ |
| public abstract MethodWriter getMethodWriter(ClassWriter classWriter) |
| throws Exception; |
| |
| /** |
| * Return the annotation type field writer for a given annotation type. |
| * |
| * @param annotationTypeWriter the writer for the annotation type |
| * being documented. |
| * @return the member writer for the given annotation type. Return null if |
| * this writer is not supported by the doclet. |
| */ |
| public abstract AnnotationTypeFieldWriter |
| getAnnotationTypeFieldWriter( |
| AnnotationTypeWriter annotationTypeWriter) throws Exception; |
| |
| /** |
| * Return the annotation type optional member writer for a given annotation |
| * type. |
| * |
| * @param annotationTypeWriter the writer for the annotation type |
| * being documented. |
| * @return the member writer for the given annotation type. Return null if |
| * this writer is not supported by the doclet. |
| */ |
| public abstract AnnotationTypeOptionalMemberWriter |
| getAnnotationTypeOptionalMemberWriter( |
| AnnotationTypeWriter annotationTypeWriter) throws Exception; |
| |
| /** |
| * Return the annotation type required member writer for a given annotation type. |
| * |
| * @param annotationTypeWriter the writer for the annotation type |
| * being documented. |
| * @return the member writer for the given annotation type. Return null if |
| * this writer is not supported by the doclet. |
| */ |
| public abstract AnnotationTypeRequiredMemberWriter |
| getAnnotationTypeRequiredMemberWriter( |
| AnnotationTypeWriter annotationTypeWriter) throws Exception; |
| |
| /** |
| * Return the enum constant writer for a given class. |
| * |
| * @param classWriter the writer for the class being documented. |
| * @return the enum constant writer for the give class. Return null if this |
| * writer is not supported by the doclet. |
| */ |
| public abstract EnumConstantWriter getEnumConstantWriter( |
| ClassWriter classWriter) throws Exception; |
| |
| /** |
| * Return the field writer for a given class. |
| * |
| * @param classWriter the writer for the class being documented. |
| * @return the field writer for the give class. Return null if this |
| * writer is not supported by the doclet. |
| */ |
| public abstract FieldWriter getFieldWriter(ClassWriter classWriter) |
| throws Exception; |
| |
| /** |
| * Return the property writer for a given class. |
| * |
| * @param classWriter the writer for the class being documented. |
| * @return the property writer for the give class. Return null if this |
| * writer is not supported by the doclet. |
| */ |
| public abstract PropertyWriter getPropertyWriter(ClassWriter classWriter) |
| throws Exception; |
| |
| /** |
| * Return the constructor writer for a given class. |
| * |
| * @param classWriter the writer for the class being documented. |
| * @return the method writer for the give class. Return null if this |
| * writer is not supported by the doclet. |
| */ |
| public abstract ConstructorWriter getConstructorWriter( |
| ClassWriter classWriter) |
| throws Exception; |
| |
| /** |
| * Return the specified member summary writer for a given class. |
| * |
| * @param classWriter the writer for the class being documented. |
| * @param memberType the {@link VisibleMemberMap} member type indicating |
| * the type of member summary that should be returned. |
| * @return the summary writer for the give class. Return null if this |
| * writer is not supported by the doclet. |
| * |
| * @see VisibleMemberMap |
| * @throws IllegalArgumentException if memberType is unknown. |
| */ |
| public abstract MemberSummaryWriter getMemberSummaryWriter( |
| ClassWriter classWriter, VisibleMemberMap.Kind memberType) |
| throws Exception; |
| |
| /** |
| * Return the specified member summary writer for a given annotation type. |
| * |
| * @param annotationTypeWriter the writer for the annotation type being |
| * documented. |
| * @param memberType the {@link VisibleMemberMap} member type indicating |
| * the type of member summary that should be returned. |
| * @return the summary writer for the give class. Return null if this |
| * writer is not supported by the doclet. |
| * |
| * @see VisibleMemberMap |
| * @throws IllegalArgumentException if memberType is unknown. |
| */ |
| public abstract MemberSummaryWriter getMemberSummaryWriter( |
| AnnotationTypeWriter annotationTypeWriter, VisibleMemberMap.Kind memberType) |
| throws Exception; |
| |
| /** |
| * Return the writer for the serialized form. |
| * |
| * @return the writer for the serialized form. |
| */ |
| public SerializedFormWriter getSerializedFormWriter() throws Exception; |
| } |