ParserHelper (swagger-doclet 1.0.5 API)

java.lang.Object
- com.carma.swagger.doclet.parser.ParserHelper

```
public class ParserHelper
extends Object
```
The ParserHelper represents a helper class for the parsers

Version:

$Id$

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ParserHelper.NumericTypeFilter

static interface ParserHelper.TypeFilter

Nested Classes
Modifier and Type	Class and Description
`static class`	`ParserHelper.NumericTypeFilter`
`static interface`	`ParserHelper.TypeFilter`

Field Summary

Fields
Modifier and Type Field and Description

static Set<String> JAXRS_PARAM_ANNOTATIONS
This is a set of the FQN of the various JAXRS parameter annotations

Fields
Modifier and Type	Field and Description
`static Set<String>`	`JAXRS_PARAM_ANNOTATIONS` This is a set of the FQN of the various JAXRS parameter annotations

Constructor Summary

Constructors
Constructor and Description

ParserHelper()

Constructors
Constructor and Description
`ParserHelper()`

Method Summary

Methods
Modifier and Type	Method and Description
`static Integer`	`compareNumericValues(String context, String type, String format, String value1, String value2)` This verifies that the given numeric values are valid for the given data type and format and returns the comparison.
`static String`	`fieldParamNameOf(com.sun.javadoc.FieldDoc field, Map<String,String> overrideParamNames, List<String> paramNameAnnotations, DocletOptions options)` Determines the string representation of the parameter name.
`static com.sun.javadoc.ClassDoc`	`findModel(Collection<com.sun.javadoc.ClassDoc> classes, String qualifiedClassName)` This finds a model class by the given name
`static String`	`generateResourceFilename(String resourcePath)` This generates a file name to use for a resource with the given resource path.
`static List<String>`	`getAllowableValues(com.sun.javadoc.ClassDoc typeClassDoc)` This gets the allowable values from an enum class doc or null if the classdoc does not represent an enum
`static String`	`getAnnotationOrTagValue(com.sun.javadoc.ProgramElementDoc item, Collection<String> annotations, Collection<String> matchTags, DocletOptions options, String... valueKeys)` This gets the first value on the given item (field or method) that matches either an annotation or a javadoc tag.
`static List<String>`	`getConsumes(com.sun.javadoc.MethodDoc methodDoc, DocletOptions options)` This gets the list of consumes mime types from the given method
`static com.sun.javadoc.Type`	`getContainerType(com.sun.javadoc.Type type, Map<String,com.sun.javadoc.Type> varsToTypes, Collection<com.sun.javadoc.ClassDoc> classes)` This gets the type that a container holds
`static List<String>`	`getCsvParams(com.sun.javadoc.ExecutableMemberDoc method, Set<String> params, Collection<String> matchTags, DocletOptions options)` This gets a list of parameter names from a method javadoc tag where the value of the tag is in the form paramName1,paramName2 ...
`static String`	`getDefaultValue(com.sun.javadoc.Parameter param, DocletOptions options)` This gets the default value of the given parameter
`static String`	`getInheritableClassLevelAnnotationValue(com.sun.javadoc.ClassDoc classDoc, DocletOptions options, String qualifiedAnnotationType, String... keys)` This gets an annotation value from the given class, it supports looking at super classes
`static String`	`getInheritableCommentText(com.sun.javadoc.ExecutableMemberDoc methodDoc)` This gets the first sentence tags of a method or its overridden ancestor method
`static String`	`getInheritableFirstSentenceTags(com.sun.javadoc.ExecutableMemberDoc methodDoc)` This gets the first sentence tags of a method or its overridden ancestor method
`static com.sun.javadoc.ClassDoc[]`	`getInheritableJsonViews(com.sun.javadoc.MethodDoc methodDoc, DocletOptions options)` This gets the json views for the given method, it supports deriving the views from an overridden method
`static String`	`getInheritableTagValue(com.sun.javadoc.ExecutableMemberDoc methodDoc, Collection<String> matchTags, DocletOptions options)` This gets the value of the first tag found from the given MethodDoc respecting the overriden methods
`static List<String>`	`getInheritableTagValues(com.sun.javadoc.ExecutableMemberDoc methodDoc, Collection<String> matchTags, DocletOptions options)` This gets values of any of the javadoc tags that are in the given collection from the method or overridden methods
`static com.sun.javadoc.ClassDoc[]`	`getJsonViews(com.sun.javadoc.ProgramElementDoc doc, DocletOptions options)` This gets the json views for the given method/field
`static Set<String>`	`getMatchingParams(com.sun.javadoc.ExecutableMemberDoc method, Set<String> params, Collection<String> javadocTags, Collection<String> annotations, DocletOptions options)` This gets params of the given method that have either any of the matching javadoc tags or annotations
`static Map<String,List<String>>`	`getMethodParamNameValueLists(com.sun.javadoc.ExecutableMemberDoc method, Set<String> params, Collection<String> matchTags, DocletOptions options)` This gets a map of parameter name to list of values from a javadoc tag on a method.
`static Map<String,String>`	`getMethodParamNameValuePairs(com.sun.javadoc.ExecutableMemberDoc method, Set<String> params, Collection<String> matchTags, DocletOptions options)` This gets a map of parameter name to value from a javadoc tag on a method.
`static List<com.sun.javadoc.Type>`	`getParameterizedTypes(com.sun.javadoc.Type type, Map<String,com.sun.javadoc.Type> varsToTypes)` This gets parameterized types of the given type substituting variable types if necessary
`static Map<String,String>`	`getParameterValues(com.sun.javadoc.ExecutableMemberDoc method, Set<String> params, Collection<String> matchTags, Collection<String> annotations, ParserHelper.TypeFilter annotationTypes, DocletOptions options, String... valueKeys)` This gets the values of parameters from either javadoc tags or annotations
`static Map<String,String>`	`getParameterValuesWithAnnotation(com.sun.javadoc.ExecutableMemberDoc methodDoc, Collection<String> annotations, ParserHelper.TypeFilter annotationTypes, DocletOptions options, String... valueKeys)` This gets the values of annotations of parameters that have any of the given annotations on them
`static com.sun.javadoc.Parameter`	`getParameterWithAnnotations(com.sun.javadoc.ExecutableMemberDoc methodDoc, int paramIndex)` This gets the first met parameter with annotations from the method overriding hierarchy
`static Set<String>`	`getParamNames(com.sun.javadoc.ExecutableMemberDoc method)` This gets the parameter names for the given method
`static List<String>`	`getProduces(com.sun.javadoc.MethodDoc methodDoc, DocletOptions options)` This gets the list of produces mime types from the given method
`static String`	`getQualifiedTypeName(com.sun.javadoc.Type type)` This gets the qualified type name of a javadoc type, It adds [] onto any array types
`static List<String>`	`getTagCsvValues(com.sun.javadoc.ExecutableMemberDoc item, Collection<String> matchTags, DocletOptions options)` This gets a csv javadoc tag value as a list of the values in the csv for the first matched tag.
`static String`	`getTagValue(com.sun.javadoc.ProgramElementDoc item, Collection<String> matchTags, DocletOptions options)` This gets the value of the first tag found from the given collection of tag names
`static List<String>`	`getTagValues(com.sun.javadoc.ProgramElementDoc item, Collection<String> matchTags, DocletOptions options)` This gets values of any of the javadoc tags that are in the given collection
`static com.sun.javadoc.Type`	`getVarType(com.sun.javadoc.TypeVariable var, Map<String,com.sun.javadoc.Type> varsToTypes)` This finds a variable type and returns its impl from the given map
`static boolean`	`hasAncestor(com.sun.javadoc.ClassDoc classDoc)` This gets whether a class doc has an ancestor class that can be processed, e.g.
`static boolean`	`hasAnnotation(com.sun.javadoc.Parameter item, Collection<String> annotations, DocletOptions options)` This gets whether the given parameter has one of the given annotations
`static boolean`	`hasAnnotation(com.sun.javadoc.ProgramElementDoc item, Collection<String> annotations, DocletOptions options)` This gets whether the given item has one of the given annotations
`static boolean`	`hasAnnotationWithPrefix(com.sun.javadoc.Parameter item, Collection<String> prefixes, DocletOptions options)` This gets whether the given parameter has an annotation whose FQN begins with one of the given prefixes
`static boolean`	`hasInheritableAnnotation(com.sun.javadoc.MethodDoc methodDoc, Collection<String> annotations, DocletOptions options)` This gets whether the given method or an overridden method has any of the given annotations
`static boolean`	`hasInheritableTag(com.sun.javadoc.ExecutableMemberDoc methodDoc, Collection<String> matchTags)` This gets whether the given method or an overridden method has any of the given tags
`static boolean`	`hasJaxRsAnnotation(com.sun.javadoc.Parameter item, DocletOptions options)` This gets whether the given parameter has a JAXRS annotation
`static boolean`	`hasJsonViews(com.sun.javadoc.ProgramElementDoc doc, DocletOptions options)` This gets whether the given method/field has a json view on it
`static boolean`	`hasTag(com.sun.javadoc.ProgramElementDoc item, Collection<String> matchTags)` This gets whether the given item has any of the given tags
`static boolean`	`isArray(String javaType)` This gets whether the given type is an Array
`static boolean`	`isArray(com.sun.javadoc.Type type)` This gets whether the given type is an Array
`static boolean`	`isAssignableFrom(com.sun.javadoc.ClassDoc[] superClasses, com.sun.javadoc.ClassDoc clazz)` This checks if the given clazz is the same as or implments or is a subclass/sub interface of any of the given classes
`static boolean`	`isCollection(String javaType)` This gets whether the given type is a Collection
`static boolean`	`isDeprecated(com.sun.javadoc.Parameter parameter, DocletOptions options)` This gets whether the given parameter is marked as deprecated either via a javadoc tag or an annotation
`static boolean`	`isDeprecated(com.sun.javadoc.ProgramElementDoc item, DocletOptions options)` This gets whether the given item is marked as deprecated either via a javadoc tag or an annotation
`static boolean`	`isFileParameterDataType(com.sun.javadoc.Parameter parameter, DocletOptions options)` This gets whether the given parameter is a File data type
`static boolean`	`isInheritableDeprecated(com.sun.javadoc.MethodDoc item, DocletOptions options)` This gets whether the given item is marked as deprecated either via a javadoc tag or an annotation, this supports looking at overridden methods
`static boolean`	`isItemPartOfView(com.sun.javadoc.ClassDoc[] operationViews, com.sun.javadoc.ClassDoc[] itemsViews)` This checks if an item view e.g optional json view that can be on a getter/field match any of the given operation views, that is it can be the same or extend/implement one of the operation views.
`static boolean`	`isMap(String javaType)` This gets whether the given type is a Map
`static boolean`	`isNumber(com.sun.javadoc.Type type, DocletOptions options)` This gets whether the given type is primitive
`static boolean`	`isPrimitive(String type, DocletOptions options)` This gets whether the given type is primitive
`static boolean`	`isPrimitive(com.sun.javadoc.Type type, DocletOptions options)` This gets whether the given type is primitive
`static boolean`	`isSet(String javaType)` This gets whether the given type is a Set
`static List<String>`	`listInheritableValues(com.sun.javadoc.ExecutableMemberDoc methodDoc, String qualifiedAnnotationType, String annotationValueName, DocletOptions options)` This gets a list of values from an annotation that uses a string array value, it supports getting it from a superclass method
`static List<String>`	`listValues(com.sun.javadoc.ProgramElementDoc doc, String qualifiedAnnotationType, String annotationValueName, DocletOptions options)` This gets a list of values from an annotation that uses a string array value
`static com.sun.javadoc.ClassDoc`	`lookUpClassDoc(com.sun.javadoc.Type type, Collection<com.sun.javadoc.ClassDoc> classes)` This looks up a class doc with the given type from the given collection of classes
`static String`	`paramNameOf(com.sun.javadoc.Parameter parameter, Map<String,String> overrideParamNames, List<String> paramNameAnnotations, DocletOptions options)` Determines the string representation of the parameter name.
`static String`	`paramTypeOf(boolean returnDefault, boolean multipart, com.sun.javadoc.ProgramElementDoc paramMember, com.sun.javadoc.Type type, DocletOptions options)` Determines the string representation of the parameter type for composite types.
`static String`	`paramTypeOf(boolean multipart, com.sun.javadoc.Parameter parameter, DocletOptions options)` Determines the string representation of the parameter type.
`static String`	`parsePath(com.sun.javadoc.ProgramElementDoc doc, DocletOptions options)` This parses the path from the annotations of a method or class
`static Map<String,com.sun.javadoc.Type>`	`readSeeTypes(com.sun.javadoc.ProgramElementDoc item)` This builds a map of FQN to type for all see annotations on the given items javadoc
`static HttpMethod`	`resolveMethodHttpMethod(com.sun.javadoc.MethodDoc methodDoc)` Resolves HttpMethod for the MethodDoc respecting the overriden methods
`static String`	`resolveMethodPath(com.sun.javadoc.MethodDoc methodDoc, DocletOptions options)` Resolves tha @Path for the MethodDoc respecting the overriden methods
`static String`	`sanitizePath(String apiPath)` This sanitizes an API path.
`static String`	`trimLeadingChars(String str, char... trimChars)` This trims specific characters from the start of the given string
`static String[]`	`typeOf(String javaType, DocletOptions options)` Determines the String representation of the given FQN.
`static String[]`	`typeOf(com.sun.javadoc.Type type, DocletOptions options)` Determines the String representation of the object Type.
`static Number`	`verifyNumericValue(String context, String type, String format, String value)` This verifies that the given value is valid for the given data type and format for use as a numeric value which means it must be integer or number type.
`static void`	`verifyValue(String context, String type, String format, String value)` This verifies that the given value is valid for the given data type and format.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - JAXRS_PARAM_ANNOTATIONS
```
public static final Set<String> JAXRS_PARAM_ANNOTATIONS
```
    This is a set of the FQN of the various JAXRS parameter annotations
