ListOfColorDefinitions (LibSBML Java API)

java.lang.Object
- org.sbml.libsbml.SBase
- - org.sbml.libsbml.ListOf
  - - org.sbml.libsbml.ListOfColorDefinitions

```
public class ListOfColorDefinitions
extends ListOf
```
LibSBML implementation for a container which holds zero or more ColorDefinition objects.

Constructor Summary

Constructors
Constructor and Description
`ListOfColorDefinitions()` Constructor which instantiates an empty `ListOfColorDefinitions` object.
`ListOfColorDefinitions(ListOfColorDefinitions source)` Copy constructor.
`ListOfColorDefinitions(long level)` Constructor which instantiates an empty `ListOfColorDefinitions` object.
`ListOfColorDefinitions(long level, long version)` Constructor which instantiates an empty `ListOfColorDefinitions` object.
`ListOfColorDefinitions(long level, long version, long pkgVersion)` Constructor which instantiates an empty `ListOfColorDefinitions` object.
`ListOfColorDefinitions(RenderPkgNamespaces renderns)` Ctor.
`ListOfColorDefinitions(XMLNode node)` Creates a new `ListOfColorDefinitions` object from the given `XMLNode` object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListOfColorDefinitions`	`cloneObject()` Creates and returns a deep copy of the `ListOfColorDefinitions` object.
`void`	`delete()` Explicitly deletes the underlying native object.
`ColorDefinition`	`get(long i)` Returns a pointer to the `ColorDefinition` with the given index or null if the index is invalid.
`ColorDefinition`	`get(java.lang.String id)` Returns a pointer to the `ColorDefinition` with the given `id` or `null` if the id is invalid.
`java.lang.String`	`getElementName()` Returns the XML element name of this object, which for `ListOfColorDefinitions`, is always `'listOfColorDefinitions'.`
`int`	`getItemTypeCode()` Get the type code of the objects contained in this `ListOf`.
`ColorDefinition`	`remove(long n)` Removes the nth item from this `ListOfColorDefinitions` items and returns a pointer to it.
`ColorDefinition`	`remove(java.lang.String sid)` Removes item in this ListOfColorDefinition items with the given identifier.
`XMLNode`	`toXML()` Creates an `XMLNode` object from this `ListOfColorDefinitions` object.

Methods inherited from class org.sbml.libsbml.ListOf
append, appendAndOwn, appendFrom, clear, clear, connectToChild, getElementByMetaId, getElementBySId, getTypeCode, insert, insertAndOwn, removeFromParentAndDelete, size

Methods inherited from class org.sbml.libsbml.SBase
addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, deleteDisabledPlugins, deleteDisabledPlugins, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getDisabledPlugin, getLevel, getLine, getListOfAllElements, getListOfAllElements, getListOfAllElementsFromPlugins, getListOfAllElementsFromPlugins, getMetaId, getModel, getModelHistory, getNamespaces, getNotes, getNotesString, getNumCVTerms, getNumDisabledPlugins, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getPlugin, getPrefix, getResourceBiologicalQualifier, getResourceModelQualifier, getSBMLDocument, getSBOTerm, getSBOTermAsURL, getSBOTermID, getURI, getVersion, hashCode, hasValidLevelVersionNamespaceCombination, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetMetaId, isSetModelHistory, isSetNotes, isSetSBOTerm, isSetUserData, matchesRequiredSBMLNamespacesForAddition, matchesSBMLNamespaces, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameMetaIdRefs, renameSIdRefs, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setMetaId, setModelHistory, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, toXMLNode, unsetAnnotation, unsetCVTerms, unsetId, unsetMetaId, unsetModelHistory, unsetName, unsetNotes, unsetSBOTerm, unsetUserData

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

- Constructor Detail
  - ListOfColorDefinitions
```
public ListOfColorDefinitions(XMLNode node)
                       throws SBMLConstructorException
```
    Creates a new ListOfColorDefinitions object from the given XMLNode object. The XMLNode object has to contain a valid XML representation of a ListOfColorDefinitions object as defined in the render extension specification. This method is normally called when render information is read from a file and should normally not have to be called explicitly.
    
    Parameters:
    
    node - the XMLNode object reference that describes the ListOfColorDefinitions object to be instantiated.
    
    Throws:
    
    SBMLConstructorException
  - ListOfColorDefinitions
```
public ListOfColorDefinitions(long level,
                              long version,
                              long pkgVersion)
                       throws SBMLConstructorException
```
    Constructor which instantiates an empty ListOfColorDefinitions object.
    
    Throws:
    
    SBMLConstructorException
  - ListOfColorDefinitions
```
public ListOfColorDefinitions(long level,
                              long version)
                       throws SBMLConstructorException
