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