Module org.phenopackets.phenopackettools.util

Package org.phenopackets.phenopackettools.util.format

Class ElementSniffer

java.lang.Object

org.phenopackets.phenopackettools.util.format.ElementSniffer

public class ElementSniffer
extends Object

Make an educated guess regarding which top-level element of Phenopacket schema is represented in the provided byte[] or InputStream.

Method Summary

Modifier and Type	Method	Description
static PhenopacketElement	sniff(byte[] payload, PhenopacketFormat format)	Make an educated guess of PhenopacketElement based on given payload.
static PhenopacketElement	sniff(byte[] payload, PhenopacketSchemaVersion schemaVersion, PhenopacketFormat format)	Deprecated. in favor of sniff(byte[], PhenopacketFormat)
static PhenopacketElement	sniff(InputStream input, PhenopacketFormat format)	Make an educated guess of PhenopacketElement present in given input.
static PhenopacketElement	sniff(InputStream input, PhenopacketSchemaVersion schemaVersion, PhenopacketFormat format)	Deprecated. in favor of sniff(InputStream, PhenopacketFormat).

Methods inherited from class java.lang.Object

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

Method Details

sniff

public static PhenopacketElement sniff(InputStream input,
 PhenopacketSchemaVersion schemaVersion,
 PhenopacketFormat format)
                                throws IOException,
SniffException

Deprecated.

in favor of sniff(InputStream, PhenopacketFormat).

Make an educated guess of PhenopacketElement present in given input.

Parameters:

input - an InputStream that supports InputStream.mark(int).

format - the payload format

Returns:

the sniffed PhenopacketElement.

Throws:

IOException - in case an error occurs while reading the input.

SniffException - if there are not enough bytes available in the input of if the input does not support InputStream.mark(int).

sniff

public static PhenopacketElement sniff(InputStream input,
 PhenopacketFormat format)
                                throws IOException,
SniffException

Make an educated guess of PhenopacketElement present in given input.

Parameters:

input - an InputStream that supports InputStream.mark(int).

format - the payload format

Returns:

the sniffed PhenopacketElement.

Throws:

IOException - in case an error occurs while reading the input.

SniffException - if the input does not support InputStream.mark(int).

sniff

public static PhenopacketElement sniff(byte[] payload,
 PhenopacketSchemaVersion schemaVersion,
 PhenopacketFormat format)
                                throws ElementSniffException

Deprecated.

in favor of sniff(byte[], PhenopacketFormat)

Make an educated guess of PhenopacketElement based on given payload.

Parameters:

payload - buffer with at least the first BUFFER_SIZE bytes of the input.

format - the payload format

Returns:

the sniffed PhenopacketElement.

Throws:

ElementSniffException - if the payload looks suspicious, e.g. contains a unique phenopacket field and a unique cohort field at the same time

sniff

public static PhenopacketElement sniff(byte[] payload,
 PhenopacketFormat format)
                                throws ElementSniffException

Make an educated guess of PhenopacketElement based on given payload.

Parameters:

payload - buffer with at least the first BUFFER_SIZE bytes of the input.

format - the payload format

Returns:

the sniffed PhenopacketElement.

Throws:

ElementSniffException - if the payload looks suspicious, e.g. contains a unique phenopacket field and a unique cohort field at the same time