XMLTriple (LibSBML Java API)

java.lang.Object
- org.sbml.libsbml.XMLTriple

```
public class XMLTriple
extends java.lang.Object
```
Representation of a qualified XML name.

This class of objects is defined by libSBML only and has no direct equivalent in terms of SBML components. This class is not prescribed by the SBML specifications, although it is used to implement features defined in SBML.

A 'triple' in the libSBML XML layer encapsulates the notion of qualified name, meaning an element name or an attribute name with an optional namespace qualifier. An XMLTriple instance carries up to three data items:
- The name of the attribute or element that is, the attribute name as it appears in an XML document or data stream
- The XML namespace prefix (if any) of the attribute. For example, in the following fragment of XML, the namespace prefix is the string mysim and it appears on both the element someelement and the attribute attribA. When both the element and the attribute are stored as XMLTriple objects, their prefix is mysim.
```
<mysim:someelement mysim:attribA='value' />
```
- The XML namespace URI with which the prefix is associated. In XML, every namespace used must be declared and mapped to a URI.
XMLTriple objects are the lowest-level data item in the XML layer of libSBML. Other objects such as XMLToken make use of XMLTriple objects.

Constructor Summary

Constructors
Constructor and Description
`XMLTriple()` Creates a new, empty `XMLTriple`.
`XMLTriple(java.lang.String triplet)` Creates a new `XMLTriple` by splitting the given `triplet` on the separator character `sepchar`.
`XMLTriple(java.lang.String triplet, char sepchar)` Creates a new `XMLTriple` by splitting the given `triplet` on the separator character `sepchar`.
`XMLTriple(java.lang.String name, java.lang.String uri, java.lang.String prefix)` Creates a new `XMLTriple` with the given `name`, `uri` and and `prefix`.
`XMLTriple(XMLTriple orig)` Copy constructor creates a copy of this `XMLTriple` set.

Method Summary

Methods
Modifier and Type	Method and Description
`XMLTriple`	`cloneObject()` Creates and returns a deep copy of this `XMLTriple` set.
`void`	`delete()` Explicitly deletes the underlying native object.
`boolean`	`equals(java.lang.Object sb)` Equality comparison method for XMLTriple.
`java.lang.String`	`getName()` Returns the name portion of this `XMLTriple`.
`java.lang.String`	`getPrefix()` Returns the prefix portion of this `XMLTriple`.
`java.lang.String`	`getPrefixedName()` Returns the prefixed name from this `XMLTriple`.
`java.lang.String`	`getURI()` Returns the URI portion of this `XMLTriple`.
`int`	`hashCode()` Returns a hashcode for this XMLTriple object.
`boolean`	`isEmpty()` Predicate returning `true` or `false` depending on whether this `XMLTriple` is empty.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - XMLTriple
```
public XMLTriple()
```
    Creates a new, empty XMLTriple.
  - XMLTriple
```
public XMLTriple(java.lang.String triplet)
```
    Creates a new XMLTriple by splitting the given triplet on the separator character sepchar.
    Triplet may be in one of the following formats:
    - name
    - URI sepchar name
    - URI sepchar name sepchar prefix
    Parameters:
    triplet - a string representing the triplet as above
    sepchar - a character, the sepchar used in the triplet
    
    Throws:
    
    XMLConstructorException - Thrown if the argument orig is null.
    
    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.
  - XMLTriple
```
public XMLTriple(java.lang.String triplet,
         char sepchar)
```
    Creates a new XMLTriple by splitting the given triplet on the separator character sepchar.
    Triplet may be in one of the following formats:
    - name
    - URI sepchar name
    - URI sepchar name sepchar prefix
    Parameters:
    triplet - a string representing the triplet as above
    sepchar - a character, the sepchar used in the triplet
    
    Throws:
    
    XMLConstructorException - Thrown if the argument orig is null.
    
    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.
  - XMLTriple
```
public XMLTriple(java.lang.String name,
         java.lang.String uri,
         java.lang.String prefix)
```
    Creates a new XMLTriple with the given name, uri and and prefix.
    
    Parameters:
    name - a string, name for the XMLTriple.
    uri - a string, URI of the XMLTriple.
    prefix - a string, prefix for the URI of the XMLTriple,
    
    Throws:
    
    XMLConstructorException - Thrown if the argument orig is null.
  - XMLTriple
```
public XMLTriple(XMLTriple orig)
```
    Copy constructor creates a copy of this XMLTriple set.
    
    Parameters:
    orig - the XMLTriple object to copy.
    
    Throws:
    
    XMLConstructorException - Thrown if the argument orig is null.
- Method Detail
  - cloneObject
```
public XMLTriple cloneObject()
```
    Creates and returns a deep copy of this XMLTriple set.
    
    Returns:
    a (deep) copy of this XMLTriple set.
  - 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 XMLTriple.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 XMLTriple.delete() themselves.
  - equals
```
public boolean equals(java.lang.Object sb)
```
    Equality comparison method for XMLTriple.
    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
  - getName
```
public java.lang.String getName()
```
    Returns the name portion of this XMLTriple.
    
    Returns:
    a string, the name from this XMLTriple.
  - getPrefix
```
public java.lang.String getPrefix()
```
    Returns the prefix portion of this XMLTriple.
    
    Returns:
    a string, the prefix portion of this XMLTriple.
  - getPrefixedName
```
public java.lang.String getPrefixedName()
```
    Returns the prefixed name from this XMLTriple.
    
    Returns:
    a string, the prefixed name from this XMLTriple.
  - getURI
```
public java.lang.String getURI()
```
    Returns the URI portion of this XMLTriple.
    
    Returns:
    URI a string, the prefix portion of this XMLTriple.
  - hashCode
```
public int hashCode()
```
    Returns a hashcode for this XMLTriple object.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    a hash code usable by Java methods that need them.
  - isEmpty
```
public boolean isEmpty()
```
    Predicate returning true or false depending on whether this XMLTriple is empty.
    
    Returns:
    true if this XMLTriple is empty, false otherwise.

Class XMLTriple

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

XMLTriple

XMLTriple

XMLTriple

XMLTriple

XMLTriple

Method Detail

cloneObject

delete

equals

getName

getPrefix

getPrefixedName

getURI

hashCode

isEmpty