PropertyModel.Builder

java.lang.Object
- com.incorta.connector.model.PropertyModel.Builder

Enclosing class:

PropertyModel
```
public static class PropertyModel.Builder
extends java.lang.Object
```
Builder is used for constructing a PropertyModel instance.

Since:

1.0

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PropertyModel.Builder`	`addDependency(PropertyModel.PropertyDependency propertyDependency)` Adds a property dependency, which is another property that this property depends on.
`PropertyModel.Builder`	`addDependency(java.lang.String propertyName, java.lang.String propertyValue)` Adds a property dependency, which is another property that this property depends on.
`PropertyModel.Builder`	`addDependency(java.lang.String propertyName, java.lang.String propertyValue, boolean inverse)` Adds a property dependency, which is another property that this property depends on.
`PropertyModel.Builder`	`addPossibleValue(PropertyModel.PropertyValue possibleValue)` Adds a possible value for this property.
`PropertyModel.Builder`	`addPossibleValue(java.lang.String value, java.lang.String label)` Adds a possible value for this property.
`PropertyModel.Builder`	`addPossibleValue(java.lang.String value, java.lang.String label, java.lang.String type)` Adds a possible value for this property.
`PropertyModel`	`build()` Creates and returns a `PropertyModel` instance based on the specified values.
`PropertyModel.Builder`	`defaultValue(java.lang.String defaultValue)` Sets the property's default value.
`PropertyModel.Builder`	`dependencies(java.util.List<PropertyModel.PropertyDependency> dependencies)` Sets a list of property dependencies, which are other properties that this property depends on.
`PropertyModel.Builder`	`dependencies(PropertyModel.PropertyDependency... dependencies)` Sets a list of property dependencies, which are other properties that this property depends on.
`PropertyModel.Builder`	`dependsOnProperties(java.lang.String dependsOnProperties)` Sets a comma-separated list of property names which, when changed, should trigger this property to be refreshed.
`PropertyModel.Builder`	`extensions(java.lang.String extensions)` Sets the comma-separated list of supported file extensions.
`PropertyModel.Builder`	`extensionsProperty(java.lang.String extensionsProperty)` Sets the name of another property, the value of which is a comma separated list of supported file extensions.
`PropertyModel.Builder`	`label(java.lang.String label)` Sets the property label that appears in the UI.
`PropertyModel.Builder`	`maxValue(java.lang.Integer maxValue)` Sets the property's maximum value.
`PropertyModel.Builder`	`minValue(java.lang.Integer minValue)` Sets the property's minimum value.
`PropertyModel.Builder`	`name(java.lang.String name)` Sets the property name.
`PropertyModel.Builder`	`possibleValues(java.util.List<PropertyModel.PropertyValue> possibleValues)` Sets a list of possible values for this property.
`PropertyModel.Builder`	`possibleValues(PropertyModel.PropertyValue... possibleValues)` Sets a list of possible values for this property.
`PropertyModel.Builder`	`prefix(java.lang.String prefix)` Sets the property prefix.
`PropertyModel.Builder`	`required(boolean required)` Sets a boolean flag indicating whether this property is required.
`PropertyModel.Builder`	`suffix(java.lang.String suffix)` Sets the property suffix.
`PropertyModel.Builder`	`tooltip(java.lang.String tooltip)` Sets the property's tooltip text.
`PropertyModel.Builder`	`type(DisplayType type)` Sets the type of field that must be displayed in the UI for this property.
`PropertyModel.Builder`	`usernameProperty(java.lang.String usernameProperty)` Sets the name of another property, the value of which is the OAuth username.

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

- Method Detail
  - type
```
public PropertyModel.Builder type(DisplayType type)
```
    Sets the type of field that must be displayed in the UI for this property.
    
    Parameters:
    
    type - Property display type
    
    Returns:
    
    Builder object for chaining
    
    Since:
    
    1.0
  - name
```
public PropertyModel.Builder name(java.lang.String name)
```
    Sets the property name. This name does not appear in the UI, but is used to access the property in the Spec object.
    
    Parameters:
    
    name - Property name
    
    Returns:
    
    Builder object for chaining
    
    Since:
    
    1.0
  - label
```
public PropertyModel.Builder label(java.lang.String label)
```
    Sets the property label that appears in the UI.
    
    Parameters:
    
    label - Property label
    
    Returns:
    
    Builder object for chaining
    
    Since:
    
    1.0
  - prefix
```
public PropertyModel.Builder prefix(java.lang.String prefix)
```
    Sets the property prefix. A prefix is an optional text string that appears before the field.
    
    Parameters:
    
    prefix - Property prefix
    
    Returns:
    
    Builder object for chaining
    
    Since:
    
    1.0
  - suffix
```
public PropertyModel.Builder suffix(java.lang.String suffix)
```
    Sets the property suffix. A suffix is an optional text string that appears after the field.
    
    Parameters:
    
    suffix - Property suffix
    
    Returns:
    
    Builder object for chaining
    
    Since:
    
    1.0
  - tooltip
```
public PropertyModel.Builder tooltip(java.lang.String tooltip)
```
    Sets the property's tooltip text. A tooltip is an icon that appears next to the property and shows a helpful hint when the user hovers over it.
    
    Parameters:
    
    tooltip - Property tooltip
    
    Returns:
    
    Since:
    
    1.0
  - defaultValue
```
public PropertyModel.Builder defaultValue(java.lang.String defaultValue)
```
    Sets the property's default value.
    
    Parameters:
    
    defaultValue - Default value
    
    Returns:
    
    Builder object for chaining
    
    Since:
    
    1.0
  - minValue
```
public PropertyModel.Builder minValue(java.lang.Integer minValue)
```
    Sets the property's minimum value. This is only valid for numeric properties.
    
    Parameters:
    
    minValue - Minimum value
    
    Returns:
    
    Builder object for chaining
    
    Since:
    
    1.0
  - maxValue
```
public PropertyModel.Builder maxValue(java.lang.Integer maxValue)
```
    Sets the property's maximum value. This is only valid for numeric properties.
    
    Parameters:
    
    maxValue - Maximum value
    
    Returns:
    
    Builder object for chaining
    
    Since:
    
    1.0
  - extensions
```
public PropertyModel.Builder extensions(java.lang.String extensions)
```
    Sets the comma-separated list of supported file extensions. This is only valid for file upload properties.
    
    Parameters:
    
    extensions - Comma-separated list of file extensions
    
    Returns:
    
    Builder object for chaining
    
    Since:
    
    1.0
  - extensionsProperty
```
public PropertyModel.Builder extensionsProperty(java.lang.String extensionsProperty)
```
    Sets the name of another property, the value of which is a comma separated list of supported file extensions. This is only valid for file upload properties.
    
    Parameters:
    
    extensionsProperty - Extensions property name
    
    Returns:
    
    Builder object for chaining
    
    Since:
    
    1.0
  - usernameProperty
```
public PropertyModel.Builder usernameProperty(java.lang.String usernameProperty)
```
    Sets the name of another property, the value of which is the OAuth username. This is only valid for OAUTH properties.
    
    Parameters:
    
    usernameProperty - Username property
    
    Returns:
    
    Builder object for chaining
    
    Since:
    
    1.0
  - dependsOnProperties
```
public PropertyModel.Builder dependsOnProperties(java.lang.String dependsOnProperties)
```
    Sets a comma-separated list of property names which, when changed, should trigger this property to be refreshed. This is only valid for DYNAMIC_LIST properties.
    
    Parameters:
    
    dependsOnProperties - Comma-separated list of property names
    
    Returns:
    
    Builder object for chaining
    
    Since:
    
    1.0
  - required
```
public PropertyModel.Builder required(boolean required)
```
    Sets a boolean flag indicating whether this property is required.
    
    Parameters:
    
    required - true if required, false otherwise
    
    Returns:
    
    Builder object for chaining
    
    Since:
    
    1.0
  - possibleValues
```
public PropertyModel.Builder possibleValues(PropertyModel.PropertyValue... possibleValues)
```
    Sets a list of possible values for this property. This is only valid for LIST, LIST_WITH_OTHER and DYNAMIC_LIST properties.
    
    Parameters:
    
    possibleValues - An array of PropertyModel.PropertyValue objects
    
    Returns:
    
    Builder object for chaining
    
    Since:
    
    1.0
  - possibleValues
```
public PropertyModel.Builder possibleValues(java.util.List<PropertyModel.PropertyValue> possibleValues)
```
    Sets a list of possible values for this property. This is only valid for LIST, LIST_WITH_OTHER and DYNAMIC_LIST properties.
    
    Parameters:
    
    possibleValues - A list of PropertyModel.PropertyValue objects
    
    Returns:
    
    Builder object for chaining
    
    Since:
    
    1.0
  - addPossibleValue
```
public PropertyModel.Builder addPossibleValue(java.lang.String value,
                                              java.lang.String label)
