public class StringProp extends GProp<String>
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_2EQC_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| Modifier | Constructor and Description |
|---|---|
protected |
StringProp()
Creates a String property with no name and with a null value.
|
|
StringProp(Atom propertyAtom)
Creates a String property with the specified name with a null value.
|
|
StringProp(Atom propertyAtom,
String newValue)
Creates a String property with the specified name and value.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
appendPropValue(PropMgr propertyManager,
Transaction trans,
Object value)
Appends the string property value.
|
StringProp |
clone()
Clones the String property.
|
protected Object |
getPropValue0(Object value,
int index)
Gets the property value in another class form than the "native" one.
|
String |
getString()
Gets the current value set as a String.
|
String |
getString(String defaultValue)
Gets the current value set as a String using
defaultValue for an
uninitialized value. |
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,
Transaction trans)
Initializes the property value from a transaction.
|
boolean |
setPropValue(String newValue)
Sets a new value for this property.
|
protected Object |
toNativeValue0(Object value,
int index)
Tries conversion of possibly accepted properties values using the
setPropertyValue method
into the most preferred property value type. |
void |
validatePropType(Object newValue)
Validates that the value to set is of String instance.
|
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, 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, warningprotected StringProp()
public StringProp(Atom propertyAtom)
propertyAtom - the property atom.public StringProp(Atom propertyAtom, String newValue) throws PropValidateException
propertyAtom - the property atom.newValue - the new string value for the property.PropValidateException - When the constraints are not met.public StringProp clone()
public Class<?>[] getValueClasses()
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.getValueClasses in interface IGProp<String>getValueClasses in class GProp<String>setPropertyValue method.
The first type is the "native" or most preferred type. The array is at least one item in length
and never null.public boolean setPropValue(String newValue) throws PropValidateException
newValue - the new value.PropValidateException - When the constraints are not met.public void validatePropType(Object newValue) throws PropTypeException
Note: When this method is called, synchronization is done at the property itself, so no synchronization on the tree should be done.
validatePropType in interface IGProp<String>validatePropType in class GProp<String>newValue - The new value to set.PropTypeException - when the new value isn't of the correct class.public String getString()
null for uninitialized value.public String getString(String defaultValue)
defaultValue for an
uninitialized value.defaultValue - the value to return if the current value is uninitialized.defaultValue for uninitialized value.protected void appendPropValue(PropMgr propertyManager, Transaction trans, Object value)
appendPropValue in class GProp<String>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.public boolean initializeValue(PropMgr propertyManager, Transaction trans) throws PropException
initializeValue in class GProp<String>propertyManager - the property manager.trans - the transaction to initialize the property with.PropExceptionprotected Object getPropValue0(Object value, int index) throws Exception
getPropValue0 in class GProp<String>value - The property value.index - The index in the Class array returned by getValueClasses().Exception - Other exceptions that could occur.protected Object toNativeValue0(Object value, int index) throws Exception
setPropertyValue method
into the most preferred property value type. If the input value already is of the preferred type, the
same object is returned.toNativeValue0 in class GProp<String>value - The input value to convert to native value.index - The index in the array returned by getValueClasses(), or -1 if not found.Exception - For conversion exceptions.iizi® is a registered trademark of Mindus SARL. © Copyright Mindus SARL, 2020. All rights reserved.