- Constructor Detail
  - ParserHelper
```
public ParserHelper()
```
- Method Detail
  - lookUpClassDoc
```
public static com.sun.javadoc.ClassDoc lookUpClassDoc(com.sun.javadoc.Type type,
                                      Collection<com.sun.javadoc.ClassDoc> classes)
```
    This looks up a class doc with the given type from the given collection of classes
    
    Parameters:
    type - The type to find the class doc for
    classes - The collection of classes to look in
    
    Returns:
    The class doc or null if none was found
  - getAllowableValues
```
public static List<String> getAllowableValues(com.sun.javadoc.ClassDoc typeClassDoc)
```
    This gets the allowable values from an enum class doc or null if the classdoc does not represent an enum
    
    Parameters:
    typeClassDoc - the class doc of the enum class to get the allowable values of
    
    Returns:
    The list of allowable values or null if this is not an enum
  - hasAncestor
```
public static boolean hasAncestor(com.sun.javadoc.ClassDoc classDoc)
```
    This gets whether a class doc has an ancestor class that can be processed, e.g. if its parent is java.lang.Object it returns false.
    
    Parameters:
    classDoc - The class doc
    
    Returns:
    True if the class doc class has a parent class that is not java.lang.Object.
  - getInheritableClassLevelAnnotationValue
