Constructor Detail

• XMLToken

  public XMLToken()
           throws XMLConstructorException

  Creates a new empty XMLToken object.

  Throws:

  XMLConstructorException

• XMLToken

  public XMLToken(XMLTriple triple,
                  XMLAttributes attributes,
                  XMLNamespaces namespaces,
                  long line,
                  long column)
           throws XMLConstructorException

  Creates an XML start element with attributes and namespace declarations.

  Parameters:

  triple - an XMLTriple object describing the start tag.

  attributes - XMLAttributes, the attributes to set on the element to be created.

  namespaces - XMLNamespaces, the namespaces to set on the element to be created.

  line - a long integer, the line number to associate with the token (default = 0).

  column - a long integer, the column number to associate with the token (default = 0).

  Documentation note:

  The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.

  Throws:
  XMLConstructorException

• XMLToken

  public XMLToken(XMLTriple triple,
                  XMLAttributes attributes,
                  XMLNamespaces namespaces,
                  long line)
           throws XMLConstructorException

  Creates an XML start element with attributes and namespace declarations.

  Parameters:

  triple - an XMLTriple object describing the start tag.

  attributes - XMLAttributes, the attributes to set on the element to be created.

  namespaces - XMLNamespaces, the namespaces to set on the element to be created.

  line - a long integer, the line number to associate with the token (default = 0).

  column - a long integer, the column number to associate with the token (default = 0).

  Documentation note:

  The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.

  Throws:
  XMLConstructorException

• XMLToken

  public XMLToken(XMLTriple triple,
                  XMLAttributes attributes,
                  XMLNamespaces namespaces)
           throws XMLConstructorException

  Creates an XML start element with attributes and namespace declarations.

  Parameters:

  triple - an XMLTriple object describing the start tag.

  attributes - XMLAttributes, the attributes to set on the element to be created.

  namespaces - XMLNamespaces, the namespaces to set on the element to be created.

  line - a long integer, the line number to associate with the token (default = 0).

  column - a long integer, the column number to associate with the token (default = 0).

  Documentation note:

  The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.

  Throws:
  XMLConstructorException

• XMLToken

  public XMLToken(XMLTriple triple,
                  XMLAttributes attributes,
                  long line,
                  long column)
           throws XMLConstructorException

  Creates an XML start element with attributes.

  Parameters:

  triple - an XMLTriple object describing the start tag.

  attributes - XMLAttributes, the attributes to set on the element to be created.

  line - a long integer, the line number to associate with the token (default = 0).

  column - a long integer, the column number to associate with the token (default = 0).

  The XML namespace component of this XMLToken object will be left empty. See the other variants of the XMLToken constructors for versions that take namespace arguments.

  Documentation note:

  The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.

  Throws:
  XMLConstructorException

• XMLToken

  public XMLToken(XMLTriple triple,
                  XMLAttributes attributes,
                  long line)
           throws XMLConstructorException

  Creates an XML start element with attributes.

  Parameters:

  triple - an XMLTriple object describing the start tag.

  attributes - XMLAttributes, the attributes to set on the element to be created.

  line - a long integer, the line number to associate with the token (default = 0).

  column - a long integer, the column number to associate with the token (default = 0).

  The XML namespace component of this XMLToken object will be left empty. See the other variants of the XMLToken constructors for versions that take namespace arguments.

  Documentation note:

  The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.

  Throws:
  XMLConstructorException

• XMLToken

  public XMLToken(XMLTriple triple,
                  XMLAttributes attributes)
           throws XMLConstructorException

  Creates an XML start element with attributes.

  Parameters:

  triple - an XMLTriple object describing the start tag.

  attributes - XMLAttributes, the attributes to set on the element to be created.

  line - a long integer, the line number to associate with the token (default = 0).

  column - a long integer, the column number to associate with the token (default = 0).

  The XML namespace component of this XMLToken object will be left empty. See the other variants of the XMLToken constructors for versions that take namespace arguments.

  Documentation note:

  The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.

  Throws:
  XMLConstructorException

• XMLToken

  public XMLToken(XMLTriple triple,
                  long line,
                  long column)
           throws XMLConstructorException

  Creates an XML end element.

  Parameters:

  triple - an XMLTriple object describing the end tag.

  line - a long integer, the line number to associate with the token (default = 0).

  column - a long integer, the column number to associate with the token (default = 0).

  Documentation note:

  The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.

  Throws:
  XMLConstructorException

• XMLToken

  public XMLToken(XMLTriple triple,
                  long line)
           throws XMLConstructorException

  Creates an XML end element.

  Parameters:

  triple - an XMLTriple object describing the end tag.

  line - a long integer, the line number to associate with the token (default = 0).

  column - a long integer, the column number to associate with the token (default = 0).

  Documentation note:

  The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.

  Throws:
  XMLConstructorException

