Package org.jdrupes.mdoclet.internal.doclets.toolkit

Schnittstelle WriterFactory

Alle bekannten Implementierungsklassen:
WriterFactoryImpl
public interface WriterFactory
The interface for a factory creates writers.

  • Methodendetails

    • getConstantsSummaryWriter

      ConstantsSummaryWriter getConstantsSummaryWriter()
      Return the writer for the constant summary.
      Gibt zurück:
      the writer for the constant summary. Return null if this writer is not supported by the doclet.

    • getPackageSummaryWriter

      PackageSummaryWriter getPackageSummaryWriter(PackageElement packageElement)
      Return the writer for the package summary.
      Parameter:
      packageElement - the package being documented
      Gibt zurück:
      the writer for the package summary. Return null if this writer is not supported by the doclet.

    • getModuleSummaryWriter

      ModuleSummaryWriter getModuleSummaryWriter(ModuleElement mdle)
      Return the writer for the module summary.
      Parameter:
      mdle - the module being documented
      Gibt zurück:
      the writer for the module summary. Return null if this writer is not supported by the doclet.

    • getClassWriter

      ClassWriter getClassWriter(TypeElement typeElement, ClassTree classTree)
      Returns the writer for a given type element, or null if this writer is not supported by the doclet.
      Parameter:
      typeElement - the class being documented
      classTree - the class tree
      Gibt zurück:
      the writer

    • getMethodWriter

      MethodWriter getMethodWriter(ClassWriter classWriter)
      Return the method writer for a given type element, or null if this writer is not supported by the doclet.
      Parameter:
      classWriter - the writer for the class being documented
      Gibt zurück:
      the method writer

    • getAnnotationTypeMemberWriter

      AnnotationTypeMemberWriter getAnnotationTypeMemberWriter(ClassWriter classWriter)
      Return the annotation type member writer for a given annotation type, or null if this writer is not supported by the doclet.
      Parameter:
      classWriter - the writer for the annotation type being documented
      Gibt zurück:
      the member writer

    • getAnnotationTypeOptionalMemberWriter

      AnnotationTypeMemberWriter getAnnotationTypeOptionalMemberWriter(ClassWriter classWriter)
      Return the annotation type optional member writer for a given annotation type, or null if this writer is not supported by the doclet.
      Parameter:
      classWriter - the writer for the annotation type being documented
      Gibt zurück:
      the member writer

    • getAnnotationTypeRequiredMemberWriter

      AnnotationTypeMemberWriter getAnnotationTypeRequiredMemberWriter(ClassWriter classWriter)
      Return the annotation type required member writer for a given annotation type, or null if this writer is not supported by the doclet.
      Parameter:
      classWriter - the writer for the annotation type being documented
      Gibt zurück:
      the member writer

    • getEnumConstantWriter

      EnumConstantWriter getEnumConstantWriter(ClassWriter classWriter)
      Return the enum constant writer for a given type element, or null if this writer is not supported by the doclet.
      Parameter:
      classWriter - the writer for the type element being documented
      Gibt zurück:
      the enum constant writer

    • getFieldWriter

      FieldWriter getFieldWriter(ClassWriter classWriter)
      Return the field writer for a given type element, or null if this writer is not supported by the doclet.
      Parameter:
      classWriter - the writer for the class being documented
      Gibt zurück:
      the field writer for the given class. Return null if this writer is not supported by the doclet.

    • getPropertyWriter

      PropertyWriter getPropertyWriter(ClassWriter classWriter)
      Return the property writer for a given class, or null if this writer is not supported by the doclet.
      Parameter:
      classWriter - the writer for the type element being documented
      Gibt zurück:
      the property writer

    • getConstructorWriter

      ConstructorWriter getConstructorWriter(ClassWriter classWriter)
      Return the constructor writer for a given type element, or null if this writer is not supported by the doclet.
      Parameter:
      classWriter - the writer for the type element being documented
      Gibt zurück:
      the constructor writer

    • getMemberSummaryWriter

      MemberSummaryWriter getMemberSummaryWriter(ClassWriter classWriter, VisibleMemberTable.Kind memberType)
      Return the specified member summary writer for a given type element, or null if this writer is not supported by the doclet.
      Parameter:
      classWriter - the writer for the class being documented
      memberType - the VisibleMemberTable member type indicating the type of member summary that should be returned
      Gibt zurück:
      the summary writer
      Siehe auch:

    • getSerializedFormWriter

      SerializedFormWriter getSerializedFormWriter()
      Return the writer for the serialized form.
      Gibt zurück:
      the writer for the serialized form

    • getDocFilesHandler

      DocFilesHandler getDocFilesHandler(Element pkg)
      Return the handler for doc files.
      Gibt zurück:
      the handler for the doc files