```
public static String getInheritableClassLevelAnnotationValue(com.sun.javadoc.ClassDoc classDoc,
                                             DocletOptions options,
                                             String qualifiedAnnotationType,
                                             String... keys)
```
    This gets an annotation value from the given class, it supports looking at super classes
    
    Parameters:
    classDoc - The class to look for the annotation
    options - The doclet options
    qualifiedAnnotationType - The FQN of the annotation to look for
    keys - The keys for the annotation values
    
    Returns:
    The value of the annotation or null if none was found
  - getDefaultValue
```
public static String getDefaultValue(com.sun.javadoc.Parameter param,
                     DocletOptions options)
```
    This gets the default value of the given parameter
    
    Parameters:
    param - The parameter
    options - The doclet options
    
    Returns:
    The default value or null if it has no default
  - parsePath
```
public static String parsePath(com.sun.javadoc.ProgramElementDoc doc,
               DocletOptions options)
```
    This parses the path from the annotations of a method or class
    
    Parameters:
    doc - The method or class
    options - The doclet options
    
    Returns:
    The path or null if no path related annotations were present
  - compareNumericValues
```
public static Integer compareNumericValues(String context,
                           String type,
                           String format,
                           String value1,
                           String value2)
```
    This verifies that the given numeric values are valid for the given data type and format and returns the comparison. If not valid it raises an exception. It ignores null/empty values.
    
    Parameters:
    context - Additional description for contextualizing the error message
    type - The data type as per json schema
    format - The data format
    value1 - The first value to check
    value2 - The 2nd value to check
    
    Returns:
    null if either value is null/empty, otherwise -1,0,1 as per standard java compare behaviour.
    
    Throws:
    
    IllegalStateException - if the value is invalid.
  - verifyNumericValue
