A B C D E F G H I J L M N O P Q R S T U V X 
All Classes All Packages

A

ACCEPTED - net.oneandone.neberus.model.ApiStatus
202 Accepted.
addCommonResponseData(AnnotationMirror, List<AnnotationValue>, RestMethodData.ResponseData) - Method in class net.oneandone.neberus.parse.MethodParser
 
addCurl(ExecutableElement, RestMethodData) - Method in class net.oneandone.neberus.parse.MethodParser
 
addCustomParameter(AnnotationMirror, RestMethodData) - Method in class net.oneandone.neberus.parse.MethodParser
 
addCustomParameters(ExecutableElement, RestMethodData) - Method in class net.oneandone.neberus.parse.MethodParser
 
addCustomRequestEntities(ExecutableElement, RestMethodData) - Method in class net.oneandone.neberus.parse.MethodParser
 
addDeprecated(ExecutableElement, RestMethodData) - Method in class net.oneandone.neberus.parse.MethodParser
 
addDescription(ExecutableElement, RestMethodData) - Method in class net.oneandone.neberus.parse.MethodParser
 
addDescription(TypeElement, RestClassData) - Method in class net.oneandone.neberus.parse.ClassParser
Use the value defined in ApiDescription and use the javadoc comment of the class.
addHeader(AnnotationMirror, RestClassData) - Method in class net.oneandone.neberus.parse.ClassParser
 
addHeaders(TypeElement, RestClassData) - Method in class net.oneandone.neberus.parse.ClassParser
 
addLabel(ExecutableElement, RestMethodData) - Method in class net.oneandone.neberus.parse.MethodParser
 
addLabel(TypeElement, RestClassData) - Method in class net.oneandone.neberus.parse.ClassParser
Use the value defined in ApiLabel or use the name of the class.
addMediaType(ExecutableElement, RestMethodData) - Method in class net.oneandone.neberus.parse.MethodParser
 
addMethodData(ExecutableElement, RestMethodData) - Method in class net.oneandone.neberus.parse.MethodParser
 
addNestedArray(TypeMirror, List<RestMethodData.ParameterInfo>) - Method in class net.oneandone.neberus.parse.MethodParser
 
addNestedMap(TypeMirror, List<RestMethodData.ParameterInfo>) - Method in class net.oneandone.neberus.parse.MethodParser
 
addNestedParameters(TypeMirror, List<RestMethodData.ParameterInfo>, List<TypeMirror>) - Method in class net.oneandone.neberus.parse.MethodParser
 
addParameterInfo(List<RestMethodData.ParameterInfo>, RestMethodData.ParameterInfo) - Method in class net.oneandone.neberus.parse.MethodParser
 
addParameters(ExecutableElement, RestMethodData) - Method in class net.oneandone.neberus.parse.MethodParser
 
addPath(ExecutableElement, RestMethodData) - Method in class net.oneandone.neberus.parse.MethodParser
 
addRequestData(ExecutableElement, RestMethodData) - Method in class net.oneandone.neberus.parse.MethodParser
 
addResponse(AnnotationMirror, RestMethodData, List<AnnotationValue>) - Method in class net.oneandone.neberus.parse.MethodParser
 
addResponseData(ExecutableElement, RestMethodData) - Method in class net.oneandone.neberus.parse.MethodParser
 
addResponsesFromAnnotations(ExecutableElement, RestMethodData) - Method in class net.oneandone.neberus.parse.MethodParser
 
addResponsesFromAnnotations(TypeElement, RestClassData) - Method in class net.oneandone.neberus.parse.ClassParser
 
AllowedValue(String, String) - Constructor for class net.oneandone.neberus.parse.RestMethodData.AllowedValue
 
allowedValues - Variable in class net.oneandone.neberus.parse.RestMethodData.HeaderInfo
 
allowedValues - Variable in class net.oneandone.neberus.parse.RestMethodData.ParameterInfo
 
allowedValues() - Method in annotation type net.oneandone.neberus.annotation.ApiHeader
Define allowed value that is returned to the client.
allowedValues() - Method in annotation type net.oneandone.neberus.annotation.ApiParameter
Define allowed value that should be provided by the client.
ALREADY_REPORTED - net.oneandone.neberus.model.ApiStatus
208 Already Reported.
ApiAllowedValue - Annotation Type in net.oneandone.neberus.annotation
Define the allowed values for a parameter.
ApiAllowedValues - Annotation Type in net.oneandone.neberus.annotation
Container annotation for ApiAllowedValues.
apiBasePath - Variable in class net.oneandone.neberus.Options
 
ApiCommonResponse - Annotation Type in net.oneandone.neberus.annotation
Document a common Response on class level, the response will be added to every method inside that class.
ApiCommonResponses - Annotation Type in net.oneandone.neberus.annotation
Container annotation for ApiCommonResponses.
ApiCurl - Annotation Type in net.oneandone.neberus.annotation
Tells Neberus to generate an example curl.
ApiDescription - Annotation Type in net.oneandone.neberus.annotation
If provided, the value of this will be used as description of the method instead of the javadoc comment.
ApiDocumentation - Annotation Type in net.oneandone.neberus.annotation
Enables neberus documentation for a class containing REST methods.
ApiEntity - Annotation Type in net.oneandone.neberus.annotation
Define a response entity.
ApiExample - Annotation Type in net.oneandone.neberus.annotation
Define a example for a specific value.
ApiHeader - Annotation Type in net.oneandone.neberus.annotation
Define a response Header within a ApiResponse.
ApiHeaderDefinition - Annotation Type in net.oneandone.neberus.annotation
Define a Header on class level, this can be used to provided descriptions of headers that are reused many times.
ApiHeaderDefinitions - Annotation Type in net.oneandone.neberus.annotation
Container annotation for ApiHeaderDefinitions.
ApiHeaders - Annotation Type in net.oneandone.neberus.annotation
Container annotation for ApiHeaders.
apiHosts - Variable in class net.oneandone.neberus.Options
 
ApiIgnore - Annotation Type in net.oneandone.neberus.annotation
Exclude a request parameter, DTO field or a whole REST method from documentation.
ApiLabel - Annotation Type in net.oneandone.neberus.annotation
Defines the name of a REST class or method.
ApiOptional - Annotation Type in net.oneandone.neberus.annotation
Declare a parameter as optional.
ApiParameter - Annotation Type in net.oneandone.neberus.annotation
Defines a custom parameter for a REST method.
ApiParameter.Type - Enum in net.oneandone.neberus.annotation
 
