Module io.jenetics.jpx

Package io.jenetics.jpx

Class GPX.Reader

java.lang.Object

io.jenetics.jpx.GPX.Reader

Enclosing class:

GPX

public static final class GPX.Reader
extends Object

Class for reading GPX files. A reader instance can be created by the GPX.reader factory methods.

Since:

1.3

Version:

3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GPX.Reader.Mode	The possible GPX reader modes.

Field Summary

Fields

Modifier and Type	Field	Description
static final GPX.Reader	DEFAULT	The default GPX reader, reading GPX files (v1.1) with reading mode GPX.Reader.Mode.STRICT.

Method Summary

Modifier and Type	Method	Description
GPX	fromString(String xml)	Create a GPX object from the given GPX-XML string.
GPX.Reader.Mode	mode()	Return the current reader mode.
static GPX.Reader	of(GPX.Reader.Mode mode)	Return a GPX reader, reading GPX files with version 1.1 and in the given reading mode.
static GPX.Reader	of(GPX.Version version, GPX.Reader.Mode mode)	Return a GPX reader, reading GPX files with the given version and in the given reading mode.
GPX	read(File file)	Read a GPX object from the given file.
GPX	read(InputStream input)	Read a GPX object from the given input stream.
GPX	read(String path)	Read a GPX object from the given path.
GPX	read(Path path)	Read a GPX object from the given path.
GPX	read(Source source)	Read a GPX object from the given input source.
GPX.Version	version()	Return the GPX version this reader is able to read.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final GPX.Reader DEFAULT

The default GPX reader, reading GPX files (v1.1) with reading mode GPX.Reader.Mode.STRICT.

Since:

3.0

Method Details

version

public GPX.Version version()

Return the GPX version this reader is able to read.

Returns:

the GPX version of this reader

mode

public GPX.Reader.Mode mode()

Return the current reader mode.

Returns:

the current reader mode

read

public GPX read(Source source)
         throws IOException

Read a GPX object from the given input source. This is the most general method for reading a GPX object.

Parameters:

source - the input source from where the GPX date is read

Returns:

the GPX object read from the source

Throws:

IOException - if the GPX object can't be read

NullPointerException - if the given source is null

InvalidObjectException - if the gpx input is invalid.

UnsupportedOperationException - if the defined XMLInputFactory doesn't support the given source

Since:

3.0

read

public GPX read(InputStream input)
         throws IOException

Read a GPX object from the given input stream.

Parameters:

input - the input stream from where the GPX date is read

Returns:

the GPX object read from the in stream

Throws:

IOException - if the GPX object can't be read

NullPointerException - if the given input stream is null

InvalidObjectException - if the gpx input is invalid.

read

public GPX read(Path path)
         throws IOException

Read a GPX object from the given path.

Parameters:

path - the input path from where the GPX date is read

Returns:

the GPX object read from the input stream

Throws:

IOException - if the GPX object can't be read

NullPointerException - if the given input stream is null

InvalidObjectException - if the gpx input is invalid.

read

public GPX read(File file)
         throws IOException

Read a GPX object from the given file.

Parameters:

file - the input file from where the GPX date is read

Returns:

the GPX object read from the input stream

Throws:

IOException - if the GPX object can't be read

NullPointerException - if the given input stream is null

InvalidObjectException - if the gpx input is invalid.

read

public GPX read(String path)
         throws IOException

Read a GPX object from the given path.

Parameters:

path - the input path from where the GPX date is read

Returns:

the GPX object read from the input stream

Throws:

IOException - if the GPX object can't be read

NullPointerException - if the given input stream is null

InvalidObjectException - if the gpx input is invalid.

fromString

public GPX fromString(String xml)

Create a GPX object from the given GPX-XML string.

Parameters:

xml - the GPX XML string

Returns:

the GPX object created from the given XML string

Throws:

IllegalArgumentException - if the given xml is not a valid GPX XML string

NullPointerException - if the given xml string is null

See Also:

• GPX.Writer.toString(GPX)

of

public static GPX.Reader of(GPX.Version version,
 GPX.Reader.Mode mode)

Return a GPX reader, reading GPX files with the given version and in the given reading mode.

Parameters:

version - the GPX version to read

mode - the reading mode

Returns:

a new GPX reader object

Throws:

NullPointerException - if one of the arguments is null

Since:

3.0

of

public static GPX.Reader of(GPX.Reader.Mode mode)

Return a GPX reader, reading GPX files with version 1.1 and in the given reading mode.

Parameters:

mode - the reading mode

Returns:

a new GPX reader object

Throws:

NullPointerException - if one of the arguments is null

Since:

3.0