Class PropertyDescriptor<T>

  • Type Parameters:
    T - Type of the property's value

    public final class PropertyDescriptor<T>
    extends Object
    Describes a property of a rule or a renderer.

    Usage of this API is described on PropertyFactory.

    A property descriptor provides validation, serialization, and default values for a datatype <T>. Property descriptors are immutable and can be shared freely.

    Brian Remedios, Clément Fournier
    See Also:
    PropertyFactory, PropertyBuilder
    • Method Detail

      • name

        public String name()
        The name of the property without spaces as it serves as the key into the property map.
      • description

        public String description()
        Describes the property and the role it plays within the rule it is specified for. Could be used in a tooltip.
      • defaultValue

        public T defaultValue()
        Default value to use when the user hasn't specified one or when they wish to revert to a known-good state.
      • serializer

        public PropertySerializer<T> serializer()
        Returns the strategy used to read and write this property to XML. May support strings too.
      • getTypeId

        public @Nullable PropertyTypeId getTypeId()
        Returns the type ID which was used to define this property. Returns null if this property was defined in Java code and not in XML. This is used to write the property back to XML, when using a RuleSetWriter.
      • isXPathAvailable

        public boolean isXPathAvailable()
        Returns whether the property is available to XPath queries.
      • hashCode

        public int hashCode()
        hashCode in class Object