org.biojava.nbio.structure

Class AugmentedResidueRange

java.lang.Object

org.biojava.nbio.structure.ResidueRange

org.biojava.nbio.structure.ResidueRangeAndLength

org.biojava.nbio.structure.AugmentedResidueRange

public class AugmentedResidueRange
extends ResidueRangeAndLength

Created by douglas on 1/23/15.

Field Summary

Fields inherited from class org.biojava.nbio.structure.ResidueRange

CHAIN_REGEX, RANGE_REGEX

Constructor Summary

Constructors

Constructor and Description
AugmentedResidueRange(String chain, ResidueNumber start, ResidueNumber end, int length, AtomPositionMap map)
AugmentedResidueRange(String chain, String start, String end, int length, AtomPositionMap map)

Method Summary

Modifier and Type	Method and Description
boolean	contains(ResidueNumber residueNumber)
ResidueNumber	getResidue(int positionInRange) Returns the ResidueNumber that is at position positionInRange in this ResidueRange.
Iterator<ResidueNumber>	iterator() Returns a new Iterator over every ResidueNumber in this ResidueRange.

Methods inherited from class org.biojava.nbio.structure.ResidueRangeAndLength

calcLength, equals, getLength, hashCode, iterator, parse, parseMultiple, parseMultiple

Methods inherited from class org.biojava.nbio.structure.ResidueRange

contains, getChainName, getEnd, getResidue, getStart, multiIterator, multiIterator, parse, parseMultiple, parseMultiple, toString, toString, toStrings

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AugmentedResidueRange

public AugmentedResidueRange(String chain,
                             ResidueNumber start,
                             ResidueNumber end,
                             int length,
                             AtomPositionMap map)

AugmentedResidueRange

public AugmentedResidueRange(String chain,
                             String start,
                             String end,
                             int length,
                             AtomPositionMap map)

Method Detail

getResidue

public ResidueNumber getResidue(int positionInRange)

Returns the ResidueNumber that is at position positionInRange in this ResidueRange.

Returns:

The ResidueNumber, or false if it does not exist or is not within this ResidueRange

contains

public boolean contains(ResidueNumber residueNumber)

Returns:

True if and only if residueNumber is within this ResidueRange

iterator

public Iterator<ResidueNumber> iterator()

Returns a new Iterator over every ResidueNumber in this ResidueRange. Stores the contents of map until the iterator is finished, so calling code should set the iterator to null if it did not finish.