```
public static Number verifyNumericValue(String context,
                        String type,
                        String format,
                        String value)
```
    This verifies that the given value is valid for the given data type and format for use as a numeric value which means it must be integer or number type. If not valid it raises an exception. It ignores null/empty values.
    
    Parameters:
    context - Additional description for contextualizing the error message
    type - The data type as per json schema
    format - The data format
    value - The value to check
    
    Returns:
    The value as a number suitable for the given type and format
    
    Throws:
    
    IllegalStateException - if the value is invalid.
  - verifyValue
```
public static void verifyValue(String context,
               String type,
               String format,
               String value)
```
    This verifies that the given value is valid for the given data type and format. If not valid it raises an exception. It ignores null/empty values.
    
    Parameters:
    context - Additional description for contextualizing the error message
    type - The data type as per json schema
    format - The data format
    value - The value to check
    
    Throws:
    
    IllegalStateException - if the value is invalid.
  - getQualifiedTypeName
```
public static String getQualifiedTypeName(com.sun.javadoc.Type type)
```
    This gets the qualified type name of a javadoc type, It adds [] onto any array types
    
    Parameters:
    type - The type
    
    Returns:
    The qualified type name
  - typeOf
```
public static String[] typeOf(String javaType,
              DocletOptions options)
```
    Determines the String representation of the given FQN. This includes the type as the first item and the format as the 2nd. Common name Swagger spec 1.2 integer integer, int32 long integer, int64 float number, float double number, double string string byte string, byte boolean boolean date string, date dateTime string, date-time
    
    Parameters:
    javaType - The java type to get the swagger type and format of
    options - The doclet options
    
    Returns:
    An array with the type as the first item and the format as the 2nd.
  - typeOf
```
public static String[] typeOf(com.sun.javadoc.Type type,
              DocletOptions options)
```
    Determines the String representation of the object Type. This includes the type as the first item and the format as the 2nd. Common name Swagger spec 1.2 integer integer, int32 long integer, int64 float number, float double number, double string string byte string, byte boolean boolean date string, date dateTime string, date-time
    
    Parameters:
    type - The java type to get the swagger type and format of
    options - The doclet options
    
    Returns:
    An array with the type as the first item and the format as the 2nd.
  - getParameterizedTypes
```
public static List<com.sun.javadoc.Type> getParameterizedTypes(com.sun.javadoc.Type type,
                                               Map<String,com.sun.javadoc.Type> varsToTypes)
```
    This gets parameterized types of the given type substituting variable types if necessary
    
    Parameters:
    type - The raw type such as Batch or Batch
    varsToTypes - A map of variable name to types
    
    Returns:
    The list of parameterized types
  - getContainerType
```
public static com.sun.javadoc.Type getContainerType(com.sun.javadoc.Type type,
                                    Map<String,com.sun.javadoc.Type> varsToTypes,
                                    Collection<com.sun.javadoc.ClassDoc> classes)
```
    This gets the type that a container holds
    
    Parameters:
    type - The raw type like Collection
    varsToTypes - A map of variables to types for parameterized types, optional if null parameterized types will not be handled
    classes - set of classes
    
    Returns:
    The container type or null if not a collection
  - getVarType
```
public static com.sun.javadoc.Type getVarType(com.sun.javadoc.TypeVariable var,
                              Map<String,com.sun.javadoc.Type> varsToTypes)
```
    This finds a variable type and returns its impl from the given map
    
    Parameters:
    var - The variable type to find
    varsToTypes - The map of variables to types
    
    Returns:
    The result.
  - isSet
```
public static boolean isSet(String javaType)
```
    This gets whether the given type is a Set
    
    Parameters:
    javaType - The java type
    
    Returns:
    True if this is a Set
  - isArray
```
public static boolean isArray(com.sun.javadoc.Type type)
```
    This gets whether the given type is an Array
    
    Parameters:
    type - The type
    
    Returns:
    True if this is an array
  - isArray
```
public static boolean isArray(String javaType)
```
    This gets whether the given type is an Array
    
    Parameters:
    javaType - The java type
    
    Returns:
    True if this is an array
  - isCollection
```
public static boolean isCollection(String javaType)
```
    This gets whether the given type is a Collection
    
    Parameters:
    javaType - The java type
    
    Returns:
    True if this is a collection
  - isMap
```
public static boolean isMap(String javaType)
```
    This gets whether the given type is a Map
    
    Parameters:
    javaType - The java type
    
    Returns:
    True if this is a map
  - isFileParameterDataType
```
public static boolean isFileParameterDataType(com.sun.javadoc.Parameter parameter,
                              DocletOptions options)
```
    This gets whether the given parameter is a File data type
    
    Parameters:
    parameter - The parameter
    options - The doclet options
    
    Returns:
    True if the parameter is a File data type
  - paramTypeOf
```
public static String paramTypeOf(boolean returnDefault,
                 boolean multipart,
                 com.sun.javadoc.ProgramElementDoc paramMember,
                 com.sun.javadoc.Type type,
                 DocletOptions options)
```
    Determines the string representation of the parameter type for composite types.
    
    Parameters:
    returnDefault - Whether to return a default value if there is no specific jaxrs param annotation
    multipart - Whether the method the parameter is for consumes multipart
    paramMember - The field or method that is the parameter
    type - The type of the parameter
    options - The doclet options
    
    Returns:
    The type of parameter, one of path, header, query, form or body.
  - paramTypeOf
