A C D E F G H I J K L M N O P R S T U V

A

addDocumentationDescriptor(String, DocumentationDescriptor) - Method in class ar.com.jmfsg.documentation.DocumentationLoader

addDocumentationListener(DocumentationListener) - Method in class ar.com.jmfsg.documentation.DocumentationLoader

afterPropertiesSet() - Method in class ar.com.jmfsg.documentation.controller.DocumentationController

afterPropertiesSet() - Method in class ar.com.jmfsg.documentation.DocumentationLoader

ar.com.jmfsg.documentation - package ar.com.jmfsg.documentation

ar.com.jmfsg.documentation.annotation - package ar.com.jmfsg.documentation.annotation

ar.com.jmfsg.documentation.controller - package ar.com.jmfsg.documentation.controller

ar.com.jmfsg.documentation.model - package ar.com.jmfsg.documentation.model

ar.com.jmfsg.documentation.support - package ar.com.jmfsg.documentation.support

C

children - Variable in class ar.com.jmfsg.documentation.model.Field

Sub elements of this field.

clear() - Method in class ar.com.jmfsg.documentation.model.RequestMethods

color - Variable in class ar.com.jmfsg.documentation.model.Tag

HTML Background color for the tag.

containsKey(Object) - Method in class ar.com.jmfsg.documentation.model.RequestMethods

containsValue(Object) - Method in class ar.com.jmfsg.documentation.model.RequestMethods

D

data - Variable in class ar.com.jmfsg.documentation.support.MethodHolder

defaultValue - Variable in class ar.com.jmfsg.documentation.model.Field

Only valid for options and filters.
The value that is taken by default if none sent.

description - Variable in class ar.com.jmfsg.documentation.model.DictionaryEntry

Description to expand in the documentation when the key is found on an item and no custom description is provided.

description - Variable in class ar.com.jmfsg.documentation.model.Field

Description that will be shown in the method documentation page

description - Variable in class ar.com.jmfsg.documentation.model.Method

The description of the method that will appear on the main page

dictionary - Variable in class ar.com.jmfsg.documentation.model.Documentation

Globally defined dictionary.

DictionaryEntry - Class in ar.com.jmfsg.documentation.model

DictionaryEntry() - Constructor for class ar.com.jmfsg.documentation.model.DictionaryEntry

Documentation - Annotation Type in ar.com.jmfsg.documentation.annotation

Documentation - Class in ar.com.jmfsg.documentation.model

The Root of the Documentation hierarchy

Documentation() - Constructor for class ar.com.jmfsg.documentation.model.Documentation

documentationChanged(DocumentationLoader) - Method in class ar.com.jmfsg.documentation.controller.DocumentationController

documentationChanged(DocumentationLoader) - Method in interface ar.com.jmfsg.documentation.DocumentationListener

DocumentationController - Class in ar.com.jmfsg.documentation.controller

