Class WriterFactoryImpl

  • All Implemented Interfaces:
    WriterFactory

    @Deprecated
    public class WriterFactoryImpl
    extends Object
    implements WriterFactory
    Deprecated.
    The factory that returns HTML writers.

    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.

    Since:
    1.5
    Author:
    Jamie Ho
    • Constructor Detail

      • WriterFactoryImpl

        public WriterFactoryImpl​(ConfigurationImpl configuration)
        Deprecated.
    • Method Detail

      • getPackageSummaryWriter

        public PackageSummaryWriter getPackageSummaryWriter​(PackageDoc packageDoc,
                                                            PackageDoc prevPkg,
                                                            PackageDoc nextPkg)
                                                     throws Exception
        Deprecated.
        Return the writer for the package summary.
        Specified by:
        getPackageSummaryWriter in interface WriterFactory
        Parameters:
        packageDoc - the package being documented.
        prevPkg - the previous package that was documented.
        nextPkg - the next package being documented.
        Returns:
        the writer for the package summary. Return null if this writer is not supported by the doclet.
        Throws:
        Exception
      • getClassWriter

        public ClassWriter getClassWriter​(ClassDoc classDoc,
                                          ClassDoc prevClass,
                                          ClassDoc nextClass,
                                          ClassTree classTree)
                                   throws IOException
        Deprecated.
        Return the writer for a class.
        Specified by:
        getClassWriter in interface WriterFactory
        Parameters:
        classDoc - the class being documented.
        prevClass - the previous class that was documented.
        nextClass - the next class being documented.
        classTree - the class tree.
        Returns:
        the writer for the class. Return null if this writer is not supported by the doclet.
        Throws:
        IOException
      • getAnnotationTypeWriter

        public AnnotationTypeWriter getAnnotationTypeWriter​(AnnotationTypeDoc annotationType,
                                                            Type prevType,
                                                            Type nextType)
                                                     throws Exception
        Deprecated.
        Return the writer for an annotation type.
        Specified by:
        getAnnotationTypeWriter in interface WriterFactory
        Parameters:
        annotationType - the type being documented.
        prevType - the previous type that was documented.
        nextType - the next type being documented.
        Returns:
        the writer for the annotation type. Return null if this writer is not supported by the doclet.
        Throws:
        Exception
      • getAnnotationTypeFieldWriter

        public AnnotationTypeFieldWriter getAnnotationTypeFieldWriter​(AnnotationTypeWriter annotationTypeWriter)
                                                               throws Exception
        Deprecated.
        Return the annotation type field writer for a given annotation type.
        Specified by:
        getAnnotationTypeFieldWriter in interface WriterFactory
        Parameters:
        annotationTypeWriter - the writer for the annotation type being documented.
        Returns:
        the member writer for the given annotation type. Return null if this writer is not supported by the doclet.
        Throws:
        Exception
      • getEnumConstantWriter

        public EnumConstantWriterImpl getEnumConstantWriter​(ClassWriter classWriter)
                                                     throws Exception
        Deprecated.
        Return the enum constant writer for a given class.
        Specified by:
        getEnumConstantWriter in interface WriterFactory
        Parameters:
        classWriter - the writer for the class being documented.
        Returns:
        the enum constant writer for the give class. Return null if this writer is not supported by the doclet.
        Throws:
        Exception
      • getFieldWriter

        public FieldWriterImpl getFieldWriter​(ClassWriter classWriter)
                                       throws Exception
        Deprecated.
        Return the field writer for a given class.
        Specified by:
        getFieldWriter in interface WriterFactory
        Parameters:
        classWriter - the writer for the class being documented.
        Returns:
        the field writer for the give class. Return null if this writer is not supported by the doclet.
        Throws:
        Exception
      • getPropertyWriter

        public PropertyWriterImpl getPropertyWriter​(ClassWriter classWriter)
                                             throws Exception
        Deprecated.
        Return the property writer for a given class.
        Specified by:
        getPropertyWriter in interface WriterFactory
        Parameters:
        classWriter - the writer for the class being documented.
        Returns:
        the property writer for the give class. Return null if this writer is not supported by the doclet.
        Throws:
        Exception
      • getMethodWriter

        public MethodWriterImpl getMethodWriter​(ClassWriter classWriter)
                                         throws Exception
        Deprecated.
        Return the method writer for a given class.
        Specified by:
        getMethodWriter in interface WriterFactory
        Parameters:
        classWriter - the writer for the class being documented.
        Returns:
        the method writer for the give class. Return null if this writer is not supported by the doclet.
        Throws:
        Exception
      • getConstructorWriter

        public ConstructorWriterImpl getConstructorWriter​(ClassWriter classWriter)
                                                   throws Exception
        Deprecated.
        Return the constructor writer for a given class.
        Specified by:
        getConstructorWriter in interface WriterFactory
        Parameters:
        classWriter - the writer for the class being documented.
        Returns:
        the method writer for the give class. Return null if this writer is not supported by the doclet.
        Throws:
        Exception