Class BadgeProp

java.lang.Object
com.iizix.prop.GProp<GBadge>
com.iizix.prop.KStringHolderProp<GBadge>
com.iizix.prop.BadgeProp
All Implemented Interfaces:
EventListener, IGProp<GBadge>, IReferencingGProp, IKStringHolder<GBadge>, IKStringInfoProvider, IKStringValuePropHolder<GBadge>, ITextExternalizableProp<GBadge>, Cloneable
public class BadgeProp extends KStringHolderProp<GBadge>
The "badge" property class holds the property name, value as a GBadge object and optionally has a parent and/or property listener(s).
Author:
Christopher Mindus

  • Constructor Details

    • BadgeProp

      public BadgeProp()
      Creates a badge property with no name and with a null value.

    • BadgeProp

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

    • BadgeProp

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

  • Method Details

    • clone

      public BadgeProp clone()
      Clones the property.
      Overrides:
      clone in class KStringHolderProp<GBadge>
      Returns:
      A new cloned instance.

    • clonePropValue

      protected GBadge clonePropValue(GBadge value)
      Clones the value for clone().
      Specified by:
      clonePropValue in class KStringHolderProp<GBadge>
      Parameters:
      value - The value to clone, never null.
      Returns:
      The cloned value.

    • disposePropValue

      protected void disposePropValue(GBadge value)
      Disposes of the value when the property is disposed of.
      Specified by:
      disposePropValue in class KStringHolderProp<GBadge>
      Parameters:
      value - The value, never null.

    • getKStringVerificationLocation

      protected String getKStringVerificationLocation()
      Gets the location name used for the KString verification errors.
      Specified by:
      getKStringVerificationLocation in class KStringHolderProp<GBadge>
      Returns:
      "Badge".

    • equalValues

      protected Object equalValues(GProp<?> compareTo, GBadge thisValue, GBadge compareValue, int how)
      Checks for property value equality. The object is of the correct type for the respective property type. The Atoms and other properties such as Private/Extends has already been checked for equality or correctness.
      Overrides:
      equalValues in class GProp<GBadge>
      Parameters:
      compareTo - The comparing-to property that contains the value.
      thisValue - This property value (for synchronization reasons).
      compareValue - Another property value.
      how - Flags EQC_* values for equal checking.
      Returns:
      The property not being equal, null for equal (both values null).

    • 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<GBadge>
      Specified by:
      getValueClasses in class GProp<GBadge>
      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 GBadge 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<GBadge>
      Specified by:
      validatePropType in class GProp<GBadge>
      Parameters:
      newValue - The new value.
      Throws:
      PropTypeException - when the new value isn't of the correct class.

    • getBadge

      public GBadge getBadge()
      Gets the current value set as an GBadge.
      Returns:
      GBadge the badge, null if undefined.

    • getKString

      public KString getKString()
      Gets the current value in as a KString.
      Returns:
      KString the value or null for uninitialized value.

    • appendPropValue

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

    • initializeProp

      protected void initializeProp(Element element) throws PropException
      Called to initialize the property from an Element. The property should initialize itself from attributes and nodes with appropriate information.

      Subclasses should override this method if custom initialization is required.

      The default implementation gets the attribute "value" and calls the methods object=convertPropertyValue(string) followed by setPropertyValue(object).

      Overrides:
      initializeProp in class GProp<GBadge>
      Parameters:
      element - The Element.
      Throws:
      PropException - when the initialization fails.

    • 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.
      Overrides:
      initializeElement in class GProp<GBadge>
      Parameters:
      element - The Element to initialize.

    • getReferenceType

      public IPropReference.IRefType getReferenceType()
      Gets the reference Type.
      Returns:
      IPropReference.RefType.Badge.

    • createNewPropValue

      public GBadge createNewPropValue(KString ks)
      Builds a new property value from a new externalized KString.
      Parameters:
      ks - The new KString.
      Returns:
      The new property based on the current property value with it's additional settings, but with the new KString contents.

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