org.nmdp.ngs.variant.vcf

Class VcfHeader.Builder

java.lang.Object

org.nmdp.ngs.variant.vcf.VcfHeader.Builder

Enclosing class:

VcfHeader

public static final class VcfHeader.Builder
extends Object

VCF header builder.

Method Summary

Methods

Modifier and Type	Method and Description
VcfHeader	build() Create and return a new VCF header populated from the configuration of this VCF header builder.
VcfHeader.Builder	reset() Reset this VCF header builder.
VcfHeader.Builder	withFileFormat(String fileFormat) Return this VCF header builder configured with the specified file format.
VcfHeader.Builder	withMeta(List<String> meta) Return this VCF header builder configured with the specified meta-information header lines.
VcfHeader.Builder	withMeta(String... meta) Return this VCF header builder configured with the specified meta-information header lines.
VcfHeader.Builder	withMeta(String meta) Return this VCF header builder configured with the specified meta-information header line.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

withFileFormat

public VcfHeader.Builder withFileFormat(String fileFormat)

Return this VCF header builder configured with the specified file format.

Parameters:

fileFormat - file format

Returns:

this VCF header builder configured with the specified file format

withMeta

public VcfHeader.Builder withMeta(String meta)

Return this VCF header builder configured with the specified meta-information header line.

Parameters:

meta - meta-information header line, must not be null

Returns:

this VCF header builder configured with the specified meta-information header line

withMeta

public VcfHeader.Builder withMeta(String... meta)

Return this VCF header builder configured with the specified meta-information header lines.

Parameters:

meta - one or more meta-information header lines, must not contain null

Returns:

this VCF header builder configured with the specified meta-information header line

withMeta

public VcfHeader.Builder withMeta(List<String> meta)

Return this VCF header builder configured with the specified meta-information header lines.

Parameters:

meta - list of meta-information header lines, must not be null and must not contain null

Returns:

this VCF header builder configured with the specified meta-information header lines

reset

public VcfHeader.Builder reset()

Reset this VCF header builder.

Returns:

this VCF header builder

build

public VcfHeader build()

Create and return a new VCF header populated from the configuration of this VCF header builder.

Returns:

a new VCF header populated from the configuration of this VCF header builder