Package com.iizix.prop

Class PlainKStringProp

java.lang.Object
com.iizix.prop.GProp<KString>
com.iizix.prop.KStringProp
com.iizix.prop.PlainKStringProp
All Implemented Interfaces:
EventListener, IGProp<KString>, IReferencingGProp, IKStringHolder<KString>, IKStringInfoProvider, IKStringValuePropHolder<KString>, ITextExternalizableProp<KString>, Cloneable
Direct Known Subclasses:
PatternProp
public class PlainKStringProp extends KStringProp
The "PlainKString" property class holds the property name, value and optionally has a parent and/or property listener(s). It is a subclass of StringProp and so is KString compared to String. KString is used to hold strings that can be either in HTML or PLAIN format. They can have references to e.g. text tables, VirtualSpace.

This class is a subclass of KStringProp that limits values to PLAIN strings. Transactions between parties is done in PLAIN strings too.

Author:
Christopher Mindus

  • Constructor Details

    • PlainKStringProp

      protected PlainKStringProp()
      Creates a KString property with no name and with a null value.

    • PlainKStringProp

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

    • PlainKStringProp

      public PlainKStringProp(Atom propertyAtom, KString newValue)
      Creates a KString property with the specified name and value.
      Parameters:
      propertyAtom - the property atom.
      newValue - the new KString value for the property.

    • PlainKStringProp

      public PlainKStringProp(Atom propertyAtom, String newValue)
      Creates a KString property with the specified name and value.
      Parameters:
      propertyAtom - the property atom.
      newValue - the new string value for the property.

  • Method Details

    • getPlainKString

      public PlainKString getPlainKString()
      Gets the PlainKString.

    • 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<KString>
      Overrides:
      validatePropType in class KStringProp
      Parameters:
      newValue - The new value to set.
      Throws:
      PropTypeException - when the new value isn't of the correct class.

    • setPropValue

      public boolean setPropValue(KString newValue) throws PropTypeException, 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.
      Overrides:
      setPropValue in class KStringProp
      Parameters:
      newValue - the new value.
      Returns:
      boolean true for value has changed, false for same value as current value.
      Throws:
      PropTypeException - If the property is read-only.
      PropValidateException - When the constraints are not met.

    • setPropValue

      public boolean setPropValue(PlainKString newValue) throws PropTypeException, 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:
      PropTypeException - If the property is read-only.
      PropValidateException - When the constraints are not met.

    • appendPropValue

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

    • 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<KString>
      Overrides:
      getValueClasses in class KStringProp
      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.

    • 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.
      Overrides:
      getPropValue0 in class KStringProp
      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.
      Overrides:
      toNativeValue0 in class KStringProp
      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.