/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 */

package org.apache.jmeter.functions;

import java.io.Serializable;
import java.util.Collection;
import java.util.LinkedList;
import java.util.List;

import org.apache.jmeter.engine.util.CompoundVariable;
import org.apache.jmeter.samplers.SampleResult;
import org.apache.jmeter.samplers.Sampler;
import org.apache.jmeter.util.JMeterUtils;

/**
 * Function to get a JMeter property, and optionally store it
 * 
 * Parameters: - property name - variable name (optional) - default value
 * (optional)
 * 
 * 
 * Returns: - the property value, but if not found - the default value, but if
 * not define - the property name itself
 * 
 * @version $Revision$ Updated: $Date$
 */
public class Property extends AbstractFunction implements Serializable {

	private static final List desc = new LinkedList();

	private static final String KEY = "__property";

	// Number of parameters expected - used to reject invalid calls
	private static final int MIN_PARAMETER_COUNT = 1;

	private static final int MAX_PARAMETER_COUNT = 3;
	static {
		desc.add(JMeterUtils.getResString("property_name_param"));
		desc.add(JMeterUtils.getResString("function_name_param"));
		desc.add(JMeterUtils.getResString("property_default_param"));
	}

	private Object[] values;

	public Property() {
	}

	public Object clone() {
		return new Property();
	}

	public synchronized String execute(SampleResult previousResult, Sampler currentSampler)
			throws InvalidVariableException {
		String propertyName = ((CompoundVariable) values[0]).execute();
		String propertyDefault = propertyName;
		if (values.length > 2) { // We have a 3rd parameter
			propertyDefault = ((CompoundVariable) values[2]).execute();
		}
		String propertyValue = JMeterUtils.getPropDefault(propertyName, propertyDefault);
		if (values.length > 1) {
			String variableName = ((CompoundVariable) values[1]).execute();
			if (variableName.length() > 0) {// Allow for empty name
				getVariables().put(variableName, propertyValue);
			}
		}
		return propertyValue;

	}

	public void setParameters(Collection parameters) throws InvalidVariableException {

		values = parameters.toArray();

		if ((values.length < MIN_PARAMETER_COUNT) || (values.length > MAX_PARAMETER_COUNT)) {
			throw new InvalidVariableException("Parameter Count not between " + MIN_PARAMETER_COUNT + " & "
					+ MAX_PARAMETER_COUNT);
		}

	}

	public String getReferenceKey() {
		return KEY;
	}

	public List getArgumentDesc() {
		return desc;
	}

}
@@ -1221,16 +1221,20 @@
 ameters:
+%0A * 
  - prope
@@ -1242,16 +1242,21 @@
 ty name 
+%0A *  
 - variab
@@ -1273,16 +1273,20 @@
 ptional)
+%0A * 
  - defau
@@ -1293,19 +1293,16 @@
 lt value
-%0A *
  (option
@@ -1309,20 +1309,16 @@
 al)%0A * %0A
- * %0A
  * Retur
@@ -1320,16 +1320,19 @@
 Returns:
+%0A *
  - the p
@@ -1362,16 +1362,20 @@
 ot found
+:%0A *
  - the d
@@ -1394,19 +1394,16 @@
 , but if
-%0A *
  not def
@@ -1405,16 +1405,21 @@
 t define
+d:%0A *
  - the p
@@ -1446,47 +1446,8 @@
  * %0A
- * @version $Revision$ Updated: $Date$%0A
  */%0A
@@ -1739,17 +1739,16 @@
 NT = 1;%0A
-%0A
 %09private
@@ -1790,16 +1790,17 @@
 NT = 3;%0A
+%0A
 %09static 

Reformat mangled comments