JMeterProperty


1   // $Header: /home/cvs/jakarta-jmeter/src/core/org/apache/jmeter/testelement/property/JMeterProperty.java,v 1.6 2004/02/18 22:32:06 sebb Exp $
2   /*
3    * Copyright 2003-2004 The Apache Software Foundation.
4    *
5    * Licensed under the Apache License, Version 2.0 (the "License");
6    * you may not use this file except in compliance with the License.
7    * 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.testelement.property;
20  
21  import java.io.Serializable  ;
22  
23  import org.apache.jmeter.testelement.TestElement;
24  
25  public interface JMeterProperty extends Serializable  , Cloneable  , Comparable  
26  {
27      /**
28       * Returns whether the property is a running version.
29       * @return boolean
30       */
31      public boolean isRunningVersion();
32      
33      /**
34       * The name of the property.  Typically this should match the name that keys
35       * the property's location in the test elements Map.
36       * @return String
37       */
38      public String   getName();
39      
40      /**
41       * Set the property name.
42       * @param name
43       */
44      public void setName(String   name);
45      
46      /**
47       * Make the property a running version or turn it off as the running
48       * version.  A property that is made a running version will preserve the
49       * current state in such a way that it is retrievable by a future call to
50       * 'recoverRunningVersion()'.  Additionally, a property that is a running
51       * version will resolve all functions prior to returning it's property
52       * value.  A non-running version property will return functions as their
53       * uncompiled string representation.
54       * @param runningVersion
55       */
56      public void setRunningVersion(boolean runningVersion);
57      
58      /**
59       * Tell the property to revert to the state at the time 
60       * setRunningVersion(true) was called.
61       */
62      public void recoverRunningVersion(TestElement owner);
63      
64      /**
65       * Take the given property object and merge it's value with the current
66       * property object.  For most property types, this will simply be ignored.
67       * But for collection properties and test element properties, more complex
68       * behavior is required.
69       * @param prop
70       */
71      public void mergeIn(JMeterProperty prop);
72      
73      public int getIntValue();
74      
75      public long getLongValue();
76      
77      public double getDoubleValue();
78      
79      public float getFloatValue();
80      
81      public boolean getBooleanValue();
82      
83      public String   getStringValue();
84      
85      public Object   getObjectValue();
86      
87      public void setObjectValue(Object   value);
88      
89      public Object   clone();
90  }
91
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags