Package com.iizix.prop

Class StringProp

java.lang.Object
com.iizix.prop.GProp<String>
com.iizix.prop.StringProp
All Implemented Interfaces:
EventListener, IGProp<String>, Cloneable
Direct Known Subclasses:
AssetReferences, ClassReference, GroupNameProp, MethodReference, PasswordProp, ValueTypeProp, VSRelativeReference
public class StringProp extends GProp<String>
The "String" property class holds the property name, value and optionally has a parent and/or property listener(s).
Author:
Christopher Mindus

  • Constructor Details

    • StringProp

      protected StringProp()
      Creates a String property with no name and with a null value.

    • StringProp

      public StringProp(Atom propertyAtom)
      Creates a String property with the specified name with a null value.
      Parameters:
      propertyAtom - the property atom.

    • StringProp

      public StringProp(Atom propertyAtom, String newValue) throws PropValidateException
      Creates a String property with the specified name and value.
      Parameters:
      propertyAtom - the property atom.
      newValue - the new string value for the property.
      Throws:
      PropValidateException - When the constraints are not met.

  • Method Details

    • clone

      public StringProp clone()
      Clones the String property.
      Overrides:
      clone in class GProp<String>
      Returns:
      A new cloned String property.

    • getValueClasses

      public 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 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.
      Specified by:
      getValueClasses in interface IGProp<String>
      Specified by:
      getValueClasses in class GProp<String>
      Returns:
      The array of Java classes that can be accepted in the setPropertyValue method. 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(String newValue) throws PropValidateException
      Sets 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(Object newValue) throws PropTypeException
      Validates that the value to set is of String 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:
      validatePropType in interface IGProp<String>
      Specified by:
      validatePropType in class GProp<String>
      Parameters:
      newValue - The new value to set.
      Throws:
      PropTypeException - when the new value isn't of the correct class.

    • getString

      public String getString()
      Gets the current value set as a String.
      Returns:
      String the value or null for uninitialized value.

    • getString

      public String getString(String defaultValue)
      Gets the current value set as a String using defaultValue for an uninitialized value.
      Parameters:
      defaultValue - the value to return if the current value is uninitialized.
      Returns:
      String the value or defaultValue for uninitialized value.

    • appendPropValue

      protected void appendPropValue(PropMgr propertyManager, SendTransaction trans, Object value)
      Appends the string property value. If uninitialized, an empty string is appended.
      Specified by:
      appendPropValue in class GProp<String>
      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:
      initializeValue in class GProp<String>
      Parameters:
      propertyManager - the property manager.
      trans - the transaction to initialize the property with.
      Returns:
      true if the value has changed, false otherwise.
      Throws:
      PropException

    • getPropValue0

      protected Object getPropValue0(Object value, int index) throws Exception
      Gets 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:
      getPropValue0 in class GProp<String>
      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:
      Exception - Other exceptions that could occur.

    • toNativeValue0

      protected Object toNativeValue0(Object value, int index) throws Exception
      Tries conversion of possibly accepted properties values using the setPropertyValue method into the most preferred property value type. If the input value already is of the preferred type, the same object is returned.
      Specified by:
      toNativeValue0 in class GProp<String>
      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:
      Exception - For conversion exceptions.