ApiParameters - Annotation Type in net.oneandone.neberus.annotation
Container annotation for ApiParameters.
ApiRequestEntities - Annotation Type in net.oneandone.neberus.annotation
Container annotation for @ApiRequestEntity.
ApiRequestEntity - Annotation Type in net.oneandone.neberus.annotation
Define a request entity for a specific content-type.
ApiRequired - Annotation Type in net.oneandone.neberus.annotation
Declare a parameter as required.
ApiResponse - Annotation Type in net.oneandone.neberus.annotation
Document a Response.
ApiResponses - Annotation Type in net.oneandone.neberus.annotation
Container annotation for ApiResponses.
ApiStatus - Enum in net.oneandone.neberus.model
 
apiTitle - Variable in class net.oneandone.neberus.Options
 
ApiType - Annotation Type in net.oneandone.neberus.annotation
Define the type that should be displayed instead of the actual type.
ApiUsecase - Annotation Type in net.oneandone.neberus.annotation
Defines a specific usecase of the REST service.
ApiUsecaseMethod - Annotation Type in net.oneandone.neberus.annotation
A specific REST method used in an usecase.
ApiUsecaseParam - Annotation Type in net.oneandone.neberus.annotation
Parameter used by a REST method in a usecase.
ApiUsecaseRequestBody - Annotation Type in net.oneandone.neberus.annotation
Request body for a REST method in a usecase.
ApiUsecaseResponseBody - Annotation Type in net.oneandone.neberus.annotation
Response body for a REST method in a usecase.
ApiUsecases - Annotation Type in net.oneandone.neberus.annotation
Container for multiple ApiUsecase annotations.
apiVersion - Variable in class net.oneandone.neberus.Options
 
ASCIIDOC - net.oneandone.neberus.Options.Markup
 
AsciiDocPrinter - Class in net.oneandone.neberus.print
 
AsciiDocPrinter() - Constructor for class net.oneandone.neberus.print.AsciiDocPrinter
 
