Package com.iizix.prop
Class LongProp
- java.lang.Object
- com.iizix.prop.GProp<java.lang.Long>
- com.iizix.prop.LongProp
 
 
- All Implemented Interfaces:
- EventListener,- IGProp<java.lang.Long>,- java.lang.Cloneable
 - public class LongProp extends GProp<java.lang.Long> The Long property class holds the property name, value and optionally has a parent and/or property listener(s).- 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- LongProp()Creates a Long property with no name and a null value.- LongProp(Atom propertyAtom)Creates a Long property with the specified name with a null value.- LongProp(Atom propertyAtom, long newValue)Creates a Long property with the specified name and 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 integer property value.- java.lang.Object- fromElementString(java.lang.String string)Called from the- initializeProperty(Element element)method once the element String is retrieved from the first child node of type "#text".- long- getLong()Gets the current value set as a "long".- long- getLong(long defaultValue)Gets the current value set as an "int" using- defaultValuefor an uninitialized 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.- boolean- initializeValue(PropMgr propertyManager, ReadTransaction trans)Initializes the property value from a transaction.- boolean- setPropValue(long newValue)Sets a new value for this property.- protected java.lang.Object- toNativeValue0(java.lang.Object value, int index)Tries conversion of possibly accepted properties values using the- setPropertyValuemethod into the most preferred property value type.- void- validatePropType(java.lang.Object newValue)Validates that the value to set is of Long 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, 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, initializeElement, 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
 
 
- Constructor Detail- LongProp- protected LongProp() Creates a Long property with no name and a null value.
 - LongProp- public LongProp(Atom propertyAtom) Creates a Long property with the specified name with a null value.- Parameters:
- propertyAtom- the property atom.
 
 - LongProp- public LongProp(Atom propertyAtom, long newValue) throws PropValidateException Creates a Long property with the specified name and value.- Parameters:
- propertyAtom- the property atom.
- newValue- the new long value for the property.
- Throws:
- PropValidateException- When the constraints are not met.
 
 
 - 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- setPropertyValuethrows- IllegalArgumentExceptionif the range in invalid, e.g. conversion of a Integer to a Byte, and the value is not -127 to 128.- Specified by:
- getValueClassesin interface- IGProp<java.lang.Long>
- Specified by:
- getValueClassesin class- GProp<java.lang.Long>
- Returns:
- The array of Java classes that can be accepted in the setPropertyValuemethod. The first type is the "native" or most preferred type. The array is at least one item in length and never null.
 
 - setPropValue- public boolean setPropValue(long newValue) throws PropValidateExceptionSets a new value for this property. If any listener is present and the value has changed compare to the last value, the listener is informed.- Parameters:
- newValue- the new value.
- Returns:
- boolean true for value has changed, false for same value as current value.
- Throws:
- PropValidateException- When the constraints are not met.
 
 - validatePropType- public void validatePropType(java.lang.Object newValue) throws PropTypeExceptionValidates that the value to set is of Long instance.- Note: When this method is called, synchronization is done at the property itself, so no synchronization on the tree should be done. - Specified by:
- validatePropTypein interface- IGProp<java.lang.Long>
- Specified by:
- validatePropTypein class- GProp<java.lang.Long>
- Parameters:
- newValue- The new value to set.
- Throws:
- PropTypeException- when the new value isn't of the correct class.
 
 - getLong- public long getLong() Gets the current value set as a "long".- Returns:
- long the value or -1for uninitialized value.
 
 - getLong- public long getLong(long defaultValue) Gets the current value set as an "int" using- defaultValuefor an uninitialized value.- Returns:
- long the value or defaultValuefor uninitialized value.
 
 - appendPropValue- protected void appendPropValue(PropMgr propertyManager, SendTransaction trans, java.lang.Object value) Appends the integer property value. If uninitialized,- -1is appended.- Specified by:
- appendPropValuein class- GProp<java.lang.Long>
- 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) throws PropException Initializes the property value from a transaction.- Specified by:
- initializeValuein class- GProp<java.lang.Long>
- Parameters:
- propertyManager- the property manager.
- trans- the transaction to initialize the property with.
- Returns:
- true if the value has changed, false otherwise.
- Throws:
- PropException
 
 - fromElementString- public java.lang.Object fromElementString(java.lang.String string) throws PropExceptionCalled from the- initializeProperty(Element element)method once the element String is retrieved from the first child node of type "#text".- The Object is converted from a String to an Integer. - Specified by:
- fromElementStringin interface- IGProp<java.lang.Long>
- Overrides:
- fromElementStringin class- GProp<java.lang.Long>
- Parameters:
- string- the String value of the object from the first child "#text" node.
- Returns:
- the Long value.
- Throws:
- PropException- when the conversion fails.
 
 - getPropValue0- protected java.lang.Object getPropValue0(java.lang.Object value, int index) throws java.lang.ExceptionGets 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:
- getPropValue0in class- GProp<java.lang.Long>
- 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.Exception- Other exceptions that could occur.
 
 - toNativeValue0- protected java.lang.Object toNativeValue0(java.lang.Object value, int index) throws java.lang.ExceptionTries conversion of possibly accepted properties values using the- setPropertyValuemethod into the most preferred property value type. If the input value already is of the preferred type, the same object is returned.- Specified by:
- toNativeValue0in class- GProp<java.lang.Long>
- 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.Exception- For conversion exceptions.