com.iizix.prop

Class MethodReference

java.lang.Object

com.iizix.prop.GProp<String>

com.iizix.prop.StringProp

com.iizix.prop.MethodReference

All Implemented Interfaces:

EventListener, IGProp<String>, Cloneable

Direct Known Subclasses:

EditorMethodReference

public class MethodReference
extends StringProp

The Method Reference property class hold the reference to a Method that is in a Java class. This Java class reference "ClassReference" is held by a parent container in the tree. It includes support for Java Refactoring in Eclipse as well as Reference Validation.

Author:

Christopher Mindus

Field Summary

Fields

Modifier and Type	Field and Description
protected String	requiredAnnotation The required annotation, or null for none.
protected Method	runtimeMethod The method for runtime, null for none.

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 and Description
protected	MethodReference() Creates a Method Reference property with no name and with a null value.
	MethodReference(Atom propertyAtom) Creates a Method Reference property with the specified name with a null value.
	MethodReference(Atom propertyAtom, String newValue) Creates a Class Reference property with the specified name and value.

Method Summary

Modifier and Type	Method and Description
protected boolean	equalsErrors(PropError pe1, PropError pe2, int how) Processes error property verification.
Method	getRuntimeMethod() Gets the loaded method for runtime.
protected void	initializeElement(Element element) Called when the XML file for the property tree is serialized from properties.
protected void	initializeProp(Element element) Called to initialize the property from an Element.
protected boolean	isPropPrivateAtCreation() Called upon creation of the property to check it's private state.
Method	lookupMethod(ClassReference classReference, List<Throwable> errors, Class<?>... parameterTypes) Called when the application is being prepared by the owner of the method reference to look-up the method with the specified parameters.

Methods inherited from class com.iizix.prop.StringProp

appendPropValue, clone, getPropValue0, getString, getString, getValueClasses, initializeValue, setPropValue, toNativeValue0, validatePropType

Methods inherited from class com.iizix.prop.GProp

addPropError, addPropListener, convertPropError, dispose, equals, equals, 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, 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, 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

Field Detail

requiredAnnotation

protected String requiredAnnotation

The required annotation, or null for none.

runtimeMethod

protected Method runtimeMethod

The method for runtime, null for none.

Constructor Detail

MethodReference

protected MethodReference()

Creates a Method Reference property with no name and with a null value.

MethodReference

public MethodReference(Atom propertyAtom)

Creates a Method Reference property with the specified name with a null value.

Parameters:

propertyAtom - the property atom.

MethodReference

public MethodReference(Atom propertyAtom,
                       String newValue)

Creates a Class Reference property with the specified name and value.

Parameters:

propertyAtom - the property atom.

newValue - the new string value for the property.

Method Detail

isPropPrivateAtCreation

protected boolean isPropPrivateAtCreation()

Called upon creation of the property to check it's private state. This is used by properties that are not distributed to the remote party.

Overrides:

isPropPrivateAtCreation in class GProp<String>

Returns:

true, always.

equalsErrors

protected boolean equalsErrors(PropError pe1,
                               PropError pe2,
                               int how)

Processes error property verification. The default processing is to verify the two error properties pe1 and pe2 for equality if includeErrors is 0 or 1, and returns true if the value is 2=no comparison with error properties.

Override to verify property errors for reference properties.

Overrides:

equalsErrors in class GProp<String>

Parameters:

pe1 - The first error property, may be null.

pe2 - The second error property, may be null.

how - Flags EQC_* values for equal checking.

Returns:

Equality flag depending on includeErrors value.

initializeElement

protected void initializeElement(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.

Overrides:

initializeElement in class GProp<String>

Parameters:

element - The Element to initialize.

initializeProp

protected void initializeProp(Element element)
                       throws PropException

Called to initialize the property from an Element. The property should initialize itself from attributes and nodes with appropriate information.

Overrides:

initializeProp in class GProp<String>

Parameters:

element - The Element.

Throws:

PropException - when the initialization fails.

lookupMethod

public Method lookupMethod(ClassReference classReference,
                           List<Throwable> errors,
                           Class<?>... parameterTypes)

Called when the application is being prepared by the owner of the method reference to look-up the method with the specified parameters.

Parameters:

classReference - The class reference instance.

errors - A list of errors that occurred but did not cause an abort.

parameterTypes - The list of parameters.

getRuntimeMethod

public Method getRuntimeMethod()

Gets the loaded method for runtime.

Returns:

The loaded method, or null for none.