1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
/*
* Copyright (C) 2014-2021 Brian L. Browning
*
* This file is part of Beagle
*
* Beagle is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Beagle is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package bref;
import java.io.Closeable;
import vcf.RefGTRec;
import vcf.Samples;
/**
* <p>Interface {@code BrefWrites} writes phased, non-missing genotypes to a
* binary reference format (bref) file. The {@code close()} method must
* be called after the last invocation of the {@code write()} method
* in order to ensure that any buffered data are written to the output
* binary reference file.
* </p>
* <p>Instances of class {@code BrefWriter} are not thread-safe.
* </p>
*
* @author Brian L. Browning {@code <browning@uw.edu>}
*/
public interface BrefWriter extends Closeable {
/**
* Returns the list of samples.
* @return the list of samples
*/
Samples samples();
/**
* Writes the specified phased genotype data in binary reference format.
* The Java virtual machine will exit with an error message if an I/O
* error occurs during method execution, if {@code this.close()}
* has previously been invoked, or if
* {@code rec.samples().equals(this.samples()) == false}.
*
* @param rec phased genotype data
*
* @throws NullPointerException if {@code rec == null}
*/
void write(RefGTRec rec);
/**
* Flushes any buffered output and releases any system resources that are
* held by this {@code BrefWriter}. The Java virtual machine will exit
* with an error message if an I/O error occurs during method execution.
*/
@Override
void close();
}
|
