java.lang.Object
- com.iizix.prop.GProp<T>
- - com.iizix.prop.PrivProp<T>

All Implemented Interfaces:
EventListener, IGProp<T>, java.lang.Cloneable
```
public class PrivProp<T>
extends GProp<T>
```
The private property class is used on the client as a dummy property in order to keep the structure of properties with the indexes as the server does, apart from that a private property can replace a property container.
The property value is always null.
Author:
Christopher Mindus

Field Summary
- Fields inherited from class com.iizix.prop.GProp
  GPDEBUG, PROP_ATTR_STRING_EDITOR_PROP, PROP_ATTR_STRING_ERRORED_NAME, PROP_ATTR_STRING_EXTENDS, PROP_ATTR_STRING_EXTENDS_FINAL, PROP_ATTR_STRING_EXTENDS_PRIVATE, PROP_ATTR_STRING_NULLABLE, PROP_ATTR_STRING_PRIVATE, PROP_ATTR_STRING_PRIVATE_CHANGE_EVENT, PROP_ATTR_STRING_READ_ONLY, PROP_USER_1, PROP_USER_2
- Fields inherited from interface com.iizix.prop.IGProp
  EQC_ERROR_IGNORE_ALL, EQC_ERROR_IGNORE_REFERENCES, EQC_IGNORE_ARRAY, EQC_IGNORE_VOLATILE_OR_EDITOR, EQC_PRIVATE, EQC_SAVE_FILE, EXT_CONTAINER_EXTENDS, EXT_CONTAINER_EXTENDS_VALID, EXT_EXTENDED, EXT_FINAL, EXT_OVERRIDES, EXT_OVERRIDES_FINAL_ERR, EXT_PRIVATE

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`PrivProp()`	Creates a private property with no name with a null value.
	`PrivProp(Atom atom)`	Creates a private property with the specified atom name with a null value.
	`PrivProp(Atom atom, java.lang.Object value)`	Creates a private property with the specified atom name with a value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`appendPropValue(PropMgr propertyManager, SendTransaction trans, java.lang.Object value)`	Appends the private property value.
`protected java.lang.Object`	`getPropValue0(java.lang.Object value, int index)`	Gets the property value in another class form than the "native" one.
`java.lang.Class<?>[]`	`getValueClasses()`	Gets the list of possible native Java classes that can be used to set a value using `setPropertyValue`, in order of importance.
`protected void`	`initializeElement(org.w3c.dom.Element element)`	Called when the XML file for the property tree is serialized from properties.
`boolean`	`initializeValue(PropMgr propertyManager, ReadTransaction trans)`	Initializes the property value from a transaction.
`void`	`initializeValue(org.w3c.dom.Element element)`	Called to initialize the property from an `Element`.
`protected java.lang.Object`	`toNativeValue0(java.lang.Object value, int index)`	Tries conversion of possibly accepted properties values using the `setPropertyValue` method into the most preferred property value type.
`void`	`validatePropType(java.lang.Object newValue)`	Validates that the value to set is of Boolean instance.

Methods inherited from class com.iizix.prop.GProp
addPropError, addPropListener, clone, convertPropError, dispose, equals, equals, equalsErrors, equalsObj, equalsPropValue, equalsTree, equalValues, extendsClone, finalize, fine, fine, finer, finer, finest, finest, fromElementString, getAliasName, getAppSessionGyro, getAppWorker, getAtomPath, getAttribute, getChildReferencePropName, getClientSessionGyro, getClientWorker, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropName, getFullPropNameDebug, getFullPropNameDebug, getListeners, getModuleFolder, getModuleFolder, getParent, getParent, getProjectName, getPropAtom, getPropBaseReference, getPropError, getPropError, getPropErroredName, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromPath, getPropFromReference, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropReferenceTarget, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getPropValueObject, getReferencePropName, getReferences, getRelativePropName, getRootFromName, getRootName, getRootParent, getRootParent, getTreeLock, getVSReference, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, initializeProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCommunicating, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropForEditor, isPropNullable, isPropPrivate, isPropPrivateAtCreation, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropUSER, isPropValueTreeLockNeeded, isPropVirtualized, isPropVirtualizing, isPropVolatile, isPropVolatileOrEditorOnly, isProxied, list, list, list, list, list, mapAliasToReference, mapAliasToReference, mapReferenceToAlias, mapReferenceToAlias, mapReferenceToProjectRelative, modifyPropValue, moveProp, moveProp, moveProp, onEvent, onEventSelf, onPrepare, onPropDispose, onPropInvalidateCache, onPropParentChanged, onPropTreeInitialized, onPropValueSet, onReferenceEvent, onRemoteEvent, onVirtualizationCompleted, onVirtualized, paramString, paramValue, post, post, removePropError, removePropListener, removePropUSER, renameProp, renameProp2, resetChangedTree, resolveRuntimeReferences, setChanged, setConstraints, setConstraints, setCreateRequiredProp, setParent, setPrivateChangeEventProp, setPrivateCreateRequiredProp, setPropError, setPropErroredName, setPropExtended, setPropExtendsFinal, setPropExtendsPrivate, setPropForEditor, setPropNullable, setPropPrivate, setPropReadOnly, setPropUSER, setPropValue, setPropValue, setPropValue, setPropValueIncognito, setPropVolatile, severe, severe, severe, shouldSerializeToXML, throwIfReadOnly, toElementString, toNativeValue, toString, toString, triggerRemoteEvent, triggerRemoteEvent, validateProp, validatePropValue, verify, verifyHasPropertyItem, virtualize, warning, warning, warning

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

