public class ListOfColorDefinitions extends ListOf
ColorDefinition
objects.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. |
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)
|
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. |
append, appendAndOwn, appendFrom, clear, clear, connectToChild, getElementByMetaId, getElementBySId, getTypeCode, insert, insertAndOwn, removeFromParentAndDelete, size
addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, deleteDisabledPlugins, deleteDisabledPlugins, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getDisabledPlugin, getId, getIdAttribute, getLevel, getLine, getListOfAllElements, getListOfAllElements, getListOfAllElementsFromPlugins, getListOfAllElementsFromPlugins, getMetaId, getModel, getModelHistory, getName, getNamespaces, getNotes, getNotesString, getNumCVTerms, getNumDisabledPlugins, getNumPlugins, getPackageCoreVersion, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getPlugin, getPrefix, getResourceBiologicalQualifier, getResourceModelQualifier, getSBMLDocument, getSBOTerm, getSBOTermAsURL, getSBOTermID, getURI, getVersion, hashCode, hasValidLevelVersionNamespaceCombination, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetId, isSetIdAttribute, isSetMetaId, isSetModelHistory, isSetName, isSetNotes, isSetSBOTerm, isSetUserData, matchesRequiredSBMLNamespacesForAddition, matchesSBMLNamespaces, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameMetaIdRefs, renameSIdRefs, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setId, setIdAttribute, setMetaId, setModelHistory, setName, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, toXMLNode, unsetAnnotation, unsetCVTerms, unsetId, unsetIdAttribute, unsetMetaId, unsetModelHistory, unsetName, unsetNotes, unsetSBOTerm, unsetUserData
public ListOfColorDefinitions(XMLNode node) throws SBMLConstructorException
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.
node
- the XMLNode
object reference that describes the ListOfColorDefinitions
object to be instantiated.SBMLConstructorException
public ListOfColorDefinitions(long level, long version, long pkgVersion) throws SBMLConstructorException
ListOfColorDefinitions
object.SBMLConstructorException
public ListOfColorDefinitions(long level, long version) throws SBMLConstructorException
ListOfColorDefinitions
object.SBMLConstructorException
public ListOfColorDefinitions(long level) throws SBMLConstructorException
ListOfColorDefinitions
object.SBMLConstructorException
public ListOfColorDefinitions() throws SBMLConstructorException
ListOfColorDefinitions
object.SBMLConstructorException
public ListOfColorDefinitions(RenderPkgNamespaces renderns) throws SBMLConstructorException
SBMLConstructorException
public ListOfColorDefinitions(ListOfColorDefinitions source) throws SBMLConstructorException
ListOfColorDefinitions
object.SBMLConstructorException
public void delete()
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.
public ListOfColorDefinitions cloneObject()
ListOfColorDefinitions
object.
cloneObject
 in class ListOf
ListOfColorDefinitions
public java.lang.String getElementName()
ListOfColorDefinitions
, is always 'listOfColorDefinitions'.
getElementName
 in class ListOf
'listOfColorDefinitions'.
public XMLNode toXML()
XMLNode
object from this ListOfColorDefinitions
object.
XMLNode
with the XML representation for the
ListOfColorDefinitions
object.public ColorDefinition get(long i)
ColorDefinition
with the given index or null if
the index is invalid.
get
 in class ListOf
i
- index of the ColorDefinition
object to be returned
ColorDefinition
at the given index or null.ListOf.size()
public ColorDefinition get(java.lang.String id)
id
- id of the ColorDefinition
object to be returned
ColorDefinition
at the given id
or null.
public ColorDefinition remove(long n)
ListOfColorDefinitions
items and returns a pointer to
it.
The caller owns the returned item and is responsible for deleting it.
remove
 in class ListOf
n
- the index of the item to remove
ListOf.size()
public ColorDefinition remove(java.lang.String sid)
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.
sid
- the identifier of the item to remove
public int getItemTypeCode()
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_.
getItemTypeCode
 in class ListOf
ListOf
instance, or SBML_UNKNOWN
(default).ListOf.getElementName()
,
SBase.getPackageName()