Controller mapping /docs/**

DocumentationController() - Constructor for class ar.com.jmfsg.documentation.controller.DocumentationController

DocumentationDescriptor - Class in ar.com.jmfsg.documentation

This descriptor is used to specify the documentation resource location.

DocumentationDescriptor() - Constructor for class ar.com.jmfsg.documentation.DocumentationDescriptor

DocumentationListener - Interface in ar.com.jmfsg.documentation

DocumentationLoader - Class in ar.com.jmfsg.documentation

Loads all DocumentationDescriptor with the actual documentation information.

DocumentationLoader() - Constructor for class ar.com.jmfsg.documentation.DocumentationLoader

E

entrySet() - Method in class ar.com.jmfsg.documentation.model.RequestMethods

extraInfo - Variable in class ar.com.jmfsg.documentation.model.Group

Page for documentation extra Info

F

facets - Variable in class ar.com.jmfsg.documentation.model.Request

Service Facets.
A Facet is like a filter, but they are returned with the service with a count that represents the amount of items that will be returned once the facet is applied.

Field - Class in ar.com.jmfsg.documentation.model

Field() - Constructor for class ar.com.jmfsg.documentation.model.Field

filters - Variable in class ar.com.jmfsg.documentation.model.Request

Service filters

friendlyName - Variable in class ar.com.jmfsg.documentation.model.Method

Friendly name is used to generate the key of the documentation page.

G

general - Variable in class ar.com.jmfsg.documentation.model.Documentation

General Documentation for the application

General - Class in ar.com.jmfsg.documentation.model

General() - Constructor for class ar.com.jmfsg.documentation.model.General

get(Object) - Method in class ar.com.jmfsg.documentation.model.RequestMethods

getChildren() - Method in class ar.com.jmfsg.documentation.model.Field

getColor() - Method in class ar.com.jmfsg.documentation.model.Tag

getData() - Method in class ar.com.jmfsg.documentation.support.MethodHolder

getDefaultValue() - Method in class ar.com.jmfsg.documentation.model.Field

getDescription() - Method in class ar.com.jmfsg.documentation.model.Field

getDescription() - Method in class ar.com.jmfsg.documentation.model.Method

getDetail(String) - Method in class ar.com.jmfsg.documentation.controller.DocumentationController

getDictionary() - Method in class ar.com.jmfsg.documentation.DocumentationLoader

getDocumentation() - Method in class ar.com.jmfsg.documentation.DocumentationLoader

getDocumentationForModule(String) - Method in class ar.com.jmfsg.documentation.DocumentationLoader

getDocumentationLoader() - Method in class ar.com.jmfsg.documentation.controller.DocumentationController

getFacets() - Method in class ar.com.jmfsg.documentation.model.Request

getFavicon() - Method in class ar.com.jmfsg.documentation.controller.DocumentationController

getFilters() - Method in class ar.com.jmfsg.documentation.model.Request

getFriendlyName() - Method in class ar.com.jmfsg.documentation.model.Method

getGeneral() - Method in class ar.com.jmfsg.documentation.DocumentationLoader

getGroup() - Method in class ar.com.jmfsg.documentation.model.Method

getGroups() - Method in class ar.com.jmfsg.documentation.DocumentationLoader

getHeaderImageSize() - Method in class ar.com.jmfsg.documentation.model.General

getHeaderImageUrl() - Method in class ar.com.jmfsg.documentation.model.General

getIndex() - Method in class ar.com.jmfsg.documentation.controller.DocumentationController

getIsList() - Method in class ar.com.jmfsg.documentation.model.Field

getLongDescription() - Method in class ar.com.jmfsg.documentation.model.General

getLongDescription() - Method in class ar.com.jmfsg.documentation.model.Method

getMethod() - Method in class ar.com.jmfsg.documentation.model.Method

getMethodSummary() - Method in class ar.com.jmfsg.documentation.model.General

getModulePrefix() - Method in class ar.com.jmfsg.documentation.DocumentationDescriptor

getName() - Method in class ar.com.jmfsg.documentation.model.Field

getName() - Method in class ar.com.jmfsg.documentation.model.Tag

getOptions() - Method in class ar.com.jmfsg.documentation.model.Request

getOrder() - Method in class ar.com.jmfsg.documentation.model.Method

getPackagesToScan() - Method in class ar.com.jmfsg.documentation.DocumentationDescriptor

getPage(String) - Method in class ar.com.jmfsg.documentation.controller.DocumentationController

getPaginable() - Method in class ar.com.jmfsg.documentation.model.Request

getParameters() - Method in class ar.com.jmfsg.documentation.model.Request

getPossibleValues() - Method in class ar.com.jmfsg.documentation.model.Sortable

getProjectName() - Method in class ar.com.jmfsg.documentation.model.General

getProjectSummary() - Method in class ar.com.jmfsg.documentation.model.General

getRaw(HttpServletResponse, String) - Method in class ar.com.jmfsg.documentation.controller.DocumentationController

getRawDoc() - Method in class ar.com.jmfsg.documentation.DocumentationLoader

getRequest() - Method in class ar.com.jmfsg.documentation.model.Method

getRequestMapping() - Method in class ar.com.jmfsg.documentation.model.Method

getResource() - Method in class ar.com.jmfsg.documentation.DocumentationDescriptor

getResponse() - Method in class ar.com.jmfsg.documentation.model.Method

getResponseIsList() - Method in class ar.com.jmfsg.documentation.model.Method

getResponseSummary() - Method in class ar.com.jmfsg.documentation.model.Method

getShortName() - Method in class ar.com.jmfsg.documentation.model.Method

getSortable() - Method in class ar.com.jmfsg.documentation.model.Request

getSubGroup() - Method in class ar.com.jmfsg.documentation.model.Method

getSupport() - Method in class ar.com.jmfsg.documentation.support.MethodHolder

getTags() - Method in class ar.com.jmfsg.documentation.DocumentationLoader

getTags() - Method in class ar.com.jmfsg.documentation.model.Method

getTitle() - Method in class ar.com.jmfsg.documentation.model.Tag

getTwitterUsername() - Method in class ar.com.jmfsg.documentation.model.General

getType() - Method in class ar.com.jmfsg.documentation.model.Field

getVectorized() - Method in class ar.com.jmfsg.documentation.model.Field

Group - Class in ar.com.jmfsg.documentation.model

Group() - Constructor for class ar.com.jmfsg.documentation.model.Group

group - Variable in class ar.com.jmfsg.documentation.model.Method

The group to which this service belongs

groups - Variable in class ar.com.jmfsg.documentation.model.Documentation

Group specific documentation

H

hasDocumentationDescriptor(String) - Method in class ar.com.jmfsg.documentation.DocumentationLoader

headerImageSize - Variable in class ar.com.jmfsg.documentation.model.General

headerImageUrl - Variable in class ar.com.jmfsg.documentation.model.General

Header Image url.

I

isEmpty() - Method in class ar.com.jmfsg.documentation.model.RequestMethods

isList - Variable in class ar.com.jmfsg.documentation.model.Field

If it has children, wether the object returned is a list or a sinlge item.

J

jsonResult(Model) - Method in class ar.com.jmfsg.documentation.controller.DocumentationController

K

key - Variable in class ar.com.jmfsg.documentation.model.DictionaryEntry

Element key.

keySet() - Method in class ar.com.jmfsg.documentation.model.RequestMethods

L

longDescription - Variable in class ar.com.jmfsg.documentation.model.General

Main application description

longDescription - Variable in class ar.com.jmfsg.documentation.model.Method

The description of the method that will appear on the method documentation page.
If the longDescription is null, the description will be used in the method documentation page

M

Method - Class in ar.com.jmfsg.documentation.model

Method() - Constructor for class ar.com.jmfsg.documentation.model.Method

method - Variable in class ar.com.jmfsg.documentation.model.Method

Http method or methods of the service [GET|PUT|POST|DELETE|...]
Supports a single String with the Http method or a Map containing the method as key and the requestMapping for that method as value, for example

MethodHolder - Class in ar.com.jmfsg.documentation.support

MethodHolder() - Constructor for class ar.com.jmfsg.documentation.support.MethodHolder

MethodHolder(Method, Map) - Constructor for class ar.com.jmfsg.documentation.support.MethodHolder

methods - Variable in class ar.com.jmfsg.documentation.model.Documentation

List of Method|methods that are available throught this application

methodSummary - Variable in class ar.com.jmfsg.documentation.model.General

Technical summary of the methods.

N

name - Variable in class ar.com.jmfsg.documentation.model.Field

The name of the field

name - Variable in class ar.com.jmfsg.documentation.model.Tag

The name of the tag, this is used both for referencing the tag to use it, and to show to the end user in the documentation

normalizeDocumentationData(Map<String, List<Method>>, Map<String, Group>, Map<String, Map<String, Object>>, Map<String, Method>) - Static method in class ar.com.jmfsg.documentation.support.Utils

O

obtainMethodName(Method) - Static method in class ar.com.jmfsg.documentation.support.Utils

options - Variable in class ar.com.jmfsg.documentation.model.Request

Options that modify the response.

order - Variable in class ar.com.jmfsg.documentation.model.Method

Order in which this method should be shown in the main documentation page.

P

paginable - Variable in class ar.com.jmfsg.documentation.model.Request

Whether the method is paginable, if true, it will automatically add the required fields.

parameters - Variable in class ar.com.jmfsg.documentation.model.Request

Method request parameters.

possibleValues - Variable in class ar.com.jmfsg.documentation.model.Sortable

projectName - Variable in class ar.com.jmfsg.documentation.model.General

Application name as it should appear in the documentation page Header and title

projectSummary - Variable in class ar.com.jmfsg.documentation.model.General

Technical summary of the application, if needed.

put(String, String) - Method in class ar.com.jmfsg.documentation.model.RequestMethods

putAll(Map<? extends String, ? extends String>) - Method in class ar.com.jmfsg.documentation.model.RequestMethods

R

readAll(Resource) - Static method in class ar.com.jmfsg.documentation.DocumentationLoader

remove(Object) - Method in class ar.com.jmfsg.documentation.model.RequestMethods

request - Variable in class ar.com.jmfsg.documentation.model.Method

All info regarding input for the service

Request - Class in ar.com.jmfsg.documentation.model

Request() - Constructor for class ar.com.jmfsg.documentation.model.Request

requestMapping - Variable in class ar.com.jmfsg.documentation.model.Method

Method request mapping (relative to the documentation context)

RequestMethods - Class in ar.com.jmfsg.documentation.model

RequestMethods() - Constructor for class ar.com.jmfsg.documentation.model.RequestMethods

RequestMethods(String) - Constructor for class ar.com.jmfsg.documentation.model.RequestMethods

RequestMethods(Map<String, String>) - Constructor for class ar.com.jmfsg.documentation.model.RequestMethods

response - Variable in class ar.com.jmfsg.documentation.model.Method

List of fields returned as a response item.

responseIsList - Variable in class ar.com.jmfsg.documentation.model.Method

Wheter the expected response is a list or a single object.

responseSummary - Variable in class ar.com.jmfsg.documentation.model.Method

List of fields that represents a Summary of the response.

S

setApplicationContext(ApplicationContext) - Method in class ar.com.jmfsg.documentation.DocumentationLoader

setDocumentationLoader(DocumentationLoader) - Method in class ar.com.jmfsg.documentation.controller.DocumentationController

setModulePrefix(String) - Method in class ar.com.jmfsg.documentation.DocumentationDescriptor

setPackagesToScan(List<String>) - Method in class ar.com.jmfsg.documentation.DocumentationDescriptor

setResource(Resource) - Method in class ar.com.jmfsg.documentation.DocumentationDescriptor

shortName - Variable in class ar.com.jmfsg.documentation.model.Method

Label to show in the index page instead of the requestMapping.

size() - Method in class ar.com.jmfsg.documentation.model.RequestMethods

sortable - Variable in class ar.com.jmfsg.documentation.model.Request

Whether it is sortable or not and by which fields it can be sorted.

Sortable - Class in ar.com.jmfsg.documentation.model

Sortable() - Constructor for class ar.com.jmfsg.documentation.model.Sortable

subGroup - Variable in class ar.com.jmfsg.documentation.model.Method

The subgroup to which this service belongs.

support - Variable in class ar.com.jmfsg.documentation.support.MethodHolder

T

Tag - Class in ar.com.jmfsg.documentation.model

Tag() - Constructor for class ar.com.jmfsg.documentation.model.Tag

tags - Variable in class ar.com.jmfsg.documentation.model.Documentation

Globally defined tags that can be applied to the methods

tags - Variable in class ar.com.jmfsg.documentation.model.Method

List of Tag names that should be applied to this method

title - Variable in class ar.com.jmfsg.documentation.model.Tag

Long description for what the tag means.
It will be shown on hovering over the tag.

twitterUsername - Variable in class ar.com.jmfsg.documentation.model.General

If avaiable, twitter username to set in the documentation page.

type - Variable in class ar.com.jmfsg.documentation.model.Field

The type of the method.

U

Utils - Class in ar.com.jmfsg.documentation.support

Utils() - Constructor for class ar.com.jmfsg.documentation.support.Utils

V

values() - Method in class ar.com.jmfsg.documentation.model.RequestMethods

vectorized - Variable in class ar.com.jmfsg.documentation.model.Field

Only valid for parameters.

A C D E F G H I J K L M N O P R S T U V