public class SBMLDocumentPlugin extends SBasePlugin
Plugin objects for the SBMLDocument
element must be this class or a
derived class of this class. Package developers should use this class
as-is if only 'required' attribute is added in the SBMLDocument
element by
their packages. Otherwise, developers must implement a derived class of
this class and use that class as the plugin object for the SBMLDocument
element.
Constructor and Description |
---|
SBMLDocumentPlugin(SBMLDocumentPlugin orig)
Copy constructor.
|
SBMLDocumentPlugin(java.lang.String uri,
java.lang.String prefix,
SBMLNamespaces sbmlns)
Constructor
|
Modifier and Type | Method and Description |
---|---|
SBasePlugin |
cloneObject()
Creates and returns a deep copy of this
SBMLDocumentPlugin object. |
void |
delete()
Explicitly deletes the underlying native object.
|
boolean |
getRequired()
Returns the boolean value of 'required' attribute of corresponding
package in
SBMLDocument element. |
boolean |
isSetRequired()
Predicate returning
true or false depending on whether this
SBMLDocumentPlugin 's 'required' attribute has been set. |
int |
setRequired(boolean value)
Sets the boolean value of 'required' attribute of corresponding package
in
SBMLDocument element. |
int |
unsetRequired()
Unsets the value of the 'required' attribute of this
SBMLDocumentPlugin . |
getElementByMetaId, getElementBySId, getElementNamespace, getLevel, getListOfAllElements, getListOfAllElements, getPackageName, getPackageVersion, getParentSBMLObject, getPrefix, getSBMLDocument, getURI, getVersion, setElementNamespace
public SBMLDocumentPlugin(SBMLDocumentPlugin orig)
public SBMLDocumentPlugin(java.lang.String uri, java.lang.String prefix, SBMLNamespaces sbmlns)
uri
- the URI of packageprefix
- the prefix for the given packagesbmlns
- the SBMLNamespaces
object for the packagepublic SBasePlugin cloneObject()
SBMLDocumentPlugin
object.
cloneObject
 in class SBasePlugin
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 SBMLDocumentPlugin.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 SBMLDocumentPlugin.delete()
themselves.
delete
 in class SBasePlugin
public boolean getRequired()
Returns the boolean value of 'required' attribute of corresponding
package in SBMLDocument
element.
SBMLDocument
element.public boolean isSetRequired()
true
or false
depending on whether this
SBMLDocumentPlugin
's 'required' attribute has been set.
true
if the 'required' attribute of this SBMLDocument
has been
set, false
otherwise.public int setRequired(boolean value)
Sets the boolean value of 'required' attribute of corresponding package
in SBMLDocument
element.
value
- the boolean value of 'required' attribute of corresponding
package in SBMLDocument
element.
public int unsetRequired()
SBMLDocumentPlugin
.