Package com.iizix.prop

Class BoolProp

java.lang.Object
com.iizix.prop.GProp<Boolean>
com.iizix.prop.BoolProp
All Implemented Interfaces:
EventListener, IGProp<Boolean>, Cloneable
public class BoolProp extends GProp<Boolean>
The Boolean property class holds the property name, value and optionally has a parent and/or property listener(s).
Author:
Christopher Mindus

  • Constructor Details

    • BoolProp

      protected BoolProp()
      Creates a Boolean property with the specified name with a null value.

    • BoolProp

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

    • BoolProp

      public BoolProp(Atom propertyAtom, boolean newValue)
      Creates a Boolean property with the specified name with and value.
      Parameters:
      propertyAtom - the property atom.
      newValue - the new boolean 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<Boolean>
      Specified by:
      getValueClasses in class GProp<Boolean>
      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(boolean 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.

    • setPropValue

      public boolean setPropValue(boolean newValue, IGProp<?> trigger)
      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.
      trigger - the trigger property, null for none.
      Returns:
      boolean true for value has changed, false for same value as current value.

    • validatePropType

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

    • getBool

      public boolean getBool()
      Gets the current value set as a "boolean".
      Returns:
      boolean the value or boolean for uninitialized value.

    • getBool

      public boolean getBool(boolean defaultValue)
      Gets the current value set as a "boolean" using defaultValue for an uninitialized value.
      Returns:
      boolean the value or defaultValue for uninitialized value.

    • appendPropValue

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

    • getBool

      public static boolean getBool(GProp<?> property, String string) throws PropException
      Gets a boolean value from a string (1/True/true/TRUE/..) or (0/False/false/FALSE/..).
      Parameters:
      property - the property owner (for exception throwing).
      string - the boolean string.
      Returns:
      the boolean value.
      Throws:
      PropException - is thrown when value cannot be determined.

    • getBool

      public static boolean getBool(GProp<?> property, String string, boolean defaultValue)
      Gets a boolean value from a string (1/True/true/TRUE/..) or (0/False/false/FALSE/..).
      Parameters:
      property - the property owner.
      string - the boolean string.
      defaultValue - the default value.
      Returns:
      the boolean value.

    • fromElementString

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

      The Object is converted from a String to a Boolean.

      Specified by:
      fromElementString in interface IGProp<Boolean>
      Overrides:
      fromElementString in class GProp<Boolean>
      Parameters:
      string - the String value of the object from the "value" attribute.
      Returns:
      the Boolean value.
      Throws:
      PropException - when the conversion fails.

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