TestProperty (Alfresco Benchmark Manager 3.0.2 API)

java.lang.Object
- org.alfresco.bm.driver.test.prop.TestProperty

All Implemented Interfaces:

Comparable<TestProperty>

Direct Known Subclasses:

BooleanTestProperty, DecimalTestProperty, IntTestProperty, StringTestProperty
```
public abstract class TestProperty
extends Object
implements Comparable<TestProperty>
```
Class to hold test properties and provide support for validation

Since:

2.0

Author:

Derek Hulley

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TestProperty.TestPropertyType
Enumeration of the basic property types supported

Nested Classes
Modifier and Type	Class and Description
`static class`	`TestProperty.TestPropertyType` Enumeration of the basic property types supported

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PROP_CHOICE_COLLECTION`
`static String`	`PROP_DEFAULT`
`static String`	`PROP_DESCRIPTION`
`static String`	`PROP_GROUP`
`static String`	`PROP_HIDE`
`static String`	`PROP_MASK`
`static String`	`PROP_NAME`
`static String`	`PROP_TITLE`
`static String`	`PROP_TYPE`
`static String`	`PROP_VALIDATION`

Constructor Summary

Constructors
Constructor and Description

TestProperty(String name, Properties properties)
Construct a test property

Constructors
Constructor and Description
`TestProperty(String name, Properties properties)` Construct a test property

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addError(String error)` Record and error condition against the test property.
`void`	`addError(String name, String valueName, String value)` Record an error when converting a value
`protected abstract void`	`addProperties(Properties properties)` Derived instances must override this and attach additional, type-specific properties
`int`	`compareTo(TestProperty o)` Compares based on group and name.
`boolean`	`equals(Object obj)` Equality is based purely on name.
`String`	`getChoices()`
`String`	`getDefault()`
`String`	`getDescription()`
`List<String>`	`getErrors()`
`String`	`getGroup()`
`String`	`getName()`
`String`	`getTitle()`
`abstract TestProperty.TestPropertyType`	`getType()`
`String`	`getValidation()`
`static Set<String>`	`getValueNames()` Fetch the values that should be defined for a test property.
`int`	`hashCode()` Hashcode is based purely on name.
`boolean`	`isHide()`
`boolean`	`isMask()`
`Properties`	`toProperties()` Convert the instance back into raw Java properties
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - PROP_NAME
```
public static final String PROP_NAME
```
    See Also:
    
    Constant Field Values
  - PROP_TYPE
```
public static final String PROP_TYPE
```
    See Also:
    
    Constant Field Values
  - PROP_DEFAULT
```
public static final String PROP_DEFAULT
```
    See Also:
    
    Constant Field Values
  - PROP_GROUP
```
public static final String PROP_GROUP
```
    See Also:
    
    Constant Field Values
  - PROP_TITLE
```
public static final String PROP_TITLE
```
    See Also:
    
    Constant Field Values
  - PROP_DESCRIPTION
```
public static final String PROP_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - PROP_HIDE
```
public static final String PROP_HIDE
```
    See Also:
    
    Constant Field Values
  - PROP_MASK
```
public static final String PROP_MASK
```
    See Also:
    
    Constant Field Values
  - PROP_VALIDATION
```
public static final String PROP_VALIDATION
```
    Since:
    
    2.1 - optional validation for the property
    
    See Also:
    
    Constant Field Values
  - PROP_CHOICE_COLLECTION
```
public static final String PROP_CHOICE_COLLECTION
```
    Since:
    
    2.1 - optional choice collection for validation
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TestProperty
```
public TestProperty(String name,
                    Properties properties)
```
    Construct a test property
- Method Detail
  - getValueNames
```
public static Set<String> getValueNames()
```
    Fetch the values that should be defined for a test property. Override to add more values depending on the specialization.
    
    Returns:
    
    the set of values that constitute a definition.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Hashcode is based purely on name.
    
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Equality is based purely on name.
    
    Overrides:
    
    equals in class Object
  - compareTo
```
public int compareTo(TestProperty o)
```
    Compares based on group and name.
    
    Specified by:
    
    compareTo in interface Comparable<TestProperty>
  - addError
```
public void addError(String error)
```
    Record and error condition against the test property. Property definitions must not fail with an exception condition but must, instead, record all errors for later.
  - addError
```
public void addError(String name,
                     String valueName,
                     String value)
```
    Record an error when converting a value
    
    Parameters:
    
    name - the name of the property
    
    valueName - the value name e.g. 'minLength'
    
    value - the actual value supplied e.g. 'A'
  - getType
```
public abstract TestProperty.TestPropertyType getType()
```
    Returns:
    
    the type of the instance
  - toProperties
```
public Properties toProperties()
```
    Convert the instance back into raw Java properties
  - addProperties
```
protected abstract void addProperties(Properties properties)
```
    Derived instances must override this and attach additional, type-specific properties
  - getErrors
```
public List<String> getErrors()
```
  - getName
```
public String getName()
```
  - getDefault
```
public String getDefault()
```
  - getGroup
```
public String getGroup()
```
  - getTitle
```
public String getTitle()
```
  - getDescription
```
public String getDescription()
```
  - isHide
```
public boolean isHide()
```
  - isMask
```
public boolean isMask()
```
  - getValidation
```
public String getValidation()
```
    Returns:
    
    validation name for UI - the JavaScript validation called for this property Note: this value is optional and defaults to "type" in the JavaScript code. This means validation will be done on the type (boolean, int, decimal or string) and the up-to 2.0.10 defined properties only. But you may specify a special validation for example to make sure an URL is reachable.
    
    Since:
    
    2.1
  - getChoices
```
public String getChoices()
```
    Returns:
    
    (String) choice collection. This a a JSON array string containing the values that are allowed for "default". Note: "choice" is optional, but if configured, only the values in the array are allowed values for the property. Example: ["browser", "atompub"] - this will allow only the two values "browser" and "atompub" to be configured.
    
    Since:
    
    2.1

Class TestProperty

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROP_NAME

PROP_TYPE

PROP_DEFAULT

PROP_GROUP

PROP_TITLE

PROP_DESCRIPTION

PROP_HIDE

PROP_MASK

PROP_VALIDATION

PROP_CHOICE_COLLECTION

Constructor Detail

TestProperty

Method Detail

getValueNames

toString

hashCode

equals

compareTo

addError

addError

getType

toProperties

addProperties

getErrors

getName

getDefault

getGroup

getTitle

getDescription

isHide

isMask

getValidation

getChoices