Interface ModelWriter

  • All Known Implementing Classes:
    DefaultModelWriter

    public interface ModelWriter
    Interface for a custom ModelWriter. QDox doesn't keep any formatting information of the original source file (if it's there). With a ModelWriter you can specify the way elements look if you write them to any output.
    Since:
    2.0
    • Method Detail

      • writeSource

        ModelWriter writeSource​(JavaSource src)
        Write the complete source file A standard source writer should write:
        • the package
        • the imports
        • the classes
        Parameters:
        src - the source
        Returns:
        itself
      • writePackage

        ModelWriter writePackage​(JavaPackage pkg)
        Write the java package A standard package writer should write:
        • the javadoc
        • the annotations
        • the package signature
        Parameters:
        pkg - the package
        Returns:
        itself
      • writeClass

        ModelWriter writeClass​(JavaClass cls)
        Write the java class A standard class writer should write:
        • the javadoc
        • the annotations
        • the class signature, containing:
          • the fields
          • the constructors
          • the methods
        Parameters:
        cls - the class
        Returns:
        itself
      • writeField

        ModelWriter writeField​(JavaField fld)
        Write the java field A standard field writer should write:
        • the javadoc
        • the annotations
        • the field signature
        Parameters:
        fld - the field
        Returns:
        itself
      • writeAnnotation

        ModelWriter writeAnnotation​(JavaAnnotation ann)
        Write the java annotation A standard annotation writer should write:
        • the annotation signature
        Parameters:
        ann - the annotation
        Returns:
        itself
      • writeMethod

        ModelWriter writeMethod​(JavaMethod mth)
        Write the java method A standard method writer should write:
        • the javadoc
        • the annotations
        • the method signature, containing:
          • the parameters
        Parameters:
        mth - the method
        Returns:
        itself
      • writeParameter

        ModelWriter writeParameter​(JavaParameter prm)
        Write the java parameter A standard parameter writer should write:
        • the javadoc
        • the annotations
        • the parameter signature
        Parameters:
        prm - the parameter
        Returns:
        itself
      • writeConstructor

        ModelWriter writeConstructor​(JavaConstructor cns)
        Write the java constructor. A standard constructor writer should write:
        • the javadoc
        • the annotations
        • the constructor signature, containing:
          • the parameters
        Parameters:
        cns - the constructor
        Returns:
        itself
      • writeInitializer

        ModelWriter writeInitializer​(JavaInitializer init)
        Write the initializer.
        Parameters:
        init - the initializer
        Returns:
        itself
      • writeModuleDescriptor

        ModelWriter writeModuleDescriptor​(JavaModuleDescriptor descriptor)
        Write the module descriptor A standard module descriptor writer should write:
        • the javadoc
        • the annotations
        • the module signature, containing:
          • the requires statements
          • the exports statements
          • the opens statements
          • the uses statements
          • the provides statements
        Parameters:
        descriptor - the module declaration
        Returns:
        itself