• XMLToken

  public XMLToken(XMLTriple triple)
           throws XMLConstructorException

  Creates an XML end element.

  Parameters:

  triple - an XMLTriple object describing the end tag.

  line - a long integer, the line number to associate with the token (default = 0).

  column - a long integer, the column number to associate with the token (default = 0).

  Documentation note:

  The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.

  Throws:
  XMLConstructorException

• XMLToken

  public XMLToken(java.lang.String chars,
                  long line,
                  long column)
           throws XMLConstructorException

  Creates a text object.

  Parameters:

  chars - a string, the text to be added to the XMLToken object.

  line - a long integer, the line number to associate with the token (default = 0).

  column - a long integer, the column number to associate with the token (default = 0).

  Documentation note:

  The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.

  Throws:
  XMLConstructorException

• XMLToken

  public XMLToken(java.lang.String chars,
                  long line)
           throws XMLConstructorException

  Creates a text object.

  Parameters:

  chars - a string, the text to be added to the XMLToken object.

  line - a long integer, the line number to associate with the token (default = 0).

  column - a long integer, the column number to associate with the token (default = 0).

  Documentation note:

  The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.

  Throws:
  XMLConstructorException

• XMLToken

  public XMLToken(java.lang.String chars)
           throws XMLConstructorException

  Creates a text object.

  Parameters:

  chars - a string, the text to be added to the XMLToken object.

  line - a long integer, the line number to associate with the token (default = 0).

  column - a long integer, the column number to associate with the token (default = 0).

  Documentation note:

  The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.

  Throws:
  XMLConstructorException

• XMLToken

  public XMLToken(XMLToken orig)
           throws XMLConstructorException

  Copy constructor creates a copy of this XMLToken object.

  Parameters:

  orig - the XMLToken object to copy.

  Throws:

  XMLConstructorException

Method Detail

• delete

  public void delete()

  Explicitly deletes the underlying native object.

  In general, application software will not need to call this method directly. The Java language binding for libSBML is implemented as a language wrapper that provides a Java interface to libSBML's underlying C++/C code. Some of the Java methods return objects that are linked to objects created not by Java code, but by C++ code. The Java objects wrapped around them will be deleted when the garbage collector invokes the corresponding C++ finalize() methods for the objects. The finalize() methods in turn call the XMLToken.delete() method on the libSBML object.

  This method is exposed in case calling programs want to ensure that the underlying object is freed immediately, and not at some arbitrary time determined by the Java garbage collector. In normal usage, callers do not need to invoke XMLToken.delete() themselves.

• equals

  public boolean equals(java.lang.Object sb)

  Equality comparison method for XMLToken.

  Because the Java methods for libSBML are actually wrappers around code implemented in C++ and C, certain operations will not behave as expected. Equality comparison is one such case. An instance of a libSBML object class is actually a proxy object wrapping the real underlying C/C++ object. The normal == equality operator in Java will only compare the Java proxy objects, not the underlying native object. The result is almost never what you want in practical situations. Unfortunately, Java does not provide a way to override ==.

  The alternative that must be followed is to use the equals() method. The equals method on this class overrides the default java.lang.Object one, and performs an intelligent comparison of instances of objects of this class. The result is an assessment of whether two libSBML Java objects are truly the same underlying native-code objects.

  The use of this method in practice is the same as the use of any other Java equals method. For example, a.equals(b) returns true if a and b are references to the same underlying object.

  Overrides:

  equals in class java.lang.Object

  Parameters:

  sb - a reference to an object to which the current object instance will be compared

  Returns:

  true if sb refers to the same underlying native object as this one, false otherwise

• hashCode

  public int hashCode()

  Returns a hashcode for this XMLToken object.

  Overrides:

  hashCode in class java.lang.Object

  Returns:

  a hash code usable by Java methods that need them.

• cloneObject

  public XMLToken cloneObject()

  Creates and returns a deep copy of this XMLToken object.

  Returns:

  the (deep) copy of this XMLToken object.

• getAttributes

  public XMLAttributes getAttributes()

  Returns the attributes of the XML element represented by this token.

  Returns:

  the attributes of this XML element, stored in an XMLAttributes object.

• setAttributes

  public int setAttributes(XMLAttributes attributes)

  Sets the attributes on the XML element represented by this token.

  This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

  Parameters:

  attributes - an XMLAttributes object to be assigned to this XMLToken object, thereby setting the XML attributes associated with this token.

  Returns:

  integer value indicating success/failure of the function. The possible values returned by this function are:

  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_OPERATION_FAILED
  • LIBSBML_INVALID_XML_OPERATION
  • LIBSBML_INVALID_OBJECT

  "Note:"

  This function replaces any existing XMLAttributes object on this XMLToken object with the one given by attributes.

