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
-
-
Field Summary
-
Fields inherited from interface org.openscience.cdk.interfaces.IChemObject
ALIPHATIC, AROMATIC, CONJUGATED, HYDROGEN_BOND_ACCEPTOR, HYDROGEN_BOND_DONOR, IN_RING, MAPPED, NOT_IN_RING, PLACED, REACTIVE_CENTER, SINGLE_OR_DOUBLE, TYPEABLE, VISITED
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddReaction(IReaction reaction)Adds an reaction to this container.IReactiongetReaction(int number)Returns the Reaction at positionnumberin the container.intgetReactionCount()Returns the number of Reactions in this Container.booleanisEmpty()Returns true if this IReactionSet is empty.Iterable<IReaction>reactions()Returns theIterableover Reactions of this container.voidremoveAllReactions()Removes all reactions from this set.voidremoveReaction(int pos)Remove a reaction from this set.voidremoveReaction(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, clear, clone, flags, getFlag, getFlags, getFlagValue, getID, getListenerCount, getNotification, getProperties, getProperty, getProperty, is, notifyChanged, notifyChanged, removeListener, removeProperty, set, 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 positionnumberin the container.- Parameters:
number- The position of the Reaction to be returned- Returns:
- The Reaction at position
number
-
reactions
Iterable<IReaction> reactions()
Returns theIterableover Reactions of this container.- Returns:
- The
Iterableover 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
-
-