public class PropertyModel
extends java.lang.Object
implements java.io.Serializable
PropertyModel
objects are immutable.Modifier and Type | Class and Description |
---|---|
static class |
PropertyModel.Builder
Builder is used for constructing a
PropertyModel instance. |
static class |
PropertyModel.PropertyDependency
Represents a property's dependency on another property.
|
static class |
PropertyModel.PropertyValue
Represents a possible property value.
|
Modifier and Type | Method and Description |
---|---|
static PropertyModel.Builder |
builder()
Creates a new blank
PropertyModel.Builder object used for constructing a PropertyModel instance. |
static PropertyModel.Builder |
builder(PropertyModel template)
Creates a new
PropertyModel.Builder object, initialized with the values from the specified PropertyModel object. |
java.lang.String |
getDefaultValue()
Returns the property's default value.
|
java.util.List<PropertyModel.PropertyDependency> |
getDependencies()
Returns a list of property dependencies, which are other properties that this property depends on.
|
java.lang.String |
getDependsOnProperties()
Returns a comma-separated list of property names which, when changed, should trigger this property to be refreshed.
|
java.lang.String |
getExtensions()
Returns the comma-separated list of supported file extensions.
|
java.lang.String |
getExtensionsProperty()
Returns the name of another property, the value of which is a comma separated list of supported file extensions.
|
java.lang.String |
getLabel()
Returns the property label that appears in the UI.
|
java.lang.Integer |
getMaxValue()
Returns the property's maximum value.
|
java.lang.Integer |
getMinValue()
Returns the property's minimum value.
|
java.lang.String |
getName()
Returns the property name.
|
java.util.List<PropertyModel.PropertyValue> |
getPossibleValues()
Returns a list of possible values for this property.
|
java.lang.String |
getPrefix()
Returns the property prefix.
|
java.lang.String |
getSuffix()
Returns the property suffix.
|
java.lang.String |
getTooltip()
Returns the property's tooltip text.
|
DisplayType |
getType()
Returns the type of field that must be displayed in the UI for this property.
|
java.lang.String |
getUsernameProperty()
Returns the name of another property, the value of which is the OAuth username.
|
boolean |
isRequired()
Returns a boolean flag indicating whether this property is required.
|
public final DisplayType getType()
public final java.lang.String getName()
public final java.lang.String getLabel()
public final java.lang.String getPrefix()
public final java.lang.String getSuffix()
public final java.lang.String getTooltip()
public final java.lang.String getDefaultValue()
public java.lang.Integer getMinValue()
public java.lang.Integer getMaxValue()
public final java.lang.String getExtensions()
public final java.lang.String getExtensionsProperty()
public final java.lang.String getUsernameProperty()
public final java.lang.String getDependsOnProperties()
public final boolean isRequired()
true
if required, false
otherwisepublic final java.util.List<PropertyModel.PropertyValue> getPossibleValues()
PropertyModel.PropertyValue
objectspublic final java.util.List<PropertyModel.PropertyDependency> getDependencies()
PropertyModel.PropertyDependency
objectspublic static PropertyModel.Builder builder()
PropertyModel.Builder
object used for constructing a PropertyModel
instance.PropertyModel.Builder
objectpublic static PropertyModel.Builder builder(PropertyModel template)
PropertyModel.Builder
object, initialized with the values from the specified PropertyModel
object.template
- PropertyModel
instance used for initializing this builderPropertyModel.Builder
object