```
public static String paramTypeOf(boolean multipart,
                 com.sun.javadoc.Parameter parameter,
                 DocletOptions options)
```
    Determines the string representation of the parameter type.
    
    Parameters:
    multipart - Whether the method the parameter is for consumes multipart
    parameter - The parameter to get the type of
    options - The doclet options
    
    Returns:
    The type of parameter, one of path, header, query, form or body.
  - paramNameOf
```
public static String paramNameOf(com.sun.javadoc.Parameter parameter,
                 Map<String,String> overrideParamNames,
                 List<String> paramNameAnnotations,
                 DocletOptions options)
```
    Determines the string representation of the parameter name.
    
    Parameters:
    parameter - The parameter to get the name of that is used for the api
    overrideParamNames - A map of rawname to override names for parameters
    paramNameAnnotations - List of FQN of annotations that can be used for the parameter name
    options - The doclet options
    
    Returns:
    the name of the parameter used by http requests
  - fieldParamNameOf
```
public static String fieldParamNameOf(com.sun.javadoc.FieldDoc field,
                      Map<String,String> overrideParamNames,
                      List<String> paramNameAnnotations,
                      DocletOptions options)
```
    Determines the string representation of the parameter name.
    
    Parameters:
    field - The parameter field to get the name of that is used for the api
    overrideParamNames - A map of rawname to override names for parameters
    paramNameAnnotations - List of FQN of annotations that can be used for the parameter name
    options - The doclet options
    
    Returns:
    the name of the parameter used by http requests
  - getInheritableJsonViews
```
public static com.sun.javadoc.ClassDoc[] getInheritableJsonViews(com.sun.javadoc.MethodDoc methodDoc,
                                                 DocletOptions options)
```
    This gets the json views for the given method, it supports deriving the views from an overridden method
    
    Parameters:
    methodDoc - The method to get the json views of
    options - The doclet options
    
    Returns:
    The json views for the given method/overridden method or null if there were none
  - getJsonViews
```
public static com.sun.javadoc.ClassDoc[] getJsonViews(com.sun.javadoc.ProgramElementDoc doc,
                                      DocletOptions options)
```
    This gets the json views for the given method/field
    
    Parameters:
    doc - The method/field to get the json views of
    options - The doclet options
    
    Returns:
    The json views for the given method/field or null if there were none
  - hasJsonViews
```
public static boolean hasJsonViews(com.sun.javadoc.ProgramElementDoc doc,
                   DocletOptions options)
```
    This gets whether the given method/field has a json view on it
    
    Parameters:
    doc - The method/field to check
    options - The doclet options
    
    Returns:
    True if the given method/field has a json view
  - isItemPartOfView
```
public static boolean isItemPartOfView(com.sun.javadoc.ClassDoc[] operationViews,
                       com.sun.javadoc.ClassDoc[] itemsViews)
```
    This checks if an item view e.g optional json view that can be on a getter/field match any of the given operation views, that is it can be the same or extend/implement one of the operation views.
    
    Parameters:
    operationViews - The operation views that indicate which views apply to the operation.
    itemsViews - The views that are on the getter/field
    
    Returns:
    True if the field/getter is part of the view
  - isAssignableFrom
```
public static boolean isAssignableFrom(com.sun.javadoc.ClassDoc[] superClasses,
                       com.sun.javadoc.ClassDoc clazz)
```
    This checks if the given clazz is the same as or implments or is a subclass/sub interface of any of the given classes
    
    Parameters:
    superClasses - the classes to check if they are super classes/super interfaces of the given class
    clazz - The class to check if it extends/implements any of the given classes
    
    Returns:
    True if the given class extends/implements any of the given classes/interfaces
  - getConsumes
```
public static List<String> getConsumes(com.sun.javadoc.MethodDoc methodDoc,
                       DocletOptions options)
```
    This gets the list of consumes mime types from the given method
    
    Parameters:
    methodDoc - The method javadoc
    options - The doclet options
    
    Returns:
    The list or null if none were found
  - getProduces
```
public static List<String> getProduces(com.sun.javadoc.MethodDoc methodDoc,
                       DocletOptions options)
```
    This gets the list of produces mime types from the given method
    
    Parameters:
    methodDoc - The method javadoc
    options - The doclet options
    
    Returns:
    The list or null if none were found
  - listInheritableValues
```
public static List<String> listInheritableValues(com.sun.javadoc.ExecutableMemberDoc methodDoc,
                                 String qualifiedAnnotationType,
                                 String annotationValueName,
                                 DocletOptions options)
```
    This gets a list of values from an annotation that uses a string array value, it supports getting it from a superclass method
    
    Parameters:
    methodDoc - The method doc
    qualifiedAnnotationType - The FQN of the annotation
    annotationValueName - The name of the value field of the annotation to use
    options - The doclet options
    
    Returns:
    A list of values or null if none were found
  - listValues
```
public static List<String> listValues(com.sun.javadoc.ProgramElementDoc doc,
                      String qualifiedAnnotationType,
                      String annotationValueName,
                      DocletOptions options)
```
    This gets a list of values from an annotation that uses a string array value
    
    Parameters:
    doc - The method/field doc
    qualifiedAnnotationType - The FQN of the annotation
    annotationValueName - The name of the value field of the annotation to use
    options - The doclet options
    
    Returns:
    A list of values or null if none were found
  - isPrimitive
```
public static boolean isPrimitive(String type,
                  DocletOptions options)
```
    This gets whether the given type is primitive
    
    Parameters:
    type - The type to check
    options - The doclet options
    
    Returns:
    True if the given type is primitive
  - isPrimitive
