org.xmlcml.tools
Interface BondSet

All Known Subinterfaces:

ChainSet, Ring, RingNucleus

All Known Implementing Classes:

BondSetImpl

public interface BondSet

extends ToolHashSet

a set of bonds, which also counts the atoms

Method Summary

void	addBond(Bond bond) add a bond, checking for nullity and duplicates
BondSet	and(BondSet bondSet) combines this with BondSet to find common elements, else null.
boolean	containsAtom(Atom atom) does this BondSet contain a given atom?
AtomSet	getAtomSet()
BondSet	not(BondSet bondSet) combines this with BondSet to find elements NOT in BondSet, else null.
BondSet	or(BondSet bondSet) combines this with BondSet to find all elements.
BondSet	xor(BondSet bondSet) combines this with BondSet to find elements NOT in common, else null.

Methods inherited from interface org.xmlcml.tools.ToolHashSet

add, addAll, and, clone, contains, debug, iterator, not, or, remove, removeAll, retainAll, size, xor

Method Detail

addBond

public void addBond(Bond bond)
             throws CMLException

add a bond, checking for nullity and duplicates

getAtomSet

public AtomSet getAtomSet()

containsAtom

public boolean containsAtom(Atom atom)

does this BondSet contain a given atom?

and

public BondSet and(BondSet bondSet)
            throws CMLException

combines this with BondSet to find common elements, else null.

xor

public BondSet xor(BondSet bondSet)
            throws CMLException

combines this with BondSet to find elements NOT in common, else null.

not

public BondSet not(BondSet bondSet)
            throws CMLException

combines this with BondSet to find elements NOT in BondSet, else null.

or

public BondSet or(BondSet bondSet)
           throws CMLException

combines this with BondSet to find all elements.