rwsf::XmlBindingHandle

rwsf::XmlBindingHandle  rwsf::XmlBindingHandleBase

• Local Index
• Header File
• Description
• Public Constructors
• Public Member Functions
• Logical Operators

Members

clone() equals() exists() get() getTypeId() getTypeIdChar() getXsiNil() getXsiNoNamespaceSchemaLocation()

getXsiSchemaLocation() isA() isHandleValid() isMarshalXsiTypeSet() isValid() isXsiNilSet() isXsiNoNamespaceSchemaLocationSet() isXsiSchemaLocationSet()

marshal() operator==() set() setMarshalXsiType() setXsiNil() setXsiNilSet() setXsiNoNamespaceSchemaLocation() setXsiNoNamespaceSchemaLocationSet()

setXsiSchemaLocation() setXsiSchemaLocationSet() typeId() typeIdChar() XmlBindingHandle() xsiType() xsiTypeChar()

#include <rwsf/xmlbinding/XmlBindingHandle.h>

The methods in this class call the corresponding methods in rwsf::XmlBindingBody. Please see that description for details.

rwsf::XmlBindingHandle implements the handle/body idiom in conjunction with rwsf::XmlBindingBody. An instance of this class is a handle to a private, reference-counted body. When a handle is copy-constructed, the new handle attaches to the same body as the original. When one handle is assigned to another handle, the handle on the left side detaches from its current body and attaches to the body pointed to by the handle on the right side. Logical operators return truth values based on whether the handles being compared point to the same body instance.

---

NOTE -- Handle methods that just call the corresponding method on the body are described only in the body class. For instance, if the handle class includes a method invoke() that calls the body's corresponding method doInvoke(), that method is documented only in the body class.

---

XmlBindingHandle();

Default constructor.

XmlBindingHandle(const XmlBindingHandle& other);

Copy constructor. Constructs a new handle from handle other.

XmlBindingHandle(rwsf::XmlBindingBody* body);

Constructs a new handle attached to the body body.

XmlBindingHandle   
clone() const;

Provides a deep copy when desired. Calls the body's doClone() method.

bool
equals(const rwsf::XmlBindingHandle& second) const;
int 
exists(const rwsf::XmlName& member);
std::vector<Member>
get(const rwsf::XmlName& member);
bool
getXsiNil() const;
std::string
getXsiNoNamespaceSchemaLocation() const;
std::string
getXsiSchemaLocation() const;
std::string
getTypeId() const;
const char*
getTypeIdChar() const;
bool 
isValid() const;
bool 
isValid(rwsf::XmlValidator& validator) const;
  
bool 
isA(const std::string& xsiType) const;

Convenience overloaded method. This method is called by the other isA() method as isA(other.xsiType()).

bool 
isA(const rwsf::XmlBindingHandle& other) const;

Returns true if the xsi:type of this handle's associated body is either the same as, or derived from, the xsi:type type passed to the convenience method as other.xsiType(); otherwise returns false.

bool 
isHandleValid() const;

Returns false if this handle points to a null body. Throws rwsf::ExternalException.

bool 
isMarshalXsiTypeSet() const;
bool
isXsiNilSet() const;
bool
isXsiNoNamespaceSchemaLocationSet() const;
bool
isXsiSchemaLocationSet() const;
void 
marshal(rwsf::XmlWriter& writer, 
               bool includeChildTypeAttributes, 
               const rwsf::XmlName&,
               bool includeSelfTypeAttribute, 
               bool nilValue) const;
void
setMarshalXsiType(bool setValue);
void
setXsiNil(bool XsiNil);
void
setXsiNilSet(bool setValue);
void
setXsiSchemaLocation(const std::string& loc);
void
setXsiSchemaLocationSet(bool setValue);
  
void
setXsiNoNamespaceSchemaLocation(const std::string& loc);
void
setXsiNoNamespaceSchemaLocationSet(bool setValue);
void 
set(const rwsf::XmlName& member, 
    const std::vector<Member>& values);
std::string
typeId() const;

Returns the type ID of the object as a string. All generated classes override this function.

const char*
typeIdChar() const;

Returns the type ID of the object as a character array. All gen-erated classes override this function.

std::string
xsiType() const;

Returns the xsi:type of the object as a string. All generated classes override this function.

const char*
xsiTypeChar() const;

Returns the xsi:type of the object as a character array. All gener-ated classes override this function.

bool
operator==(const rwsf::XmlBindingHandle& second) const 
bool

operator!=(const rwsf::XmlBindingHandle& second) const

©2004-2007 Copyright Quovadx, Inc. All Rights Reserved.
Quovadx and Rogue Wave are registered trademarks of Quovadx, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.