• addAttr

  public int addAttr(java.lang.String name,
                     java.lang.String value,
                     java.lang.String namespaceURI,
                     java.lang.String prefix)

  Adds an attribute to the XML element represented by this token.

  This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

  Parameters:

  name - a string, the so-called 'local part' of the attribute name that is, the attribute name without any namespace qualifier or prefix.

  value - a string, the value assigned to the attribute.

  namespaceURI - a string, the XML namespace URI of the attribute.

  prefix - a string, the prefix for the XML namespace.

  Recall that in XML, the complete form of an attribute on an XML element is the following:

  prefix:name='value' The name part is the name of the attribute, the 'value' part is the value assigned to the attribute (and it is always a quoted string), and the prefix part is an optional XML namespace prefix. Internally in libSBML, this data is stored in an XMLAttributes object associated with this XMLToken.

  Returns:

  integer value indicating success/failure of the function. The possible values returned by this function are:

  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_INVALID_OBJECT
  • LIBSBML_INVALID_XML_OPERATION

  "Note:"

  If an attribute with the same name and XML namespace URI already exists on this XMLToken object, then the previous value will be replaced with the new value provided to this method.

  Documentation note:

  The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.

• addAttr

  public int addAttr(java.lang.String name,
                     java.lang.String value,
                     java.lang.String namespaceURI)

  Adds an attribute to the XML element represented by this token.

  This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

  Parameters:

  name - a string, the so-called 'local part' of the attribute name that is, the attribute name without any namespace qualifier or prefix.

  value - a string, the value assigned to the attribute.

  namespaceURI - a string, the XML namespace URI of the attribute.

  prefix - a string, the prefix for the XML namespace.

  Recall that in XML, the complete form of an attribute on an XML element is the following:

  prefix:name='value' The name part is the name of the attribute, the 'value' part is the value assigned to the attribute (and it is always a quoted string), and the prefix part is an optional XML namespace prefix. Internally in libSBML, this data is stored in an XMLAttributes object associated with this XMLToken.

  Returns:

  integer value indicating success/failure of the function. The possible values returned by this function are:

  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_INVALID_OBJECT
  • LIBSBML_INVALID_XML_OPERATION

  "Note:"

  If an attribute with the same name and XML namespace URI already exists on this XMLToken object, then the previous value will be replaced with the new value provided to this method.

  Documentation note:

  The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.

• addAttr

  public int addAttr(java.lang.String name,
                     java.lang.String value)

  Adds an attribute to the XML element represented by this token.

  This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

  Parameters:

  name - a string, the so-called 'local part' of the attribute name that is, the attribute name without any namespace qualifier or prefix.

  value - a string, the value assigned to the attribute.

  namespaceURI - a string, the XML namespace URI of the attribute.

  prefix - a string, the prefix for the XML namespace.

  Recall that in XML, the complete form of an attribute on an XML element is the following:

  prefix:name='value' The name part is the name of the attribute, the 'value' part is the value assigned to the attribute (and it is always a quoted string), and the prefix part is an optional XML namespace prefix. Internally in libSBML, this data is stored in an XMLAttributes object associated with this XMLToken.

  Returns:

  integer value indicating success/failure of the function. The possible values returned by this function are:

  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_INVALID_OBJECT
  • LIBSBML_INVALID_XML_OPERATION

  "Note:"

  If an attribute with the same name and XML namespace URI already exists on this XMLToken object, then the previous value will be replaced with the new value provided to this method.

  Documentation note:

  The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.

• addAttr

  public int addAttr(XMLTriple triple,
                     java.lang.String value)

  Adds an attribute to the XML element represented by this token.

  This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

  Parameters:

  triple - an XMLTriple object defining the attribute, its value, and optionally its XML namespace (if any is provided).

  value - a string, the value assigned to the attribute.

  Returns:

  integer value indicating success/failure of the function. The possible values returned by this function are:

  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_INVALID_OBJECT
  • LIBSBML_INVALID_XML_OPERATION

  "Note:"

  If an attribute with the same name and XML namespace URI already exists on this XMLToken object, then the previous value will be replaced with the new value provided to this method.

• removeAttr

  public int removeAttr(int n)

  Removes the nth attribute from the XML element represented by this token.

  This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

  Parameters:

  n - an integer the index of the resource to be deleted.

  Returns:

  integer value indicating success/failure of the function. The possible values returned by this function are:

  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_INVALID_XML_OPERATION
  • LIBSBML_INDEX_EXCEEDS_SIZE

  The value LIBSBML_INDEX_EXCEEDS_SIZE is returned if there is no attribute on this element at the given index n.

  See Also:

  XMLToken.getAttrIndex(XMLTriple triple), XMLToken.getAttrIndex(String name, String uri), XMLToken.getAttributesLength()