```
    Adds a possible value for this property. This is only valid for LIST, LIST_WITH_OTHER and DYNAMIC_LIST properties.
    
    Parameters:
    
    value - Property option value
    
    label - Property option label
    
    Returns:
    
    Builder object for chaining
    
    Since:
    
    1.0
  - addPossibleValue
```
public PropertyModel.Builder addPossibleValue(java.lang.String value,
                                              java.lang.String label,
                                              java.lang.String type)
```
    Adds a possible value for this property. This is only valid for LIST, LIST_WITH_OTHER and DYNAMIC_LIST properties.
    
    Parameters:
    
    value - Property option value
    
    label - Property option label
    
    type - Property option type
    
    Returns:
    
    Builder object for chaining
    
    Since:
    
    1.0
  - addPossibleValue
```
public PropertyModel.Builder addPossibleValue(PropertyModel.PropertyValue possibleValue)
```
    Adds a possible value for this property. This is only valid for LIST, LIST_WITH_OTHER and DYNAMIC_LIST properties.
    
    Parameters:
    
    possibleValue - PropertyModel.PropertyValue object to be added
    
    Returns:
    
    Builder object for chaining
    
    Since:
    
    1.0
  - dependencies
```
public PropertyModel.Builder dependencies(PropertyModel.PropertyDependency... dependencies)
```
    Sets a list of property dependencies, which are other properties that this property depends on.
    
    Parameters:
    
    dependencies - An array of PropertyModel.PropertyDependency objects
    
    Returns:
    
    Builder object for chaining
    
    Since:
    
    1.0
  - dependencies
```
public PropertyModel.Builder dependencies(java.util.List<PropertyModel.PropertyDependency> dependencies)
```
    Sets a list of property dependencies, which are other properties that this property depends on.
    
    Parameters:
    
    dependencies - A list of PropertyModel.PropertyDependency objects
    
    Returns:
    
    Builder object for chaining
    
    Since:
    
    1.0
  - addDependency
```
public PropertyModel.Builder addDependency(java.lang.String propertyName,
                                           java.lang.String propertyValue)
