ListOfGradientDefinitions (LibSBML Java API)

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

```
public class ListOfGradientDefinitions
extends ListOf
```
a container class that holds a list of gradient definitions. There are two types of gradient definitions: LinearGradient and RadialGradient
Each RenderInformation object can have it's own list of gradient definitions.

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListOfGradientDefinitions`	`cloneObject()` Creates and returns a deep copy of the `ListOfGradientDefinitions` object.
`void`	`delete()` Explicitly deletes the underlying native object.
`SBase`	`get(long i)` Returns a pointer to the `GradientBase` with the given index or null if the index is invalid.
`GradientBase`	`get(java.lang.String id)` Returns a pointer to the `GradientBase` 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 `ListOfGradientDefinitions`, is always `'listOfGradientDefinitions'.`
`int`	`getItemTypeCode()` Get the type code of the objects contained in this `ListOf`.
`boolean`	`isValidTypeForList(SBase item)`
`SBase`	`remove(long n)` Removes the nth item from this `ListOfGradientDefinitions` items and returns a pointer to it.
`GradientBase`	`remove(java.lang.String sid)` Removes item in this `ListOfGradientDefinitions` items with the given identifier.
`XMLNode`	`toXML()` Creates an `XMLNode` object from this `ListOfGradientDefinitions` 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
  - ListOfGradientDefinitions
```
public ListOfGradientDefinitions(XMLNode node,
                                 long l2version)
                          throws SBMLConstructorException
```
    Creates a new ListOfGradientDefinitions object from the given XMLNode object. The XMLNode object has to contain a valid XML representation of a ListOfGradientDefinitions 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 ListOfGradientDefinitions object to be instantiated.
    
    Throws:
    
    SBMLConstructorException
  - ListOfGradientDefinitions
```
public ListOfGradientDefinitions(XMLNode node)
                          throws SBMLConstructorException
```
    Creates a new ListOfGradientDefinitions object from the given XMLNode object. The XMLNode object has to contain a valid XML representation of a ListOfGradientDefinitions 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 ListOfGradientDefinitions object to be instantiated.
    
    Throws:
    
    SBMLConstructorException
  - ListOfGradientDefinitions
```
public ListOfGradientDefinitions(long level,
                                 long version,
                                 long pkgVersion)
                          throws SBMLConstructorException
```
    Constructor which instantiates an empty ListOfGradientDefinitions object.
    
    Throws:
    
    SBMLConstructorException
  - ListOfGradientDefinitions
```
public ListOfGradientDefinitions(long level,
                                 long version)
                          throws SBMLConstructorException
```
    Constructor which instantiates an empty ListOfGradientDefinitions object.
    
    Throws:
    
    SBMLConstructorException
  - ListOfGradientDefinitions
```
public ListOfGradientDefinitions(long level)
                          throws SBMLConstructorException
```
    Constructor which instantiates an empty ListOfGradientDefinitions object.
    
    Throws:
    
    SBMLConstructorException
  - ListOfGradientDefinitions
```
public ListOfGradientDefinitions()
                          throws SBMLConstructorException
```
    Constructor which instantiates an empty ListOfGradientDefinitions object.
    
    Throws:
    
    SBMLConstructorException
  - ListOfGradientDefinitions
```
public ListOfGradientDefinitions(RenderPkgNamespaces renderns)
                          throws SBMLConstructorException
```
    Ctor.
    
    Throws:
    
    SBMLConstructorException
  - ListOfGradientDefinitions
```
public ListOfGradientDefinitions(ListOfGradientDefinitions source)
                          throws SBMLConstructorException
```
    Copy constructor. Creates a copy of this ListOfGradientDefinitions 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 ListOfGradientDefinitions.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 ListOfGradientDefinitions.delete() themselves.
    
    Overrides:
    
    delete in class ListOf
  - cloneObject
```
public ListOfGradientDefinitions cloneObject()
```
    Creates and returns a deep copy of the ListOfGradientDefinitions object.
    
    Overrides:
    
    cloneObject in class ListOf
    
    Returns:
    
    a (deep) copy of this ListOfGradientDefinitions
  - 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()
  - isValidTypeForList
```
public boolean isValidTypeForList(SBase item)
```
  - toXML
```
public XMLNode toXML()
```
    Creates an XMLNode object from this ListOfGradientDefinitions object.
    
    Returns:
    
    the XMLNode with the XML representation for the ListOfGradientDefinitions object.
  - getElementName
```
public java.lang.String getElementName()
```
    Returns the XML element name of this object, which for ListOfGradientDefinitions, is always 'listOfGradientDefinitions'.
    
    Overrides:
    
    getElementName in class ListOf
    
    Returns:
    
    the name of this element, i.e., 'listOfGradientDefinitions'.
  - get
```
public SBase get(long i)
```
    Returns a pointer to the GradientBase with the given index or null if the index is invalid.
    
    Overrides:
    
    get in class ListOf
    
    Parameters:
    
    i - index of the GradientBase object to be returned
    
    Returns:
    
    pointer to the GradientBase at the given index or null.
    
    See Also:
    
    ListOf.size()
  - get
```
public GradientBase get(java.lang.String id)
```
    Returns a pointer to the GradientBase with the given id or null if the id is invalid.
    
    Parameters:
    
    id - id of the GradientBase object to be returned
    
    Returns:
    
    pointer to the GradientBase at the given id or null.
  - remove
```
public SBase remove(long n)
```
    Removes the nth item from this ListOfGradientDefinitions 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 GradientBase remove(java.lang.String sid)
```
    Removes item in this ListOfGradientDefinitions 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.

Class ListOfGradientDefinitions

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

ListOfGradientDefinitions

ListOfGradientDefinitions

ListOfGradientDefinitions

ListOfGradientDefinitions

ListOfGradientDefinitions

ListOfGradientDefinitions

ListOfGradientDefinitions

ListOfGradientDefinitions

Method Detail

delete

cloneObject

getItemTypeCode

isValidTypeForList

toXML

getElementName

get

get

remove

remove