Class PropertyPointer

    • Field Detail

      • propertyIndex

        protected int propertyIndex
        property index
      • bean

        protected java.lang.Object bean
        owning object
      • UNINITIALIZED

        private static final java.lang.Object UNINITIALIZED
      • value

        private java.lang.Object value
    • Constructor Detail

      • PropertyPointer

        public PropertyPointer​(NodePointer parent)
        Takes a javabean, a descriptor of a property of that object and an offset within that property (starting with 0).
        Parameters:
        parent - parent pointer
    • Method Detail

      • getPropertyIndex

        public int getPropertyIndex()
        Get the property index.
        Returns:
        int index
      • setPropertyIndex

        public void setPropertyIndex​(int index)
        Set the property index.
        Parameters:
        index - property index
      • getBean

        public java.lang.Object getBean()
        Get the parent bean.
        Returns:
        Object
      • getName

        public QName getName()
        Description copied from class: NodePointer
        Returns the name of this node. Can be null.
        Specified by:
        getName in class NodePointer
        Returns:
        QName
      • getPropertyName

        public abstract java.lang.String getPropertyName()
        Get the property name.
        Returns:
        String property name.
      • setPropertyName

        public abstract void setPropertyName​(java.lang.String propertyName)
        Set the property name.
        Parameters:
        propertyName - property name to set.
      • getPropertyCount

        public abstract int getPropertyCount()
        Count the number of properties represented.
        Returns:
        int
      • getPropertyNames

        public abstract java.lang.String[] getPropertyNames()
        Get the names of the included properties.
        Returns:
        String[]
      • isActualProperty

        protected abstract boolean isActualProperty()
        Learn whether this pointer references an actual property.
        Returns:
        true if actual
      • isActual

        public boolean isActual()
        Description copied from class: NodePointer
        An actual pointer points to an existing part of an object graph, even if it is null. A non-actual pointer represents a part that does not exist at all. For instance consider the pointer "/address/street". If both address and street are not null, the pointer is actual. If address is not null, but street is null, the pointer is still actual. If address is null, the pointer is not actual. (In JavaBeans) if address is not a property of the root bean, a Pointer for this path cannot be obtained at all - actual or otherwise.
        Overrides:
        isActual in class NodePointer
        Returns:
        boolean
      • getImmediateNode

        public java.lang.Object getImmediateNode()
        Description copied from class: NodePointer
        Returns the object the pointer points to; does not convert it to a "canonical" type.
        Specified by:
        getImmediateNode in class NodePointer
        Returns:
        Object node
      • isCollection

        public boolean isCollection()
        Description copied from class: NodePointer
        Returns true if the value of the pointer is an array or a Collection.
        Specified by:
        isCollection in class NodePointer
        Returns:
        boolean
      • isLeaf

        public boolean isLeaf()
        Description copied from class: NodePointer
        If true, this node does not have children
        Specified by:
        isLeaf in class NodePointer
        Returns:
        boolean
      • getLength

        public int getLength()
        If the property contains a collection, then the length of that collection, otherwise - 1.
        Specified by:
        getLength in class NodePointer
        Returns:
        int length
      • createPath

        public NodePointer createPath​(JXPathContext context)
        Description copied from class: NodePointer
        Called by a child pointer when it needs to create a parent object. Must create an object described by this pointer and return a new pointer that properly describes the new object.
        Overrides:
        createPath in class NodePointer
        Parameters:
        context - the owning JXPathContext
        Returns:
        created NodePointer
      • createPath

        public NodePointer createPath​(JXPathContext context,
                                      java.lang.Object value)
        Description copied from class: NodePointer
        Called directly by JXPathContext. Must create path and set value.
        Overrides:
        createPath in class NodePointer
        Parameters:
        context - the owning JXPathContext
        value - the new value to set
        Returns:
        created NodePointer
      • createChild

        public NodePointer createChild​(JXPathContext context,
                                       QName name,
                                       int index,
                                       java.lang.Object value)
        Description copied from class: NodePointer
        Called by a child pointer if that child needs to assign the value supplied in the createPath(context, value) call to a non-existent node. This method may have to expand the collection in order to assign the element.
        Overrides:
        createChild in class NodePointer
        Parameters:
        context - the owning JXPathCOntext
        name - the QName at which a child should be created
        index - child index.
        value - node value to set
        Returns:
        created NodePointer
      • createChild

        public NodePointer createChild​(JXPathContext context,
                                       QName name,
                                       int index)
        Description copied from class: NodePointer
        Called by a child pointer when it needs to create a parent object for a non-existent collection element. It may have to expand the collection, then create an element object and return a new pointer describing the newly created element.
        Overrides:
        createChild in class NodePointer
        Parameters:
        context - the owning JXPathCOntext
        name - the QName at which a child should be created
        index - child index.
        Returns:
        created NodePointer
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object object)
        Overrides:
        equals in class java.lang.Object
      • compareChildNodePointers

        public int compareChildNodePointers​(NodePointer pointer1,
                                            NodePointer pointer2)
        Description copied from class: NodePointer
        Compares two child NodePointers and returns a positive number, zero or a positive number according to the order of the pointers.
        Specified by:
        compareChildNodePointers in class NodePointer
        Parameters:
        pointer1 - first pointer to be compared
        pointer2 - second pointer to be compared
        Returns:
        int per Java comparison conventions