1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 */
18
19 package org.apache.jmeter.config;
20
21 public interface ConfigElement extends Cloneable {
22
23 /**
24 * Add a configuration element to this one. This allows config elements to
25 * combine and give a "layered" effect. For example,
26 * HTTPConfigElements have properties for domain, path, method, and
27 * parameters. If element A has everything filled in, but null for domain,
28 * and element B is added, which has only domain filled in, then after
29 * adding B to A, A will have the domain from B. If A already had a domain,
30 * then the correct behavior is for A to ignore the addition of element B.
31 *
32 * @param config
33 * the element to be added to this ConfigElement
34 */
35 void addConfigElement(ConfigElement config);
36
37 /**
38 * If your config element expects to be modified in the process of a test
39 * run, and you want those modifications to carry over from sample to sample
40 * (as in a cookie manager - you want to save all cookies that get set
41 * throughout the test), then return true for this method. Your config
42 * element will not be cloned for each sample. If your config elements are
43 * more static in nature, return false. If in doubt, return false.
44 *
45 * @return true if the element expects to be modified over the course of a
46 * test run
47 */
48 boolean expectsModification();
49
50 Object clone();
51 }