org.expasy.mzjava.core.mol

Interface SymbolSequence<S extends Symbol>

All Known Implementing Classes:

AminoAcidSequence, Peptide, PeptideFragment, PeptideMatch, Protein

public interface SymbolSequence<S extends Symbol>

Version:

1.0

Author:

nikitin, Oliver Horlacher

Method Summary

Methods

Modifier and Type	Method and Description
S	getSymbol(int index) Returns the symbol at the specified position in this symbol sequence.
int	size() Returns the number of symbols in this symbol sequence.
String	toSymbolString() String containing the Symbols

Method Detail

getSymbol

S getSymbol(int index)

Returns the symbol at the specified position in this symbol sequence.

Parameters:

index - index of the symbol to return

Returns:

the symbol at the specified position in this symbol sequence

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

toSymbolString

String toSymbolString()

String containing the Symbols

Returns:

String containing the Symbols

size

int size()

Returns the number of symbols in this symbol sequence. If this symbol sequence contains more than Integer.MAX_VALUE symbols, returns Integer.MAX_VALUE.

Returns:

the number of symbols in this symbol sequence