• removeAttr

  public int removeAttr(java.lang.String name,
                        java.lang.String uri)

  Removes an attribute from the XML element represented by this token.

  This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

  Parameters:

  name - a string, the name of the attribute to be removed.

  uri - a string, the XML namespace URI of the attribute to be removed.

  Returns:

  integer value indicating success/failure of the function. The possible values returned by this function are:

  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_INVALID_XML_OPERATION
  • LIBSBML_INDEX_EXCEEDS_SIZE

  The value LIBSBML_INDEX_EXCEEDS_SIZE is returned if there is no attribute on this element with the given name (and uri if specified).

  See Also:

  XMLToken.hasAttr(String name, String uri)

• removeAttr

  public int removeAttr(java.lang.String name)

  Removes an attribute from the XML element represented by this token.

  This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

  Parameters:

  name - a string, the name of the attribute to be removed.

  uri - a string, the XML namespace URI of the attribute to be removed.

  Returns:

  integer value indicating success/failure of the function. The possible values returned by this function are:

  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_INVALID_XML_OPERATION
  • LIBSBML_INDEX_EXCEEDS_SIZE

  The value LIBSBML_INDEX_EXCEEDS_SIZE is returned if there is no attribute on this element with the given name (and uri if specified).

  See Also:

  XMLToken.hasAttr(String name, String uri)

• removeAttr

  public int removeAttr(XMLTriple triple)

  Removes an attribute from the XML element represented by this token.

  This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

  Parameters:

  triple - an XMLTriple describing the attribute to be removed.

  Returns:

  integer value indicating success/failure of the function. The possible values returned by this function are:

  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_INVALID_XML_OPERATION
  • LIBSBML_INDEX_EXCEEDS_SIZE

  The value LIBSBML_INDEX_EXCEEDS_SIZE is returned if there is no attribute on this element matching the properties of the given triple.

  See Also:

  XMLToken.hasAttr(XMLTriple triple)

• clearAttributes

  public int clearAttributes()

  Removes all attributes of this XMLToken object.

  This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

  Returns:

  integer value indicating success/failure of the function. The possible values returned by this function are:

  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_INVALID_XML_OPERATION

• getAttrIndex

  public int getAttrIndex(java.lang.String name,
                          java.lang.String uri)

  Returns the index of the attribute with the given name and namespace URI.

  Parameters:

  name - a string, the name of the attribute.

  uri - a string, the namespace URI of the attribute.

  Returns:

  the index of an attribute with the given local name and namespace URI, or -1 if it is not present on this token.

  Documentation note:

  The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.

• getAttrIndex

  public int getAttrIndex(java.lang.String name)

  Returns the index of the attribute with the given name and namespace URI.

  Parameters:

  name - a string, the name of the attribute.

  uri - a string, the namespace URI of the attribute.

  Returns:

  the index of an attribute with the given local name and namespace URI, or -1 if it is not present on this token.

  Documentation note:

  The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.

• getAttrIndex

  public int getAttrIndex(XMLTriple triple)

  Returns the index of the attribute defined by the given XMLTriple object.

  Parameters:

  triple - the XMLTriple object that defines the attribute whose index is being sought.

  Returns:

  the index of an attribute with the given XMLTriple object, or -1 if no such attribute is present on this token.

• getAttributesLength

  public int getAttributesLength()

  Returns the number of attributes on this XMLToken object.

  Returns:

  the number of attributes possessed by this token.

  See Also:

  XMLToken.hasAttr(int)

• getAttrName

  public java.lang.String getAttrName(int index)

  Returns the name of the nth attribute in this token's list of attributes.

  Parameters:

  index - an integer, the position of the attribute whose name is being sought.

  Returns:

  the name of the attribute located at position n in the list of attributes possessed by this XMLToken object.

  See Also:

  XMLToken.hasAttr(int), XMLToken.getAttributesLength()

  "Note:"

  If index is out of range, this method will return an empty string. XMLToken.hasAttr(int) can be used to test for an attribute's existence explicitly, and XMLToken.getAttributesLength() can be used to find out the number of attributes possessed by this token.

• getAttrPrefix

  public java.lang.String getAttrPrefix(int index)

  Returns the prefix of the nth attribute in this token's list of attributes.

  Parameters:

  index - an integer, the position of the attribute whose prefix is being sought.

  Returns:

  the XML namespace prefix of the attribute located at position n in the list of attributes possessed by this XMLToken object.

  See Also:

  XMLToken.hasAttr(int), XMLToken.getAttributesLength()

  "Note:"

  If index is out of range, this method will return an empty string. XMLToken.hasAttr(int) can be used to test for an attribute's existence explicitly, and XMLToken.getAttributesLength() can be used to find out the number of attributes possessed by this token.

