Package org.jdrupes.mdoclet.internal.doclets.formats.html

Klasse WriterFactoryImpl

java.lang.Object

org.jdrupes.mdoclet.internal.doclets.formats.html.WriterFactoryImpl

Alle implementierten Schnittstellen:

WriterFactory

public class WriterFactoryImpl
extends Object
implements WriterFactory

The factory that returns HTML writers.

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
WriterFactoryImpl(HtmlConfiguration configuration)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
AnnotationTypeMemberWriterImpl	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.
AnnotationTypeMemberWriterImpl	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.
AnnotationTypeMemberWriterImpl	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.
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.
ConstantsSummaryWriter	getConstantsSummaryWriter()	Return the writer for the constant summary.
ConstructorWriterImpl	getConstructorWriter(ClassWriter classWriter)	Return the constructor writer for a given type element, or null if this writer is not supported by the doclet.
DocFilesHandler	getDocFilesHandler(Element element)	Return the handler for doc files.
EnumConstantWriterImpl	getEnumConstantWriter(ClassWriter classWriter)	Return the enum constant writer for a given type element, or null if this writer is not supported by the doclet.
FieldWriterImpl	getFieldWriter(ClassWriter classWriter)	Return the field writer for a given type element, or null if this writer is not supported by the doclet.
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.
MethodWriterImpl	getMethodWriter(ClassWriter classWriter)	Return the method writer for a given type element, or null if this writer is not supported by the doclet.
ModuleSummaryWriter	getModuleSummaryWriter(ModuleElement mdle)	Return the writer for the module summary.
PackageSummaryWriter	getPackageSummaryWriter(PackageElement packageElement)	Return the writer for the package summary.
PropertyWriterImpl	getPropertyWriter(ClassWriter classWriter)	Return the property writer for a given class, or null if this writer is not supported by the doclet.
SerializedFormWriter	getSerializedFormWriter()	Return the writer for the serialized form.

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Konstruktordetails

WriterFactoryImpl

public WriterFactoryImpl(HtmlConfiguration configuration)

Methodendetails

getConstantsSummaryWriter

public ConstantsSummaryWriter getConstantsSummaryWriter()

Beschreibung aus Schnittstelle kopiert: WriterFactory

Return the writer for the constant summary.

Angegeben von:

getConstantsSummaryWriter in Schnittstelle WriterFactory

Gibt zurück:

the writer for the constant summary. Return null if this writer is not supported by the doclet.

getPackageSummaryWriter

public PackageSummaryWriter getPackageSummaryWriter(PackageElement packageElement)

Beschreibung aus Schnittstelle kopiert: WriterFactory

Return the writer for the package summary.

Angegeben von:

getPackageSummaryWriter in Schnittstelle WriterFactory

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

public ModuleSummaryWriter getModuleSummaryWriter(ModuleElement mdle)

Beschreibung aus Schnittstelle kopiert: WriterFactory

Return the writer for the module summary.

Angegeben von:

getModuleSummaryWriter in Schnittstelle WriterFactory

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

public ClassWriter getClassWriter(TypeElement typeElement,
 ClassTree classTree)

Beschreibung aus Schnittstelle kopiert: WriterFactory

Returns the writer for a given type element, or null if this writer is not supported by the doclet.

Angegeben von:

getClassWriter in Schnittstelle WriterFactory

Parameter:

typeElement - the class being documented

classTree - the class tree

Gibt zurück:

the writer

getAnnotationTypeMemberWriter

public AnnotationTypeMemberWriterImpl getAnnotationTypeMemberWriter(ClassWriter classWriter)

Beschreibung aus Schnittstelle kopiert: WriterFactory

Return the annotation type member writer for a given annotation type, or null if this writer is not supported by the doclet.

Angegeben von:

getAnnotationTypeMemberWriter in Schnittstelle WriterFactory

Parameter:

classWriter - the writer for the annotation type being documented

Gibt zurück:

the member writer

getAnnotationTypeOptionalMemberWriter

