Package com.iizix.prop

Class PrivProp<T>

java.lang.Object
com.iizix.prop.GProp<T>
com.iizix.prop.PrivProp<T>
All Implemented Interfaces:
EventListener, IGProp<T>, Cloneable
public class PrivProp<T> extends GProp<T>
The private property class is used on the client as a dummy property in order to keep the structure of properties with the indexes as the server does, apart from that a private property can replace a property container.

The property value is always null.

Author:
Christopher Mindus

  • Constructor Details

    • PrivProp

      protected PrivProp()
      Creates a private property with no name with a null value.

    • PrivProp

      public PrivProp(Atom atom)
      Creates a private property with the specified atom name with a null value.

    • PrivProp

      public PrivProp(Atom atom, Object value)
      Creates a private property with the specified atom name with a value. The value is set "incognito" and cannot be changed.

  • Method Details

    • 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<T>
      Specified by:
      getValueClasses in class GProp<T>
      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.

    • validatePropType

      public void validatePropType(Object newValue) throws PropTypeException
      Validates that the value to set is of Boolean instance.
      Specified by:
      validatePropType in interface IGProp<T>
      Specified by:
      validatePropType in class GProp<T>
      Parameters:
      newValue - The new value to set.
      Throws:
      PropTypeException - always thrown if newValue is not null.

    • appendPropValue

      protected void appendPropValue(PropMgr propertyManager, SendTransaction trans, Object value)
      Appends the private property value. If uninitialized, false is appended.

      The PrivateProperty always throws InternalError when this method is called because it shouldn't be called!

      Specified by:
      appendPropValue in class GProp<T>
      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)
      Initializes the property value from a transaction.
      Specified by:
      initializeValue in class GProp<T>
      Parameters:
      propertyManager - the property manager.
      trans - the transaction to initialize the property with.
      Returns:
      true if the value has changed, false otherwise.

    • initializeValue

      public void initializeValue(Element element)
      Called to initialize the property from an Element. The property should initialize itself from attributes and nodes with appropriate information.

      This method does nothing...

      Parameters:
      element - The Element to initialize the property from.

    • 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.

      This method does nothing...

      Overrides:
      initializeElement in class GProp<T>
      Parameters:
      element - The Element to initialize.

    • 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<T>
      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:
      IllegalArgumentException - Invalid index, this should never happen though.
      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<T>
      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:
      IllegalArgumentException - Invalid index, this should never happen though.
      Exception - For conversion exceptions.