net.sf.octet.model
Interface AtomPair

All Known Implementing Classes:

BasicAtomPair

public interface AtomPair

An AtomPair represents a pair of Atoms. The significance ascribed to source and target Atom designations, will vary by implementation.

Author:

Richard Apodaca

Method Summary

boolean	connects(Atom source, Atom target) Returns true if the specified atoms are connected by this AtomPair.
boolean	contains(Atom atom) Returns true if the spacified Atom is linked by this AtomPair.
Atom	getMate(Atom atom) Returns the mate for the specified atom.
Atom	getSource() Returns the source Atom.
Atom	getTarget() Returns the target Atom.

Method Detail

getSource

public Atom getSource()

Returns the source Atom.

Returns:

the source atom

getTarget

public Atom getTarget()

Returns the target Atom.

Returns:

the target atom

getMate

public Atom getMate(Atom atom)

Returns the mate for the specified atom. Returns null if the specified atom is not connected by this Bond.

Parameters:

atom - the atom for which the mate will be returned

Returns:

the mate to the specified atom

contains

public boolean contains(Atom atom)

Returns true if the spacified Atom is linked by this AtomPair.

Parameters:

atom - the atom to examine

Returns:

true if the atom is linked by this bond, false otherwise

connects

public boolean connects(Atom source,
                        Atom target)

Returns true if the specified atoms are connected by this AtomPair.

Parameters:

source - the first atom

target - the second atom

Returns:

true if the two atoms are connected by this AtomPair, false otherwise