Package com.iizix.prop

Class ByteArrayProp

java.lang.Object
com.iizix.prop.GProp<byte[]>
com.iizix.prop.ByteArrayProp
All Implemented Interfaces:
EventListener, IGProp<byte[]>, Cloneable
Direct Known Subclasses:
PKCS12IdentityProp, X509CertificatesProp
public class ByteArrayProp extends GProp<byte[]>
The byte array property is used to store binary data in various forms, e.g. for Java class files, Jar files, etc.
Author:
Christopher Mindus

  • Constructor Details

    • ByteArrayProp

      protected ByteArrayProp()
      Creates a byte array property with the specified name with a null value.

    • ByteArrayProp

      public ByteArrayProp(Atom propertyAtom)
      Creates a byte array property with the specified name with a null value.
      Parameters:
      propertyAtom - the property atom.

    • ByteArrayProp

      public ByteArrayProp(Atom propertyAtom, byte[] newValue)
      Creates a byte property with the specified name with and value.
      Parameters:
      propertyAtom - the property atom.
      newValue - the new Font value for the property.

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

    • clone

      public ByteArrayProp clone()
      Clones the byte array property.
      Overrides:
      clone in class GProp<byte[]>
      Returns:
      A new cloned ByteArrayProp.

    • setPropValue

      public boolean setPropValue(byte[] newValue)
      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.

    • getByteArray

      public byte[] getByteArray()
      Gets the byte array value. (For JavaScript this would not be relevant, but rather to return either a String in one method and an Array in another).
      Returns:
      the byte array or null if no value is set.

    • validatePropType

      public void validatePropType(Object newValue) throws PropTypeException
      Validates that the value to set is of Font 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<byte[]>
      Specified by:
      validatePropType in class GProp<byte[]>
      Parameters:
      newValue - The new value to set.
      Throws:
      PropTypeException - when the new value isn't of the correct class.

    • modifyPropValue

      protected int modifyPropValue(Object oldValue, Object newValue, PropMgr propMgr) throws PropException
      Called when setting a new value for this property. This method is normally not overridden by subclasses, but e.g. for properties containing arrays, this may be handled here, in order not modify the "oldValue" (such as an array, but rather to change it with the data from the "newValue").
      Overrides:
      modifyPropValue in class GProp<byte[]>
      Parameters:
      oldValue - The old value.
      newValue - The new value.
      propMgr - The property manager for remote change, null for local.
      Returns:
      1 for value has changed, 0 for same value as current value, -1 for not processed. 2 can also be returned to indicate the current value has been modified with new contents. This is e.g. the case for the StringMapProp.
      Throws:
      PropException - when the new value doesn't validate correctly.

    • appendPropValue

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

    • fromElementString

      public Object fromElementString(String str) throws PropException
      Called from the initializeProperty(Element element) method once the element String is retrieved from the "value" attribute.

      The string is the hexadecimal code for the byte array. White spaces are allowed, but not within pairs of hexadecimal values.

      Specified by:
      fromElementString in interface IGProp<byte[]>
      Overrides:
      fromElementString in class GProp<byte[]>
      Parameters:
      str - the String value of the object from the value attribute.
      Returns:
      the returned byte array.
      Throws:
      PropException - When the

    • toElementString

      public String toElementString(Object value)
      Called from the initializeElement(Element element) method. Override this method to provide the appropriate Object to String conversion.

      The return string is the hexadecimal code for the byte array. White spaces ([CR]+LF) are allowed and are placed at every 80th character, but not within pairs of hexadecimal values.

      Specified by:
      toElementString in interface IGProp<byte[]>
      Overrides:
      toElementString in class GProp<byte[]>
      Parameters:
      value - the value in the object to convert to a string.
      Returns:
      the string corresponding to the object value.

    • 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<byte[]>
      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<byte[]>
      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.