public interface XenonPropertyDescription
XenonPropertyDescription contains all necessary information about a property that is recognized by Xenon or one of its components.
Each XenonPropertyDescription contains the following information:
Map
.
XenonPropertyDescription.Type
enum).
Even though it is customary to pass the values of properties as String
s, the user should ensure the values can be
converted into the expected type.
Set
of XenonPropertyDescription.Component
).
Properties are only valid for certain components of Xenon. For example, some properties may be used when creating an new
Xenon
, while others can be used when creating a new Scheduler
, FileSystem
, or
Credential
.
Modifier and Type | Interface and Description |
---|---|
static class |
XenonPropertyDescription.Component
The Component enumeration lists all possible parts of Xenon for which a property can be provided.
|
static class |
XenonPropertyDescription.Type
This Type enumeration lists all possible types of properties recognized by Xenon.
|
Modifier and Type | Method and 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.util.Set<XenonPropertyDescription.Component> |
getLevels()
Return a set containing all components that accept this property.
|
java.lang.String |
getName()
Returns the name of the property.
|
XenonPropertyDescription.Type |
getType()
Returns the type of the property.
|
java.lang.String getName()
XenonPropertyDescription.Type getType()
java.util.Set<XenonPropertyDescription.Component> getLevels()
java.lang.String getDefaultValue()
null
is no default is set.java.lang.String getDescription()