```
public static boolean isPrimitive(com.sun.javadoc.Type type,
                  DocletOptions options)
```
    This gets whether the given type is primitive
    
    Parameters:
    type - The type to check
    options - The doclet options
    
    Returns:
    True if the given type is primitive
  - isNumber
```
public static boolean isNumber(com.sun.javadoc.Type type,
               DocletOptions options)
```
    This gets whether the given type is primitive
    
    Parameters:
    type - The type to check
    options - The doclet options
    
    Returns:
    True if the given type is primitive
  - hasInheritableTag
```
public static boolean hasInheritableTag(com.sun.javadoc.ExecutableMemberDoc methodDoc,
                        Collection<String> matchTags)
```
    This gets whether the given method or an overridden method has any of the given tags
    
    Parameters:
    methodDoc - The method doc to get the tag value of
    matchTags - The names of the tags to look for
    
    Returns:
    True if the method or an overridden method has any of the given tags
  - hasTag
```
public static boolean hasTag(com.sun.javadoc.ProgramElementDoc item,
             Collection<String> matchTags)
```
    This gets whether the given item has any of the given tags
    
    Parameters:
    item - The javadoc item
    matchTags - The names of the tags to look for
    
    Returns:
    True if the item has any of the given tags
  - getParamNames
```
public static Set<String> getParamNames(com.sun.javadoc.ExecutableMemberDoc method)
```
    This gets the parameter names for the given method
    
    Parameters:
    method - The method
    
    Returns:
    the names of the method parameters or an empty set if the method had none
  - getMatchingParams
```
public static Set<String> getMatchingParams(com.sun.javadoc.ExecutableMemberDoc method,
                            Set<String> params,
                            Collection<String> javadocTags,
                            Collection<String> annotations,
                            DocletOptions options)
```
    This gets params of the given method that have either any of the matching javadoc tags or annotations
    
    Parameters:
    method - The method
    params - The pre-read params of the method, if null they will be read from the given method
    javadocTags - Csv javadoc tags to look at
    annotations - Annotations to look at
    options - The doclet options
    
    Returns:
    A set of param names for the params that have either any of the matching javadoc tags or annotations
  - getParameterWithAnnotations
```
public static com.sun.javadoc.Parameter getParameterWithAnnotations(com.sun.javadoc.ExecutableMemberDoc methodDoc,
                                                    int paramIndex)
```
    This gets the first met parameter with annotations from the method overriding hierarchy
    
    Parameters:
    methodDoc - The method
    paramIndex - Parameter index
    
    Returns:
    A parameter from the method overriding hierarchy with annotations
  - getParameterValues
```
public static Map<String,String> getParameterValues(com.sun.javadoc.ExecutableMemberDoc method,
                                    Set<String> params,
                                    Collection<String> matchTags,
                                    Collection<String> annotations,
                                    ParserHelper.TypeFilter annotationTypes,
                                    DocletOptions options,
                                    String... valueKeys)
```
    This gets the values of parameters from either javadoc tags or annotations
    
    Parameters:
    method - The method
    params - The pre-read params of the method, if null they will be read from the given method
    matchTags - The names of the javadoc tags to look for
    annotations - The annotations to look for
    annotationTypes - The types that the annotations should apply to
    options - The doclet options (used for var replacement)
    valueKeys - The attribute names to look for on the annotations as the value
    
    Returns:
    A set of param names with the given annotations
  - getParameterValuesWithAnnotation
```
public static Map<String,String> getParameterValuesWithAnnotation(com.sun.javadoc.ExecutableMemberDoc methodDoc,
                                                  Collection<String> annotations,
                                                  ParserHelper.TypeFilter annotationTypes,
                                                  DocletOptions options,
                                                  String... valueKeys)
```
    This gets the values of annotations of parameters that have any of the given annotations on them
    
    Parameters:
    methodDoc - The method
    annotations - The annotations to look for
    annotationTypes - The types that the annotations should apply to
    options - The doclet options (used for var replacement)
    valueKeys - The attribute names to look for on the annotations as the value
    
    Returns:
    A set of param names with the given annotations
  - getMethodParamNameValuePairs
```
public static Map<String,String> getMethodParamNameValuePairs(com.sun.javadoc.ExecutableMemberDoc method,
                                              Set<String> params,
                                              Collection<String> matchTags,
                                              DocletOptions options)
```
    This gets a map of parameter name to value from a javadoc tag on a method. This validates that the names of the parameters in each NVP is an actual method parameter
    
    Parameters:
    method - The method
    params - The pre-read params of the method, if null they will be read from the given method
    matchTags - The names of the javadoc tags to look for
    options - The doclet options
    
    Returns:
    a map of parameter name to value from a javadoc tag on a method or an empty map if none were found
  - getMethodParamNameValueLists
```
public static Map<String,List<String>> getMethodParamNameValueLists(com.sun.javadoc.ExecutableMemberDoc method,
                                                    Set<String> params,
                                                    Collection<String> matchTags,
                                                    DocletOptions options)
```
    This gets a map of parameter name to list of values from a javadoc tag on a method. This validates that the names of the parameters in each name to list is an actual method parameter
    
    Parameters:
    method - The method
    params - The pre-read params of the method, if null they will be read from the given method
    matchTags - The names of the javadoc tags to look for
    options - The doclet options
    
    Returns:
    a map of parameter name to list of values from a javadoc tag on a method or an empty map if none were found
  - getCsvParams
