com.github.kongchen.swagger.docgen.mavenplugin

类 MavenDocumentSource

java.lang.Object

com.github.kongchen.swagger.docgen.AbstractDocumentSource

com.github.kongchen.swagger.docgen.mavenplugin.MavenDocumentSource

public class MavenDocumentSource
extends AbstractDocumentSource

作者:

chekong 05/13/2013

字段概要

从类继承的字段 com.github.kongchen.swagger.docgen.AbstractDocumentSource

apiSource, encoding, LOG, swagger, swaggerSchemaConverter, typesToSkip

构造器概要

构造器

构造器和说明
MavenDocumentSource(ApiSource apiSource, org.apache.maven.plugin.logging.Log log, java.lang.String encoding)

方法概要

限定符和类型	方法和说明
protected java.util.Set<java.lang.Class<?>>	getValidClasses() Returns the set of classes which should be included in the scanning.
protected ClassSwaggerReader	resolveApiReader() Resolves the API reader which should be used to scan the classes.

从类继承的方法 com.github.kongchen.swagger.docgen.AbstractDocumentSource

createFile, getCustomApiReader, loadDocuments, loadModelConverters, loadModelModifier, loadTypesToSkip, removeBasePathFromEndpoints, resolveSwaggerExtensions, toDocuments, toSwaggerDocuments, toSwaggerDocuments

从类继承的方法 java.lang.Object

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

构造器详细资料

MavenDocumentSource

public MavenDocumentSource(ApiSource apiSource,
                           org.apache.maven.plugin.logging.Log log,
                           java.lang.String encoding)
                    throws org.apache.maven.plugin.MojoFailureException

抛出:

org.apache.maven.plugin.MojoFailureException

方法详细资料

getValidClasses

protected java.util.Set<java.lang.Class<?>> getValidClasses()

从类复制的说明: AbstractDocumentSource

Returns the set of classes which should be included in the scanning.

覆盖:

getValidClasses 在类中 AbstractDocumentSource

返回:

Set containing all valid classes

resolveApiReader

protected ClassSwaggerReader resolveApiReader()
                                       throws GenerateException

从类复制的说明: AbstractDocumentSource

Resolves the API reader which should be used to scan the classes.

指定者:

resolveApiReader 在类中 AbstractDocumentSource

返回:

ClassSwaggerReader to use

抛出:

GenerateException - if the reader cannot be created / resolved