org.hl7.fhir.instance.formats

Interface IParser

public interface IParser

General interface - either an XML or JSON parser: read or write instances Defined to allow a factory to create a parser of the right type

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IParser.OutputStyle

Method Summary

Modifier and Type	Method and Description
void	compose(OutputStream stream, Resource resource) Compose a resource to a stream, possibly using pretty presentation for a human reader (used in the spec, for example, but not normally in production)
void	compose(OutputStream stream, Type type, String rootName) Compose a type to a stream, possibly using pretty presentation for a human reader (used in the spec, for example, but not normally in production) Not supported by all implementations.
byte[]	composeBytes(Resource resource) Compose a resource to a stream, possibly using pretty presentation for a human reader (used in the spec, for example, but not normally in production)
byte[]	composeBytes(Type type, String rootName) Compose a type to a stream, possibly using pretty presentation for a human reader (used in the spec, for example, but not normally in production) Not supported by all implementations.
String	composeString(Resource resource) Compose a resource to a stream, possibly using pretty presentation for a human reader (used in the spec, for example, but not normally in production)
String	composeString(Type type, String rootName) Compose a type to a stream, possibly using pretty presentation for a human reader (used in the spec, for example, but not normally in production) Not supported by all implementations.
boolean	getHandleComments() Whether to parse or ignore comments - either reading or writing
IParser.OutputStyle	getOutputStyle() Writing:
ParserType	getType() check what kind of parser this is
boolean	isAllowUnknownContent()
Resource	parse(byte[] bytes) parse content that is known to be a resource
Resource	parse(InputStream input) parse content that is known to be a resource
Resource	parse(String input) parse content that is known to be a resource
Type	parseType(byte[] bytes, String knownType) This is used to parse a type - a fragment of a resource.
Type	parseType(InputStream input, String knownType) This is used to parse a type - a fragment of a resource.
Type	parseType(String input, String knownType) This is used to parse a type - a fragment of a resource.
IParser	setAllowUnknownContent(boolean value)
IParser	setHandleComments(boolean value)
IParser	setOutputStyle(IParser.OutputStyle value)
IParser	setSuppressXhtml(String message) This method is used by the publication tooling to stop the xhrtml narrative being generated.

Method Detail

getType

ParserType getType()

check what kind of parser this is

Returns:

what kind of parser this is

getHandleComments

boolean getHandleComments()

Whether to parse or ignore comments - either reading or writing

setHandleComments

IParser setHandleComments(boolean value)

isAllowUnknownContent

boolean isAllowUnknownContent()

Parameters:

allowUnknownContent - Whether to throw an exception if unknown content is found (or just skip it) when parsing

setAllowUnknownContent

IParser setAllowUnknownContent(boolean value)

getOutputStyle

IParser.OutputStyle getOutputStyle()

Writing:

setOutputStyle

IParser setOutputStyle(IParser.OutputStyle value)

setSuppressXhtml

IParser setSuppressXhtml(String message)

This method is used by the publication tooling to stop the xhrtml narrative being generated. It is not valid to use in production use. The tooling uses it to generate json/xml representations in html that are not cluttered by escaped html representations of the html representation

parse

Resource parse(InputStream input)
        throws Exception

parse content that is known to be a resource

Throws:

Exception

parse

Resource parse(String input)
        throws Exception

parse content that is known to be a resource

Throws:

Exception

parse

Resource parse(byte[] bytes)
        throws Exception

parse content that is known to be a resource

Throws:

Exception

parseType

Type parseType(InputStream input,
               String knownType)
        throws Exception

This is used to parse a type - a fragment of a resource. There's no reason to use this in production - it's used in the build tools Not supported by all implementations

Parameters:

input -

knownType. - if this is blank, the parser may try to infer the type (xml only)

Returns:

Throws:

Exception

parseType

Type parseType(String input,
               String knownType)
        throws Exception

This is used to parse a type - a fragment of a resource. There's no reason to use this in production - it's used in the build tools Not supported by all implementations

Parameters:

input -

knownType. - if this is blank, the parser may try to infer the type (xml only)

Returns:

Throws:

Exception

parseType

Type parseType(byte[] bytes,
               String knownType)
        throws Exception

This is used to parse a type - a fragment of a resource. There's no reason to use this in production - it's used in the build tools Not supported by all implementations

Parameters:

input -

knownType. - if this is blank, the parser may try to infer the type (xml only)

Returns:

Throws:

Exception

compose

void compose(OutputStream stream,
             Resource resource)
      throws Exception

Compose a resource to a stream, possibly using pretty presentation for a human reader (used in the spec, for example, but not normally in production)

Throws:

Exception

composeString

String composeString(Resource resource)
              throws Exception

Compose a resource to a stream, possibly using pretty presentation for a human reader (used in the spec, for example, but not normally in production)

Throws:

Exception

composeBytes

byte[] composeBytes(Resource resource)
             throws Exception

Compose a resource to a stream, possibly using pretty presentation for a human reader (used in the spec, for example, but not normally in production)

Throws:

Exception

compose

void compose(OutputStream stream,
             Type type,
             String rootName)
      throws Exception

Compose a type to a stream, possibly using pretty presentation for a human reader (used in the spec, for example, but not normally in production) Not supported by all implementations. rootName is ignored in the JSON format

Throws:

Exception

composeString

String composeString(Type type,
                     String rootName)
              throws Exception

Compose a type to a stream, possibly using pretty presentation for a human reader (used in the spec, for example, but not normally in production) Not supported by all implementations. rootName is ignored in the JSON format

Throws:

Exception

composeBytes

byte[] composeBytes(Type type,
                    String rootName)
             throws Exception

Compose a type to a stream, possibly using pretty presentation for a human reader (used in the spec, for example, but not normally in production) Not supported by all implementations. rootName is ignored in the JSON format

Throws:

Exception