程序包 springfox.documentation.spi.schema.contexts

类 ModelContext

java.lang.Object
springfox.documentation.spi.schema.contexts.ModelContext
public class ModelContext extends Object

  • 方法详细资料

    • getType

      public Type getType()
      返回:
      type behind this context

    • resolvedType

      public com.fasterxml.classmate.ResolvedType resolvedType(com.fasterxml.classmate.TypeResolver resolver)
      参数:
      resolver - - type resolved
      返回:
      resolved type

    • isReturnType

      public boolean isReturnType()
      返回:
      is the context for a return type

    • getAlternateTypeProvider

      public AlternateTypeProvider getAlternateTypeProvider()
      返回:
      alternate type provider that's available to this context

    • alternateFor

      public com.fasterxml.classmate.ResolvedType alternateFor(com.fasterxml.classmate.ResolvedType resolved)
      参数:
      resolved - - type to find an alternate type for
      返回:
      alternate type for given resolved type

    • getGroupName

      public String getGroupName()
      返回:
      group name of the docket

    • inputParam

      public static ModelContext inputParam(String group, Type type, DocumentationType documentationType, AlternateTypeProvider alternateTypeProvider, GenericTypeNamingStrategy genericNamingStrategy, com.google.common.collect.ImmutableSet<Class> ignorableTypes)
      Convenience method to provide an new context for an input parameter
      参数:
      group - - group name of the docket
      type - - type
      documentationType - - for documentation type
      alternateTypeProvider - - alternate type provider
      genericNamingStrategy - - how generic types should be named
      ignorableTypes - - types that can be ignored
      返回:
      new context

    • returnValue

      public static ModelContext returnValue(String groupName, Type type, DocumentationType documentationType, AlternateTypeProvider alternateTypeProvider, GenericTypeNamingStrategy genericNamingStrategy, com.google.common.collect.ImmutableSet<Class> ignorableTypes)
      Convenience method to provide an new context for an return parameter
      参数:
      groupName - - group name of the docket
      type - - type
      documentationType - - for documentation type
      alternateTypeProvider - - alternate type provider
      genericNamingStrategy - - how generic types should be named
      ignorableTypes - - types that can be ignored
      返回:
      new context

    • fromParent

      public static ModelContext fromParent(ModelContext context, com.fasterxml.classmate.ResolvedType input)
      Convenience method to provide an new context for an input parameter
      参数:
      context - - parent context
      input - - context for given input
      返回:
      new context based on parent context for a given input

    • hasSeenBefore

      public boolean hasSeenBefore(com.fasterxml.classmate.ResolvedType resolvedType)
      Answers the question, has the given type been processed?
      参数:
      resolvedType - - type to check
      返回:
      true or false

    • getDocumentationType

      public DocumentationType getDocumentationType()

    • getGenericNamingStrategy

      public GenericTypeNamingStrategy getGenericNamingStrategy()

    • getBuilder

      public ModelBuilder getBuilder()

    • seen

      public void seen(com.fasterxml.classmate.ResolvedType resolvedType)

    • equals

      public boolean equals(Object o)
      覆盖:
      equals 在类中 Object

    • hashCode

      public int hashCode()
      覆盖:
      hashCode 在类中 Object

    • description

      public String description()

    • canIgnore

      public boolean canIgnore(com.fasterxml.classmate.ResolvedType type)