Commit a0eb37a2 authored by Vibhuti Sharma [Microsoft]'s avatar Vibhuti Sharma [Microsoft]
Browse files

writing better comments

parent d4d2ed2c
Pipeline #20093 failed with stages
in 2 minutes and 11 seconds
......@@ -6,7 +6,7 @@ import java.util.Map;
import java.util.concurrent.Callable;
/**
* Implementing Callable such that it is MDC Aware.
* Implementing a custom Callable such that it is MDC Aware.
* @param <V>
*/
public class MDCAwareCallable<V> implements Callable<V> {
......
......@@ -14,14 +14,15 @@ import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeoutException;
/**
*
* An ExecutorService implementation that uses a delegate of ExecutorService provided by the caller,
* along with a custom Callable instance.
*/
public class MDCAwareExecutorService implements ExecutorService {
private ExecutorService delegate;
/**
* Constructor.
* Constructor which received delegate for ExecutorService.
* @param executorServiceDelegate this is a parameter.
*/
public MDCAwareExecutorService(final ExecutorService executorServiceDelegate) {
......@@ -29,7 +30,7 @@ public class MDCAwareExecutorService implements ExecutorService {
}
/**
* Javadoc.
* Calling the shutdown() method of delegate.
*/
@Override
public void shutdown() {
......@@ -37,7 +38,7 @@ public class MDCAwareExecutorService implements ExecutorService {
}
/**
* Javadoc.
* Calling the shutdownNow() method of delegate.
* @return
*/
@NotNull
......@@ -47,7 +48,7 @@ public class MDCAwareExecutorService implements ExecutorService {
}
/**
* Javadoc.
* Calling the isShutdown() method of delegate.
* @return
*/
@Override
......@@ -56,7 +57,7 @@ public class MDCAwareExecutorService implements ExecutorService {
}
/**
* Javadoc.
* Calling the isTerminated() method of delegate.
* @return
*/
@Override
......@@ -65,7 +66,7 @@ public class MDCAwareExecutorService implements ExecutorService {
}
/**
* Javadoc.
* Calling the awaitTermination() method of delegate.
* @param timeout
* @param unit
* @return
......@@ -77,7 +78,7 @@ public class MDCAwareExecutorService implements ExecutorService {
}
/**
* Javadoc.
* Calling the submit() method of delegate.
* @param task
* @param <T>
* @return
......@@ -89,7 +90,7 @@ public class MDCAwareExecutorService implements ExecutorService {
}
/**
* Javadoc.
* Calling the submit() method of delegate.
* @param task
* @param result
* @param <T>
......@@ -102,7 +103,7 @@ public class MDCAwareExecutorService implements ExecutorService {
}
/**
* Javadoc.
* Calling the submit() method of delegate.
* @param task
* @return
*/
......@@ -113,7 +114,7 @@ public class MDCAwareExecutorService implements ExecutorService {
}
/**
* Javadoc.
* Calling the invokeAll() method of delegate.
* @param tasks
* @param <T>
* @return
......@@ -132,7 +133,7 @@ public class MDCAwareExecutorService implements ExecutorService {
}
/**
* Javadoc.
* Calling the invokeAll() method of delegate.
* @param tasks
* @param timeout
* @param unit
......@@ -153,7 +154,7 @@ public class MDCAwareExecutorService implements ExecutorService {
}
/**
* Javadoc.
* Calling the invokeAny() method of delegate.
* @param tasks
* @param <T>
* @return
......@@ -174,7 +175,7 @@ public class MDCAwareExecutorService implements ExecutorService {
}
/**
* Javadoc.
* Calling the invokeAny() method of delegate.
* @param tasks
* @param timeout
* @param unit
......@@ -196,7 +197,7 @@ public class MDCAwareExecutorService implements ExecutorService {
}
/**
* Javadoc.
* Calling the execute() method of delegate.
* @param command
*/
@Override
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment