src/share/classes/com/sun/tools/doclets/formats/html/WriterFactoryImpl.java

Thu, 02 Oct 2008 19:58:40 -0700

author
xdono
date
Thu, 02 Oct 2008 19:58:40 -0700
changeset 117
24a47c3062fe
parent 1
9a66ca7c79fa
child 140
22c4c1143a3a
permissions
-rw-r--r--

6754988: Update copyright year
Summary: Update for files that have been modified starting July 2008
Reviewed-by: ohair, tbell

duke@1 1 /*
duke@1 2 * Copyright 2003 Sun Microsystems, Inc. All Rights Reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
duke@1 7 * published by the Free Software Foundation. Sun designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
duke@1 9 * by Sun in the LICENSE file that accompanied this code.
duke@1 10 *
duke@1 11 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 14 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 15 * accompanied this code).
duke@1 16 *
duke@1 17 * You should have received a copy of the GNU General Public License version
duke@1 18 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 20 *
duke@1 21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1 22 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1 23 * have any questions.
duke@1 24 */
duke@1 25
duke@1 26 package com.sun.tools.doclets.formats.html;
duke@1 27
duke@1 28 import com.sun.tools.doclets.internal.toolkit.*;
duke@1 29 import com.sun.tools.doclets.internal.toolkit.util.*;
duke@1 30 import com.sun.javadoc.*;
duke@1 31
duke@1 32 /**
duke@1 33 * The factory that returns HTML writers.
duke@1 34 *
duke@1 35 * @author Jamie Ho
duke@1 36 * @since 1.5
duke@1 37 */
duke@1 38 public class WriterFactoryImpl implements WriterFactory {
duke@1 39
duke@1 40 private static WriterFactoryImpl instance;
duke@1 41
duke@1 42 private ConfigurationImpl configuration;
duke@1 43
duke@1 44 private WriterFactoryImpl(ConfigurationImpl configuration) {
duke@1 45 this.configuration = configuration;
duke@1 46 }
duke@1 47
duke@1 48 /**
duke@1 49 * Return an instance of this factory.
duke@1 50 *
duke@1 51 * @return an instance of this factory.
duke@1 52 */
duke@1 53 public static WriterFactoryImpl getInstance() {
duke@1 54 if (instance == null) {
duke@1 55 instance = new WriterFactoryImpl(ConfigurationImpl.getInstance());
duke@1 56 }
duke@1 57 return instance;
duke@1 58 }
duke@1 59
duke@1 60 /**
duke@1 61 * {@inheritDoc}
duke@1 62 */
duke@1 63 public ConstantsSummaryWriter getConstantsSummaryWriter() throws Exception {
duke@1 64 return new ConstantsSummaryWriterImpl(configuration);
duke@1 65 }
duke@1 66
duke@1 67 /**
duke@1 68 * {@inheritDoc}
duke@1 69 */
duke@1 70 public PackageSummaryWriter getPackageSummaryWriter(PackageDoc packageDoc,
duke@1 71 PackageDoc prevPkg, PackageDoc nextPkg) throws Exception {
duke@1 72 return new PackageWriterImpl(ConfigurationImpl.getInstance(), packageDoc,
duke@1 73 prevPkg, nextPkg);
duke@1 74 }
duke@1 75
duke@1 76 /**
duke@1 77 * {@inheritDoc}
duke@1 78 */
duke@1 79 public ClassWriter getClassWriter(ClassDoc classDoc, ClassDoc prevClass,
duke@1 80 ClassDoc nextClass, ClassTree classTree)
duke@1 81 throws Exception {
duke@1 82 return new ClassWriterImpl(classDoc, prevClass, nextClass, classTree);
duke@1 83 }
duke@1 84
duke@1 85 /**
duke@1 86 * {@inheritDoc}
duke@1 87 */
duke@1 88 public AnnotationTypeWriter getAnnotationTypeWriter(
duke@1 89 AnnotationTypeDoc annotationType, Type prevType, Type nextType)
duke@1 90 throws Exception {
duke@1 91 return new AnnotationTypeWriterImpl(annotationType, prevType, nextType);
duke@1 92 }
duke@1 93
duke@1 94 /**
duke@1 95 * {@inheritDoc}
duke@1 96 */
duke@1 97 public AnnotationTypeOptionalMemberWriter
duke@1 98 getAnnotationTypeOptionalMemberWriter(
duke@1 99 AnnotationTypeWriter annotationTypeWriter) throws Exception {
duke@1 100 return new AnnotationTypeOptionalMemberWriterImpl(
duke@1 101 (SubWriterHolderWriter) annotationTypeWriter,
duke@1 102 annotationTypeWriter.getAnnotationTypeDoc());
duke@1 103 }
duke@1 104
duke@1 105 /**
duke@1 106 * {@inheritDoc}
duke@1 107 */
duke@1 108 public AnnotationTypeRequiredMemberWriter
duke@1 109 getAnnotationTypeRequiredMemberWriter(AnnotationTypeWriter annotationTypeWriter) throws Exception {
duke@1 110 return new AnnotationTypeRequiredMemberWriterImpl(
duke@1 111 (SubWriterHolderWriter) annotationTypeWriter,
duke@1 112 annotationTypeWriter.getAnnotationTypeDoc());
duke@1 113 }
duke@1 114
duke@1 115 /**
duke@1 116 * {@inheritDoc}
duke@1 117 */
duke@1 118 public EnumConstantWriter getEnumConstantWriter(ClassWriter classWriter)
duke@1 119 throws Exception {
duke@1 120 return new EnumConstantWriterImpl((SubWriterHolderWriter) classWriter,
duke@1 121 classWriter.getClassDoc());
duke@1 122 }
duke@1 123
duke@1 124 /**
duke@1 125 * {@inheritDoc}
duke@1 126 */
duke@1 127 public FieldWriter getFieldWriter(ClassWriter classWriter)
duke@1 128 throws Exception {
duke@1 129 return new FieldWriterImpl((SubWriterHolderWriter) classWriter,
duke@1 130 classWriter.getClassDoc());
duke@1 131 }
duke@1 132
duke@1 133 /**
duke@1 134 * {@inheritDoc}
duke@1 135 */
duke@1 136 public MethodWriter getMethodWriter(ClassWriter classWriter)
duke@1 137 throws Exception {
duke@1 138 return new MethodWriterImpl((SubWriterHolderWriter) classWriter,
duke@1 139 classWriter.getClassDoc());
duke@1 140 }
duke@1 141
duke@1 142 /**
duke@1 143 * {@inheritDoc}
duke@1 144 */
duke@1 145 public ConstructorWriter getConstructorWriter(ClassWriter classWriter)
duke@1 146 throws Exception {
duke@1 147 return new ConstructorWriterImpl((SubWriterHolderWriter) classWriter,
duke@1 148 classWriter.getClassDoc());
duke@1 149 }
duke@1 150
duke@1 151 /**
duke@1 152 * {@inheritDoc}
duke@1 153 */
duke@1 154 public MemberSummaryWriter getMemberSummaryWriter(
duke@1 155 ClassWriter classWriter, int memberType)
duke@1 156 throws Exception {
duke@1 157 switch (memberType) {
duke@1 158 case VisibleMemberMap.CONSTRUCTORS:
duke@1 159 return (ConstructorWriterImpl) getConstructorWriter(classWriter);
duke@1 160 case VisibleMemberMap.ENUM_CONSTANTS:
duke@1 161 return (EnumConstantWriterImpl) getEnumConstantWriter(classWriter);
duke@1 162 case VisibleMemberMap.FIELDS:
duke@1 163 return (FieldWriterImpl) getFieldWriter(classWriter);
duke@1 164 case VisibleMemberMap.INNERCLASSES:
duke@1 165 return new NestedClassWriterImpl((SubWriterHolderWriter)
duke@1 166 classWriter, classWriter.getClassDoc());
duke@1 167 case VisibleMemberMap.METHODS:
duke@1 168 return (MethodWriterImpl) getMethodWriter(classWriter);
duke@1 169 default:
duke@1 170 return null;
duke@1 171 }
duke@1 172 }
duke@1 173
duke@1 174 /**
duke@1 175 * {@inheritDoc}
duke@1 176 */
duke@1 177 public MemberSummaryWriter getMemberSummaryWriter(
duke@1 178 AnnotationTypeWriter annotationTypeWriter, int memberType)
duke@1 179 throws Exception {
duke@1 180 switch (memberType) {
duke@1 181 case VisibleMemberMap.ANNOTATION_TYPE_MEMBER_OPTIONAL:
duke@1 182 return (AnnotationTypeOptionalMemberWriterImpl)
duke@1 183 getAnnotationTypeOptionalMemberWriter(annotationTypeWriter);
duke@1 184 case VisibleMemberMap.ANNOTATION_TYPE_MEMBER_REQUIRED:
duke@1 185 return (AnnotationTypeRequiredMemberWriterImpl)
duke@1 186 getAnnotationTypeRequiredMemberWriter(annotationTypeWriter);
duke@1 187 default:
duke@1 188 return null;
duke@1 189 }
duke@1 190 }
duke@1 191
duke@1 192 /**
duke@1 193 * {@inheritDoc}
duke@1 194 */
duke@1 195 public SerializedFormWriter getSerializedFormWriter() throws Exception {
duke@1 196 return new SerializedFormWriterImpl();
duke@1 197 }
duke@1 198 }

mercurial