• getAttrPrefixedName

  public java.lang.String getAttrPrefixedName(int index)

  Returns the prefixed name of the nth attribute in this token's list of attributes.

  In this context, prefixed name means the name of the attribute prefixed with the XML namespace prefix assigned to the attribute. This will be a string of the form prefix:name.

  Parameters:

  index - an integer, the position of the attribute whose prefixed name is being sought.

  Returns:

  the prefixed name of the attribute located at position n in the list of attributes possessed by this XMLToken object.

  "Note:"

  If index is out of range, this method will return an empty string. XMLToken.hasAttr(int) can be used to test for an attribute's existence explicitly, and XMLToken.getAttributesLength() can be used to find out the number of attributes possessed by this token.

• getAttrURI

  public java.lang.String getAttrURI(int index)

  Returns the XML namespace URI of the nth attribute in this token's list of attributes.

  Parameters:

  index - an integer, the position of the attribute whose namespace URI is being sought.

  Returns:

  the XML namespace URI of the attribute located at position n in the list of attributes possessed by this XMLToken object.

  "Note:"

  If index is out of range, this method will return an empty string. XMLToken.hasAttr(int) can be used to test for an attribute's existence explicitly, and XMLToken.getAttributesLength() can be used to find out the number of attributes possessed by this token.

• getAttrValue

  public java.lang.String getAttrValue(int index)

  Returns the value of the nth attribute in this token's list of attributes.

  Parameters:

  index - an integer, the position of the attribute whose value is required.

  Returns:

  the value of the attribute located at position n in the list of attributes possessed by this XMLToken object.

  "Note:"

  If index is out of range, this method will return an empty string. XMLToken.hasAttr(int) can be used to test for an attribute's existence explicitly, and XMLToken.getAttributesLength() can be used to find out the number of attributes possessed by this token.

• getAttrValue

  public java.lang.String getAttrValue(java.lang.String name,
                                       java.lang.String uri)

  Returns the value of the attribute with a given name and XML namespace URI.

  Parameters:

  name - a string, the name of the attribute whose value is being sought.

  uri - a string, the XML namespace URI of the attribute.

  Returns:

  The value of the attribute, as a string.

  "Note:"

  If an attribute with the given name and uri does not exist on this token object, this method will return an empty string. XMLToken.hasAttr(String, String) can be used to test explicitly for the presence of an attribute with a given name and namespace.

  Documentation note:

  The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.

• getAttrValue

  public java.lang.String getAttrValue(java.lang.String name)

  Returns the value of the attribute with a given name and XML namespace URI.

  Parameters:

  name - a string, the name of the attribute whose value is being sought.

  uri - a string, the XML namespace URI of the attribute.

  Returns:

  The value of the attribute, as a string.

  "Note:"

  If an attribute with the given name and uri does not exist on this token object, this method will return an empty string. XMLToken.hasAttr(String, String) can be used to test explicitly for the presence of an attribute with a given name and namespace.

  Documentation note:

  The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.

• getAttrValue

  public java.lang.String getAttrValue(XMLTriple triple)

  Returns the value of the attribute specified by a given XMLTriple object.

  Parameters:

  triple - an XMLTriple describing the attribute whose value is being sought.

  Returns:

  The value of the attribute, as a string.

  "Note:"

  If an attribute defined by the given triple does not exist on this token object, this method will return an empty string. XMLToken.hasAttr(XMLTriple) can be used to test explicitly for the existence of an attribute with the properties of a given triple.

• hasAttr

  public boolean hasAttr(int index)

  Returns true if an attribute with the given index exists.

  Parameters:

  index - an integer, the position of the attribute.

  Returns:

  true if this token object possesses an attribute with the given index, false otherwise.

• hasAttr

  public boolean hasAttr(java.lang.String name,
                         java.lang.String uri)

  Returns true if an attribute with a given name and namespace URI exists.

  Parameters:

  name - a string, the name of the attribute being sought.

  uri - a string, the XML namespace URI of the attribute being sought.

  Returns:

  true if an attribute with the given local name and namespace URI exists in the list of attributes on this token object, false otherwise.

  Documentation note:

  The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.

• hasAttr

  public boolean hasAttr(java.lang.String name)

  Returns true if an attribute with a given name and namespace URI exists.

  Parameters:

  name - a string, the name of the attribute being sought.

  uri - a string, the XML namespace URI of the attribute being sought.

  Returns:

  true if an attribute with the given local name and namespace URI exists in the list of attributes on this token object, false otherwise.

  Documentation note:

  The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.