asElement(TypeMirror, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 

B

BAD_GATEWAY - net.oneandone.neberus.model.ApiStatus
502 Bad Gateway.
BAD_REQUEST - net.oneandone.neberus.model.ApiStatus
400 Bad Request.
BANDWIDTH_LIMIT_EXCEEDED - net.oneandone.neberus.model.ApiStatus
509 Bandwidth Limit Exceeded
BODY - net.oneandone.neberus.parse.RestMethodData.ParameterType
 

C

CHECKPOINT - net.oneandone.neberus.model.ApiStatus
103 Checkpoint.
classDoc - Variable in class net.oneandone.neberus.parse.RestClassData
 
className - Variable in class net.oneandone.neberus.parse.RestClassData
 
ClassParser - Class in net.oneandone.neberus.parse
Parses class related things.
ClassParser(MethodParser) - Constructor for class net.oneandone.neberus.parse.ClassParser
 
commonResponseData - Variable in class net.oneandone.neberus.parse.RestClassData
Class scope defined responses that will be added to every method in the whole class.
concat(String...) - Method in class net.oneandone.neberus.print.DocPrinter
 
concat(List<String>) - Method in class net.oneandone.neberus.print.DocPrinter
 
CONFLICT - net.oneandone.neberus.model.ApiStatus
409 Conflict.
constraints - Variable in class net.oneandone.neberus.parse.RestMethodData.ParameterInfo
 
containedFieldNamesAreNotAvailableOrPackageExcluded(TypeMirror, Options) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
containingClass - Variable in class net.oneandone.neberus.parse.RestMethodData
 
contentType - Variable in class net.oneandone.neberus.parse.RestMethodData.Entity
 
contentType() - Method in annotation type net.oneandone.neberus.annotation.ApiEntity
If unset, the first Content-Type defined on the method will be used.
contentType() - Method in annotation type net.oneandone.neberus.annotation.ApiRequestEntity
If unset, the first Content-Type defined on the method will be used.
contentType() - Method in annotation type net.oneandone.neberus.annotation.ApiUsecaseRequestBody
 
contentType() - Method in annotation type net.oneandone.neberus.annotation.ApiUsecaseResponseBody
 
CONTINUE - net.oneandone.neberus.model.ApiStatus
100 Continue.
copyFile(File, File) - Static method in class net.oneandone.neberus.util.FileUtils
 
copyJarResourcesRecursively(File, JarURLConnection) - Static method in class net.oneandone.neberus.util.FileUtils
 
copyResourcesRecursively(URL, File) - Static method in class net.oneandone.neberus.util.FileUtils
 
CREATED - net.oneandone.neberus.model.ApiStatus
201 Created.
curl - Variable in class net.oneandone.neberus.parse.RestMethodData.MethodData
 

D

deprecated - Variable in class net.oneandone.neberus.parse.RestMethodData.HeaderInfo
 
deprecated - Variable in class net.oneandone.neberus.parse.RestMethodData.MethodData
 
deprecated - Variable in class net.oneandone.neberus.parse.RestMethodData.ParameterInfo
 
deprecated() - Method in annotation type net.oneandone.neberus.annotation.ApiHeader
If true, the header will be marked as deprecated.
deprecated() - Method in annotation type net.oneandone.neberus.annotation.ApiParameter
If true, the parameter will be marked as deprecated.
deprecatedDescription - Variable in class net.oneandone.neberus.parse.RestMethodData.HeaderInfo
 
deprecatedDescription - Variable in class net.oneandone.neberus.parse.RestMethodData.MethodData
 
deprecatedDescription - Variable in class net.oneandone.neberus.parse.RestMethodData.ParameterInfo
 
deprecatedDescription() - Method in annotation type net.oneandone.neberus.annotation.ApiHeader
Additional description that will be shown if the header is deprecated.
deprecatedDescription() - Method in annotation type net.oneandone.neberus.annotation.ApiParameter
Additional description that will be shown if the parameter is deprecated.
description - Variable in class net.oneandone.neberus.parse.RestClassData
the javadoc comment on the class
description - Variable in class net.oneandone.neberus.parse.RestMethodData.Entity
 
description - Variable in class net.oneandone.neberus.parse.RestMethodData.Example
 
description - Variable in class net.oneandone.neberus.parse.RestMethodData.HeaderInfo
 
description - Variable in class net.oneandone.neberus.parse.RestMethodData.MethodData
 
description - Variable in class net.oneandone.neberus.parse.RestMethodData.ParameterInfo
 
description - Variable in class net.oneandone.neberus.parse.RestMethodData.ResponseData
 
description - Variable in class net.oneandone.neberus.parse.RestUsecaseData
 
description - Variable in class net.oneandone.neberus.parse.RestUsecaseData.UsecaseData
 
description - Variable in class net.oneandone.neberus.parse.RestUsecaseData.UsecaseMethodData
 
description() - Method in annotation type net.oneandone.neberus.annotation.ApiCommonResponse
Description of the response.
description() - Method in annotation type net.oneandone.neberus.annotation.ApiEntity
Description of the entity.
description() - Method in annotation type net.oneandone.neberus.annotation.ApiHeader
Description of the header.
description() - Method in annotation type net.oneandone.neberus.annotation.ApiHeaderDefinition
Description of the header.
description() - Method in annotation type net.oneandone.neberus.annotation.ApiParameter
Description of the parameter.
description() - Method in annotation type net.oneandone.neberus.annotation.ApiRequestEntity
Description of the request entity.
description() - Method in annotation type net.oneandone.neberus.annotation.ApiResponse
Description of the response.
description() - Method in annotation type net.oneandone.neberus.annotation.ApiUsecase
General description of the usecase.
description() - Method in annotation type net.oneandone.neberus.annotation.ApiUsecaseMethod
Description of the usage of this method.
DESCRIPTION - Static variable in class net.oneandone.neberus.parse.MethodParser
 
DESTINATION_LOCKED - net.oneandone.neberus.model.ApiStatus
Deprecated.
DETAIL - Static variable in class net.oneandone.neberus.parse.MethodParser
 
displayClass - Variable in class net.oneandone.neberus.parse.RestMethodData.ParameterInfo
 
docBasePath - Variable in class net.oneandone.neberus.Options
 
DocletOption - Class in net.oneandone.neberus
 
DocPrinter - Class in net.oneandone.neberus.print
 
DocPrinter(List<NeberusModule>, ShortCodeExpander, Options) - Constructor for class net.oneandone.neberus.print.DocPrinter
 

E

entities - Variable in class net.oneandone.neberus.parse.RestMethodData.RequestData
 
entities - Variable in class net.oneandone.neberus.parse.RestMethodData.ResponseData
 
entities() - Method in annotation type net.oneandone.neberus.annotation.ApiCommonResponse
Entities used in this response.
entities() - Method in annotation type net.oneandone.neberus.annotation.ApiResponse
Entities used in this response.
Entity() - Constructor for class net.oneandone.neberus.parse.RestMethodData.Entity
 
entityClass - Variable in class net.oneandone.neberus.parse.RestMethodData.Entity
 
entityClass - Variable in class net.oneandone.neberus.parse.RestMethodData.ParameterInfo
 
entityClass() - Method in annotation type net.oneandone.neberus.annotation.ApiEntity
Set the class of the DTO used for the entity.
entityClass() - Method in annotation type net.oneandone.neberus.annotation.ApiParameter
Define the class of the parameter.
entityClass() - Method in annotation type net.oneandone.neberus.annotation.ApiRequestEntity
Set the class of the DTO used for the entity.
enumValues() - Method in annotation type net.oneandone.neberus.annotation.ApiAllowedValue
Allow all values of the specified enum.
environment - Variable in class net.oneandone.neberus.Options
 
equals(Object) - Method in class net.oneandone.neberus.Options
 
Example() - Constructor for class net.oneandone.neberus.parse.RestMethodData.Example
 
examples - Variable in class net.oneandone.neberus.parse.RestMethodData.Entity
 
examples() - Method in annotation type net.oneandone.neberus.annotation.ApiEntity
Custom examples for this entity.
examples() - Method in annotation type net.oneandone.neberus.annotation.ApiRequestEntity
Custom examples for this entity.
expand(String) - Method in class net.oneandone.neberus.shortcode.ShortCodeExpander
 
expander - Variable in class net.oneandone.neberus.NeberusModule
 
expander - Variable in class net.oneandone.neberus.print.DocPrinter
 
EXPECTATION_FAILED - net.oneandone.neberus.model.ApiStatus
417 Expectation Failed.
extractValue(AnnotationMirror, String) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 

F

FAILED_DEPENDENCY - net.oneandone.neberus.model.ApiStatus
424 Failed Dependency.
FileUtils - Class in net.oneandone.neberus.util
 
FORBIDDEN - net.oneandone.neberus.model.ApiStatus
403 Forbidden.
FormParameters - Class in net.oneandone.neberus.model
Generic container for form params.
FormParameters() - Constructor for class net.oneandone.neberus.model.FormParameters
 
FOUND - net.oneandone.neberus.model.ApiStatus
302 Found.

G

GATEWAY_TIMEOUT - net.oneandone.neberus.model.ApiStatus
504 Gateway Timeout.
getAllowedValuesFromLinkTag(Element, List<? extends DocTree>) - Method in class net.oneandone.neberus.parse.MethodParser
 
getAllowedValuesFromSeeTag(Element, List<? extends DocTree>) - Method in class net.oneandone.neberus.parse.MethodParser
 
getAllowedValuesFromType(TypeMirror) - Method in class net.oneandone.neberus.parse.MethodParser
 
getAnnotationDesc(Element, Class) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getAnnotationDesc(ExecutableElement, Class, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getAnnotationDesc(ExecutableElement, String, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getAnnotationDesc(ExecutableElement, VariableElement, Class, int, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getAnnotationDesc(ExecutableElement, VariableElement, String, int, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getAnnotationDesc(TypeElement, Class, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getAnnotations(ExecutableElement, VariableElement, int, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getAnnotationValue(List<? extends AnnotationMirror>, String, String) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getAnnotationValue(ExecutableElement, Class, String, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getAnnotationValue(ExecutableElement, String, String, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getAnnotationValue(ExecutableElement, VariableElement, Class, int, String, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getAnnotationValue(ExecutableElement, VariableElement, Class, String, int, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getAnnotationValue(ExecutableElement, VariableElement, String, int, String, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getAnnotationValue(TypeElement, Class, String, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getArgumentCount() - Method in class net.oneandone.neberus.DocletOption
 
getBlockTags(Element, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getCommentText(Element, DocletEnvironment, boolean) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getCommentTextFromInterfaceOrClass(ExecutableElement, DocletEnvironment, boolean) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getCommentTextFromInterfaceOrClass(TypeElement, DocletEnvironment, boolean) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getCommentTextWithoutInlineTags(List<? extends DocTree>) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getConstraintsFromLinkTag(Element, List<? extends DocTree>) - Method in class net.oneandone.neberus.parse.MethodParser
 
getConstraintsFromSeeTag(Element, List<? extends DocTree>) - Method in class net.oneandone.neberus.parse.MethodParser
 
getConstructors(Element) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getConstructors(TypeMirror, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getConsumes(ExecutableElement) - Method in class net.oneandone.neberus.parse.MethodParser
 
getDataFields(TypeMirror, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getDataFields(RestMethodData.ParameterInfo, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getDescription() - Method in class net.oneandone.neberus.DocletOption
 
getDirectAnnotationValue(Element, Class, String) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getDirectAnnotationValue(Element, String, String) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getDirectAnnotationValue(VariableElement, Class, String) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getDirectAnnotationValue(VariableElement, String, String) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getDocCommentTreeFromInterfaceOrClass(ExecutableElement, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getEnumValuesAsList(TypeElement, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getEnumValuesAsList(TypeMirror, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getExecutableElements(Element) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getExtendedCollectionType(TypeMirror, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getFilename() - Method in class net.oneandone.neberus.NeberusModule
 
getFormParam(ExecutableElement, VariableElement, int) - Method in class net.oneandone.neberus.parse.MethodParser
 
getHeaderParam(ExecutableElement, VariableElement, int) - Method in class net.oneandone.neberus.parse.MethodParser
 
getHttpMethods(ExecutableElement) - Method in class net.oneandone.neberus.parse.ClassParser
 
getInlineTags(Element, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getInterfaceClass(TypeElement, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getKey() - Method in class net.oneandone.neberus.shortcode.ShortCode
 
getKind() - Method in class net.oneandone.neberus.DocletOption
 
getName() - Method in class net.oneandone.neberus.NeberusModule
 
getNameFromGetter(ExecutableElement, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getNames() - Method in class net.oneandone.neberus.DocletOption
 
getPackageName(Element, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getPackageName(TypeMirror, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getParameter(List<RestMethodData.ParameterInfo>, String) - Static method in class net.oneandone.neberus.parse.RestUsecaseData
 
getParameters() - Method in class net.oneandone.neberus.DocletOption
 
getParamTag(ExecutableElement, int, Map<String, ParamTree>, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getParamTags(ExecutableElement, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getParamTreeComment(ParamTree) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getPath(ExecutableElement) - Method in class net.oneandone.neberus.parse.MethodParser
 
getPathParam(ExecutableElement, VariableElement, int) - Method in class net.oneandone.neberus.parse.MethodParser
 
getProduces(ExecutableElement) - Method in class net.oneandone.neberus.parse.MethodParser
 
getPublicName(Element) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getPublicName(VariableElement) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getQualifiedName(TypeMirror, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getQueryParam(ExecutableElement, VariableElement, int) - Method in class net.oneandone.neberus.parse.MethodParser
 
getReferencedElement(Element, DocTree, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getRequiredStatus(ExecutableElement, VariableElement, int) - Method in class net.oneandone.neberus.parse.MethodParser
 
getResponseEntityClass(ExecutableElement, AnnotationMirror) - Method in class net.oneandone.neberus.parse.MethodParser
 
getRootPath(TypeElement) - Method in class net.oneandone.neberus.parse.MethodParser
 
getSimpleTypeName(TypeMirror, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getTags(ExecutableElement, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getTypeElements(DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getTypeString(TypeMirror, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getVisibleCtorParameters(ExecutableElement) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getVisibleFields(TypeMirror, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
getVisibleGetters(TypeMirror, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
GONE - net.oneandone.neberus.model.ApiStatus
410 Gone.

H

hasAnnotation(ExecutableElement, Class, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
hasAnnotation(ExecutableElement, String, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
hasAnnotation(ExecutableElement, VariableElement, Class, int, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
hasAnnotation(TypeElement, Class, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
hasDirectAnnotation(VariableElement, Class) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
hasDirectAnnotation(VariableElement, String) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
hashCode() - Method in class net.oneandone.neberus.Options
 
HEADER - net.oneandone.neberus.annotation.ApiParameter.Type
 
HEADER - net.oneandone.neberus.parse.RestMethodData.ParameterType
 
headerDefinitions - Variable in class net.oneandone.neberus.parse.RestClassData
Class scope defined headers that enable the reuse of the provided header description in the whole class
HeaderInfo() - Constructor for class net.oneandone.neberus.parse.RestMethodData.HeaderInfo
 
headers - Variable in class net.oneandone.neberus.parse.RestMethodData.ResponseData
 
headers() - Method in annotation type net.oneandone.neberus.annotation.ApiCommonResponse
Headers used in this response.
headers() - Method in annotation type net.oneandone.neberus.annotation.ApiResponse
Headers used in this response.
HTML - net.oneandone.neberus.Options.Markup
 
HTTP_VERSION_NOT_SUPPORTED - net.oneandone.neberus.model.ApiStatus
505 HTTP Version Not Supported.
httpMethod - Variable in class net.oneandone.neberus.parse.RestMethodData.MethodData
 
httpMethod - Variable in class net.oneandone.neberus.parse.RestUsecaseData.UsecaseMethodData
 
httpMethod() - Method in annotation type net.oneandone.neberus.annotation.ApiUsecaseMethod
HttpMethod to use with the provided path.

I

I_AM_A_TEAPOT - net.oneandone.neberus.model.ApiStatus
418 I'm a teapot.
id - Variable in class net.oneandone.neberus.parse.RestUsecaseData.UsecaseData
 
ignoreErrors - Variable in class net.oneandone.neberus.Options
 
IM_USED - net.oneandone.neberus.model.ApiStatus
226 IM Used.
INSUFFICIENT_SPACE_ON_RESOURCE - net.oneandone.neberus.model.ApiStatus
Deprecated.
INSUFFICIENT_STORAGE - net.oneandone.neberus.model.ApiStatus
507 Insufficient Storage
INTERNAL_SERVER_ERROR - net.oneandone.neberus.model.ApiStatus
500 Internal Server Error.
isArrayType(TypeMirror) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
isCollectionType(TypeMirror) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
isDocumentableSimpleType(TypeMirror, String) - Method in class net.oneandone.neberus.print.DocPrinter
 
isEnum(TypeMirror, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
isJavaType(TypeMirror, DocletEnvironment) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
isMapType(TypeMirror) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 
isRequired() - Method in class net.oneandone.neberus.parse.RestMethodData.HeaderInfo
 
isRequired() - Method in class net.oneandone.neberus.parse.RestMethodData.ParameterInfo
 

J

JACKSON_XML_ROOT_ELEMENT - Static variable in class net.oneandone.neberus.util.JavaDocUtils
 
JavaDocUtils - Class in net.oneandone.neberus.util
 

L

label - Variable in class net.oneandone.neberus.parse.RestClassData
 
label - Variable in class net.oneandone.neberus.parse.RestMethodData.MethodData
 
LENGTH_REQUIRED - net.oneandone.neberus.model.ApiStatus
411 Length Required.
linkedMethod - Variable in class net.oneandone.neberus.parse.RestUsecaseData.UsecaseMethodData
 
links - Variable in class net.oneandone.neberus.parse.RestMethodData.MethodData
 
listFiles(URL) - Static method in class net.oneandone.neberus.util.FileUtils
 
LOCKED - net.oneandone.neberus.model.ApiStatus
423 Locked.
LOOP_DETECTED - net.oneandone.neberus.model.ApiStatus
508 Loop Detected

M

MARKDOWN - net.oneandone.neberus.Options.Markup
 
MarkdownPrinter - Class in net.oneandone.neberus.print
 
MarkdownPrinter() - Constructor for class net.oneandone.neberus.print.MarkdownPrinter
 
markup - Variable in class net.oneandone.neberus.Options
 
mediaType - Variable in class net.oneandone.neberus.parse.RestMethodData.RequestData
 
merge(RestMethodData.ParameterInfo) - Method in class net.oneandone.neberus.parse.RestMethodData.ParameterInfo
 
METHOD_FAILURE - net.oneandone.neberus.model.ApiStatus
Deprecated.
METHOD_NOT_ALLOWED - net.oneandone.neberus.model.ApiStatus
405 Method Not Allowed.
methodData - Variable in class net.oneandone.neberus.parse.RestMethodData
 
MethodData(String) - Constructor for class net.oneandone.neberus.parse.RestMethodData.MethodData
 
methodDoc - Variable in class net.oneandone.neberus.parse.RestMethodData.MethodData
 
MethodParser - Class in net.oneandone.neberus.parse
Parses all stuff related to a single REST method.
MethodParser(Options) - Constructor for class net.oneandone.neberus.parse.MethodParser
 
methods - Variable in class net.oneandone.neberus.parse.RestClassData
 
methods - Variable in class net.oneandone.neberus.parse.RestUsecaseData.UsecaseData
 
methods() - Method in annotation type net.oneandone.neberus.annotation.ApiUsecase
The REST methods to be used for this usecase in order of definition.
modules - Variable in class net.oneandone.neberus.print.DocPrinter
 
MOVED_PERMANENTLY - net.oneandone.neberus.model.ApiStatus
301 Moved Permanently.
MOVED_TEMPORARILY - net.oneandone.neberus.model.ApiStatus
Deprecated.
in favor of ApiStatus.FOUND which will be returned from HttpStatus.valueOf(302)
MULTI_STATUS - net.oneandone.neberus.model.ApiStatus
207 Multi-Status.
MULTIPLE_CHOICES - net.oneandone.neberus.model.ApiStatus
300 Multiple Choices.

N

name - Variable in class net.oneandone.neberus.parse.RestMethodData.HeaderInfo
 
name - Variable in class net.oneandone.neberus.parse.RestMethodData.ParameterInfo
 
name - Variable in class net.oneandone.neberus.parse.RestUsecaseData.UsecaseData
 
name() - Method in annotation type net.oneandone.neberus.annotation.ApiHeader
Name of the header.
name() - Method in annotation type net.oneandone.neberus.annotation.ApiHeaderDefinition
Name of the header.
name() - Method in annotation type net.oneandone.neberus.annotation.ApiParameter
The name of the parameter.
name() - Method in annotation type net.oneandone.neberus.annotation.ApiUsecase
Name of the usecase.
name() - Method in annotation type net.oneandone.neberus.annotation.ApiUsecaseParam
Name of the parameter.
neberus.core - module neberus.core
 
NeberusModule - Class in net.oneandone.neberus
 
NeberusModule(ShortCodeExpander, Options) - Constructor for class net.oneandone.neberus.NeberusModule
 
NeberusPrinter - Class in net.oneandone.neberus.print
 
NeberusPrinter(Options) - Constructor for class net.oneandone.neberus.print.NeberusPrinter
 
nestedParameters - Variable in class net.oneandone.neberus.parse.RestMethodData.Entity
 
nestedParameters - Variable in class net.oneandone.neberus.parse.RestMethodData.ParameterInfo
 
net.oneandone.neberus - package net.oneandone.neberus
 
net.oneandone.neberus.annotation - package net.oneandone.neberus.annotation
 
net.oneandone.neberus.model - package net.oneandone.neberus.model
 
net.oneandone.neberus.parse - package net.oneandone.neberus.parse
 
net.oneandone.neberus.print - package net.oneandone.neberus.print
 
net.oneandone.neberus.print.openapiv3 - package net.oneandone.neberus.print.openapiv3
 
net.oneandone.neberus.shortcode - package net.oneandone.neberus.shortcode
 
net.oneandone.neberus.util - package net.oneandone.neberus.util
 
NETWORK_AUTHENTICATION_REQUIRED - net.oneandone.neberus.model.ApiStatus
511 Network Authentication Required.
NO_CONTENT - net.oneandone.neberus.model.ApiStatus
204 No Content.
NON_AUTHORITATIVE_INFORMATION - net.oneandone.neberus.model.ApiStatus
203 Non-Authoritative Information.
NOT_ACCEPTABLE - net.oneandone.neberus.model.ApiStatus
406 Not Acceptable.
NOT_EXTENDED - net.oneandone.neberus.model.ApiStatus
510 Not Extended
NOT_FOUND - net.oneandone.neberus.model.ApiStatus
404 Not Found.
NOT_IMPLEMENTED - net.oneandone.neberus.model.ApiStatus
501 Not Implemented.
NOT_MODIFIED - net.oneandone.neberus.model.ApiStatus
304 Not Modified.

O

OK - net.oneandone.neberus.model.ApiStatus
200 OK.
OpenApiV3JsonPrinter - Class in net.oneandone.neberus.print.openapiv3
 
OpenApiV3JsonPrinter(List<NeberusModule>, ShortCodeExpander, Options) - Constructor for class net.oneandone.neberus.print.openapiv3.OpenApiV3JsonPrinter
 
optional() - Method in annotation type net.oneandone.neberus.annotation.ApiHeader
If true, the header will be marked as optional, else as mandatory.
optional() - Method in annotation type net.oneandone.neberus.annotation.ApiParameter
If true, the parameter will be marked as optional, else as mandatory.
OPTIONAL - net.oneandone.neberus.parse.RequiredStatus
 
options - Variable in class net.oneandone.neberus.NeberusModule
 
options - Variable in class net.oneandone.neberus.parse.MethodParser
 
options - Variable in class net.oneandone.neberus.print.NeberusPrinter
 
Options - Class in net.oneandone.neberus
Options that may be specified for the doclet
Options() - Constructor for class net.oneandone.neberus.Options
 
Options.Markup - Enum in net.oneandone.neberus
 
outputDirectory - Variable in class net.oneandone.neberus.Options
 

P

ParameterInfo() - Constructor for class net.oneandone.neberus.parse.RestMethodData.ParameterInfo
 
parameters - Variable in class net.oneandone.neberus.parse.RestMethodData.RequestData
 
parameters - Variable in class net.oneandone.neberus.parse.RestUsecaseData.UsecaseMethodData
 
parameters() - Method in annotation type net.oneandone.neberus.annotation.ApiUsecaseMethod
Usage explanation of the parameters (header|query|path).
parameterType - Variable in class net.oneandone.neberus.parse.RestMethodData.ParameterInfo
 
parse(TypeElement) - Method in class net.oneandone.neberus.NeberusModule
 
parse(TypeElement) - Method in class net.oneandone.neberus.parse.ClassParser
 
parse(TypeElement, List<RestClassData>) - Method in class net.oneandone.neberus.parse.UsecaseParser
 
parseCustomParameterInfo(AnnotationMirror) - Method in class net.oneandone.neberus.parse.MethodParser
 
parseMethod(ExecutableElement, String) - Method in class net.oneandone.neberus.parse.MethodParser
 
parseParameter(ExecutableElement, VariableElement, Map<String, ParamTree>, int) - Method in class net.oneandone.neberus.parse.MethodParser
 
PARTIAL_CONTENT - net.oneandone.neberus.model.ApiStatus
206 Partial Content.
path - Variable in class net.oneandone.neberus.parse.RestMethodData.MethodData
 
path - Variable in class net.oneandone.neberus.parse.RestUsecaseData.UsecaseMethodData
 
path() - Method in annotation type net.oneandone.neberus.annotation.ApiUsecaseMethod
Path of the method to call.
PATH - net.oneandone.neberus.annotation.ApiParameter.Type
 
PATH - net.oneandone.neberus.parse.RestMethodData.ParameterType
 
PAYLOAD_TOO_LARGE - net.oneandone.neberus.model.ApiStatus
413 Payload Too Large.
PAYMENT_REQUIRED - net.oneandone.neberus.model.ApiStatus
402 Payment Required.
PERMANENT_REDIRECT - net.oneandone.neberus.model.ApiStatus
308 Permanent Redirect.
PRECONDITION_FAILED - net.oneandone.neberus.model.ApiStatus
412 Precondition failed.
PRECONDITION_REQUIRED - net.oneandone.neberus.model.ApiStatus
428 Precondition Required.
print() - Method in class net.oneandone.neberus.NeberusModule
 
print(String) - Method in class net.oneandone.neberus.print.AsciiDocPrinter
 
print(String) - Method in class net.oneandone.neberus.print.MarkdownPrinter
 
printCurl - Variable in class net.oneandone.neberus.parse.RestMethodData.MethodData
 
printIndexFile(List<RestClassData>, List<RestUsecaseData>, String) - Method in class net.oneandone.neberus.print.DocPrinter
 
printIndexFile(List<RestClassData>, List<RestUsecaseData>, String) - Method in class net.oneandone.neberus.print.openapiv3.OpenApiV3JsonPrinter
 
printRestClassFile(RestClassData, List<RestClassData>, List<RestUsecaseData>) - Method in class net.oneandone.neberus.print.DocPrinter
 
printRestClassFile(RestClassData, List<RestClassData>, List<RestUsecaseData>) - Method in class net.oneandone.neberus.print.openapiv3.OpenApiV3JsonPrinter
 
process(String) - Method in class net.oneandone.neberus.shortcode.ShortCode
 
PROCESSING - net.oneandone.neberus.model.ApiStatus
102 Processing.
PROXY_AUTHENTICATION_REQUIRED - net.oneandone.neberus.model.ApiStatus
407 Proxy Authentication Required.

Q

QUERY - net.oneandone.neberus.annotation.ApiParameter.Type
 
QUERY - net.oneandone.neberus.parse.RestMethodData.ParameterType
 

R

reasonPhrase - Variable in enum net.oneandone.neberus.model.ApiStatus
 
REQUEST_ENTITY_TOO_LARGE - net.oneandone.neberus.model.ApiStatus
Deprecated.
in favor of ApiStatus.PAYLOAD_TOO_LARGE which will be returned from HttpStatus.valueOf(413)
REQUEST_HEADER_FIELDS_TOO_LARGE - net.oneandone.neberus.model.ApiStatus
431 Request Header Fields Too Large.
REQUEST_TIMEOUT - net.oneandone.neberus.model.ApiStatus
408 Request Timeout.
REQUEST_URI_TOO_LONG - net.oneandone.neberus.model.ApiStatus
Deprecated.
in favor of ApiStatus.URI_TOO_LONG which will be returned from HttpStatus.valueOf(414)
requestBody - Variable in class net.oneandone.neberus.parse.RestUsecaseData.UsecaseMethodData
 
requestBody() - Method in annotation type net.oneandone.neberus.annotation.ApiUsecaseMethod
Custom example of the request body for the usecase.
requestData - Variable in class net.oneandone.neberus.parse.RestMethodData
 
RequestData() - Constructor for class net.oneandone.neberus.parse.RestMethodData.RequestData
 
REQUESTED_RANGE_NOT_SATISFIABLE - net.oneandone.neberus.model.ApiStatus
416 Requested Range Not Satisfiable.
required - Variable in class net.oneandone.neberus.parse.RestMethodData.HeaderInfo
 
required - Variable in class net.oneandone.neberus.parse.RestMethodData.ParameterInfo
 
REQUIRED - net.oneandone.neberus.parse.RequiredStatus
 
RequiredStatus - Enum in net.oneandone.neberus.parse
 
RESET_CONTENT - net.oneandone.neberus.model.ApiStatus
205 Reset Content.
responseBody - Variable in class net.oneandone.neberus.parse.RestUsecaseData.UsecaseMethodData
 
responseBody() - Method in annotation type net.oneandone.neberus.annotation.ApiUsecaseMethod
Custom example of the response body for the usecase.
responseData - Variable in class net.oneandone.neberus.parse.RestMethodData
 
ResponseData() - Constructor for class net.oneandone.neberus.parse.RestMethodData.ResponseData
 
responseValues - Variable in class net.oneandone.neberus.parse.RestMethodData
 
RestClassData - Class in net.oneandone.neberus.parse
Contains data belonging the REST service class.
RestClassData() - Constructor for class net.oneandone.neberus.parse.RestClassData
 
RestMethodData - Class in net.oneandone.neberus.parse
 
RestMethodData(String) - Constructor for class net.oneandone.neberus.parse.RestMethodData
 
RestMethodData.AllowedValue - Class in net.oneandone.neberus.parse
 
RestMethodData.Entity - Class in net.oneandone.neberus.parse
 
RestMethodData.Example - Class in net.oneandone.neberus.parse
 
RestMethodData.HeaderInfo - Class in net.oneandone.neberus.parse
 
RestMethodData.MethodData - Class in net.oneandone.neberus.parse
General method data.
RestMethodData.ParameterInfo - Class in net.oneandone.neberus.parse
 
RestMethodData.ParameterType - Enum in net.oneandone.neberus.parse
 
RestMethodData.RequestData - Class in net.oneandone.neberus.parse
Request related data
RestMethodData.ResponseData - Class in net.oneandone.neberus.parse
Response related data
RestUsecaseData - Class in net.oneandone.neberus.parse
 
RestUsecaseData() - Constructor for class net.oneandone.neberus.parse.RestUsecaseData
 
RestUsecaseData.UsecaseData - Class in net.oneandone.neberus.parse
 
RestUsecaseData.UsecaseMethodData - Class in net.oneandone.neberus.parse
 
RestUsecaseData.UsecaseValueInfo - Class in net.oneandone.neberus.parse
 

S

saveToFile(String, String, String) - Method in class net.oneandone.neberus.print.NeberusPrinter
 
scanPackages - Variable in class net.oneandone.neberus.Options
 
SEE_OTHER - net.oneandone.neberus.model.ApiStatus
303 See Other.
SERVICE_UNAVAILABLE - net.oneandone.neberus.model.ApiStatus
503 Service Unavailable.
ShortCode - Class in net.oneandone.neberus.shortcode
[[key][value]]
ShortCode() - Constructor for class net.oneandone.neberus.shortcode.ShortCode
 
ShortCodeExpander - Class in net.oneandone.neberus.shortcode
 
ShortCodeExpander() - Constructor for class net.oneandone.neberus.shortcode.ShortCodeExpander
 
shortDescription - Variable in class net.oneandone.neberus.parse.RestClassData
the value of an ApiDescription annotation on the class
skipParameter(ExecutableElement, VariableElement, int) - Method in class net.oneandone.neberus.parse.MethodParser
 
status - Variable in class net.oneandone.neberus.parse.RestMethodData.ResponseData
 
status() - Method in annotation type net.oneandone.neberus.annotation.ApiCommonResponse
Status of the response.
status() - Method in annotation type net.oneandone.neberus.annotation.ApiResponse
Status of the response.
SWITCHING_PROTOCOLS - net.oneandone.neberus.model.ApiStatus
101 Switching Protocols.

T

TEMPORARY_REDIRECT - net.oneandone.neberus.model.ApiStatus
307 Temporary Redirect.
title - Variable in class net.oneandone.neberus.parse.RestMethodData.Example
 
title() - Method in annotation type net.oneandone.neberus.annotation.ApiExample
Title or description of this example.
TITLE - Static variable in class net.oneandone.neberus.parse.MethodParser
 
TOO_MANY_REQUESTS - net.oneandone.neberus.model.ApiStatus
429 Too Many Requests.
toString() - Method in class net.oneandone.neberus.Options
 
toString() - Method in class net.oneandone.neberus.parse.RestClassData
 
toString() - Method in class net.oneandone.neberus.parse.RestMethodData.AllowedValue
 
toString() - Method in class net.oneandone.neberus.parse.RestMethodData.Entity
 
toString() - Method in class net.oneandone.neberus.parse.RestMethodData.Example
 
toString() - Method in class net.oneandone.neberus.parse.RestMethodData.HeaderInfo
 
toString() - Method in class net.oneandone.neberus.parse.RestMethodData.MethodData
 
toString() - Method in class net.oneandone.neberus.parse.RestMethodData.ParameterInfo
 
toString() - Method in class net.oneandone.neberus.parse.RestMethodData.RequestData
 
toString() - Method in class net.oneandone.neberus.parse.RestMethodData.ResponseData
 
toString() - Method in class net.oneandone.neberus.parse.RestMethodData
 
type() - Method in annotation type net.oneandone.neberus.annotation.ApiParameter
Define the type such as "path", "query" or "header".
TYPE - Static variable in class net.oneandone.neberus.parse.MethodParser
 
typeCantBeDocumented(TypeMirror, Options) - Static method in class net.oneandone.neberus.util.JavaDocUtils
 

U

UNAUTHORIZED - net.oneandone.neberus.model.ApiStatus
401 Unauthorized.
UNAVAILABLE_FOR_LEGAL_REASONS - net.oneandone.neberus.model.ApiStatus
451 Unavailable For Legal Reasons.
UNPROCESSABLE_ENTITY - net.oneandone.neberus.model.ApiStatus
422 Unprocessable Entity.
UNSET - net.oneandone.neberus.parse.RequiredStatus
 
UNSET - net.oneandone.neberus.parse.RestMethodData.ParameterType
 
UNSUPPORTED_MEDIA_TYPE - net.oneandone.neberus.model.ApiStatus
415 Unsupported Media Type.
UPGRADE_REQUIRED - net.oneandone.neberus.model.ApiStatus
426 Upgrade Required.
URI_TOO_LONG - net.oneandone.neberus.model.ApiStatus
414 URI Too Long.
USE_PROXY - net.oneandone.neberus.model.ApiStatus
Deprecated.
due to security concerns regarding in-band configuration of a proxy
UsecaseData(String) - Constructor for class net.oneandone.neberus.parse.RestUsecaseData.UsecaseData
 
UsecaseMethodData() - Constructor for class net.oneandone.neberus.parse.RestUsecaseData.UsecaseMethodData
 
UsecaseParser - Class in net.oneandone.neberus.parse
Parses usecase related things.
UsecaseParser(Options) - Constructor for class net.oneandone.neberus.parse.UsecaseParser
 
usecases - Variable in class net.oneandone.neberus.parse.RestUsecaseData
 
UsecaseValueInfo(String, String) - Constructor for class net.oneandone.neberus.parse.RestUsecaseData.UsecaseValueInfo
 

V

validate(boolean) - Method in class net.oneandone.neberus.parse.RestClassData
 
validate(boolean) - Method in class net.oneandone.neberus.parse.RestMethodData
 
validate(boolean) - Method in class net.oneandone.neberus.parse.RestUsecaseData
 
value - Variable in enum net.oneandone.neberus.model.ApiStatus
 
value - Variable in class net.oneandone.neberus.parse.RestMethodData.AllowedValue
 
value - Variable in class net.oneandone.neberus.parse.RestMethodData.Example
 
value - Variable in class net.oneandone.neberus.parse.RestUsecaseData.UsecaseValueInfo
 
value() - Method in annotation type net.oneandone.neberus.annotation.ApiAllowedValue
The exact allowed values for this parameter.
value() - Method in annotation type net.oneandone.neberus.annotation.ApiAllowedValues
 
value() - Method in annotation type net.oneandone.neberus.annotation.ApiCommonResponses
 
value() - Method in annotation type net.oneandone.neberus.annotation.ApiCurl
If provided, this will be included in the documentation and no curl will be generated.
value() - Method in annotation type net.oneandone.neberus.annotation.ApiDescription
 
value() - Method in annotation type net.oneandone.neberus.annotation.ApiExample
The actual example value.
value() - Method in annotation type net.oneandone.neberus.annotation.ApiHeaderDefinitions
 
value() - Method in annotation type net.oneandone.neberus.annotation.ApiHeaders
 
value() - Method in annotation type net.oneandone.neberus.annotation.ApiLabel
 
value() - Method in annotation type net.oneandone.neberus.annotation.ApiParameters
 
value() - Method in annotation type net.oneandone.neberus.annotation.ApiRequestEntities
 
value() - Method in annotation type net.oneandone.neberus.annotation.ApiResponses
 
value() - Method in annotation type net.oneandone.neberus.annotation.ApiType
The type to be displayed instead.
value() - Method in annotation type net.oneandone.neberus.annotation.ApiUsecaseParam
Exact value to use.
value() - Method in annotation type net.oneandone.neberus.annotation.ApiUsecaseRequestBody
Exact returned value.
value() - Method in annotation type net.oneandone.neberus.annotation.ApiUsecaseResponseBody
Exact returned value.
value() - Method in annotation type net.oneandone.neberus.annotation.ApiUsecases
 
VALUE - Static variable in class net.oneandone.neberus.parse.MethodParser
 
VALUE_HINT - Static variable in class net.oneandone.neberus.parse.MethodParser
 
valueHint - Variable in class net.oneandone.neberus.parse.RestMethodData.AllowedValue
 
valueHint - Variable in class net.oneandone.neberus.parse.RestUsecaseData.UsecaseValueInfo
 
valueHint() - Method in annotation type net.oneandone.neberus.annotation.ApiAllowedValue
Hint about the allowed values.
valueHint() - Method in annotation type net.oneandone.neberus.annotation.ApiUsecaseParam
Hint about the value to be used.
valueHint() - Method in annotation type net.oneandone.neberus.annotation.ApiUsecaseRequestBody
Hint about the value to be used.
valueHint() - Method in annotation type net.oneandone.neberus.annotation.ApiUsecaseResponseBody
Hint about the value to be used.
valueOf(int) - Static method in enum net.oneandone.neberus.model.ApiStatus
Return the enum constant of this type with the specified numeric value.
valueOf(String) - Static method in enum net.oneandone.neberus.annotation.ApiParameter.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.oneandone.neberus.model.ApiStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.oneandone.neberus.Options.Markup
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.oneandone.neberus.parse.RequiredStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.oneandone.neberus.parse.RestMethodData.ParameterType
Returns the enum constant of this type with the specified name.
values() - Static method in enum net.oneandone.neberus.annotation.ApiParameter.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.oneandone.neberus.model.ApiStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.oneandone.neberus.Options.Markup
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.oneandone.neberus.parse.RequiredStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.oneandone.neberus.parse.RestMethodData.ParameterType
Returns an array containing the constants of this enum type, in the order they are declared.
VARIANT_ALSO_NEGOTIATES - net.oneandone.neberus.model.ApiStatus
506 Variant Also Negotiates

X

XML_ROOT_ELEMENT - Static variable in class net.oneandone.neberus.util.JavaDocUtils
 
XML_TRANSIENT - Static variable in class net.oneandone.neberus.util.JavaDocUtils
 
A B C D E F G H I J L M N O P Q R S T U V X 
All Classes All Packages