Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixing javadoc #156

Merged
merged 1 commit into from
Feb 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -702,6 +702,8 @@ public static TextMessage request(final String queueName, final String body, fin
/**
* @param txt the message to encrypt
* @throws CryptoException on crypto errors
* @throws InfrastructureException on infrastructure exception
* @return if message is secure
*/
public static boolean isMessageSecure(final TextMessage txt) throws CryptoException, InfrastructureException {
try {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ protected ADaemonMessageHandler(final Collection<Class<? extends IDaemonHandler>
* Create a new request handler.
*
* @return ADaemonHandler
* @param registryEntry
* @param registryEntry the registry entry
*/
protected abstract IDaemonHandler createRequestHandler(RegistryEntry registryEntry);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public abstract class ADaemonProxyFactory implements IDaemonProxyFactory {
* @param uuid Universally unique identifier of the request
* @param queue Queue name
* @param request Request IVO
* @param responseClazz
* @param responseClazz the response class
* @param timeout maximum time to wait
* @param unit time unit of the timeout argument
* @param secure Secure (encrypted communication)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Expand All @@ -37,7 +37,7 @@ public interface IDaemonRequestResponse {
* @param uuid Universally unique identifier of the request
* @param queue Queue name
* @param request Request IVO
* @param responseClazz
* @param responseClazz the response class
* @param <R> Response type
* @return Response IVO
* @throws ExecutionException If the requests fails
Expand All @@ -48,7 +48,7 @@ public interface IDaemonRequestResponse {
* @param uuid Universally unique identifier of the request
* @param queue Queue name
* @param request Request IVO
* @param responseClazz
* @param responseClazz the response class
* @param timeout maximum time to wait
* @param unit time unit of the timeout argument
* @param <R> Response type
Expand All @@ -61,7 +61,7 @@ public interface IDaemonRequestResponse {
* @param uuid Universally unique identifier of the request
* @param queue Queue name
* @param request Request IVO
* @param responseClazz
* @param responseClazz the response class
* @param timeout maximum time to wait
* @param unit time unit of the timeout argument
* @param secure Secure (encrypted communication)
Expand All @@ -75,7 +75,7 @@ public interface IDaemonRequestResponse {
* @param uuid Universally unique identifier of the request
* @param queue Queue name
* @param request Request IVO
* @param responseClazz
* @param responseClazz the response class
* @param <R> Response type
* @return Response IVO
*/
Expand All @@ -85,7 +85,7 @@ public interface IDaemonRequestResponse {
* @param uuid Universally unique identifier of the request
* @param queue Queue name
* @param request Request IVO
* @param responseClazz
* @param responseClazz the response class
* @param timeout maximum time to wait
* @param unit time unit of the timeout argument
* @param <R> Response type
Expand All @@ -97,7 +97,7 @@ public interface IDaemonRequestResponse {
* @param uuid Universally unique identifier of the request
* @param queue Queue name
* @param request Request IVO
* @param responseClazz
* @param responseClazz the response class
* @param timeout maximum time to wait
* @param unit time unit of the timeout argument
* @param secure Secure (encrypted communication)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@

/**
* You can give me a Request-IVO and an IDaemon interface and I will get all the pages for that request as an Iterable if the result is an
* IVOQueryResultIVO_v1<E extends IVO>. Be sure to type me according to the return of the Daemon otherwise I will produce a class cast
* IVOQueryResultIVO_v1. Be sure to type me according to the return of the Daemon otherwise I will produce a class cast
* exception at runtime.<br>
* New Pages are fetched on hasNext() call so be prepared that a call to hasNext() will block all this.limit items for a while.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@
public class GeneratorHelper {

/**
* @param log the logger
* @param model the generator model
* @param targetDir the target path for generation
* @throws MojoExecutionException on errors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ public class InterfaceIVOModel extends AbstractIVOModel {
/**
* @param definition the definition
* @param logger the logger
* @param additionalMemberHandlers the additional member handlers
*/
public InterfaceIVOModel(IVODef definition, Log logger, IAdditionalMemberHandler... additionalMemberHandlers) {
super(additionalMemberHandlers);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ public static String toJson(InterconnectObject object) throws IOException {
* Returns a clone of the given object using JSON (de)serialization.
*
* @param object the object to be cloned
* @param <T> the cloned object class name
* @return a clone of this object.
* @throws JsonGenerationException if the JSON data could not be generated
* @throws JsonMappingException if the object could not be mapped to a JSON string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ public interface IDaemon {
/**
* @param req {@link PingIVO}
* @return {@link PongIVO}
* @throws DaemonError the daemon error
*/
@DaemonRequestMethod(idempotent = true)
PongIVO alive(PingIVO req) throws DaemonError;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -153,18 +153,18 @@ public void receive(UUID uuid, String queue, InterconnectObject request) {
public interface RequestMockHandler {

/**
* @param <R>
* @param uuid
* @param ico
* @param responseClazz
* @param <R> response class type
* @param uuid the uuid
* @param ico the interconnect object
* @param responseClazz the response class
* @return the response
* @throws DaemonError
* @throws DaemonError if deamon error
*/
<R> R handle(UUID uuid, InterconnectObject ico, Class<R> responseClazz) throws DaemonError;

/**
* @param uuid
* @param ico
* @param uuid the uuid
* @param ico the interconnect object
*/
void handle(UUID uuid, InterconnectObject ico);

Expand Down
Loading