• hasAttr

  public boolean hasAttr(XMLTriple triple)

  Returns true if an attribute defined by a given XMLTriple object exists.

  Parameters:

  triple - an XMLTriple object describing the attribute being sought.

  Returns:

  true if an attribute matching the properties of the given XMLTriple object exists in the list of attributes on this token, false otherwise.

• isAttributesEmpty

  public boolean isAttributesEmpty()

  Returns true if this token has no attributes.

  Returns:

  true if the list of attributes on XMLToken object is empty, false otherwise.

• getNamespaces

  public XMLNamespaces getNamespaces()

  Returns the XML namespaces declared for this token.

  Returns:

  the XML namespace declarations for this XML element.

• setNamespaces

  public int setNamespaces(XMLNamespaces namespaces)

  Sets the XML namespaces on this XML element.

  This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

  Parameters:

  namespaces - the XMLNamespaces object to be assigned to this XMLToken object.

  Returns:

  integer value indicating success/failure of the function. The possible values returned by this function are:

  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_OPERATION_FAILED
  • LIBSBML_INVALID_XML_OPERATION
  • LIBSBML_INVALID_OBJECT

  "Note:"

  This function replaces any existing XMLNamespaces object on this XMLToken object with the new one given by namespaces.

• addNamespace

  public int addNamespace(java.lang.String uri,
                          java.lang.String prefix)

  Appends an XML namespace declaration to this token.

  The namespace added will be defined by the given XML namespace URI and an optional prefix. If this XMLToken object already possesses an XML namespace declaration with the given prefix, then the existing XML namespace URI will be overwritten by the new one given by uri.

  This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

  Parameters:

  uri - a string, the XML namespace URI for the namespace.

  prefix - a string, the namespace prefix to use.

  Returns:

  integer value indicating success/failure of the function. The possible values returned by this function are:

  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_INVALID_XML_OPERATION

  Documentation note:

  The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.

• addNamespace

  public int addNamespace(java.lang.String uri)

  Appends an XML namespace declaration to this token.

  The namespace added will be defined by the given XML namespace URI and an optional prefix. If this XMLToken object already possesses an XML namespace declaration with the given prefix, then the existing XML namespace URI will be overwritten by the new one given by uri.

  This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

  Parameters:

  uri - a string, the XML namespace URI for the namespace.

  prefix - a string, the namespace prefix to use.

  Returns:

  integer value indicating success/failure of the function. The possible values returned by this function are:

  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_INVALID_XML_OPERATION

  Documentation note:

  The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.

• removeNamespace

  public int removeNamespace(int index)

  Removes the nth XML namespace declaration.

  This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

  Parameters:

  index - an integer, the position of the namespace to be removed. The position in this context refers to the position of the namespace in the XMLNamespaces object stored in this XMLToken object. Callers can use one of the getNamespace___() methods to find the index number of a given namespace.

  Returns:

  integer value indicating success/failure of the function. The possible values returned by this function are:

  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_INVALID_XML_OPERATION
  • LIBSBML_INDEX_EXCEEDS_SIZE

  See Also:

  XMLToken.getNamespaceIndex(String uri), XMLToken.getNamespaceIndexByPrefix(String prefix), XMLToken.getNamespacesLength()

• removeNamespace

  public int removeNamespace(java.lang.String prefix)

  Removes an XML namespace declaration having a given prefix.

  This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

  Parameters:

  prefix - a string, the prefix of the namespace to be removed.

  Returns:

  integer value indicating success/failure of the function. The possible values returned by this function are:

  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_INVALID_XML_OPERATION
  • LIBSBML_INDEX_EXCEEDS_SIZE

  The value LIBSBML_INDEX_EXCEEDS_SIZE is returned if there is no namespace with the given prefix on this element.

  See Also:

  XMLToken.getNamespaceIndexByPrefix(String prefix)

• clearNamespaces

  public int clearNamespaces()

  Removes all XML namespace declarations from this token.

  This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

  Returns:

  integer value indicating success/failure of the function. The possible values returned by this function are:

  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_INVALID_XML_OPERATION
  • LIBSBML_OPERATION_FAILED

• getNamespaceIndex

  public int getNamespaceIndex(java.lang.String uri)

  Returns the index of an XML namespace declaration based on its URI.

  Parameters:

  uri - a string, the XML namespace URI of the sought-after namespace.

  Returns:

  the index of the given declaration, or -1 if no such namespace URI is present on this XMLToken object.

• getNamespaceIndexByPrefix

  public int getNamespaceIndexByPrefix(java.lang.String prefix)

  Returns the index of an XML namespace declaration based on its prefix.

  Parameters:

  prefix - a string, the prefix of the sought-after XML namespace.

  Returns:

  the index of the given declaration, or -1 if no such namespace URI is present on this XMLToken object.

