XenonPropertyDescription (xenon 3.1.0 API)

java.lang.Object
- nl.esciencecenter.xenon.XenonPropertyDescription

```
public class XenonPropertyDescription
extends java.lang.Object
```
XenonPropertyDescription contains all necessary information about a property that is recognized by Xenon

Each XenonPropertyDescription contains the following information:
- A name that uniquely identifies the property. This name should be used as a key when passing properties to Xenon in a Map.
- A (human-readable) description that explains the use of the property.
- The type of values that are accepted for the property (one of the XenonPropertyDescription.Type enum). Even though it is customary to pass the values of properties as Strings, the user should ensure the values can be converted into the expected type.
- The default value of the property.
Since:

1.0

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class XenonPropertyDescription.Type
This Type enumeration lists all possible types of properties recognized by Xenon.

Constructor Summary

Constructors
Constructor	Description
`XenonPropertyDescription(java.lang.String name, XenonPropertyDescription.Type type, java.lang.String defaultValue, java.lang.String description)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getDefaultValue()`	Returns the default value for this property.
`java.lang.String`	`getDescription()`	Returns a human readable description of this property.
`java.lang.String`	`getName()`	Returns the name of the property.
`XenonPropertyDescription.Type`	`getType()`	Returns the type of the property.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - XenonPropertyDescription
```
public XenonPropertyDescription(java.lang.String name,
                                XenonPropertyDescription.Type type,
                                java.lang.String defaultValue,
                                java.lang.String description)
```
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Returns the name of the property.
    
    Returns:
    
    the name of the property.
  - getType
```
public XenonPropertyDescription.Type getType()
```
    Returns the type of the property.
    
    Returns:
    
    the type of the property.
  - getDefaultValue
```
public java.lang.String getDefaultValue()
```
    Returns the default value for this property.
    
    Returns:
    
    the default value for this property or null is no default is set.
  - getDescription
```
public java.lang.String getDescription()
```
    Returns a human readable description of this property.
    
    Returns:
    
    a human readable description of this property.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object