Skip to content

Commit

Permalink
[RESTEASY-2055] Fixed Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
jurakp authored and asoldano committed Jan 22, 2019
1 parent eb1bc8b commit 0d38263
Show file tree
Hide file tree
Showing 8 changed files with 22 additions and 5 deletions.
Expand Up @@ -46,7 +46,7 @@ public boolean isMapperExecuted()
* of exception.
*
* @param exception exception
* @return response
* @return response response object
*/
@SuppressWarnings(value = "unchecked")
public Response executeExactExceptionMapper(Throwable exception)
Expand Down Expand Up @@ -84,6 +84,7 @@ protected Response handleApplicationException(HttpRequest request, ApplicationEx
* Execute an ExceptionMapper if one exists for the given exception. Recurse to base class if not found.
*
* @param exception exception
* @param logger logger
* @return true if an ExceptionMapper was found and executed
*/
@SuppressWarnings(value = "unchecked")
Expand Down
Expand Up @@ -42,10 +42,11 @@ public Object inject(HttpRequest request, HttpResponse response)
}

/**
* Calls the super {@link #inject(org.jboss.resteasy.spi.HttpRequest, org.jboss.resteasy.spi.HttpResponse)} method.
* Calls the super {@link #inject(org.jboss.resteasy.spi.HttpRequest, org.jboss.resteasy.spi.HttpResponse, boolean)} method.
* @param prefix prefix
* @param request http request
* @param response http response
* @param unwrapAsync unwrap async
* @return injector instance
*/
protected Object doInject(String prefix, HttpRequest request, HttpResponse response)
Expand Down
Expand Up @@ -13,6 +13,7 @@ public interface ValueInjector
* Inject outside the context of an HTTP request. For instance, a singleton may have proxiable and injectable
* jax-rs objects like Request, UriInfo, or HttpHeaders.
*
* @param unwrapAsync unwrap async
* @return object
*/
Object inject();
Expand All @@ -22,6 +23,7 @@ public interface ValueInjector
*
* @param request http request
* @param response http response
* @param unwrapAsync unwrap async
* @return object
*/
Object inject(HttpRequest request, HttpResponse response);
Expand Down
Expand Up @@ -10,7 +10,7 @@ public interface ConstructorInjector
{
/**
* Construct outside the scope of an HTTP request. Useful for singleton factories.
*
* @param unwrapAsync unwrap async
* @return constructed object
*/
Object construct();
Expand All @@ -20,6 +20,7 @@ public interface ConstructorInjector
*
* @param request http request
* @param response http response
* @param unwrapAsync unwrap async
* @return constructed object
* @throws Failure if failure occurred
* @throws WebApplicationException if application exception occurred
Expand All @@ -32,6 +33,7 @@ public interface ConstructorInjector
* in cases where the resource factory wants to allocate the object itself, but wants resteasy to populate
* the arguments.
*
* @param unwrapAsync unwrap async
* @return array of arguments
*/
Object[] injectableArguments();
Expand All @@ -43,6 +45,7 @@ public interface ConstructorInjector
*
* @param request http request
* @param response http response
* @param unwrapAsync unwrap async
* @return array of arguments
* @throws Failure if failure occurred
*/
Expand Down
Expand Up @@ -13,6 +13,8 @@ public interface PropertyInjector
* This method should only be used outside the scope of an HTTP request.
*
* @param target target object
* @param unwrapAsync unwrap async
* @return {@link CompletionStage}
*/
void inject(Object target);

Expand All @@ -23,7 +25,10 @@ public interface PropertyInjector
* @param request http request
* @param response http response
* @param target target object
* @param unwrapAsync unwrap async
* @return {@link CompletionStage}
* @throws Failure if application failure occurred
* @throws WebApplicationException if application exception occurred
*/
void inject(HttpRequest request, HttpResponse response, Object target) throws Failure, WebApplicationException, ApplicationException;
}
Expand Up @@ -10,7 +10,6 @@
*
* @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
* @version $Revision: 1 $
* @see StringConverter
* @see org.jboss.resteasy.annotations.StringParameterUnmarshallerBinder
*/
public interface StringParameterUnmarshaller<T>
Expand Down
Expand Up @@ -740,6 +740,7 @@ public ResourceClassBuilder buildSetter()
* Register a new {@link ResourceClassProcessor} which will be used to post-process all
* {@link ResourceClass} instances created from the builder.
* @param processor resource class processor
* @param priority processor priority
*/
public void registerResourceClassProcessor(ResourceClassProcessor processor, int priority)
{
Expand Down
Expand Up @@ -292,7 +292,12 @@ public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
}

/**
* process a single @Provider or a single resource.
* Process a single @Provider or a single resource.
* @param beanFactory bean factory
* @param dependsOnProviders dependent providers list
* @param name bean name
* @param beanDef bean definition
* @return bean class
*/
protected Class<?> processBean(final ConfigurableListableBeanFactory beanFactory,
List<String> dependsOnProviders, String name, BeanDefinition beanDef)
Expand Down

0 comments on commit 0d38263

Please sign in to comment.