```
public static List<String> getCsvParams(com.sun.javadoc.ExecutableMemberDoc method,
                        Set<String> params,
                        Collection<String> matchTags,
                        DocletOptions options)
```
    This gets a list of parameter names from a method javadoc tag where the value of the tag is in the form paramName1,paramName2 ... paramNameN
    
    Parameters:
    method - The method
    params - The pre-read params of the method, if null they will be read from the given method
    matchTags - The names of the javadoc tags to look for
    options - The doclet options
    
    Returns:
    The list of parameter names or an empty list if there were none
  - getTagCsvValues
```
public static List<String> getTagCsvValues(com.sun.javadoc.ExecutableMemberDoc item,
                           Collection<String> matchTags,
                           DocletOptions options)
```
    This gets a csv javadoc tag value as a list of the values in the csv for the first matched tag. e.g. @myTag 1,2,3 would return a list of 1,2,3 assuming matchTags contained myTag
    
    Parameters:
    item - The javadoc item
    matchTags - The tags to match
    options - The doclet options
    
    Returns:
    The csv values of the first matching tags value or an empty list if there were none.
  - getAnnotationOrTagValue
```
public static String getAnnotationOrTagValue(com.sun.javadoc.ProgramElementDoc item,
                             Collection<String> annotations,
                             Collection<String> matchTags,
                             DocletOptions options,
                             String... valueKeys)
```
    This gets the first value on the given item (field or method) that matches either an annotation or a javadoc tag. This does NOT support method overriding
    
    Parameters:
    item - The javadoc item
    annotations - The FQN of the annotations to check
    matchTags - The collection of tag names of the tag to get a value of
    options - The doclet options
    valueKeys - The names of the attributes of the annotations to look at
    
    Returns:
    The value or null if none was found
  - resolveMethodHttpMethod
```
public static HttpMethod resolveMethodHttpMethod(com.sun.javadoc.MethodDoc methodDoc)
```
    Resolves HttpMethod for the MethodDoc respecting the overriden methods
    
    Parameters:
    methodDoc - The method to be processed
    
    Returns:
    The resolved HttpMethod
  - resolveMethodPath
```
public static String resolveMethodPath(com.sun.javadoc.MethodDoc methodDoc,
                       DocletOptions options)
```
    Resolves tha @Path for the MethodDoc respecting the overriden methods
    
    Parameters:
    methodDoc - The method to be processed
    options - Doclet options
    
    Returns:
    The resolved path
  - getInheritableFirstSentenceTags
```
public static String getInheritableFirstSentenceTags(com.sun.javadoc.ExecutableMemberDoc methodDoc)
```
    This gets the first sentence tags of a method or its overridden ancestor method
    
    Parameters:
    methodDoc - The method
    
    Returns:
    The first sentence tag or null if there is none
  - getInheritableCommentText
```
public static String getInheritableCommentText(com.sun.javadoc.ExecutableMemberDoc methodDoc)
```
    This gets the first sentence tags of a method or its overridden ancestor method
    
    Parameters:
    methodDoc - The method
    
    Returns:
    The first sentence tag or null if there is none
  - getInheritableTagValues
```
public static List<String> getInheritableTagValues(com.sun.javadoc.ExecutableMemberDoc methodDoc,
                                   Collection<String> matchTags,
                                   DocletOptions options)
```
    This gets values of any of the javadoc tags that are in the given collection from the method or overridden methods
    
    Parameters:
    methodDoc - The javadoc method to get the tags of
    matchTags - The names of the tags to get
    options - The doclet options
    
    Returns:
    A list of tag values or null if none were found
  - getTagValues
```
public static List<String> getTagValues(com.sun.javadoc.ProgramElementDoc item,
                        Collection<String> matchTags,
                        DocletOptions options)
```
    This gets values of any of the javadoc tags that are in the given collection
    
    Parameters:
    item - The javadoc item to get the tags of
    matchTags - The names of the tags to get
    options - The doclet options
    
    Returns:
    A list of tag values or null if none were found
  - getInheritableTagValue
```
public static String getInheritableTagValue(com.sun.javadoc.ExecutableMemberDoc methodDoc,
                            Collection<String> matchTags,
                            DocletOptions options)
```
    This gets the value of the first tag found from the given MethodDoc respecting the overriden methods
    
    Parameters:
    methodDoc - The method doc to get the tag value of
    matchTags - The collection of tag names of the tag to get a value of
    options - The doclet options
    
    Returns:
    The value of the first tag found with the name in the given collection or null if either the tag was not present or had no value
  - getTagValue
```
public static String getTagValue(com.sun.javadoc.ProgramElementDoc item,
                 Collection<String> matchTags,
                 DocletOptions options)
```
    This gets the value of the first tag found from the given collection of tag names
    
    Parameters:
    item - The item to get the tag value of
    matchTags - The collection of tag names of the tag to get a value of
    options - The doclet options
    
    Returns:
    The value of the first tag found with the name in the given collection or null if either the tag was not present or had no value
  - hasInheritableAnnotation
```
public static boolean hasInheritableAnnotation(com.sun.javadoc.MethodDoc methodDoc,
                               Collection<String> annotations,
                               DocletOptions options)
```
    This gets whether the given method or an overridden method has any of the given annotations
    
    Parameters:
    methodDoc - The method doc to check
    annotations - the annotations to check
    options - The doclet options
    
    Returns:
    True if the method or an overridden method has one of the given annotations
  - hasAnnotation
```
public static boolean hasAnnotation(com.sun.javadoc.ProgramElementDoc item,
                    Collection<String> annotations,
                    DocletOptions options)
```
    This gets whether the given item has one of the given annotations
    
    Parameters:
    item - The field/method to check
    annotations - the annotations to check
    options - The doclet options
    
    Returns:
    True if the item has one of the given annotations
  - hasAnnotation
