Property.Builder (JMinor Framework API 0.12.5-SNAPSHOT)

All Known Subinterfaces:

ColumnProperty.Builder, ForeignKeyProperty.Builder, TransientProperty.Builder

Enclosing interface:

Property
```
public static interface Property.Builder
```
Builds a Property instance

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Property`	`get()`
`Property.Builder`	`setBeanProperty(java.lang.String beanProperty)` Sets the bean name property to associate with this property
`Property.Builder`	`setDateTimeFormatPattern(java.lang.String dateTimeFormatPattern)` Sets the date/time format pattern used when presenting values
`Property.Builder`	`setDefaultValue(java.lang.Object defaultValue)` Sets the default value for this property, overrides the underlying column default value, if any
`Property.Builder`	`setDefaultValueProvider(Property.ValueProvider provider)` Sets the default value provider, use in case of dynamic default values.
`Property.Builder`	`setDescription(java.lang.String description)`
`Property.Builder`	`setEntityId(java.lang.String entityId)`
`Property.Builder`	`setFormat(java.text.Format format)` Sets the Format to use when presenting property values
`Property.Builder`	`setHidden(boolean hidden)`
`Property.Builder`	`setMax(double max)` Sets the maximum allowed value for this property, only applicable to numerical properties
`Property.Builder`	`setMaximumFractionDigits(int maximumFractionDigits)` Sets the maximum fraction digits to show for this property, only applicable to properties based on Types.DOUBLE.
`Property.Builder`	`setMaxLength(int maxLength)` Sets the maximum length of this property value, this applies to String (varchar) based properties
`Property.Builder`	`setMin(double min)` Only applicable to numerical properties
`Property.Builder`	`setMnemonic(java.lang.Character mnemonic)` Sets the mnemonic to use when creating a label for this property
`Property.Builder`	`setNullable(boolean nullable)` Specifies whether or not this property is nullable, in case of properties that are parts of a ForeignKeyProperty inherit the nullable state of that property.
`Property.Builder`	`setPreferredColumnWidth(int preferredColumnWidth)`
`Property.Builder`	`setReadOnly(boolean readOnly)`
`Property.Builder`	`setUseNumberFormatGrouping(boolean useGrouping)` Specifies whether to use number grouping when presenting the value associated with this property.

- Method Detail
  - get
```
Property get()
```
    Returns:
    
    the property
  - setEntityId
```
Property.Builder setEntityId(java.lang.String entityId)
```
    Parameters:
    
    entityId - the id of the entity this property is associated with
    
    Returns:
    
    this instance
    
    Throws:
    
    java.lang.IllegalStateException - in case the entityId has already been set
  - setBeanProperty
```
Property.Builder setBeanProperty(java.lang.String beanProperty)
```
    Sets the bean name property to associate with this property
    
    Parameters:
    
    beanProperty - the bean property name
    
    Returns:
    
    this instance
  - setDefaultValue
```
Property.Builder setDefaultValue(java.lang.Object defaultValue)
```
    Sets the default value for this property, overrides the underlying column default value, if any
    
    Parameters:
    
    defaultValue - the value to use as default
    
    Returns:
    
    this instance
  - setDefaultValueProvider
```
Property.Builder setDefaultValueProvider(Property.ValueProvider provider)
```
    Sets the default value provider, use in case of dynamic default values.
    
    Parameters:
    
    provider - the default value provider
    
    Returns:
    
    this instance
  - setHidden
```
Property.Builder setHidden(boolean hidden)
```
    Parameters:
    
    hidden - specifies whether this property should hidden in table views
    
    Returns:
    
    this instance
  - setMax
```
Property.Builder setMax(double max)
```
    Sets the maximum allowed value for this property, only applicable to numerical properties
    
    Parameters:
    
    max - the maximum allowed value
    
    Returns:
    
    this instance
  - setMin
```
Property.Builder setMin(double min)
```
    Only applicable to numerical properties
    
    Parameters:
    
    min - the minimum allowed value for this property
    
    Returns:
    
    this instance
  - setMaximumFractionDigits
```
Property.Builder setMaximumFractionDigits(int maximumFractionDigits)
```
    Sets the maximum fraction digits to show for this property, only applicable to properties based on Types.DOUBLE. This setting is overridden during subsequent calls to setFormat(Format). Note that values associated with this property are automatically rounded to maximumFractionDigits digits.
    
    Parameters:
    
    maximumFractionDigits - the maximum fraction digits
    
    Returns:
    
    this instance
  - setUseNumberFormatGrouping
```
Property.Builder setUseNumberFormatGrouping(boolean useGrouping)
```
    Specifies whether to use number grouping when presenting the value associated with this property. i.e. 1234567 shown as 1.234.567 or 1,234,567 depending on locale. By default grouping is not used. Only applicable to numerical properties. This setting is overridden during subsequent calls to setFormat
    
    Parameters:
    
    useGrouping - if true then number grouping is used
    
    Returns:
    
    this instance
  - setPreferredColumnWidth
```
Property.Builder setPreferredColumnWidth(int preferredColumnWidth)
```
    Parameters:
    
    preferredColumnWidth - the preferred column width of this property in pixels when displayed in a table
    
    Returns:
    
    this instance
  - setReadOnly
```
Property.Builder setReadOnly(boolean readOnly)
```
    Parameters:
    
    readOnly - specifies whether this property should be included during insert/update operations
    
    Returns:
    
    this instance
  - setNullable
```
Property.Builder setNullable(boolean nullable)
```
    Specifies whether or not this property is nullable, in case of properties that are parts of a ForeignKeyProperty inherit the nullable state of that property.
    
    Parameters:
    
    nullable - specifies whether or not this property accepts a null value
    
    Returns:
    
    this instance
  - setMaxLength
```
Property.Builder setMaxLength(int maxLength)
```
    Sets the maximum length of this property value, this applies to String (varchar) based properties
    
    Parameters:
    
    maxLength - the maximum length
    
    Returns:
    
    this instance
  - setMnemonic
```
Property.Builder setMnemonic(java.lang.Character mnemonic)
```
    Sets the mnemonic to use when creating a label for this property
    
    Parameters:
    
    mnemonic - the mnemonic character
    
    Returns:
    
    this instance
  - setDescription
```
Property.Builder setDescription(java.lang.String description)
```
    Parameters:
    
    description - a String describing this property
    
    Returns:
    
    this instance
  - setFormat
```
Property.Builder setFormat(java.text.Format format)
```
    Sets the Format to use when presenting property values
    
    Parameters:
    
    format - the format to use
    
    Returns:
    
    this instance
    
    Throws:
    
    java.lang.NullPointerException - in case format is null
    
    java.lang.IllegalArgumentException - in case the format does not fit the property type, f.ex. NumberFormat is expected for numerical properties
  - setDateTimeFormatPattern
```
Property.Builder setDateTimeFormatPattern(java.lang.String dateTimeFormatPattern)
```
    Sets the date/time format pattern used when presenting values
    
    Parameters:
    
    dateTimeFormatPattern - the format pattern
    
    Returns:
    
    this instance
    
    Throws:
    
    java.lang.IllegalArgumentException - in case the pattern is invalid or if this property is not a date/time based one

Interface Property.Builder

Method Summary

Method Detail

get

setEntityId

setBeanProperty

setDefaultValue

setDefaultValueProvider

setHidden

setMax

setMin

setMaximumFractionDigits

setUseNumberFormatGrouping

setPreferredColumnWidth

setReadOnly

setNullable

setMaxLength

setMnemonic

setDescription

setFormat

setDateTimeFormatPattern