org.jibx.schema.codegen

Class SchemaDocumentationGenerator

java.lang.Object

org.jibx.schema.codegen.SchemaDocumentationGenerator

public class SchemaDocumentationGenerator
extends Object

Visitor to write a filtered view of a schema definition matching the data structure of a class. This is used when schema fragments are included in class documentation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMENT_LEAD_TEXT Leading text for comment lines.

Constructor Summary

Constructors

Constructor and Description
SchemaDocumentationGenerator() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	generate(GroupItem group, boolean dropanno) Generate documentation from the schema component corresponding to a class.

Methods inherited from class java.lang.Object

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

Field Detail

COMMENT_LEAD_TEXT

public static final String COMMENT_LEAD_TEXT

Leading text for comment lines.

See Also:

Constant Field Values

Constructor Detail

SchemaDocumentationGenerator

public SchemaDocumentationGenerator()
                             throws JiBXException

Constructor.

Throws:

JiBXException - on error loading binding information

Method Detail

generate

public String generate(GroupItem group,
              boolean dropanno)

Generate documentation from the schema component corresponding to a class.

Parameters:

group - item group for class

dropanno - delete annotations from schema documentation flag

Returns:

schema extract documentation