001: /*
002: * Licensed to the Apache Software Foundation (ASF) under one or more
003: * contributor license agreements. See the NOTICE file distributed with
004: * this work for additional information regarding copyright ownership.
005: * The ASF licenses this file to You under the Apache License, Version 2.0
006: * (the "License"); you may not use this file except in compliance with
007: * the License. You may obtain a copy of the License at
008: *
009: * http://www.apache.org/licenses/LICENSE-2.0
010: *
011: * Unless required by applicable law or agreed to in writing, software
012: * distributed under the License is distributed on an "AS IS" BASIS,
013: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014: * See the License for the specific language governing permissions and
015: * limitations under the License.
016: *
017: */
018:
019: package org.apache.jmeter.config;
020:
021: import java.io.Serializable;
022:
023: import org.apache.jmeter.testelement.AbstractTestElement;
024: import org.apache.jmeter.testelement.property.StringProperty;
025:
026: /**
027: * Class representing an argument. Each argument consists of a name/value pair,
028: * as well as (optional) metadata.
029: *
030: * @author Michael Stover
031: * @author Mark Walsh
032: */
033: public class Argument extends AbstractTestElement implements
034: Serializable {
035: /** Name used to store the argument's name. */
036: public static final String ARG_NAME = "Argument.name";
037:
038: /** Name used to store the argument's value. */
039: public static final String VALUE = "Argument.value";
040:
041: /** Name used to store the argument's metadata. */
042: public static final String METADATA = "Argument.metadata";
043:
044: /**
045: * Create a new Argument without a name, value, or metadata.
046: */
047: public Argument() {
048: }
049:
050: /**
051: * Create a new Argument with the specified name and value, and no metadata.
052: *
053: * @param name
054: * the argument name
055: * @param value
056: * the argument value
057: */
058: public Argument(String name, String value) {
059: setProperty(new StringProperty(ARG_NAME, name));
060: setProperty(new StringProperty(VALUE, value));
061: }
062:
063: /**
064: * Create a new Argument with the specified name, value, and metadata.
065: *
066: * @param name
067: * the argument name
068: * @param value
069: * the argument value
070: * @param metadata
071: * the argument metadata
072: */
073: public Argument(String name, String value, String metadata) {
074: setProperty(new StringProperty(ARG_NAME, name));
075: setProperty(new StringProperty(VALUE, value));
076: setProperty(new StringProperty(METADATA, metadata));
077: }
078:
079: /**
080: * Set the name of the Argument.
081: *
082: * @param newName
083: * the new name
084: */
085: public void setName(String newName) {
086: setProperty(new StringProperty(ARG_NAME, newName));
087: }
088:
089: /**
090: * Get the name of the Argument.
091: *
092: * @return the attribute's name
093: */
094: public String getName() {
095: return getPropertyAsString(ARG_NAME);
096: }
097:
098: /**
099: * Sets the value of the Argument.
100: *
101: * @param newValue
102: * the new value
103: */
104: public void setValue(String newValue) {
105: setProperty(new StringProperty(VALUE, newValue));
106: }
107:
108: /**
109: * Gets the value of the Argument object.
110: *
111: * @return the attribute's value
112: */
113: public String getValue() {
114: return getPropertyAsString(VALUE);
115: }
116:
117: /**
118: * Sets the Meta Data attribute of the Argument.
119: *
120: * @param newMetaData
121: * the new metadata
122: */
123: public void setMetaData(String newMetaData) {
124: setProperty(new StringProperty(METADATA, newMetaData));
125: }
126:
127: /**
128: * Gets the Meta Data attribute of the Argument.
129: *
130: * @return the MetaData value
131: */
132: public String getMetaData() {
133: return getPropertyAsString(METADATA);
134: }
135:
136: public String toString() {
137: return getName() + getMetaData() + getValue();
138: }
139: }
|