public AnnotationTypeMemberWriterImpl getAnnotationTypeOptionalMemberWriter(ClassWriter classWriter)

Beschreibung aus Schnittstelle kopiert: WriterFactory

Return the annotation type optional member writer for a given annotation type, or null if this writer is not supported by the doclet.

Angegeben von:

getAnnotationTypeOptionalMemberWriter in Schnittstelle WriterFactory

Parameter:

classWriter - the writer for the annotation type being documented

Gibt zurück:

the member writer

getAnnotationTypeRequiredMemberWriter

public AnnotationTypeMemberWriterImpl getAnnotationTypeRequiredMemberWriter(ClassWriter classWriter)

Beschreibung aus Schnittstelle kopiert: WriterFactory

Return the annotation type required member writer for a given annotation type, or null if this writer is not supported by the doclet.

Angegeben von:

getAnnotationTypeRequiredMemberWriter in Schnittstelle WriterFactory

Parameter:

classWriter - the writer for the annotation type being documented

Gibt zurück:

the member writer

getEnumConstantWriter

public EnumConstantWriterImpl getEnumConstantWriter(ClassWriter classWriter)

Beschreibung aus Schnittstelle kopiert: WriterFactory

Return the enum constant writer for a given type element, or null if this writer is not supported by the doclet.

Angegeben von:

getEnumConstantWriter in Schnittstelle WriterFactory

Parameter:

classWriter - the writer for the type element being documented

Gibt zurück:

the enum constant writer

getFieldWriter

public FieldWriterImpl getFieldWriter(ClassWriter classWriter)

Beschreibung aus Schnittstelle kopiert: WriterFactory

Return the field writer for a given type element, or null if this writer is not supported by the doclet.

Angegeben von:

getFieldWriter in Schnittstelle WriterFactory

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

public PropertyWriterImpl getPropertyWriter(ClassWriter classWriter)

Beschreibung aus Schnittstelle kopiert: WriterFactory

Return the property writer for a given class, or null if this writer is not supported by the doclet.

Angegeben von:

getPropertyWriter in Schnittstelle WriterFactory

Parameter:

classWriter - the writer for the type element being documented

Gibt zurück:

the property writer

getMethodWriter

public MethodWriterImpl getMethodWriter(ClassWriter classWriter)

Beschreibung aus Schnittstelle kopiert: WriterFactory

Return the method writer for a given type element, or null if this writer is not supported by the doclet.

Angegeben von:

getMethodWriter in Schnittstelle WriterFactory

Parameter:

classWriter - the writer for the class being documented

Gibt zurück:

the method writer

getConstructorWriter

public ConstructorWriterImpl getConstructorWriter(ClassWriter classWriter)

Beschreibung aus Schnittstelle kopiert: WriterFactory

Return the constructor writer for a given type element, or null if this writer is not supported by the doclet.

Angegeben von:

getConstructorWriter in Schnittstelle WriterFactory

Parameter:

classWriter - the writer for the type element being documented

Gibt zurück:

the constructor writer

getMemberSummaryWriter

public MemberSummaryWriter getMemberSummaryWriter(ClassWriter classWriter,
 VisibleMemberTable.Kind memberType)

Beschreibung aus Schnittstelle kopiert: WriterFactory

Return the specified member summary writer for a given type element, or null if this writer is not supported by the doclet.

Angegeben von:

getMemberSummaryWriter in Schnittstelle WriterFactory

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:

• VisibleMemberTable

getSerializedFormWriter

public SerializedFormWriter getSerializedFormWriter()

Beschreibung aus Schnittstelle kopiert: WriterFactory

Return the writer for the serialized form.

Angegeben von:

getSerializedFormWriter in Schnittstelle WriterFactory

Gibt zurück:

the writer for the serialized form

getDocFilesHandler

public DocFilesHandler getDocFilesHandler(Element element)

Beschreibung aus Schnittstelle kopiert: WriterFactory

Return the handler for doc files.

Angegeben von:

getDocFilesHandler in Schnittstelle WriterFactory

Gibt zurück:

the handler for the doc files