• getNamespacesLength

  public int getNamespacesLength()

  Returns the number of XML namespaces declared on this token.

  Returns:

  the number of XML namespaces stored in the XMLNamespaces object of this XMLToken object.

• getNamespacePrefix

  public java.lang.String getNamespacePrefix(int index)

  Returns the prefix of the nth XML namespace declaration.

  Parameters:

  index - an integer, position of the required prefix.

  Returns:

  the prefix of an XML namespace declaration in the XMLNamespaces (by position).

  See Also:

  XMLToken.getNamespacesLength()

  "Note:"

  If index is out of range, this method will return an empty string. XMLToken.getNamespacesLength() can be used to find out how many namespaces are defined on this XMLToken object.

• getNamespacePrefix

  public java.lang.String getNamespacePrefix(java.lang.String uri)

  Returns the prefix associated with a given XML namespace URI on this token.

  Parameters:

  uri - a string, the URI of the namespace whose prefix is being sought.

  Returns:

  the prefix of an XML namespace declaration on this XMLToken object.

  "Note:"

  If there is no XML namespace with the given uri declared on this XMLToken object, this method will return an empty string.

• getNamespaceURI

  public java.lang.String getNamespaceURI(int index)

  Returns the URI of the nth XML namespace declared on this token.

  Parameters:

  index - an integer, the position of the sought-after XML namespace URI.

  Returns:

  the URI of the nth XML namespace stored in the XMLNamespaces object in this XMLToken object.

  See Also:

  XMLToken.getNamespacesLength()

  "Note:"

  If index is out of range, this method will return an empty string.

• getNamespaceURI

  public java.lang.String getNamespaceURI(java.lang.String prefix)

  Returns the URI of an XML namespace with a given prefix.

  Parameters:

  prefix - a string, the prefix of the sought-after XML namespace URI.

  Returns:

  the URI of an XML namespace declaration given its prefix.

  "Note:"

  If there is no XML namespace with the given prefix stored in the XMLNamespaces object of this XMLToken object, this method will return an empty string.

  Documentation note:

  The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.

• getNamespaceURI

  public java.lang.String getNamespaceURI()

  Returns the URI of an XML namespace with a given prefix.

  Parameters:

  prefix - a string, the prefix of the sought-after XML namespace URI.

  Returns:

  the URI of an XML namespace declaration given its prefix.

  "Note:"

  If there is no XML namespace with the given prefix stored in the XMLNamespaces object of this XMLToken object, this method will return an empty string.

  Documentation note:

  The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.

• isNamespacesEmpty

  public boolean isNamespacesEmpty()

  Returns true if there are no namespaces declared on this token.

  Returns:

  true if the XMLNamespaces object stored in this XMLToken token is empty, false otherwise.

• hasNamespaceURI

  public boolean hasNamespaceURI(java.lang.String uri)

  Returns true if this token has an XML namespace with a given URI.

  Parameters:

  uri - a string, the URI of the XML namespace.

  Returns:

  true if an XML namespace with the given URI is contained in the XMLNamespaces object of this XMLToken object, false otherwise.

• hasNamespacePrefix

  public boolean hasNamespacePrefix(java.lang.String prefix)

  Returns true if this token has an XML namespace with a given prefix.

  Parameters:

  prefix - a string, the prefix for the XML namespace.

  Returns:

  true if an XML Namespace with the given URI is contained in the XMLNamespaces of this XMLToken, false otherwise.

• hasNamespaceNS

  public boolean hasNamespaceNS(java.lang.String uri,
                                java.lang.String prefix)

  Returns true if this token has an XML namespace with a given prefix and URI combination.

  Parameters:

  uri - a string, the URI for the namespace.

  prefix - a string, the prefix for the namespace.

  Returns:

  true if an XML namespace with the given URI/prefix pair is contained in the XMLNamespaces object of this XMLToken object, false otherwise.

• setTriple

  public int setTriple(XMLTriple triple)

  Sets the name, namespace prefix and namespace URI of this token.

  This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

  Parameters:

  triple - the new XMLTriple to use for this XMLToken object. If this XMLToken already had an XMLTriple object stored within it, that object will be replaced.

  Returns:

  integer value indicating success/failure of the function. The possible values returned by this function are:

  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_OPERATION_FAILED
  • LIBSBML_INVALID_XML_OPERATION
  • LIBSBML_INVALID_OBJECT

• getName

  public java.lang.String getName()

  Returns the (unqualified) name of token.

  Returns:

  the (unqualified) name of token.

