|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.biojava3.sequencing.io.fastq.FastqBuilder
public final class FastqBuilder
Fluent builder API for creating FASTQ formatted sequences.
Field Summary | |
---|---|
static FastqVariant |
DEFAULT_VARIANT
Default FASTQ sequence format variant, FastqVariant.FASTQ_SANGER . |
Constructor Summary | |
---|---|
FastqBuilder()
Create a new FASTQ formatted sequence builder. |
Method Summary | |
---|---|
FastqBuilder |
appendQuality(String quality)
Return this FASTQ formatted sequence builder configured with the specified quality scores appended to its current quality scores. |
FastqBuilder |
appendSequence(String sequence)
Return this FASTQ formatted sequence builder configured with the specified sequence appended to its current sequence. |
Fastq |
build()
Build and return a new FASTQ formatted sequence configured from the properties of this builder. |
String |
getDescription()
Return the description for this FASTQ formatted sequence builder. |
boolean |
sequenceAndQualityLengthsMatch()
Return true if the sequence and quality scores for this FASTQ formatted sequence builder are equal in length. |
FastqBuilder |
withDescription(String description)
Return this FASTQ formatted sequence builder configured with the specified description. |
FastqBuilder |
withQuality(String quality)
Return this FASTQ formatted sequence builder configured with the specified quality scores. |
FastqBuilder |
withSequence(String sequence)
Return this FASTQ formatted sequence builder configured with the specified sequence. |
FastqBuilder |
withVariant(FastqVariant variant)
Return this FASTQ formatted sequence builder configured with the specified FASTQ sequence format variant. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final FastqVariant DEFAULT_VARIANT
FastqVariant.FASTQ_SANGER
.
Constructor Detail |
---|
public FastqBuilder()
Method Detail |
---|
public String getDescription()
public FastqBuilder withDescription(String description)
description
- description for this FASTQ formatted sequence builder, must not be null
public FastqBuilder withSequence(String sequence)
sequence
- sequence for this FASTQ formatted sequence builder, must not be null
public FastqBuilder appendSequence(String sequence)
sequence
- sequence to append to the sequence for this FASTQ formatted sequence builder, must not be null
public FastqBuilder withQuality(String quality)
quality
- quality scores for this FASTQ formatted sequence builder, must not be null
public FastqBuilder appendQuality(String quality)
quality
- quality scores to append to the quality scores for this FASTQ formatted sequence
builder, must not be null
public boolean sequenceAndQualityLengthsMatch()
public FastqBuilder withVariant(FastqVariant variant)
variant
- FASTQ sequence format variant for this FASTQ formatted sequence builder, must not be null
public Fastq build()
IllegalStateException
- if the configuration of this builder results in an illegal state
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |