public class

XmlObject

extends Object
implements XMLizable
java.lang.Object
   ↳ com.sforce.ws.bind.XmlObject
Known Direct Subclasses

Class Overview

This is a generic XML element -- same a DOM element. In the common case this class must be able to hold child elements. We do not have a usecase for it yet. So child elements are not implemented.

Summary

Fields
private ArrayList<XmlObject> children
private String defaultNamespace
private QName name
private Object value
private QName xmlType
Public Constructors
XmlObject()
XmlObject(QName name)
XmlObject(QName name, Object value)
Public Methods
XmlObject addField(String name, Object value)
Iterator<XmlObject> evaluate(String xpath)
evaluate the given xpath like expression.
XmlObject getChild(String name)
Iterator<XmlObject> getChildren()
Iterator<XmlObject> getChildren(String name)
Object getField(String name)
QName getName()
Object getValue()
QName getXmlType()
boolean hasChildren()
void load(XmlInputStream in, TypeMapper typeMapper)
load the fileds/children from the specified xml stream
boolean removeField(String name)
void setDefaultNamespace(String namespace)
XmlObject setField(String name, Object value)
void setName(QName name)
void setValue(Object value)
Map<String, Object> toMap()
String toString()
void write(QName element, XmlOutputStream out, TypeMapper typeMapper)
write this instace as xml.
Protected Methods
void loadAfterStartTag(XmlInputStream in, TypeMapper typeMapper)
void loadStartTag(XmlInputStream in, TypeMapper typeMapper)
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.sforce.ws.bind.XMLizable

Fields

private ArrayList<XmlObject> children

private String defaultNamespace

private QName name

private Object value

private QName xmlType

Public Constructors

public XmlObject ()

public XmlObject (QName name)

Parameters
name

public XmlObject (QName name, Object value)

Parameters
name
value

Public Methods

public XmlObject addField (String name, Object value)

Parameters
name
value

public Iterator<XmlObject> evaluate (String xpath)

evaluate the given xpath like expression. eg xpath: "OpportunityContactRoles/records/Contact/LastName" this will list all LastName

Parameters
xpath

public XmlObject getChild (String name)

Parameters
name

public Iterator<XmlObject> getChildren ()

public Iterator<XmlObject> getChildren (String name)

Parameters
name

public Object getField (String name)

Parameters
name

public QName getName ()

public Object getValue ()

public QName getXmlType ()

public boolean hasChildren ()

public void load (XmlInputStream in, TypeMapper typeMapper)

load the fileds/children from the specified xml stream

Parameters
in Xml input stream from which the data is read
typeMapper Type mapper to be used
Throws
ConnectionException
IOException

public boolean removeField (String name)

Parameters
name

public void setDefaultNamespace (String namespace)

Parameters
namespace

public XmlObject setField (String name, Object value)

Parameters
name
value

public void setName (QName name)

Parameters
name

public void setValue (Object value)

Parameters
value

public Map<String, Object> toMap ()

public String toString ()

public void write (QName element, XmlOutputStream out, TypeMapper typeMapper)

write this instace as xml.

Parameters
element Xml element name
out Xml output stream
typeMapper Type mapper to be used
Throws
IOException

Protected Methods

protected void loadAfterStartTag (XmlInputStream in, TypeMapper typeMapper)

Parameters
in
typeMapper
Throws
ConnectionException
IOException

protected void loadStartTag (XmlInputStream in, TypeMapper typeMapper)

Parameters
in
typeMapper