Documentation

InvalidSequenceException extends InvalidArgumentException

Class InvalidSequenceException

Tags
author

Amélie DUVERNET aka Amelaye amelieonline@gmail.com

Table of Contents

Methods

circularSliceLengthExceedsSequence()  : InvalidSequenceException
Builds the exception raised when sliceCircular() is asked for a length longer than the circular sequence itself, which would require an explicit, not yet supported, repeat.
emptyCircularSequence()  : InvalidSequenceException
Builds the exception raised when a circular sequence is built from an empty string.
invalidSymbol()  : InvalidSequenceException
Builds the exception raised when a symbol does not belong to the alphabet of the value object.
negativeCircularSliceLength()  : InvalidSequenceException
Builds the exception raised when sliceCircular() is asked for a negative length.
unsupportedMolType()  : InvalidSequenceException
Builds the exception raised when a molecule type cannot be mapped to a value object.

Methods

circularSliceLengthExceedsSequence()

Builds the exception raised when sliceCircular() is asked for a length longer than the circular sequence itself, which would require an explicit, not yet supported, repeat.

public static circularSliceLengthExceedsSequence(int $iLength, int $iSequenceLength) : InvalidSequenceException
Parameters
$iLength : int

The rejected length

$iSequenceLength : int

The length of the circular sequence

Return values
InvalidSequenceException

invalidSymbol()

Builds the exception raised when a symbol does not belong to the alphabet of the value object.

public static invalidSymbol(string $sMolType, string $sSymbol, int $iPosition) : InvalidSequenceException
Parameters
$sMolType : string

The molecule type of the rejected value object (DNA, RNA, PROTEIN)

$sSymbol : string

The offending symbol

$iPosition : int

Zero-based position of the offending symbol

Return values
InvalidSequenceException
On this page

Search results