Author: fschumacher
Date: Sun Dec 28 12:47:46 2014
New Revision: 1648193
URL: http://svn.apache.org/r1648193
Log:
Bug 57193: Add param and return tags to javadoc
Bugzilla Id: 57193
Modified:
jmeter/trunk/src/core/org/apache/jmeter/util/BeanShellInterpreter.java
jmeter/trunk/src/core/org/apache/jmeter/util/BeanShellServer.java
jmeter/trunk/src/core/org/apache/jmeter/util/Calculator.java
jmeter/trunk/src/core/org/apache/jmeter/util/ColorHelper.java
jmeter/trunk/src/core/org/apache/jmeter/util/Document.java
jmeter/trunk/src/core/org/apache/jmeter/util/JMeterUtils.java
jmeter/trunk/src/core/org/apache/jmeter/util/JsseSSLManager.java
jmeter/trunk/src/core/org/apache/jmeter/util/NameUpdater.java
jmeter/trunk/src/core/org/apache/jmeter/util/SSLManager.java
jmeter/trunk/src/core/org/apache/jmeter/util/SlowSocket.java
jmeter/trunk/src/core/org/apache/jmeter/util/XPathUtil.java
jmeter/trunk/src/core/org/apache/jmeter/util/keystore/JmeterKeyStore.java
jmeter/trunk/src/core/org/apache/jmeter/visualizers/Sample.java
jmeter/trunk/src/core/org/apache/jmeter/visualizers/TableSample.java
jmeter/trunk/src/core/org/apache/jmeter/visualizers/Visualizer.java
jmeter/trunk/src/functions/org/apache/jmeter/functions/FileWrapper.java
Modified: jmeter/trunk/src/core/org/apache/jmeter/util/BeanShellInterpreter.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/util/BeanShellInterpreter.java?rev=1648193&r1=1648192&r2=1648193&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/util/BeanShellInterpreter.java
(original)
+++ jmeter/trunk/src/core/org/apache/jmeter/util/BeanShellInterpreter.java Sun
Dec 28 12:47:46 2014
@@ -101,6 +101,7 @@ public class BeanShellInterpreter {
*
* @param init initialisation file
* @param _log logger to pass to interpreter
+ * @throws ClassNotFoundException when beanshell can not be instantiated
*/
public BeanShellInterpreter(String init, Logger _log) throws
ClassNotFoundException {
initFile = init;
Modified: jmeter/trunk/src/core/org/apache/jmeter/util/BeanShellServer.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/util/BeanShellServer.java?rev=1648193&r1=1648192&r2=1648193&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/util/BeanShellServer.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/util/BeanShellServer.java Sun Dec
28 12:47:46 2014
@@ -41,7 +41,14 @@ public class BeanShellServer implements
private final String serverfile;
/**
- *
+ * Constructor which sets the port for this server and the path to an
+ * optional init file
+ *
+ * @param port
+ * the port for the server to use
+ * @param file
+ * the path to an init file, or an empty string, if no init file
+ * should be used
*/
public BeanShellServer(int port, String file) {
super();
Modified: jmeter/trunk/src/core/org/apache/jmeter/util/Calculator.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/util/Calculator.java?rev=1648193&r1=1648192&r2=1648193&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/util/Calculator.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/util/Calculator.java Sun Dec 28
12:47:46 2014
@@ -22,10 +22,12 @@ import org.apache.jmeter.samplers.Sample
/**
* Class to calculate various items that don't require all previous results to
be saved:
- * - mean = average
- * - standard deviation
- * - minimum
- * - maximum
+ * <ul>
+ * <li>mean = average</li>
+ * <li>standard deviation</li>
+ * <li>minimum</li>
+ * <li>maximum</li>
+ * </ul>
*/
public class Calculator {
@@ -70,7 +72,7 @@ public class Calculator {
/**
* Add the value for a single sample.
*
- * @param newValue
+ * @param newValue the value for the new sample
*
* @see #addValue(long, int)
* @deprecated Use {@link #addSample(SampleResult)} instead
@@ -189,6 +191,8 @@ public class Calculator {
* May be slightly skewed because it takes the timestamps of the first and
* last samples as the total time passed, and the test may actually have
* started before that start time and ended after that end time.
+ *
+ * @return throughput associated to this sampler in requests per second
*/
public double getRate() {
if (elapsedTime == 0) {
Modified: jmeter/trunk/src/core/org/apache/jmeter/util/ColorHelper.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/util/ColorHelper.java?rev=1648193&r1=1648192&r2=1648193&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/util/ColorHelper.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/util/ColorHelper.java Sun Dec 28
12:47:46 2014
@@ -38,6 +38,8 @@ public final class ColorHelper {
* If all the components are the same value increment in the order of red,
* green and blue.
*
+ * @param col
+ * {@link Color} to start with
* @param inc
* value to increment the color components
* @return the color after change
Modified: jmeter/trunk/src/core/org/apache/jmeter/util/Document.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/util/Document.java?rev=1648193&r1=1648192&r2=1648193&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/util/Document.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/util/Document.java Sun Dec 28
12:47:46 2014
@@ -41,9 +41,11 @@ public class Document {
JMeterUtils.getPropDefault("document.max_size", 10 * 1024 * 1024); //
$NON-NLS-1$
/**
- * Convert to text plain a lot of kind of document
- * (like odt, ods, odp, doc(x), xls(x), ppt(x), pdf, mp3, mp4, etc.) with
Apache Tika
- * @param document
+ * Convert to text plain a lot of kind of document (like odt, ods, odp,
+ * doc(x), xls(x), ppt(x), pdf, mp3, mp4, etc.) with Apache Tika
+ *
+ * @param document
+ * binary representation of the document
* @return text from document without format
*/
public static String getTextFromDocument(byte[] document) {
Modified: jmeter/trunk/src/core/org/apache/jmeter/util/JMeterUtils.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/util/JMeterUtils.java?rev=1648193&r1=1648192&r2=1648193&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/util/JMeterUtils.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/util/JMeterUtils.java Sun Dec 28
12:47:46 2014
@@ -173,7 +173,9 @@ public class JMeterUtils implements Unit
* Load the JMeter properties file; if not found, then
* default to "org/apache/jmeter/jmeter.properties" from the classpath
*
+ * <p>
* c.f. loadProperties
+ *
* @param file Name of the file from which the JMeter properties should be
loaded
*/
public static void loadJMeterProperties(String file) {
@@ -259,7 +261,7 @@ public class JMeterUtils implements Unit
/**
* Get a compiled expression from the pattern cache (READ_ONLY).
*
- * @param expression
+ * @param expression regular expression to be looked up
* @return compiled pattern
*
* @throws MalformedCachePatternException (Runtime)
@@ -274,7 +276,7 @@ public class JMeterUtils implements Unit
* Get a compiled expression from the pattern cache.
*
* @param expression RE
- * @param options e.g. READ_ONLY_MASK
+ * @param options e.g. {@link Perl5Compiler#READ_ONLY_MASK READ_ONLY_MASK}
* @return compiled pattern
*
* @throws MalformedCachePatternException (Runtime)
@@ -714,8 +716,14 @@ public class JMeterUtils implements Unit
/**
* Creates the vector of alias strings.
+ * <p>
+ * The properties will be filtered by all values starting with
+ * <code>alias.</code>. The matching entries will be used for the new
+ * {@link Hashtable} while the prefix <code>alias.</code> will be stripped
+ * of the keys.
*
* @param properties
+ * the input values
* @return The Alias value
*/
public static Hashtable<String, String> getAlias(Properties properties) {
@@ -747,10 +755,22 @@ public class JMeterUtils implements Unit
/**
* Creates a table of strings for all the properties that start with a
* common prefix.
+ * <p>
+ * So if you have {@link Properties} <code>prop</code> with two entries,
say
+ * <ul>
+ * <li>this.test</li>
+ * <li>that.something</li>
+ * </ul>
+ * And would call this method with a <code>prefix</code> <em>this</em>, the
+ * result would be a new {@link Hashtable} with one entry, which key would
+ * be <em>test</em>.
*
- * @param properties input to search
- * @param prefix to match against properties
- * @return a Hashtable where the keys are the original keys with the
prefix removed
+ * @param properties
+ * input to search
+ * @param prefix
+ * to match against properties
+ * @return a Hashtable where the keys are the original matching keys with
+ * the prefix removed
*/
public static Hashtable<String, String> getHashtable(Properties
properties, String prefix) {
Hashtable<String, String> t = new Hashtable<String, String>();
@@ -1205,7 +1225,7 @@ public class JMeterUtils implements Unit
/**
* Find a file in the current directory or in the JMeter bin directory.
*
- * @param fileName
+ * @param fileName the name of the file to find
* @return File object
*/
public static File findFile(String fileName){
Modified: jmeter/trunk/src/core/org/apache/jmeter/util/JsseSSLManager.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/util/JsseSSLManager.java?rev=1648193&r1=1648192&r2=1648193&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/util/JsseSSLManager.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/util/JsseSSLManager.java Sun Dec 28
12:47:46 2014
@@ -173,11 +173,12 @@ public class JsseSSLManager extends SSLM
}
/**
- * Returns the SSLContext we are using.
- * This is either a context per thread,
+ * Returns the SSLContext we are using. This is either a context per
thread,
* or, for backwards compatibility, a single shared context.
*
* @return The Context value
+ * @throws GeneralSecurityException
+ * when constructing the context fails
*/
public SSLContext getContext() throws GeneralSecurityException {
if (SHARED_SESSION_CONTEXT) {
@@ -211,11 +212,15 @@ public class JsseSSLManager extends SSLM
this.threadlocal.set(null);
}
}
+
/*
- *
+ *
* Creates new SSL context
+ *
* @return SSL context
- * @throws GeneralSecurityException
+ *
+ * @throws GeneralSecurityException when the algorithm for the context can
+ * not be found or the keys have problems
*/
private SSLContext createContext() throws GeneralSecurityException {
SSLContext context;
Modified: jmeter/trunk/src/core/org/apache/jmeter/util/NameUpdater.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/util/NameUpdater.java?rev=1648193&r1=1648192&r2=1648193&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/util/NameUpdater.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/util/NameUpdater.java Sun Dec 28
12:47:46 2014
@@ -181,7 +181,7 @@ public final class NameUpdater {
* {@link org.apache.jmeter.save.SaveService#checkClasses()
SaveService#checkClasses()}
* only.
*
- * @param key
+ * @param key name of the key to check
* @return true if the key is in the map
*/
public static boolean isMapped(String key) {
Modified: jmeter/trunk/src/core/org/apache/jmeter/util/SSLManager.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/util/SSLManager.java?rev=1648193&r1=1648192&r2=1648193&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/util/SSLManager.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/util/SSLManager.java Sun Dec 28
12:47:46 2014
@@ -242,6 +242,8 @@ public abstract class SSLManager {
/**
* Static accessor for the SSLManager object. The SSLManager is a
singleton.
+ *
+ * @return the singleton {@link SSLManager}
*/
public static final synchronized SSLManager getInstance() {
if (null == SSLManager.manager) {
@@ -267,6 +269,8 @@ public abstract class SSLManager {
/**
* Test whether SSL is supported or not.
+ *
+ * @return flag whether SSL is supported
*/
public static final boolean isSSLSupported() {
return SSLManager.isSSLSupported;
@@ -274,10 +278,17 @@ public abstract class SSLManager {
/**
* Configure Keystore
- * @param preload
- * @param startIndex
- * @param endIndex
- * @param clientCertAliasVarName
+ *
+ * @param preload
+ * flag whether the keystore should be opened within this
method,
+ * or the opening should be delayed
+ * @param startIndex
+ * first index to consider for a key
+ * @param endIndex
+ * last index to consider for a key
+ * @param clientCertAliasVarName
+ * name of the default key, if empty the first key will be used
+ * as default key
*/
public void configureKeystore(boolean preload, int startIndex, int
endIndex, String clientCertAliasVarName) {
this.keystoreAliasStartIndex = startIndex;
Modified: jmeter/trunk/src/core/org/apache/jmeter/util/SlowSocket.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/util/SlowSocket.java?rev=1648193&r1=1648192&r2=1648193&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/util/SlowSocket.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/util/SlowSocket.java Sun Dec 28
12:47:46 2014
@@ -50,14 +50,23 @@ public class SlowSocket extends Socket {
/**
*
- * @param cps characters per second
- * @param host hostname
- * @param port port
- * @param localAddr local address
- * @param localPort local port
+ * @param cps
+ * characters per second
+ * @param host
+ * hostname
+ * @param port
+ * port
+ * @param localAddr
+ * local address
+ * @param localPort
+ * local port
*
* @throws IOException
- * @throws IllegalArgumentException if cps <= 0
+ * if an I/O error occurs during initialization
+ * @throws IllegalArgumentException
+ * if cps <= 0, or if the <code>port</code> or
+ * <code>localPort</code> values lie outside of the allowed
+ * range between <code>0</code> and <code>65535</code>
*/
public SlowSocket(int cps, String host, int port, InetAddress localAddr,
int localPort) throws IOException {
super(host, port, localAddr, localPort);
@@ -69,13 +78,21 @@ public class SlowSocket extends Socket {
/**
*
- * @param cps characters per second
- * @param host hostname
- * @param port port
+ * @param cps
+ * characters per second
+ * @param host
+ * hostname
+ * @param port
+ * port
*
* @throws UnknownHostException
+ * if the name of the host can not be determined automatically
* @throws IOException
- * @throws IllegalArgumentException if cps <= 0
+ * if an I/O error occurs during initialization
+ * @throws IllegalArgumentException
+ * if cps <= 0, or if the <code>port</code> or
+ * <code>localPort</code> values lie outside of the allowed
+ * range between <code>0</code> and <code>65535</code>
*/
public SlowSocket(int cps, String host, int port) throws
UnknownHostException, IOException {
super(host, port);
@@ -88,7 +105,7 @@ public class SlowSocket extends Socket {
/**
* Added for use by SlowHC4SocketFactory.
*
- * @param cps
+ * @param cps characters per second
*/
public SlowSocket(int cps) {
super();
Modified: jmeter/trunk/src/core/org/apache/jmeter/util/XPathUtil.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/util/XPathUtil.java?rev=1648193&r1=1648192&r2=1648193&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/util/XPathUtil.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/util/XPathUtil.java Sun Dec 28
12:47:46 2014
@@ -101,7 +101,7 @@ public class XPathUtil {
* @param namespace should the parser be namespace aware?
* @param downloadDTDs if true, parser should attempt to resolve external
entities
* @return document builder
- * @throws ParserConfigurationException
+ * @throws ParserConfigurationException if {@link DocumentBuilder} can not
be created for the wanted configuration
*/
public static DocumentBuilder makeDocumentBuilder(boolean validate,
boolean whitespace, boolean namespace, boolean downloadDTDs)
throws ParserConfigurationException {
@@ -134,10 +134,10 @@ public class XPathUtil {
* @param isXml - is document already XML (Tidy only)
* @param downloadDTDs - if true, try to download external DTDs
* @return document
- * @throws ParserConfigurationException
- * @throws SAXException
- * @throws IOException
- * @throws TidyException
+ * @throws ParserConfigurationException when no {@link DocumentBuilder}
can be constructed for the wanted configuration
+ * @throws SAXException if parsing fails
+ * @throws IOException if an I/O error occurs while parsing
+ * @throws TidyException if a ParseError is detected and
<code>report_errors</code> is <code>true</code>
*/
public static Document makeDocument(InputStream stream, boolean validate,
boolean whitespace, boolean namespace,
boolean tolerant, boolean quiet, boolean showWarnings, boolean
report_errors, boolean isXml, boolean downloadDTDs)
@@ -161,10 +161,10 @@ public class XPathUtil {
* @param downloadDTDs - if true, try to download external DTDs
* @param tidyOut OutputStream for Tidy pretty-printing
* @return document
- * @throws ParserConfigurationException
- * @throws SAXException
- * @throws IOException
- * @throws TidyException
+ * @throws ParserConfigurationException if {@link DocumentBuilder} can not
be created for the wanted configuration
+ * @throws SAXException if parsing fails
+ * @throws IOException if I/O error occurs while parsing
+ * @throws TidyException if a ParseError is detected and
<code>report_errors</code> is <code>true</code>
*/
public static Document makeDocument(InputStream stream, boolean validate,
boolean whitespace, boolean namespace,
boolean tolerant, boolean quiet, boolean showWarnings, boolean
report_errors, boolean isXml, boolean downloadDTDs,
@@ -289,7 +289,7 @@ public class XPathUtil {
* @param document {@link Document}
* @param xPathExpression XPath expression
* @return {@link NodeList}
- * @throws TransformerException
+ * @throws TransformerException when the internally used xpath engine fails
*/
public static NodeList selectNodeList(Document document, String
xPathExpression) throws TransformerException {
XObject xObject = XPathAPI.eval(document, xPathExpression,
getPrefixResolver(document));
@@ -302,7 +302,7 @@ public class XPathUtil {
* @param xPathQuery XPath Query
* @param matchStrings List of strings that will be filled
* @param fragment return fragment
- * @throws TransformerException
+ * @throws TransformerException when the internally used xpath engine fails
*/
public static void putValuesForXPathInList(Document document,
String xPathQuery,
@@ -374,7 +374,7 @@ public class XPathUtil {
* @param result {@link AssertionResult}
* @param doc XML Document
* @param xPathExpression XPath expression
- * @param isNegated
+ * @param isNegated flag whether a non-match should be considered a success
*/
public static void computeAssertionResult(AssertionResult result,
Document doc,
@@ -430,7 +430,7 @@ public class XPathUtil {
/**
* Formats XML
- * @param xml
+ * @param xml string to format
* @return String formatted XML
*/
public static final String formatXml(String xml){
Modified:
jmeter/trunk/src/core/org/apache/jmeter/util/keystore/JmeterKeyStore.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/util/keystore/JmeterKeyStore.java?rev=1648193&r1=1648192&r2=1648193&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/util/keystore/JmeterKeyStore.java
(original)
+++ jmeter/trunk/src/core/org/apache/jmeter/util/keystore/JmeterKeyStore.java
Sun Dec 28 12:47:46 2014
@@ -48,8 +48,14 @@ public final class JmeterKeyStore {
private static final Logger LOG = LoggingManager.getLoggerForClass();
private final KeyStore store;
+
+ /** first index to consider for a key */
private final int startIndex;
+
+ /** last index to consider for a key */
private final int endIndex;
+
+ /** name of the default alias */
private String clientCertAliasVarName;
private String[] names = new String[0]; // default empty array to prevent
NPEs
@@ -60,6 +66,18 @@ public final class JmeterKeyStore {
private int last_user;
+ /**
+ * @param type
+ * type of the {@link KeyStore}
+ * @param startIndex which keys should be considered starting from
<code>0</code>
+ * @param endIndex which keys should be considered up to <code>count -
1</code>
+ * @param clientCertAliasVarName name for the default key, if empty use
the first key available
+ * @throws KeyStoreException
+ * when the type of the keystore is not supported
+ * @throws IllegalArgumentException
+ * when <code>startIndex</code> < 0, <code>endIndex</code>
+ * < 0 or <code>endIndex</code> <
</code>startIndex</code>
+ */
private JmeterKeyStore(String type, int startIndex, int endIndex, String
clientCertAliasVarName) throws KeyStoreException {
if (startIndex < 0 || endIndex < 0 || endIndex < startIndex) {
throw new IllegalArgumentException("Invalid index(es).
Start="+startIndex+", end="+endIndex);
@@ -71,12 +89,26 @@ public final class JmeterKeyStore {
}
/**
- * Process the input stream
- * @throws IOException
- * @throws CertificateException
- * @throws NoSuchAlgorithmException
- * @throws KeyStoreException
- * @throws UnrecoverableKeyException
+ * Process the input stream and try to read the keys from the store
+ *
+ * @param is
+ * {@link InputStream} from which the store should be loaded
+ * @param pword
+ * the password used to check the integrity of the store
+ * @throws IOException
+ * if there is a problem decoding or reading the store. A bad
+ * password might be the cause for this, or an empty store
+ * @throws CertificateException
+ * if any of the certificated in the store can not be loaded
+ * @throws NoSuchAlgorithmException
+ * if the algorithm to check the integrity of the store can not
+ * be found
+ * @throws KeyStoreException
+ * if the store has not been initialized (should not happen
+ * here)
+ * @throws UnrecoverableKeyException
+ * if the key can not be recovered from the store (should not
+ * happen here, either)
*/
public void load(InputStream is, String pword) throws
NoSuchAlgorithmException, CertificateException, IOException, KeyStoreException,
UnrecoverableKeyException {
char pw[] = pword==null ? null : pword.toCharArray();
@@ -133,6 +165,12 @@ public final class JmeterKeyStore {
/**
* Get the ordered certificate chain for a specific alias.
+ *
+ * @param alias
+ * the alias for which the certificate chain should be given
+ * @return the certificate chain for the alias
+ * @throws IllegalArgumentException
+ * if no chain could be found for the alias
*/
public X509Certificate[] getCertificateChain(String alias) {
X509Certificate[] result = this.certsByAlias.get(alias);
@@ -145,7 +183,12 @@ public final class JmeterKeyStore {
/**
* Get the next or only alias.
+ *
* @return the next or only alias.
+ * @throws IllegalArgumentException
+ * if {@link JmeterKeyStore#clientCertAliasVarName
+ * clientCertAliasVarName} is not empty and no key for this
+ * alias could be found
*/
public String getAlias() {
if(!StringUtils.isEmpty(clientCertAliasVarName)) {
@@ -181,6 +224,12 @@ public final class JmeterKeyStore {
/**
* Return the private Key for a specific alias
+ *
+ * @param alias
+ * the name of the alias for the private key
+ * @return the private key for the given <code>alias</code>
+ * @throws IllegalArgumentException
+ * when no private key could be found
*/
public PrivateKey getPrivateKey(String alias) {
PrivateKey pk = this.privateKeyByAlias.get(alias);
@@ -192,12 +241,22 @@ public final class JmeterKeyStore {
/**
* Create a keystore which returns a range of aliases (if available)
- * @param type store type (e.g. JKS)
- * @param startIndex first index (from 0)
- * @param endIndex last index (to count -1)
- * @param clientCertAliasVarName
+ *
+ * @param type
+ * store type (e.g. JKS)
+ * @param startIndex
+ * first index (from 0)
+ * @param endIndex
+ * last index (to count -1)
+ * @param clientCertAliasVarName
+ * name of the default key to, if empty the first key will be
+ * used as default key
* @return the keystore
- * @throws KeyStoreException
+ * @throws KeyStoreException
+ * when the type of the store is not supported
+ * @throws IllegalArgumentException
+ * when <code>startIndex</code> < 0, <code>endIndex</code>
+ * < 0, or <code>endIndex</code> <
<code>startIndex</code>
*/
public static JmeterKeyStore getInstance(String type, int startIndex, int
endIndex, String clientCertAliasVarName) throws KeyStoreException {
return new JmeterKeyStore(type, startIndex, endIndex,
clientCertAliasVarName);
@@ -205,9 +264,12 @@ public final class JmeterKeyStore {
/**
* Create a keystore which returns the first alias only.
- * @param type e.g. JKS
+ *
+ * @param type
+ * of the store e.g. JKS
* @return the keystore
* @throws KeyStoreException
+ * when the type of the store is not supported
*/
public static JmeterKeyStore getInstance(String type) throws
KeyStoreException {
return getInstance(type, 0, 0, null);
Modified: jmeter/trunk/src/core/org/apache/jmeter/visualizers/Sample.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/visualizers/Sample.java?rev=1648193&r1=1648192&r2=1648193&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/visualizers/Sample.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/visualizers/Sample.java Sun Dec 28
12:47:46 2014
@@ -208,6 +208,7 @@ public class Sample implements Serializa
}
/**
+ * @param format the format of the time to be used
* @return the start time using the specified format
* Intended for use from Functors
*/
Modified: jmeter/trunk/src/core/org/apache/jmeter/visualizers/TableSample.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/visualizers/TableSample.java?rev=1648193&r1=1648192&r2=1648193&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/visualizers/TableSample.java
(original)
+++ jmeter/trunk/src/core/org/apache/jmeter/visualizers/TableSample.java Sun
Dec 28 12:47:46 2014
@@ -98,6 +98,7 @@ public class TableSample implements Seri
}
/**
+ * @param format the format to be used on the time
* @return the start time using the specified format
* Intended for use from Functors
*/
Modified: jmeter/trunk/src/core/org/apache/jmeter/visualizers/Visualizer.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/visualizers/Visualizer.java?rev=1648193&r1=1648192&r2=1648193&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/visualizers/Visualizer.java
(original)
+++ jmeter/trunk/src/core/org/apache/jmeter/visualizers/Visualizer.java Sun Dec
28 12:47:46 2014
@@ -33,6 +33,9 @@ public interface Visualizer {
/**
* This method is called by sampling thread to inform the visualizer about
* the arrival of a new sample.
+ *
+ * @param sample
+ * the newly arrived sample
*/
void add(SampleResult sample);
Modified:
jmeter/trunk/src/functions/org/apache/jmeter/functions/FileWrapper.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/functions/org/apache/jmeter/functions/FileWrapper.java?rev=1648193&r1=1648192&r2=1648193&view=diff
==============================================================================
--- jmeter/trunk/src/functions/org/apache/jmeter/functions/FileWrapper.java
(original)
+++ jmeter/trunk/src/functions/org/apache/jmeter/functions/FileWrapper.java Sun
Dec 28 12:47:46 2014
@@ -179,7 +179,9 @@ public final class FileWrapper {
* Gets the current row number (mainly for error reporting)
*
* @param file
- * @return the current row number for this thread
+ * name of the file for which the row number is asked
+ * @return the current row number for this thread, or <code>-1</code> if
+ * <code>file</code> was not opened yet
*/
public static int getCurrentRow(String file) {