```
    Constructor which instantiates an empty ListOfColorDefinitions object.
    
    Throws:
    
    SBMLConstructorException
  - ListOfColorDefinitions
```
public ListOfColorDefinitions(long level)
                       throws SBMLConstructorException
```
    Constructor which instantiates an empty ListOfColorDefinitions object.
    
    Throws:
    
    SBMLConstructorException
  - ListOfColorDefinitions
```
public ListOfColorDefinitions()
                       throws SBMLConstructorException
```
    Constructor which instantiates an empty ListOfColorDefinitions object.
    
    Throws:
    
    SBMLConstructorException
  - ListOfColorDefinitions
```
public ListOfColorDefinitions(RenderPkgNamespaces renderns)
                       throws SBMLConstructorException
```
    Ctor.
    
    Throws:
    
    SBMLConstructorException
  - ListOfColorDefinitions
```
public ListOfColorDefinitions(ListOfColorDefinitions source)
                       throws SBMLConstructorException
```
    Copy constructor. Creates a copy of this ListOfColorDefinitions object.
    
    Throws:
    
    SBMLConstructorException
- 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 ListOfColorDefinitions.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 ListOfColorDefinitions.delete() themselves.
    
    Overrides:
    
    delete in class ListOf
  - cloneObject
```
public ListOfColorDefinitions cloneObject()
```
    Creates and returns a deep copy of the ListOfColorDefinitions object.
    
    Overrides:
    
    cloneObject in class ListOf
    
    Returns:
    
    a (deep) copy of this ListOfColorDefinitions
  - getElementName
```
public java.lang.String getElementName()
```
    Returns the XML element name of this object, which for ListOfColorDefinitions, is always 'listOfColorDefinitions'.
    
    Overrides:
    
    getElementName in class ListOf
    
    Returns:
    
    the name of this element, i.e., 'listOfColorDefinitions'.
  - toXML
```
public XMLNode toXML()
```
    Creates an XMLNode object from this ListOfColorDefinitions object.
    
    Returns:
    
    the XMLNode with the XML representation for the ListOfColorDefinitions object.
  - get
```
public ColorDefinition get(long i)
```
    Returns a pointer to the ColorDefinition with the given index or null if the index is invalid.
    
    Overrides:
    
    get in class ListOf
    
    Parameters:
    
    i - index of the ColorDefinition object to be returned
    
    Returns:
    
    pointer to the ColorDefinition at the given index or null.
    
    See Also:
    
    ListOf.size()
  - get
```
public ColorDefinition get(java.lang.String id)
```
    Returns a pointer to the ColorDefinition with the given id or null if the id is invalid.
    
    Parameters:
    
    id - id of the ColorDefinition object to be returned
    
    Returns:
    
    pointer to the ColorDefinition at the given id or null.
  - remove
```
public ColorDefinition remove(long n)
```
    Removes the nth item from this ListOfColorDefinitions items and returns a pointer to it.
    The caller owns the returned item and is responsible for deleting it.
    
    Overrides:
    
    remove in class ListOf
    
    Parameters:
    
    n - the index of the item to remove
    
    See Also:
    
    ListOf.size()
  - remove
```
public ColorDefinition remove(java.lang.String sid)
```
    Removes item in this ListOfColorDefinition items with the given identifier.
    The caller owns the returned item and is responsible for deleting it. If none of the items in this list have the identifier sid, then @c null is returned.
    
    Parameters:
    
    sid - the identifier of the item to remove
    
    Returns:
    
    the item removed. As mentioned above, the caller owns the returned item.
  - getItemTypeCode
```
public int getItemTypeCode()
```
    Get the type code of the objects contained in this ListOf.
    LibSBML attaches an identifying code to every kind of SBML object. These are known as SBML type codes. In other languages, the set of type codes is stored in an enumeration in the Java language interface for libSBML, the type codes are defined as static integer constants in the interface class libsbmlConstants. The names of the type codes all begin with the characters SBML_.
    
    Overrides:
    
    getItemTypeCode in class ListOf
    
    Returns:
    
    the SBML type code for the objects contained in this ListOf instance, or SBML_UNKNOWN (default).
    
    See Also:
    
    ListOf.getElementName(), SBase.getPackageName()

Class ListOfColorDefinitions

Constructor Summary

Method Summary

Methods inherited from class org.sbml.libsbml.ListOf

Methods inherited from class org.sbml.libsbml.SBase

Methods inherited from class java.lang.Object

Constructor Detail

ListOfColorDefinitions

ListOfColorDefinitions

ListOfColorDefinitions

ListOfColorDefinitions

ListOfColorDefinitions

ListOfColorDefinitions

ListOfColorDefinitions

Method Detail

delete

cloneObject

getElementName

toXML

get

get

remove

remove

getItemTypeCode