Class AnnotationsContainer
- java.lang.Object
- com.iizix.prop.GProp<java.lang.Object>
- com.iizigo.java.parser.annotation.AnnotationsContainer
 
 
- All Implemented Interfaces:
- EventListener,- IGProp<java.lang.Object>,- java.lang.Cloneable
 - public class AnnotationsContainer extends GProp<java.lang.Object> Annotations container specialized to store annotations as GAnnotation.- 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 - Constructor - Description - AnnotationsContainer()Creates an GAnnotation array with no name and an empty HashMap<String,String>.- AnnotationsContainer(Atom propertyAtom)Creates an GAnnotation array property with the specified name with an empty HashMap<String,String>.
 - 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 string array to an outgoing transaction.- AnnotationsContainer- clone()Creates a clone out of this property.- 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.- void- initializeProp(org.w3c.dom.Element element)Called to initialize the property from an- Element.- boolean- initializeValue(PropMgr propertyManager, ReadTransaction trans)Initializes the property value from a transaction.- protected int- modifyPropValue(java.lang.Object oldValue, java.lang.Object newValue, PropMgr propMgr)Called when setting a new value for this property.- void- onEventSelf(GEvent event)Called when a property event is send to this property.- protected void- onPropDispose()Called when a property is disposed of by delete/remove in a container, or by the dispose method.- protected void- onReferenceEvent(ResolveReferencesEvent event)Called to perform reference resolving.- 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- Map<?,?>instance.- Methods inherited from class com.iizix.prop.GProp- addPropError, addPropListener, 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, 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, moveProp, moveProp, moveProp, onEvent, onPrepare, onPropInvalidateCache, onPropParentChanged, onPropTreeInitialized, onPropValueSet, 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- AnnotationsContainer- public AnnotationsContainer() Creates an GAnnotation array with no name and an empty HashMap<String,String>.
 - AnnotationsContainer- public AnnotationsContainer(Atom propertyAtom) Creates an GAnnotation array property with the specified name with an empty HashMap<String,String>.- Parameters:
- propertyAtom- the property atom.
 
 
 - Method Detail- onPropDispose- protected void onPropDispose() Called when a property is disposed of by delete/remove in a container, or by the dispose method.- Overrides:
- onPropDisposein class- GProp<java.lang.Object>
- See Also:
- GProp.onPropDispose()
 
 - 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.- Specified by:
- getValueClassesin interface- IGProp<java.lang.Object>
- Specified by:
- getValueClassesin class- GProp<java.lang.Object>
- 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.
 
 - clone- public AnnotationsContainer clone() throws java.lang.CloneNotSupportedException Creates a clone out of this property. The cloning is overridden by the subclasses in order to handle cloning of its class variables appropriately.- Cloning is used for "virtualization" of a property tree in the server. Client property classes will therefore throw - CloneNotSupportedException.- Once a tree has been cloned, the change-flag is reset, and the create-flag is set. All listeners are also removed! The new cloned property is an orphan, i.e. has no parent set. - Note that the cloning process is done WITHOUT thread synchronization for performance reasons, thus no modifications should be done to the tree! - The StrinMapProperty clones the HashMap used for the items. 
 - validatePropType- public void validatePropType(java.lang.Object newValue) throws PropTypeExceptionValidates that the value to set is of- Map<?,?>instance. Later, when setting the property, the method- modifyPropertyValuewill be called, and this one will require the type- Map<Integer,GAnnotation>in order not to throw- PropertyException.- Specified by:
- validatePropTypein interface- IGProp<java.lang.Object>
- Specified by:
- validatePropTypein class- GProp<java.lang.Object>
- Parameters:
- newValue- The new value to set.
- Throws:
- PropTypeException- if- newValueis not of- Map<Integer,GAnnotation>instance.
 
 - modifyPropValue- protected int modifyPropValue(java.lang.Object oldValue, java.lang.Object newValue, PropMgr propMgr) throws PropExceptionCalled when setting a new value for this property. This method is normally not overridden by subclasses, but e.g. for properties containing arrays, this may be handled here, in order not modify the "oldValue" (such as an array, but rather to change it with the data from the "newValue").- Overrides:
- modifyPropValuein class- GProp<java.lang.Object>
- Parameters:
- oldValue- The old value.
- newValue- The new value.
- propMgr- The property manager for remote change, null for local.
- Returns:
- 2 for value has changed and it's the same value, 0 for same value as current value.
- Throws:
- PropException- when the new value doesn't validate correctly.
 
 - appendPropValue- protected void appendPropValue(PropMgr propertyManager, SendTransaction trans, java.lang.Object value) Appends the string array to an outgoing transaction.- Specified by:
- appendPropValuein class- GProp<java.lang.Object>
- 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:
- initializeValuein class- GProp<java.lang.Object>
- Parameters:
- propertyManager- the property manager.
- trans- the transaction to initialize the property with.
- Returns:
- true if the value has changed, false otherwise.
 
 - initializeProp- public void initializeProp(org.w3c.dom.Element element) throws PropExceptionCalled to initialize the property from an- Element. The property should initialize itself from attributes and nodes with appropriate information.- This element creates sub-elements "item" that holds a text node. - Overrides:
- initializePropin class- GProp<java.lang.Object>
- Parameters:
- element- The- Element.
- Throws:
- PropException- when the initialization fails.
 
 - 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.- The attribute "sort" may be set to "client", "server" or not present, i.e. no sorting. The setting "server" indicates that the Server provides the sorting rule to use, settable for each client session programmatically. - After the element, elements "entry" builds up all text entries containing the strings in "key" and "value" attributes. - Overrides:
- initializeElementin class- GProp<java.lang.Object>
- Parameters:
- element- The- Elementto initialize.
 
 - 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.Object>
- 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.Object>
- 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.
 
 - onEventSelf- public void onEventSelf(GEvent event) Called when a property event is send to this property.- A subclass can override this method to perform appropriate processing and is not required to call - super.onEventSelf(e).- Specified by:
- onEventSelfin interface- IGProp<java.lang.Object>
- Overrides:
- onEventSelfin class- GProp<java.lang.Object>
- Parameters:
- event- The property event.
 
 - onReferenceEvent- protected void onReferenceEvent(ResolveReferencesEvent event) Called to perform reference resolving. A property should override this method if it needs to perform reference resolving and validation.- Subclasses override this method and only subclasses extending - PropCnrneeds to call- super.onReferenceEvent(ResolveReferenceEvent event).- Overrides:
- onReferenceEventin class- GProp<java.lang.Object>
- Parameters:
- event- The resolve references event.