Xalan-C++ API Reference  1.12.0
Public Types | Public Member Functions | List of all members
xalanc::XString Class Reference

#include <xalanc/XPath/XString.hpp>

Inheritance diagram for xalanc::XString:
[legend]
Collaboration diagram for xalanc::XString:
[legend]

Public Types

typedef XStringBase ParentType
 
- Public Types inherited from xalanc::XStringBase
typedef XObject ParentType
 
- Public Types inherited from xalanc::XObject
enum  eObjectType {
  eTypeNull = 0, eTypeUnknown = 1, eTypeBoolean = 2, eTypeNumber = 3,
  eTypeString = 4, eTypeNodeSet = 5, eTypeResultTreeFrag = 6, eTypeUserDefined = 7,
  eTypeStringReference = 8, eTypeStringAdapter = 9, eTypeStringCached = 10, eTypeXTokenNumberAdapter = 11,
  eTypeXTokenStringAdapter = 12, eTypeNodeSetNodeProxy = 13, eUnknown
}
 Enumeration of possible object types. More...
 
typedef XPathExecutionContext::GetCachedString GetCachedString
 
typedef void(FormatterListener::* MemberFunctionPtr) (const XMLCh *const, const FormatterListener::size_type)
 

Public Member Functions

 XString (const XalanDOMString &val, MemoryManager &theManager)
 Construct an XString object from a string. More...
 
 XString (const XalanDOMChar *val, MemoryManager &theManager)
 Construct an XString object from a string. More...
 
 XString (const XalanDOMChar *val, XalanSize_t len, MemoryManager &theManager)
 Construct an XString object from a string. More...
 
 XString (const XString &source, MemoryManager &theManager)
 Construct an XString object from another string. More...
 
virtual ~XString ()
 
void set (const XalanDOMString &theString)
 
virtual const XalanDOMStringstr (XPathExecutionContext &executionContext) const
 Cast result object to a string. More...
 
virtual const XalanDOMStringstr () const
 Cast result object to a string. More...
 
virtual void str (XPathExecutionContext &executionContext, FormatterListener &formatterListener, MemberFunctionPtr function) const
 Send the string value to a FormatterListener instance. More...
 
virtual void str (FormatterListener &formatterListener, MemberFunctionPtr function) const
 Send the string value to a FormatterListener instance. More...
 
virtual void str (XPathExecutionContext &executionContext, XalanDOMString &theBuffer) const
 Append the string value directly a string. More...
 
virtual void str (XalanDOMString &theBuffer) const
 Append the string value directly a string. More...
 
virtual double stringLength (XPathExecutionContext &executionContext) const
 Get the length of the string value of the instance. More...
 
- Public Member Functions inherited from xalanc::XStringBase
 XStringBase (MemoryManager &theMemoryManager)
 Construct an XStringBase object. More...
 
 XStringBase (MemoryManager &theMemoryManager, XPathExecutionContext &theExecutionContext)
 Construct an XStringBase object. More...
 
 XStringBase (const XStringBase &source, MemoryManager &theMemoryManager)
 Construct an XStringBase object from another. More...
 
virtual ~XStringBase ()
 
virtual const XalanDOMStringgetTypeString () const
 Given a request type, return the equivalent string. More...
 
virtual double num (XPathExecutionContext &executionContext) const
 Cast result object to a number. More...
 
virtual bool boolean (XPathExecutionContext &executionContext) const
 Cast result object to a boolean. More...
 
virtual const XalanDocumentFragmentrtree () const
 Cast result object to a result tree fragment. More...
 
virtual void ProcessXObjectTypeCallback (XObjectTypeCallback &theCallbackObject)
 Process a callback request for preferred type information. More...
 
virtual void ProcessXObjectTypeCallback (XObjectTypeCallback &theCallbackObject) const
 Process a callback request for preferred type information. More...
 
virtual double num (XPathExecutionContext &executionContext) const
 Cast result object to a number. More...
 
virtual double num () const
 Cast result object to a number. More...
 
virtual const XalanDOMStringstr (XPathExecutionContext &executionContext) const=0
 Cast result object to a string. More...
 
virtual const XalanDOMStringstr () const=0
 Cast result object to a string. More...
 
virtual void str (XPathExecutionContext &executionContext, FormatterListener &formatterListener, MemberFunctionPtr function) const=0
 Send the string value to a FormatterListener instance. More...
 
virtual void str (FormatterListener &formatterListener, MemberFunctionPtr function) const=0
 Send the string value to a FormatterListener instance. More...
 
virtual void str (XPathExecutionContext &executionContext, XalanDOMString &theBuffer) const=0
 Append the string value directly a string. More...
 
virtual void str (XalanDOMString &theBuffer) const=0
 Append the string value directly a string. More...
 
