org.barrelorgandiscovery.xml

Class VirtualBookXmlIO

java.lang.Object

org.barrelorgandiscovery.xml.VirtualBookXmlIO

public class VirtualBookXmlIO
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VirtualBookXmlIO.VirtualBookResult

Constructor Summary

Constructors

Constructor and Description
VirtualBookXmlIO()

Method Summary

Modifier and Type	Method and Description
static VirtualBookXmlIO.VirtualBookResult	read(java.io.File f) read a virtual book from a file
static VirtualBookXmlIO.VirtualBookResult	read(java.io.InputStream is) read a virtual book from a stream, the stream is not closed by the method
static VirtualBookXmlIO.VirtualBookResult	read2010(java.io.InputStream is) Read in 2010 version of the virtual book specification
static VirtualBookXmlIO.VirtualBookResult	read2012(java.io.InputStream is) read the specific 2012 virtualbook version, using a stream the stream is not closed by this method
static VirtualBookXmlIO.VirtualBookResult	read2014(java.io.InputStream is) read the specific 2014 virtualbook version, using a stream the stream is not closed by this method
static VirtualBookXmlIO.VirtualBookResult	read2016(java.io.InputStream is) read the specific 2016 virtualbook version, using a stream the stream is not closed by this method
static void	write_2010(java.io.OutputStream os, VirtualBook vb, java.lang.String preferredInstrument) Write book for the 2010 specification
static void	write_2012(java.io.OutputStream os, VirtualBook vb, java.lang.String preferredInstrument) Write in the current 2012 version of book specification
static void	write_2014(java.io.OutputStream os, VirtualBook vb, java.lang.String preferredInstrument) Write in the current 2014 version of book specification
static void	write(java.io.OutputStream os, VirtualBook vb, java.lang.String preferredInstrument)

Methods inherited from class java.lang.Object

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

Constructor Detail

VirtualBookXmlIO

public VirtualBookXmlIO()

Method Detail

read

public static VirtualBookXmlIO.VirtualBookResult read(java.io.File f)
                                               throws java.lang.Exception

read a virtual book from a file

Parameters:

f - the file to read, this method use the same method with a stream

Returns:

Throws:

java.lang.Exception

read

public static VirtualBookXmlIO.VirtualBookResult read(java.io.InputStream is)
                                               throws java.lang.Exception

read a virtual book from a stream, the stream is not closed by the method

Parameters:

is - the stream to read

Returns:

a read result

Throws:

java.lang.Exception

read2014

public static VirtualBookXmlIO.VirtualBookResult read2014(java.io.InputStream is)
                                                   throws java.lang.Exception

read the specific 2014 virtualbook version, using a stream the stream is not closed by this method

Parameters:

is -

Returns:

Throws:

java.lang.Exception

read2016

public static VirtualBookXmlIO.VirtualBookResult read2016(java.io.InputStream is)
                                                   throws java.lang.Exception

read the specific 2016 virtualbook version, using a stream the stream is not closed by this method

Parameters:

is -

Returns:

Throws:

java.lang.Exception

read2012

public static VirtualBookXmlIO.VirtualBookResult read2012(java.io.InputStream is)
                                                   throws java.lang.Exception

read the specific 2012 virtualbook version, using a stream the stream is not closed by this method

Parameters:

is -

Returns:

Throws:

java.lang.Exception

read2010

public static VirtualBookXmlIO.VirtualBookResult read2010(java.io.InputStream is)
                                                   throws java.lang.Exception

Read in 2010 version of the virtual book specification

Parameters:

is -

Returns:

Throws:

java.lang.Exception

write

public static void write(java.io.OutputStream os,
                         VirtualBook vb,
                         java.lang.String preferredInstrument)
                  throws java.lang.Exception

Throws:

java.lang.Exception

write_2014

public static void write_2014(java.io.OutputStream os,
                              VirtualBook vb,
                              java.lang.String preferredInstrument)
                       throws java.lang.Exception

Write in the current 2014 version of book specification

Parameters:

os -

vb -

preferredInstrument -

Throws:

java.lang.Exception

write_2012

public static void write_2012(java.io.OutputStream os,
                              VirtualBook vb,
                              java.lang.String preferredInstrument)
                       throws java.lang.Exception

Write in the current 2012 version of book specification

Parameters:

os -

vb -

preferredInstrument -

Throws:

java.lang.Exception

write_2010

public static void write_2010(java.io.OutputStream os,
                              VirtualBook vb,
                              java.lang.String preferredInstrument)
                       throws java.lang.Exception

Write book for the 2010 specification

Parameters:

os -

vb -

preferredInstrument -

Throws:

java.lang.Exception