```
    Adds a property dependency, which is another property that this property depends on.
    
    Parameters:
    
    propertyName - Target property name
    
    propertyValue - Target property value
    
    Returns:
    
    Builder object for chaining
    
    Since:
    
    1.0
  - addDependency
```
public PropertyModel.Builder addDependency(java.lang.String propertyName,
                                           java.lang.String propertyValue,
                                           boolean inverse)
```
    Adds a property dependency, which is another property that this property depends on.
    
    Parameters:
    
    propertyName - Target property name
    
    propertyValue - Target property value
    
    inverse - Inverse flag
    
    Returns:
    
    Builder object for chaining
    
    Since:
    
    1.0
  - addDependency
```
public PropertyModel.Builder addDependency(PropertyModel.PropertyDependency propertyDependency)
```
    Adds a property dependency, which is another property that this property depends on.
    
    Parameters:
    
    propertyDependency - A PropertyModel.PropertyDependency object
    
    Returns:
    
    Builder object for chaining
    
    Since:
    
    1.0
  - build
```
public PropertyModel build()
```
    Creates and returns a PropertyModel instance based on the specified values.
    
    Returns:
    
    PropertyModel instance
    
    Since:
    
    1.0

Class PropertyModel.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

type

name

label

prefix

suffix

tooltip

defaultValue

minValue

maxValue

extensions

extensionsProperty

usernameProperty

dependsOnProperties

required

possibleValues

possibleValues

addPossibleValue

addPossibleValue

addPossibleValue

dependencies

dependencies

addDependency

addDependency

addDependency

build