org.sbml.libsbml

Class SBMLDocumentPlugin

java.lang.Object

org.sbml.libsbml.SBasePlugin

org.sbml.libsbml.SBMLDocumentPlugin

Direct Known Subclasses:

CompSBMLDocumentPlugin

public class SBMLDocumentPlugin
extends SBasePlugin

Template class for the SBMLDocument Plugin class needed by all packages.

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 Summary

Constructors

Constructor and Description
SBMLDocumentPlugin(SBMLDocumentPlugin orig) Copy constructor.
SBMLDocumentPlugin(java.lang.String uri, java.lang.String prefix, SBMLNamespaces sbmlns) Constructor

Method Summary

Methods

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.

Methods inherited from class org.sbml.libsbml.SBasePlugin

getElementByMetaId, getElementBySId, getElementNamespace, getLevel, getListOfAllElements, getListOfAllElements, getPackageName, getPackageVersion, getParentSBMLObject, getPrefix, getSBMLDocument, getURI, getVersion, setElementNamespace

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SBMLDocumentPlugin

public SBMLDocumentPlugin(SBMLDocumentPlugin orig)

Copy constructor. Creates a copy of this object.

SBMLDocumentPlugin

public SBMLDocumentPlugin(java.lang.String uri,
                  java.lang.String prefix,
                  SBMLNamespaces sbmlns)

Constructor

Parameters:

uri - the URI of package

prefix - the prefix for the given package

sbmlns - the SBMLNamespaces object for the package

Method Detail

cloneObject

public SBasePlugin cloneObject()

Creates and returns a deep copy of this SBMLDocumentPlugin object.

Overrides:

cloneObject in class SBasePlugin

Returns:

a (deep) copy of this object

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 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.

Overrides:

delete in class SBasePlugin

getRequired

public boolean getRequired()

Returns the boolean value of 'required' attribute of corresponding package in SBMLDocument element.

Returns:

the boolean value of 'required' attribute of corresponding package in SBMLDocument element.

isSetRequired

public boolean isSetRequired()

Predicate returning true or false depending on whether this SBMLDocumentPlugin's 'required' attribute has been set.

Returns:

true if the 'required' attribute of this SBMLDocument has been set, false otherwise.

setRequired

public int setRequired(boolean value)

Sets the boolean value of 'required' attribute of corresponding package in SBMLDocument element.

Parameters:

value - the boolean value of 'required' attribute of corresponding package in SBMLDocument element.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_UNEXPECTED_ATTRIBUTE

unsetRequired

public int unsetRequired()

Unsets the value of the 'required' attribute of this SBMLDocumentPlugin.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_OPERATION_FAILED