- Public Member Functions inherited from xalanc::XObject
 XObject (eObjectType theObjectType, MemoryManager &theMemoryManager)
 Create an XObject. More...
 
virtual double num () const
 Cast result object to a number. More...
 
virtual const NodeRefListBasenodeset () const
 Cast result object to a nodelist. More...
 
bool equals (const XObject &theRHS, XPathExecutionContext &executionContext) const
 Tell if two objects are functionally equal. More...
 
bool notEquals (const XObject &theRHS, XPathExecutionContext &executionContext) const
 Tell if two objects are functionally not equal. More...
 
bool lessThan (const XObject &theRHS, XPathExecutionContext &executionContext) const
 Tell if one object is less than the other. More...
 
bool lessThanOrEquals (const XObject &theRHS, XPathExecutionContext &executionContext) const
 Tell if one object is less than or equal the other. More...
 
bool greaterThan (const XObject &theRHS, XPathExecutionContext &executionContext) const
 Tell if one object is greater than the other. More...
 
bool greaterThanOrEquals (const XObject &theRHS, XPathExecutionContext &executionContext) const
 Tell if one object is greater than or equal the other. More...
 
eObjectType getType () const
 Tell what kind of class this is. More...
 
void setFactory (XObjectFactory *theFactory)
 

Additional Inherited Members

- Static Public Member Functions inherited from xalanc::XObject
static void initialize (MemoryManager &theMemoryManager)
 Perform static initialization. More...
 
static void terminate ()
 Perform static shut down. More...
 
static bool boolean (double theNumber)
 Static conversion function. More...
 
static bool boolean (const XalanDOMString &theString)
 Static conversion function. More...
 
static bool boolean (const NodeRefListBase &theNodeList)
 Static conversion function. More...
 
static const XalanDOMStringstring (bool theBool)
 Static conversion function. More...
 
static void string (bool theBool, XalanDOMString &theString)
 Static conversion function. More...
 
static void string (bool theBool, FormatterListener &formatterListener, MemberFunctionPtr function)
 Static conversion function. More...
 
static void string (double theNumber, XalanDOMString &theString)
 Static conversion function. More...
 
static void string (double theNumber, FormatterListener &formatterListener, MemberFunctionPtr function)
 Static conversion function. More...
 
static void string (const XalanNode &theNode, XalanDOMString &theString)
 Static conversion function. More...
 
static void string (const XalanNode &theNode, FormatterListener &formatterListener, MemberFunctionPtr function)
 Static conversion function. More...
 
static void string (const NodeRefListBase &theNodeList, XalanDOMString &theString)
 Static conversion function. More...
 
static void string (const NodeRefListBase &theNodeList, FormatterListener &formatterListener, MemberFunctionPtr function)
 Static conversion function. More...
 
static void string (const XalanNode &theNode, XPathExecutionContext &theExecutionContext, XalanDOMString &theString)
 Static conversion function. More...
 
static void string (const XalanNode &theNode, XPathExecutionContext &theExecutionContext, FormatterListener &formatterListener, MemberFunctionPtr function)
 Static conversion function. More...
 
static void string (const NodeRefListBase &theNodeList, XPathExecutionContext &theExecutionContext, XalanDOMString &theString)
 Static conversion function. More...
 
static void string (const NodeRefListBase &theNodeList, XPathExecutionContext &theExecutionContext, FormatterListener &formatterListener, MemberFunctionPtr function)
 Static conversion function. More...
 
static void string (const XalanDOMString &theString, FormatterListener &formatterListener, MemberFunctionPtr function)
 Calls the supplied FormatterListener member function with the string. More...
 
static double number (bool theBoolean)
 Static conversion function. More...
 
static double number (const XalanDOMString &theString, MemoryManager &theManager)
 
static double number (XPathExecutionContext &executionContext, const NodeRefListBase &theNodeList)
 Static conversion function. More...
 
static double number (XPathExecutionContext &executionContext, const XalanNode &theNode)
 Static conversion function. More...
 
- Protected Member Functions inherited from xalanc::XObject
 XObject (const XObject &)
 Create an XObject from another XObject. More...
 
 XObject (const XObject &source, MemoryManager &theManager)
 Create an XObject from another XObject. More...
 
MemoryManager & getMemoryManager () const
 Get the MemoryManager for this instance. More...
 
void throwInvalidConversionException (const XalanDOMString &theTargetType) const
 
virtual eObjectType getRealType () const
 Tell what kind of class this is. More...
 
virtual void referenced ()
 
virtual void dereferenced ()
 
virtual ~XObject ()
 
- Protected Member Functions inherited from xalanc::XalanReferenceCountedObject
 XalanReferenceCountedObject ()
 Create a XalanReferenceCountedObject. More...
 
