svn commit: r1685853 - /jmeter/trunk/src/core/org/apache/jmeter/samplers/SampleResult.java

[se...@apache.org]

Author: sebb
Date: Tue Jun 16 14:43:54 2015
New Revision: 1685853

URL: http://svn.apache.org/r1685853
Log:
Javadoc for dataType field

Modified:
    jmeter/trunk/src/core/org/apache/jmeter/samplers/SampleResult.java

Modified: jmeter/trunk/src/core/org/apache/jmeter/samplers/SampleResult.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/samplers/SampleResult.java?rev=1685853&r1=1685852&r2=1685853&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/samplers/SampleResult.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/samplers/SampleResult.java Tue Jun 16 14:43:54 2015
@@ -73,7 +73,7 @@ public class SampleResult implements Ser
     private static final String DEFAULT_CHARSET = Charset.defaultCharset().name();
 
     /**
-     * Data type value indicating that the response data is text.
+     * Data type value ({@value}) indicating that the response data is text.
      *
      * @see #getDataType
      * @see #setDataType(java.lang.String)
@@ -81,7 +81,7 @@ public class SampleResult implements Ser
     public static final String TEXT = "text"; // $NON-NLS-1$
 
     /**
-     * Data type value indicating that the response data is binary.
+     * Data type value ({@value}) indicating that the response data is binary.
      *
      * @see #getDataType
      * @see #setDataType(java.lang.String)
@@ -159,6 +159,13 @@ public class SampleResult implements Ser
 
     private List<SampleResult> subResults;
 
+    /**
+     * The data type of the sample
+     * @see #getDataType()
+     * @see #setDataType(String)
+     * @see #TEXT
+     * @see #BINARY
+     */
     private String dataType=""; // Don't return null if not set
 
     private boolean success;
@@ -756,13 +763,27 @@ public class SampleResult implements Ser
         return success;
     }
 
+    /**
+     * Sets the data type of the sample.
+     * @param dataType String containing {@link BINARY} or {@link TEXT}
+     * @see #BINARY
+     * @see #TEXT
+     */
     public void setDataType(String dataType) {
         this.dataType = dataType;
     }
 
+    /**
+     * Returns the data type of the sample.
+     * 
+     * @return String containing {@link BINARY} or {@link TEXT} or the empty string
+     * @see #BINARY
+     * @see #TEXT
+     */
     public String getDataType() {
         return dataType;
     }
+
     /**
      * Extract and save the DataEncoding and DataType from the parameter provided.
      * Does not save the full content Type.