• getPrefix

  public java.lang.String getPrefix()

  Returns the XML namespace prefix of token.

  Returns:

  the XML namespace prefix of token.

  "Note:"

  If no XML namespace prefix has been assigned to this token, this method will return an empty string.

• getURI

  public java.lang.String getURI()

  Returns the XML namespace URI of token.

  Returns:

  the XML namespace URI of token.

• getCharacters

  public java.lang.String getCharacters()

  Returns the character text of token.

  Returns:

  the characters of this XML token. If this token is not a text token (i.e., it's an XML element and not character content), then this will return an empty string.

  See Also:

  XMLToken.isText(), XMLToken.isElement()

• setCharacters

  public int setCharacters(java.lang.String chars)

  Sets the characters for this XMLToken

  This method only makes sense for XMLToken objects that contains text. If this method is called on a token that represents an XML start or end tag, it will return the code LIBSBML_OPERATION_FAILED.

  Parameters:

  chars - string, characters to append to the text of this token.

  Returns:

  integer value indicating success/failure of the function. The possible values returned by this function are:

  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_OPERATION_FAILED

  See Also:

  XMLToken.isText(), XMLToken.isElement()

• append

  public int append(java.lang.String chars)

  Appends characters to the text content of token.

  This method only makes sense for XMLToken objects that contains text. If this method is called on a token that represents an XML start or end tag, it will return the code LIBSBML_OPERATION_FAILED.

  Parameters:

  chars - string, characters to append to the text of this token.

  Returns:

  integer value indicating success/failure of the function. The possible values returned by this function are:

  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_OPERATION_FAILED

  See Also:

  XMLToken.isText(), XMLToken.isElement()

• getColumn

  public long getColumn()

  Returns the column number at which this token occurs in the input.

  Returns:

  the column at which this XMLToken occurred.

• getLine

  public long getLine()

  Returns the line number at which this token occurs in the input.

  Returns:

  the line at which this XMLToken occurred.

• isElement

  public boolean isElement()

  Returns true if this token represents an XML element.

  This generic predicate returns true if the element is either a start or end tag, and false if it's a text object. The related methods XMLToken:isStart(), XMLToken.isEnd() and XMLToken.isText() are more specific predicates.

  Returns:

  true if this XMLToken object represents an XML element, false otherwise.

  See Also:

  XMLToken.isStart(), XMLToken.isEnd(), XMLToken.isText()

• isEnd

  public boolean isEnd()

  Returns true if this token represents an XML end element.

  Returns:

  true if this XMLToken object represents an XML end element, false otherwise.

  See Also:

  XMLToken.isStart(), XMLToken.isElement(), XMLToken.isText()

• isEndFor

  public boolean isEndFor(XMLToken element)

  Returns true if this token represents an XML end element for a particular start element.

  Parameters:

  element - XMLToken, the element with which the current object should be compared to determined whether the current object is a start element for the given one.

  Returns:

  true if this XMLToken object represents an XML end tag for the start tag given by element, false otherwise.

  See Also:

  XMLToken.isElement(), XMLToken.isStart(), XMLToken.isEnd(), XMLToken.isText()

• isEOF

  public boolean isEOF()

  Returns true if this token is an end of file marker.

  Returns:

  true if this XMLToken object represents the end of the input, false otherwise.

  See Also:

  XMLToken.setEOF()

• isStart

  public boolean isStart()

  Returns true if this token represents an XML start element.

  Returns:

  true if this XMLToken is an XML start element, false otherwise.

  See Also:

  XMLToken.isElement(), XMLToken.isEnd(), XMLToken.isText()

• isText

  public boolean isText()

  Returns true if this token represents an XML text element.

  Returns:

  true if this XMLToken is an XML text element, false otherwise.

  See Also:

  XMLToken.isElement(), XMLToken.isStart(), XMLToken.isEnd()

• setEnd

  public int setEnd()

  Declares that this token represents an XML element end tag.

  Returns:

  integer value indicating success/failure of the function. The possible values returned by this function are:

  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_OPERATION_FAILED

  See Also:

  XMLToken.isStart(), XMLToken.isEnd()

• setEOF

  public int setEOF()

  Declares that this token is an end-of-file/input marker.

  Returns:

  integer value indicating success/failure of the function. The possible values returned by this function are:

  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_OPERATION_FAILED

  See Also:

  XMLToken.isEOF()

• unsetEnd

  public int unsetEnd()

  Declares that this token no longer represents an XML start/end element.

  Returns:

  integer value indicating success/failure of the function. The possible values returned by this function are:

  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_OPERATION_FAILED

• toString

  public java.lang.String toString()

  Prints a string representation of the underlying token stream.

  This method is intended for debugging purposes.

  Overrides:

  toString in class java.lang.Object

  Returns:

  a text string representing this XMLToken object.