virtual ~XalanReferenceCountedObject ()
 
virtual XalanSize_t getReferenceCount () const
 
- Static Protected Member Functions inherited from xalanc::XalanReferenceCountedObject
static void addReference (XalanReferenceCountedObject *theInstance)
 Increment reference count. More...
 
static void removeReference (XalanReferenceCountedObject *theInstance)
 Decrement reference count. More...
 
- Static Protected Attributes inherited from xalanc::XObject
static const XalanDOMString s_emptyString
 
static const XalanDOMStrings_booleanString
 
static const XalanDOMStrings_falseString
 
static const XalanDOMStrings_nodesetString
 
static const XalanDOMStrings_numberString
 
static const XalanDOMStrings_resultTreeFragmentString
 
static const XalanDOMStrings_stringString
 
static const XalanDOMStrings_trueString
 

Detailed Description

Definition at line 37 of file XString.hpp.

Member Typedef Documentation

◆ ParentType

Definition at line 41 of file XString.hpp.

Constructor & Destructor Documentation

◆ XString() [1/4]

xalanc::XString::XString ( const XalanDOMString val,
MemoryManager &  theManager 
)

Construct an XString object from a string.

Parameters
valThe string value to use.
theMemoryManagerThe MemoryManager instance.

◆ XString() [2/4]

xalanc::XString::XString ( const XalanDOMChar *  val,
MemoryManager &  theManager 
)

Construct an XString object from a string.

Parameters
valThe string value to use.
theMemoryManagerThe MemoryManager instance.

◆ XString() [3/4]

xalanc::XString::XString ( const XalanDOMChar *  val,
XalanSize_t  len,
MemoryManager &  theManager 
)

Construct an XString object from a string.

Parameters
valThe string value to use.
lenThe length of the string value.
theMemoryManagerThe MemoryManager instance.

◆ XString() [4/4]

xalanc::XString::XString ( const XString source,
MemoryManager &  theManager 
)

Construct an XString object from another string.

Parameters
sourceThe source XString.
theMemoryManagerThe MemoryManager instance.

◆ ~XString()

virtual xalanc::XString::~XString ( )
virtual

Member Function Documentation

◆ set()

void xalanc::XString::set ( const XalanDOMString theString)
inline

Definition at line 89 of file XString.hpp.

◆ str() [1/6]

virtual const XalanDOMString& xalanc::XString::str ( ) const
virtual

Cast result object to a string.

This function does not have access to the current XPathExecutionContext, so the result may contain data from whitespace text nodes that might have been stripped otherwise.

Parameters
executionContextThe current XPathExecutionContext
Returns
string value

Implements xalanc::XStringBase.

◆ str() [2/6]

virtual void xalanc::XString::str ( FormatterListener formatterListener,
MemberFunctionPtr  function 
) const
virtual

Send the string value to a FormatterListener instance.

This function does not have access to the current XPathExecutionContext, so the result may contain data from whitespace text nodes that might have been stripped otherwise.

Parameters
formatterListenerThe FormatterListener instance
functionA pointer to the member function of FormatterListener to call

Implements xalanc::XStringBase.

◆ str() [3/6]

virtual void xalanc::XString::str ( XalanDOMString theBuffer) const
virtual

Append the string value directly a string.

This function does not have access to the current XPathExecutionContext, so the result may contain data from whitespace text nodes that might have been stripped otherwise.

Parameters
theBufferThe buffer for the data

Implements xalanc::XStringBase.

◆ str() [4/6]

virtual const XalanDOMString& xalanc::XString::str ( XPathExecutionContext executionContext) const
virtual

Cast result object to a string.

Parameters
executionContextThe current XPathExecutionContext
Returns
string value

Implements xalanc::XStringBase.

◆ str() [5/6]

virtual void xalanc::XString::str ( XPathExecutionContext executionContext,
FormatterListener formatterListener,
MemberFunctionPtr  function 
) const
virtual

Send the string value to a FormatterListener instance.

Parameters
executionContextThe current XPathExecutionContext
formatterListenerThe FormatterListener instance
functionA pointer to the member function of FormatterListener to call

Implements xalanc::XStringBase.

◆ str() [6/6]

virtual void xalanc::XString::str ( XPathExecutionContext executionContext,
XalanDOMString theBuffer 
) const
virtual

Append the string value directly a string.

Parameters
executionContextThe current XPathExecutionContext
theBufferThe buffer for the data

Implements xalanc::XStringBase.

◆ stringLength()

virtual double xalanc::XString::stringLength ( XPathExecutionContext executionContext) const
virtual

Get the length of the string value of the instance.

Returns
The length of the string value

Implements xalanc::XStringBase.


The documentation for this class was generated from the following file: