ValueProperty (pl.decerto:hyperon-persistence 1.12.2 API)

java.lang.Object
- pl.decerto.hyperon.persistence.model.value.Property
- - pl.decerto.hyperon.persistence.model.value.ValueProperty

All Implemented Interfaces:

Iterable<Property>, Handle
```
public class ValueProperty
extends Property
```
This class represents value property, which is a simple wrapper for any value of simple type. These values should be type of any allowed types by TypeConverter.

Author:

przemek hertel

Implementation Note:

instead of providing simple types as String, there should be enum of allowed types and/or proper helper static methods.

See Also:

TypeConverter, ValueHolder

Constructor Summary

Constructors
Constructor and Description
`ValueProperty(String simpleType)` Creates `ValueProperty` based on simple type name.
`ValueProperty(String simpleType, String text)` Creates `ValueProperty` based on simple type and given `text` for `StringHolder`.
`ValueProperty(String simpleType, ValueHolder holder)` Creates `ValueProperty` based on simple type name and prepared `ValueHolder` with value.
`ValueProperty(TypeDef type, ValueHolder holder)` Creates `ValueProperty` based on provided `type` type definition and prepared `ValueHolder` with value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`booleanValue()`
`Property`	`deepcopy(boolean resetIds)` Returns deep copy of this property's subtree.
`boolean`	`equals(Object o)`
`Boolean`	`getBoolean()`
`Date`	`getDate()`
`Date`	`getDatetime()`
`BigDecimal`	`getDecimal()`
`ElementType`	`getElementType()` Gets associated element type, based on property implementation.
`ValueHolder`	`getHolder()`
`long`	`getId()`
`Integer`	`getInteger()`
`Long`	`getLong()`
`double`	`getNumber()`
`Object`	`getObject()`
`String`	`getSimpleType()`
`String`	`getString()`
`ValueHolder`	`getValue()`
`int`	`hashCode()`
`int`	`intValue()`
`boolean`	`isValue()` Is property a value type.
`void`	`print(StringBuilder sb, int level, String prefix, String suffix)` Adds to `sb` formatted String, specific for `ValueProperty`, which looks like: `* code = CA (string) * premium = 100 (number) * su = 10000 (number)`
`void`	`set(Object value)` Sets new simple value, which must be supported by `TypeConverter`.
`void`	`setValue(ValueHolder value)` Sets value holder and state of this property to `EntityState#PERSISTENT`.
`String`	`toString()`

Methods inherited from class pl.decerto.hyperon.persistence.model.value.Property
add, add, asCollection, asEntity, asRef, asValue, at, booleanValue, bundle, clear, create, deepcopy, get, getBoolean, getBundle, getCanonicalPath, getCollection, getContainer, getDate, getDatetime, getDecimal, getEntity, getHolder, getInteger, getLong, getName, getNumber, getOwnerId, getOwnerPropertyName, getParent, getParentName, getPath, getRefCount, getRefTarget, getState, getString, getType, getTypeCode, intValue, isCollection, isEntity, isPersistent, isRoot, isTransient, iterator, print, remove, remove, resetIds, set, setContainer, setName, setOwnerId, setParent, setupOwnerId, size, traverse, traverse

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

Methods inherited from interface pl.decerto.hyperon.persistence.model.value.Handle
find, has, isRef

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - ValueProperty
```
public ValueProperty(String simpleType)
```
    Creates ValueProperty based on simple type name.
    
    Parameters:
    
    simpleType - supported simple type
  - ValueProperty
```
public ValueProperty(TypeDef type,
                     ValueHolder holder)
```
    Creates ValueProperty based on provided type type definition and prepared ValueHolder with value.
    
    Parameters:
    
    type - definition type
    
    holder - holder with value
  - ValueProperty
```
public ValueProperty(String simpleType,
                     ValueHolder holder)
```
    Creates ValueProperty based on simple type name and prepared ValueHolder with value.
    
    Parameters:
    
    simpleType - supported simple type
    
    holder - holder with value
  - ValueProperty
```
public ValueProperty(String simpleType,
                     String text)
```
    Creates ValueProperty based on simple type and given text for StringHolder.
    
    Parameters:
    
    simpleType - supported simple type
    
    text - value for StringHolder
- Method Detail
  - getValue
```
public ValueHolder getValue()
```
    Returns:
    
    value holder, that might have null value.
  - getObject
```
public Object getObject()
```
    Returns:
    
    direct value from holder or null if there is no holder
  - setValue
```
public final void setValue(ValueHolder value)
```
    Sets value holder and state of this property to EntityState#PERSISTENT.
    
    Parameters:
    
    value - for this property
  - getSimpleType
```
public String getSimpleType()
```
    Returns:
    
    simple type name from definition
    
    See Also:
    
    TypeDef
  - deepcopy
```
public Property deepcopy(boolean resetIds)
```
    Returns deep copy of this property's subtree.
    
    Specified by:
    
    deepcopy in class Property
    
    Parameters:
    
    resetIds - whether to reset ids on copy
    
    Returns:
    
    property created from deepcopy
    
    See Also:
    
    Property.deepcopy()
  - print
```
public void print(StringBuilder sb,
                  int level,
                  String prefix,
                  String suffix)
```
    Adds to sb formatted String, specific for ValueProperty, which looks like:
```
         * code = CA  (string)
         * premium = 100  (number)
         * su = 10000  (number)
 
```
    Specified by:
    
    print in class Property
    
    Parameters:
    
    sb - StringBuilder containing data to print
    
    level - level used to indentation
    
    prefix - value to used as prefix
    
    suffix - value to used as suffix
    
    See Also:
    
    toString()
  - set
```
public void set(Object value)
```
    Sets new simple value, which must be supported by TypeConverter.
    
    Specified by:
    
    set in interface Handle
    
    Overrides:
    
    set in class Property
    
    Parameters:
    
    value - new simple value
    
    Throws:
    
    HyperonRuntimeException - if value is not supported
  - getString
```
public String getString()
```
    Description copied from class: Property
    
    Specified by:
    
    getString in interface Handle
    
    Overrides:
    
    getString in class Property
    
    Returns:
    
    value converted to String
    
    See Also:
    
    TypeConverter.getString(Object)
  - getInteger
```
public Integer getInteger()
```
    Description copied from class: Property
    
    Specified by:
    
    getInteger in interface Handle
    
    Overrides:
    
    getInteger in class Property
    
    Returns:
    
    value converted to Integer
    
    See Also:
    
    TypeConverter.getInteger(Object)
  - getDecimal
```
public BigDecimal getDecimal()
```
    Description copied from class: Property
    
    Specified by:
    
    getDecimal in interface Handle
    
    Overrides:
    
    getDecimal in class Property
    
    Returns:
    
    value converted to BigDecimal
    
    See Also:
    
    TypeConverter.getDecimal(Object)
  - booleanValue
```
public boolean booleanValue()
```
    Description copied from class: Property
    
    Specified by:
    
    booleanValue in interface Handle
    
    Overrides:
    
    booleanValue in class Property
    
    Returns:
    
    value converted to boolean
    
    See Also:
    
    TypeConverter.getBoolean(Object)
  - getBoolean
```
public Boolean getBoolean()
```
    Description copied from class: Property
    
    Specified by:
    
    getBoolean in interface Handle
    
    Overrides:
    
    getBoolean in class Property
    
    Returns:
    
    value converted to Boolean
    
    See Also:
    
    TypeConverter.toBooleanHolder(Object)
  - getDate
```
public Date getDate()
```
    Description copied from class: Property
    
    Specified by:
    
    getDate in interface Handle
    
    Overrides:
    
    getDate in class Property
    
    Returns:
    
    value converted to Date
    
    See Also:
    
    TypeConverter.getDate(Object)
  - getDatetime
```
public Date getDatetime()
```
    Description copied from class: Property
    
    Specified by:
    
    getDatetime in interface Handle
    
    Overrides:
    
    getDatetime in class Property
    
    Returns:
    
    value converted to Date with time
    
    See Also:
    
    TypeConverter.getDatetime(Object)
  - getHolder
```
public ValueHolder getHolder()
```
    Description copied from class: Property
    
    Specified by:
    
    getHolder in interface Handle
    
    Overrides:
    
    getHolder in class Property
    
    Returns:
    
    value as ValueHolder
  - getLong
```
public Long getLong()
```
    Description copied from class: Property
    
    Specified by:
    
    getLong in interface Handle
    
    Overrides:
    
    getLong in class Property
    
    Returns:
    
    value converted to Date with time
    
    See Also:
    
    TypeConverter.getDatetime(Object)
  - getNumber
```
public double getNumber()
```
    Description copied from class: Property
    
    Specified by:
    
    getNumber in interface Handle
    
    Overrides:
    
    getNumber in class Property
    
    Returns:
    
    value converted to double
    
    See Also:
    
    TypeConverter.getNumber(Object)
  - intValue
```
public int intValue()
```
    Description copied from class: Property
    
    Specified by:
    
    intValue in interface Handle
    
    Overrides:
    
    intValue in class Property
    
    Returns:
    
    value converted to int
    
    See Also:
    
    TypeConverter.toIntegerHolder(Object)
  - getElementType
```
public ElementType getElementType()
```
    Description copied from interface: Handle
    
    Gets associated element type, based on property implementation.
    
    Returns:
    
    ElementType.VALUE element type
    
    See Also:
    
    Handle.get(String)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    Returns:
    
    formatted String
    
    See Also:
    
    print(StringBuilder, int, String, String)
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Property
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Property
  - getId
```
public long getId()
```
    Specified by:
    
    getId in class Property
    
    Returns:
    
    id of property
  - isValue
```
public boolean isValue()
```
    Description copied from class: Property
    
    Is property a value type.
    
    Specified by:
    
    isValue in interface Handle
    
    Overrides:
    
    isValue in class Property
    
    Returns:
    
    true
    
    See Also:
    
    ValueProperty

Class ValueProperty

Constructor Summary

Method Summary

Methods inherited from class pl.decerto.hyperon.persistence.model.value.Property

Methods inherited from class java.lang.Object

Methods inherited from interface pl.decerto.hyperon.persistence.model.value.Handle

Methods inherited from interface java.lang.Iterable

Constructor Detail

ValueProperty

ValueProperty

ValueProperty

ValueProperty

Method Detail

getValue

getObject

setValue

getSimpleType

deepcopy

print

set

getString

getInteger

getDecimal

booleanValue

getBoolean

getDate

getDatetime

getHolder

getLong

getNumber

intValue

getElementType

toString

equals

hashCode

getId

isValue