```
public static boolean hasAnnotation(com.sun.javadoc.Parameter item,
                    Collection<String> annotations,
                    DocletOptions options)
```
    This gets whether the given parameter has one of the given annotations
    
    Parameters:
    item - The field/method to check
    annotations - the annotations to check
    options - The doclet options
    
    Returns:
    True if the parameter has one of the given annotations
  - hasAnnotationWithPrefix
```
public static boolean hasAnnotationWithPrefix(com.sun.javadoc.Parameter item,
                              Collection<String> prefixes,
                              DocletOptions options)
```
    This gets whether the given parameter has an annotation whose FQN begins with one of the given prefixes
    
    Parameters:
    item - The field/method to check
    prefixes - the prefixes to check for
    options - The doclet options
    
    Returns:
    True if the parameter has an annotation whose FQN begins with one of the given prefixes
  - hasJaxRsAnnotation
```
public static boolean hasJaxRsAnnotation(com.sun.javadoc.Parameter item,
                         DocletOptions options)
```
    This gets whether the given parameter has a JAXRS annotation
    
    Parameters:
    item - The parameter
    options - The doclet options
    
    Returns:
    True if the parameter has the given annotation
  - isInheritableDeprecated
```
public static boolean isInheritableDeprecated(com.sun.javadoc.MethodDoc item,
                              DocletOptions options)
```
    This gets whether the given item is marked as deprecated either via a javadoc tag or an annotation, this supports looking at overridden methods
    
    Parameters:
    item - The item to check
    options - The doclet options
    
    Returns:
    True if the item is flagged as deprecated
  - isDeprecated
```
public static boolean isDeprecated(com.sun.javadoc.ProgramElementDoc item,
                   DocletOptions options)
```
    This gets whether the given item is marked as deprecated either via a javadoc tag or an annotation
    
    Parameters:
    item - The item to check
    options - The doclet options
    
    Returns:
    True if the item is flagged as deprecated
  - isDeprecated
```
public static boolean isDeprecated(com.sun.javadoc.Parameter parameter,
                   DocletOptions options)
```
    This gets whether the given parameter is marked as deprecated either via a javadoc tag or an annotation
    
    Parameters:
    parameter - The parameter to check
    options - The doclet options
    
    Returns:
    True if the parameter is flagged as deprecated
  - readSeeTypes
```
public static Map<String,com.sun.javadoc.Type> readSeeTypes(com.sun.javadoc.ProgramElementDoc item)
```
    This builds a map of FQN to type for all see annotations on the given items javadoc
    
    Parameters:
    item - The item to get the see types of
    
    Returns:
    A map of see types or an empty map if there were no see tags.
  - findModel
```
public static com.sun.javadoc.ClassDoc findModel(Collection<com.sun.javadoc.ClassDoc> classes,
                                 String qualifiedClassName)
```
    This finds a model class by the given name
    
    Parameters:
    classes - The model classes
    qualifiedClassName - The FQN of the class
    
    Returns:
    ClassDoc found among all classes processed by the doclet based on a given qualifiedClassName; null if not found
  - generateResourceFilename
```
public static String generateResourceFilename(String resourcePath)
```
    This generates a file name to use for a resource with the given resource path. It ensures that any non filename safe characters are removed For example /api/test/{id:[0-9]+} will become api_test_id
    
    Parameters:
    resourcePath - The path to sanitize
    
    Returns:
    The resource path sanitized
  - sanitizePath
```
public static String sanitizePath(String apiPath)
```
    This sanitizes an API path. It handles removing regex path expressions e.g instead of /api/test/{id:[0-9]+} it will return /api/test/{id}
    
    Parameters:
    apiPath - The api path to sanitize
    
    Returns:
    The sanitized path
  - trimLeadingChars
```
public static String trimLeadingChars(String str,
                      char... trimChars)
```
    This trims specific characters from the start of the given string
    
    Parameters:
    str - The string to trim
    trimChars - The characters to trim from the string
    
    Returns:
    The string with any of the trimable characters removed from the start of the string

Class ParserHelper

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JAXRS_PARAM_ANNOTATIONS

Constructor Detail

ParserHelper

Method Detail

lookUpClassDoc

getAllowableValues

hasAncestor

getInheritableClassLevelAnnotationValue

getDefaultValue

parsePath

compareNumericValues

verifyNumericValue

verifyValue

getQualifiedTypeName

typeOf

typeOf

getParameterizedTypes

getContainerType

getVarType

isSet

isArray

isArray

isCollection

isMap

isFileParameterDataType

paramTypeOf

paramTypeOf

paramNameOf

fieldParamNameOf

getInheritableJsonViews

getJsonViews

hasJsonViews

isItemPartOfView

isAssignableFrom

getConsumes

getProduces

listInheritableValues

listValues

isPrimitive

isPrimitive

isNumber

hasInheritableTag

hasTag

getParamNames

getMatchingParams

getParameterWithAnnotations

getParameterValues

getParameterValuesWithAnnotation

getMethodParamNameValuePairs

getMethodParamNameValueLists

getCsvParams

getTagCsvValues

getAnnotationOrTagValue

resolveMethodHttpMethod

resolveMethodPath

getInheritableFirstSentenceTags

getInheritableCommentText

getInheritableTagValues

getTagValues

getInheritableTagValue

getTagValue

hasInheritableAnnotation

hasAnnotation

hasAnnotation

hasAnnotationWithPrefix

hasJaxRsAnnotation

isInheritableDeprecated

isDeprecated

isDeprecated

readSeeTypes

findModel

generateResourceFilename

sanitizePath