Package com.iizix.server.prop
Class ServerConfigEnvReference
- java.lang.Object
- com.iizix.prop.GProp<ReferenceString>
- com.iizix.prop.AbstractReference<ServerConfigEnvProps>
- com.iizix.server.prop.ServerConfigEnvReference
- All Implemented Interfaces:
EventListener
,ICircularRetargetParent
,IGProp<ReferenceString>
,IPropReference
,java.lang.Cloneable
public class ServerConfigEnvReference extends AbstractReference<ServerConfigEnvProps>
The ServerConfigEnvReference property class hold the reference to a Server configuration environment.- Author:
- Christopher Mindus
Nested Class Summary
Nested classes/interfaces inherited from interface com.iizix.prop.IPropReference
IPropReference.ReferenceChangeEvent
Field Summary
Fields inherited from class com.iizix.prop.AbstractReference
ERROR_ID, hasBeenValidated, QUICK_FIX_DELETE_PROP, reference
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 ServerConfigEnvReference()
Creates a Server configuration environment Reference property with no name and with a null value.ServerConfigEnvReference(Atom propertyAtom)
Creates a Server configuration environment Reference property with the specified name with a null value.ServerConfigEnvReference(Atom propertyAtom, java.lang.String newValue)
Creates a Server configuration environment Reference property with the specified name and value.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.lang.String
getLookupPropReference(ReferenceString name)
Creates the reference string to look-up from the ReferenceString.java.lang.Class<ServerConfigEnvProps>
getPropertyClass()
Gets the class wanted.java.lang.String
getReferenceDescription()
Gets a short description of this reference.ServerConfigEnvProps
getServerConfigEnvironment()
Gets the Server configuration environment for this reference.protected boolean
isPropPrivateAtCreation()
Called upon creation of the property to check it's private state.boolean
isReferenceValid(GProp<?> property)
Validates the property reference that has been looked up.protected java.lang.String
setLookedUpReference(java.lang.String name)
Sets the reference found that also has been validated.Methods inherited from class com.iizix.prop.AbstractReference
appendPropValue, assignError, assignNotFoundError, changeReference, checkCreateReference, clearError, clearFixedTarget, clone, createUpdateReference, disposeReference, doPostResolve, equalsErrors, equalValues, getFixedTarget, getPropValue0, getReference, getReferences, getReferenceString, getTargetReference, getTargetReference, getValueClasses, informClearError, informError, informResolved, initializeReferenceClone, initializeValue, isValid, onEventSelf, onProjectNameChanged, onPropDispose, onPropParentChanged, onRefactored, onReferenceDisposed, onReferenceEvent, onReferenceEvent, setPropValue, toNativeValue0, updateReference, validatePropType, validateReferenceScope, wouldValidate
Methods inherited from class com.iizix.prop.GProp
addPropError, addPropListener, convertPropError, dispose, equals, equals, equalsObj, equalsPropValue, equalsTree, 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, 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, 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, onPrepare, onPropInvalidateCache, 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
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.iizix.prop.ICircularRetargetParent
isCircularRetargetParent
Constructor Detail
ServerConfigEnvReference
public ServerConfigEnvReference()
Creates a Server configuration environment Reference property with no name and with a null value.
ServerConfigEnvReference
public ServerConfigEnvReference(Atom propertyAtom)
Creates a Server configuration environment Reference property with the specified name with a null value.- Parameters:
propertyAtom
- the property atom.
ServerConfigEnvReference
public ServerConfigEnvReference(Atom propertyAtom, java.lang.String newValue)
Creates a Server configuration environment 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 classGProp<ReferenceString>
- Returns:
- true, always.
getReferenceDescription
public java.lang.String getReferenceDescription()
Gets a short description of this reference.- Specified by:
getReferenceDescription
in interfaceIPropReference
- Specified by:
getReferenceDescription
in classAbstractReference<ServerConfigEnvProps>
- Returns:
- "Server configuration environment".
getPropertyClass
public java.lang.Class<ServerConfigEnvProps> getPropertyClass()
Gets the class wanted.- Specified by:
getPropertyClass
in classAbstractReference<ServerConfigEnvProps>
- Returns:
- ServerConfigEnvProps.class.
isReferenceValid
public boolean isReferenceValid(GProp<?> property)
Validates the property reference that has been looked up.- Specified by:
isReferenceValid
in interfaceIPropReference
- Specified by:
isReferenceValid
in classAbstractReference<ServerConfigEnvProps>
- Parameters:
property
- The property to validate.- Returns:
- true if valid, false otherwise.
getServerConfigEnvironment
public ServerConfigEnvProps getServerConfigEnvironment()
Gets the Server configuration environment for this reference.The method first attempts to use the resolved mechanism of getting the selector. If this has failed or has not been resolved yet, the property tree will be used to search for it. The latter is, of course, slower.
- Returns:
- The
Selector
instance, ornull
if not found.
getLookupPropReference
protected java.lang.String getLookupPropReference(ReferenceString name)
Creates the reference string to look-up from the ReferenceString. Override this method for e.g. Base or Fixed Relative referencing.- Overrides:
getLookupPropReference
in classAbstractReference<ServerConfigEnvProps>
- Parameters:
name
- The reference name.- Returns:
- The property reference string to look-up.
setLookedUpReference
protected java.lang.String setLookedUpReference(java.lang.String name)
Sets the reference found that also has been validated. This method gives the opportunity for a subclass to remove e.g. the Base or Fixed Relative reference from the string start.- Overrides:
setLookedUpReference
in classAbstractReference<ServerConfigEnvProps>
- Parameters:
name
- The full reference.- Returns:
- The reference to set in this property as ReferenceString.