Interface Pointer

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String asPath()
      Returns a string that is a proper "canonical" XPath that corresponds to this pointer.
      java.lang.Object clone()
      Pointers are cloneable.
      java.lang.Object getNode()
      Returns the raw value of the object, property or collection element this pointer represents.
      java.lang.Object getRootNode()
      Returns the node this pointer is based on.
      java.lang.Object getValue()
      Returns the value of the object, property or collection element this pointer represents.
      void setValue​(java.lang.Object value)
      Modifies the value of the object, property or collection element this pointer represents.
      • Methods inherited from interface java.lang.Comparable

        compareTo
    • Method Detail

      • getValue

        java.lang.Object getValue()
        Returns the value of the object, property or collection element this pointer represents. May convert the value to one of the canonical InfoSet types: String, Number, Boolean, Set. For example, in the case of an XML element, getValue() will return the text contained by the element rather than the element itself.
        Returns:
        Object value
      • getNode

        java.lang.Object getNode()
        Returns the raw value of the object, property or collection element this pointer represents. Never converts the object to a canonical type: returns it as is. For example, for an XML element, getNode() will return the element itself rather than the text it contains.
        Returns:
        Object node
      • setValue

        void setValue​(java.lang.Object value)
        Modifies the value of the object, property or collection element this pointer represents.
        Parameters:
        value - value to set
      • getRootNode

        java.lang.Object getRootNode()
        Returns the node this pointer is based on.
        Returns:
        Object
      • asPath

        java.lang.String asPath()
        Returns a string that is a proper "canonical" XPath that corresponds to this pointer. Consider this example:

        Pointer ptr = ctx.getPointer("//employees[firstName = 'John']")

        The value of ptr.asPath() will look something like "/departments[2]/employees[3]", so, basically, it represents the concrete location(s) of the result of a search performed by JXPath. If an object in the pointer's path is a Dynamic Property object (like a Map), the asPath method generates an XPath that looks like this: " /departments[@name = 'HR']/employees[3]".

        Returns:
        String path
      • clone

        java.lang.Object clone()
        Pointers are cloneable.
        Returns:
        cloned Object