jmeter-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From fschumac...@apache.org
Subject svn commit: r1783938 - in /jmeter/trunk: src/jorphan/org/apache/jorphan/logging/ src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/render/ test/src/org/apache/jmeter/protocol/http/control/
Date Tue, 21 Feb 2017 20:45:28 GMT
Author: fschumacher
Date: Tue Feb 21 20:45:28 2017
New Revision: 1783938

URL: http://svn.apache.org/viewvc?rev=1783938&view=rev
Log:
javadoc: Add description to deprecated tags

Modified:
    jmeter/trunk/src/jorphan/org/apache/jorphan/logging/LoggingManager.java
    jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/render/MessageRenderer.java
    jmeter/trunk/test/src/org/apache/jmeter/protocol/http/control/TestHC4CookieManager.java

Modified: jmeter/trunk/src/jorphan/org/apache/jorphan/logging/LoggingManager.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/jorphan/org/apache/jorphan/logging/LoggingManager.java?rev=1783938&r1=1783937&r2=1783938&view=diff
==============================================================================
--- jmeter/trunk/src/jorphan/org/apache/jorphan/logging/LoggingManager.java (original)
+++ jmeter/trunk/src/jorphan/org/apache/jorphan/logging/LoggingManager.java Tue Feb 21 20:45:28
2017
@@ -35,20 +35,20 @@ public final class LoggingManager {
     /**
      * Predefined format patterns, selected by the property log_format_type (see
      * jmeter.properties) The new-line is added later
-     * @deprecated
+     * @deprecated  since 3.2, use SLF4J for logging
      */
     @Deprecated
     public static final String DEFAULT_PATTERN = "%{time:yyyy/MM/dd HH:mm:ss} %5.5{priority}
- "  //$NON_NLS-1$
             + "%{category}: %{message} %{throwable}"; //$NON_NLS-1$
 
     /**
-     * @deprecated
+     * @deprecated  since 3.2, use SLF4J for logging
      */
     @Deprecated
     public static final String LOG_FILE = "log_file";  //$NON_NLS-1$
 
     /**
-     * @deprecated
+     * @deprecated  since 3.2, use SLF4J for logging
      */
     @Deprecated
     public static final String LOG_PRIORITY = "log_level";  //$NON_NLS-1$
@@ -67,7 +67,7 @@ public final class LoggingManager {
      *
      * @param properties
      *            {@link Properties} to be used for initialization
-     * @deprecated
+     * @deprecated  since 3.2, use SLF4J for logging
      */
     @Deprecated
     public static void initializeLogging(Properties properties) {
@@ -83,7 +83,7 @@ public final class LoggingManager {
      *            {@link Properties} that contain the
      *            {@link LoggingManager#LOG_PRIORITY LOG_PRIORITY} and
      *            {@link LoggingManager#LOG_FILE LOG_FILE} prefixed entries
-     * @deprecated
+     * @deprecated since 3.2, use SLF4J for logging
      */
     @Deprecated
     public static void setLoggingLevels(Properties appProperties) {
@@ -101,7 +101,7 @@ public final class LoggingManager {
      * 
      * @param name from which to remove the prefix
      * @return the name with the prefix removed
-     * @deprecated
+     * @deprecated since 3.2, use SLF4J for logging
      */
     @Deprecated
     public static String removePrefix(String name){
@@ -139,7 +139,7 @@ public final class LoggingManager {
      * @param category - the full name of the logger category, this will have the prefix
removed.
      *
      * @return Logger
-     * @deprecated
+     * @deprecated since 3.2, use SLF4J for logging
      */
     @Deprecated
     public static Logger getLoggerForShortName(String category) {
@@ -151,7 +151,7 @@ public final class LoggingManager {
      * 
      * @param priority - string containing the priority name, e.g. "INFO", "WARN", "DEBUG",
"FATAL_ERROR"
      * @param category - string containing the category
-     * @deprecated
+     * @deprecated since 3.2, use SLF4J for logging
      */
     @Deprecated
     public static void setPriority(String priority, String category) {
@@ -163,7 +163,7 @@ public final class LoggingManager {
      * 
      * @param priority - priority, e.g. DEBUG, INFO
      * @param fullName - e.g. org.apache.jmeter.etc, will have the prefix removed.
-     * @deprecated
+     * @deprecated since 3.2, use SLF4J for logging
      */
     @Deprecated
     public static void setPriorityFullName(String priority, String fullName) {
@@ -175,7 +175,7 @@ public final class LoggingManager {
      * 
      * @param priority - e.g. Priority.DEBUG
      * @param category - string containing the category
-     * @deprecated
+     * @deprecated since 3.2, use SLF4J for logging
      */
     @Deprecated
     public static void setPriority(Priority priority, String category) {
@@ -186,7 +186,7 @@ public final class LoggingManager {
      * Set the logging priority.
      * 
      * @param priority - e.g. Priority.DEBUG
-     * @deprecated
+     * @deprecated since 3.2, use SLF4J for logging
      */
     @Deprecated
     public static void setPriority(String priority) {
@@ -197,7 +197,7 @@ public final class LoggingManager {
      * Set the default logging priority.
      * 
      * @param priority e.g. Priority.DEBUG
-     * @deprecated
+     * @deprecated since 3.2, use SLF4J for logging
      */
     @Deprecated
     public static void setPriority(Priority priority) {
@@ -209,7 +209,7 @@ public final class LoggingManager {
      * 
      * @param target the LogTarget
      * @param category the category name
-     * @deprecated
+     * @deprecated since 3.2, use SLF4J for logging
      */
     @Deprecated
     public static void setTarget(LogTarget target, String category) {
@@ -220,7 +220,7 @@ public final class LoggingManager {
      * Add logTargets to root logger
      * FIXME What's the clean way to add a LogTarget afterwards ?
      * @param logTargets LogTarget array
-     * @deprecated
+     * @deprecated since 3.2, use SLF4J for logging
      */
     @Deprecated
     public static void addLogTargetToRootLogger(LogTarget[] logTargets) {

Modified: jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/render/MessageRenderer.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/render/MessageRenderer.java?rev=1783938&r1=1783937&r2=1783938&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/render/MessageRenderer.java
(original)
+++ jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/render/MessageRenderer.java
Tue Feb 21 20:45:28 2017
@@ -20,8 +20,29 @@ package org.apache.jmeter.protocol.jms.s
 import com.github.benmanes.caffeine.cache.Cache;
 
 public interface MessageRenderer<T> {
-    /** Convert text to expected type **/
+
+    /**
+     * Convert text to expected type
+     * 
+     * @param text
+     *            Text representing the type
+     * @return the constructed object
+     **/
     T getValueFromText(String text);
-    /** Read text from file, eventually replace variables, then convert it. Cached content
depends if variabilisation is active or not. **/
+
+    /**
+     * Read text from file, eventually replace variables, then convert it.
+     * Cached content depends if variabilisation is active or not.
+     * 
+     * @param filename
+     *            name of the file to get the value from
+     * @param encoding
+     *            encoding of the file
+     * @param hasVariable
+     *            flag, whether variables inside the value should be replaced
+     * @param cache
+     *            Cache in which the raw values will be stored/read from
+     * @return the constructed object
+     **/
     T getValueFromFile(String filename, String encoding, boolean hasVariable, Cache<Object,Object>
cache);
 }

Modified: jmeter/trunk/test/src/org/apache/jmeter/protocol/http/control/TestHC4CookieManager.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/test/src/org/apache/jmeter/protocol/http/control/TestHC4CookieManager.java?rev=1783938&r1=1783937&r2=1783938&view=diff
==============================================================================
--- jmeter/trunk/test/src/org/apache/jmeter/protocol/http/control/TestHC4CookieManager.java
(original)
+++ jmeter/trunk/test/src/org/apache/jmeter/protocol/http/control/TestHC4CookieManager.java
Tue Feb 21 20:45:28 2017
@@ -114,7 +114,7 @@ public class TestHC4CookieManager extend
         }
 
         /**
-         * @throws Exception
+         * @throws Exception when anything goes wrong in the test
          */
         @Test
         public void testAddCookieFromHeaderWithWildcard() throws Exception {
@@ -147,7 +147,7 @@ public class TestHC4CookieManager extend
         }
 
         /**
-         * @throws Exception
+         * @throws Exception when anything goes wrong in the test
          */
         @Test
         public void testAddCookieFromHeaderWithNoWildcard() throws Exception {
@@ -175,7 +175,7 @@ public class TestHC4CookieManager extend
         }
 
         /**
-         * @throws Exception
+         * @throws Exception  when anything goes wrong in the test
          */
         @Test
         public void testAddCookieFromHeaderWithWildcard2() throws Exception {
@@ -199,7 +199,7 @@ public class TestHC4CookieManager extend
         }
 
         /**
-         * @throws Exception
+         * @throws Exception  when anything goes wrong in the test
          */
         @Test
         public void testBug56358() throws Exception {



Mime
View raw message