- Constructor Detail
  - PrivProp
```
protected PrivProp()
```
    Creates a private property with no name with a null value.
  - PrivProp
```
public PrivProp(Atom atom)
```
    Creates a private property with the specified atom name with a null value.
  - PrivProp
```
public PrivProp(Atom atom,
                java.lang.Object value)
```
    Creates a private property with the specified atom name with a value. The value is set "incognito" and cannot be changed.
- Method Detail
  - getValueClasses
```
public java.lang.Class<?>[] getValueClasses()
```
    Gets the list of possible native Java classes that can be used to set a value using setPropertyValue, in order of importance. Note that loss of precision in data if e.g. an Float property accepts a Double. However, the setPropertyValue throws IllegalArgumentException if the range in invalid, e.g. conversion of a Integer to a Byte, and the value is not -127 to 128.
    Specified by:
    getValueClasses in interface IGProp<T>
    Specified by:
    getValueClasses in class GProp<T>
    Returns:
    The array of Java classes that can be accepted in the setPropertyValue method. The first type is the "native" or most preferred type. The array is at least one item in length and never null.
  - validatePropType
```
public void validatePropType(java.lang.Object newValue)
                      throws PropTypeException
```
    Validates that the value to set is of Boolean instance.
    Specified by:
    validatePropType in interface IGProp<T>
    Specified by:
    validatePropType in class GProp<T>
    Parameters:
    newValue - The new value to set.
    Throws:
    PropTypeException - always thrown if newValue is not null.
  - appendPropValue
```
protected void appendPropValue(PropMgr propertyManager,
                               SendTransaction trans,
                               java.lang.Object value)
```
    Appends the private property value. If uninitialized, false is appended.
    The PrivateProperty always throws InternalError when this method is called because it shouldn't be called!
    Specified by:
    appendPropValue in class GProp<T>
    Parameters:
    propertyManager - the property manager instance.
    trans - transaction to append the properties to.
    value - the value to append to the transaction, a reference to the current property value.
  - initializeValue
```
public boolean initializeValue(PropMgr propertyManager,
                               ReadTransaction trans)
```
    Initializes the property value from a transaction.
    Specified by:
    initializeValue in class GProp<T>
    Parameters:
    propertyManager - the property manager.
    trans - the transaction to initialize the property with.
    Returns:
    true if the value has changed, false otherwise.
  - initializeValue
```
public void initializeValue(org.w3c.dom.Element element)
```
    Called to initialize the property from an Element. The property should initialize itself from attributes and nodes with appropriate information.
    This method does nothing...
    Parameters:
    element - The Element to initialize the property from.
  - initializeElement
```
protected void initializeElement(org.w3c.dom.Element element)
```
    Called when the XML file for the property tree is serialized from properties. The property should fill attributes and nodes with appropriate information.
    This method does nothing...
    Overrides:
    initializeElement in class GProp<T>
    Parameters:
    element - The Element to initialize.
  - getPropValue0
```
protected java.lang.Object getPropValue0(java.lang.Object value,
                                         int index)
                                  throws java.lang.Exception
```
    Gets the property value in another class form than the "native" one. This method tries conversion of a "native" property value into another class type. This method is used when filling in a POJO variable (Plain Old Java Object Field) from a "native" property value.
    Specified by:
    getPropValue0 in class GProp<T>
    Parameters:
    value - The property value.
    index - The index in the Class array returned by getValueClasses().
    Returns:
    The property value in the requested class, after conversion.
    Throws:
    java.lang.IllegalArgumentException - Invalid index, this should never happen though.
    java.lang.Exception - Other exceptions that could occur.
  - toNativeValue0
```
protected java.lang.Object toNativeValue0(java.lang.Object value,
                                          int index)
                                   throws java.lang.Exception
```
    Tries conversion of possibly accepted properties values using the setPropertyValue method into the most preferred property value type. If the input value already is of the preferred type, the same object is returned.
    Specified by:
    toNativeValue0 in class GProp<T>
    Parameters:
    value - The input value to convert to native value.
    index - The index in the array returned by getValueClasses(), or -1 if not found.
    Returns:
    The converted input value in the preferred property value object type.
    Throws:
    java.lang.IllegalArgumentException - Invalid index, this should never happen though.
    java.lang.Exception - For conversion exceptions.

Class PrivProp<T>

Field Summary

Fields inherited from class com.iizix.prop.GProp

Fields inherited from interface com.iizix.prop.IGProp

Constructor Summary

Method Summary

Methods inherited from class com.iizix.prop.GProp

Methods inherited from class java.lang.Object

Constructor Detail

PrivProp

PrivProp

PrivProp

Method Detail

getValueClasses

validatePropType

appendPropValue

initializeValue

initializeValue

initializeElement

getPropValue0

toNativeValue0