Package org.openscience.cdk.interfaces
Interface IReactionSet
-
- All Superinterfaces:
Cloneable
,ICDKObject
,IChemObject
- All Known Subinterfaces:
IReactionScheme
- All Known Implementing Classes:
DebugReactionScheme
,DebugReactionSet
,ReactionChain
,ReactionScheme
,ReactionScheme
,ReactionSet
,ReactionSet
public interface IReactionSet extends IChemObject
A set of reactions, for example those taking part in a reaction.- Source code:
- main
- Belongs to CDK module:
- interfaces
- Keywords:
- reaction
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addReaction(IReaction reaction)
Adds an reaction to this container.IReaction
getReaction(int number)
Returns the Reaction at positionnumber
in the container.int
getReactionCount()
Returns the number of Reactions in this Container.boolean
isEmpty()
Returns true if this IReactionSet is empty.Iterable<IReaction>
reactions()
Returns theIterable
over Reactions of this container.void
removeAllReactions()
Removes all reactions from this set.void
removeReaction(int pos)
Remove a reaction from this set.void
removeReaction(IReaction relevantReaction)
Removes all instances of a reaction from this IReactionSet.-
Methods inherited from interface org.openscience.cdk.interfaces.ICDKObject
getBuilder
-
Methods inherited from interface org.openscience.cdk.interfaces.IChemObject
addListener, addProperties, clone, getFlag, getFlags, getFlagValue, getID, getListenerCount, getNotification, getProperties, getProperty, getProperty, notifyChanged, notifyChanged, removeListener, removeProperty, setFlag, setFlags, setID, setNotification, setProperties, setProperty, toString
-
-
-
-
Method Detail
-
addReaction
void addReaction(IReaction reaction)
Adds an reaction to this container.- Parameters:
reaction
- The reaction to be added to this container
-
removeReaction
void removeReaction(int pos)
Remove a reaction from this set.- Parameters:
pos
- The position of the reaction to be removed.
-
getReaction
IReaction getReaction(int number)
Returns the Reaction at positionnumber
in the container.- Parameters:
number
- The position of the Reaction to be returned- Returns:
- The Reaction at position
number
-
reactions
Iterable<IReaction> reactions()
Returns theIterable
over Reactions of this container.- Returns:
- The
Iterable
over Reactions of this container
-
getReactionCount
int getReactionCount()
Returns the number of Reactions in this Container.- Returns:
- The number of Reactions in this Container
-
removeAllReactions
void removeAllReactions()
Removes all reactions from this set.
-
removeReaction
void removeReaction(IReaction relevantReaction)
Removes all instances of a reaction from this IReactionSet.- Parameters:
relevantReaction
- the reaction to remove
-
isEmpty
boolean isEmpty()
Returns true if this IReactionSet is empty.- Returns:
- a boolean indicating if this ring set no reactions
-
-