Package org.jibx.runtime.impl
Class UnmarshallingContext
java.lang.Object
org.jibx.runtime.impl.UnmarshallingContext
- All Implemented Interfaces:
IUnmarshallingContext
Pull parser wrapper supplying convenience methods for access. Most of
these methods are designed for use in code generated by the binding
generator.
- Author:
- Dennis M. Sosnoski
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final int
Starting size for object stack.private StringIntHashMap
Map from fully-qualified class name to index in internal tables.private IBindingFactory
Binding factory used to create this unmarshaller.protected String[]
Class names of referenced types (null
unless class-specific IDs used).protected Map[]
ID maps for finding references.protected String
Last IDREF value parsed.protected String[]
Names for elements associated with class mappings.protected String[]
Namespaces for elements associated with class mappings.protected Object[]
Stack of objects being unmarshalled.private IXMLReader
Parser in use.protected int
Current unmarshalling stack depth.private int
Index past end of last fixed marshaller class.private String[]
Transient unmarshaller classes for mapping definition (null
for mappings out of context).protected Map
Mapping from element name to class index for transient mappings.protected IUnmarshaller[]
Unmarshallers for classes in mapping definition (lazy create of actual unmarshaller instances)protected Map
Mapping from element name to class index for global mappings (cached from binding factory).protected Object
User context object (not used by JiBX, only for user convenience).private static final IXMLReaderFactory
Factory for creating XML readers. -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.UnmarshallingContext
(int nmap, String[] umcs, String[] nss, String[] names, String[] idcs, IBindingFactory ifact) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionAccumulate text content.void
addUnmarshalling
(String mapname, String ns, String name, String cname) Define unmarshalling for element.private void
advance()
Advance to next parse item.boolean
attributeBoolean
(String ns, String name) Get boolean value of attribute from current start tag.boolean
attributeBoolean
(String ns, String name, boolean dflt) Get boolean value of optional attribute from current start tag.byte
attributeByte
(String ns, String name) Get byte value of attribute from current start tag.byte
attributeByte
(String ns, String name, byte dflt) Get byte value of optional attribute from current start tag.char
attributeChar
(String ns, String name) Get char value of attribute from current start tag.char
attributeChar
(String ns, String name, char dflt) Get char value of optional attribute from current start tag.attributeDate
(String ns, String name) Getjava.util.Date
value of attribute from current start tag.attributeDate
(String ns, String name, Date dflt) Getjava.util.Date
value of optional attribute from current start tag.double
attributeDouble
(String ns, String name) Get double value of attribute from current start tag.double
attributeDouble
(String ns, String name, double dflt) Get double value of optional attribute from current start tag.int
attributeEnumeration
(String ns, String name, String[] enums, int[] vals) Get enumeration attribute value from current start tag.int
attributeEnumeration
(String ns, String name, String[] enums, int[] vals, int dflt) Get optional enumeration attribute value from current start tag.attributeExistingIDREF
(String ns, String name, int index) Get previously defined object corresponding to IDREF attribute from current start tag.float
attributeFloat
(String ns, String name) Get float value of attribute from current start tag.float
attributeFloat
(String ns, String name, float dflt) Get float value of optional attribute from current start tag.attributeForwardIDREF
(String ns, String name, int index) Get object (if defined yet) corresponding to IDREF attribute from current start tag.int
attributeInt
(String ns, String name) Get integer value of attribute from current start tag.int
attributeInt
(String ns, String name, int dflt) Get integer value of optional attribute from current start tag.long
attributeLong
(String ns, String name) Get long value of attribute from current start tag.long
attributeLong
(String ns, String name, long dflt) Get long value of optional attribute from current start tag.short
attributeShort
(String ns, String name) Get short value of attribute from current start tag.short
attributeShort
(String ns, String name, short dflt) Get short value of optional attribute from current start tag.attributeText
(String ns, String name) Get text value of attribute from current start tag.attributeText
(String ns, String name, String dflt) Get text value of optional attribute from current start tag.static String
buildNameString
(String ns, String name) Build name with optional namespace.Build current parse input position description.void
checkAllowedAttributes
(String[] nss, String[] names) Check that only allowed attributes are present on current start tag.boolean
convertBoolean
(String text) Convert boolean value.byte
convertByte
(String text) Convert byte value with exception wrapper.char
convertChar
(String text) Convert char value with exception wrapper.convertDate
(String text) Convertjava.util.Date
value with exception wrapper.double
convertDouble
(String text) Convert double value with exception wrapper.int
convertEnum
(String target, String[] enums, int[] vals) Find required text value in enumeration.int
convertEnum
(String target, String[] enums, int[] vals, int dflt) Find optional text value in enumeration.float
convertFloat
(String text) Convert float value with exception wrapper.long
convertLong
(String text) Convert long value with exception wrapper.short
convertShort
(String text) Convert short value with exception wrapper.int
Get the current parse event type.Build current element name, with optional namespace.void
Define object for ID.findDefinedID
(String id, int index) Find previously defined object corresponding to an ID.Find the object corresponding to an ID.int
Get count of active namespaces.getActiveNamespacePrefix
(int index) Get prefix for an active namespace.getActiveNamespaceUri
(int index) Get URI for an active namespace.int
Get number of attributes for current START_ELEMENT event.getAttributeName
(int index) Get attribute name for current START_ELEMENT event.getAttributeNamespace
(int index) Get attribute namespace for current START_ELEMENT event.getAttributePrefix
(int index) Get attribute namespace prefix for current START_ELEMENT event.getAttributeValue
(int index) Get attribute value for current START_ELEMENT event.private String
getAttributeValue
(String ns, String name) Get attribute value from parser.Return the supplied document name.Returns current element name.Returns current element namespace URI.Return the binding factory used to create this unmarshaller.Return the input encoding, if known.getName()
Get name associated with current parse event.Get namespace associated with current parse event.int
Get number of namespace declarations for current START_ELEMENT event.getNamespacePrefix
(int index) Get namespace prefix for namespace declaration on current START_ELEMENT event.getNamespaceUri
(int index) Get namespace URI for namespace declaration on current START_ELEMENT event.getNamespaceUri
(String prefix) Get namespace URI matching prefix.Get namespace prefix associated with current parse event.int
Get current unmarshalling object stack depth.getStackObject
(int depth) Get object from unmarshalling stack.Get top object on unmarshalling stack.getText()
Get text value for current event.private IUnmarshaller
getUnmarshaller
(int index) Find the unmarshaller for a particular class index in the current context.getUnmarshaller
(String mapname) Find the unmarshaller for a particular class in the current context.getUnmarshaller
(String ns, String name) Find the unmarshaller for a particular element name (including namespace) in the current context.Get the user context object.boolean
hasAnyAttribute
(String[] nss, String[] names) Check if any of several attributes is present on current start tag.boolean
hasAttribute
(String ns, String name) Check if attribute is present on current start tag.boolean
Check if next tag is start of element.boolean
isEnd()
Check if next tag is an end tag.boolean
isStart()
Check if next tag is a start tag.protected void
mapUnmarshalling
(int index) Map unmarshalling for element.private void
matchStart
(String ns, String name) Internal parse to expected start tag.int
next()
Advance to next major parse event.int
Advance to next parse event.byte
parseContentByte
(String ns, String tag) Parse past end of element, returning byte value of content.char
parseContentChar
(String ns, String tag) Parse past end of element, returning char value of content.int
parseContentEnumeration
(String ns, String tag, String[] enums, int[] vals) Parse past end of element, returning enumeration value of content.int
parseContentInt
(String ns, String tag) Parse past end of element, returning integer value of content.short
parseContentShort
(String ns, String tag) Parse past end of element, returning short value of content.Parse required text content.parseContentText
(String ns, String tag) Parse past end of element, returning optional text content.boolean
parseElementBoolean
(String ns, String tag) Parse entire element, returning boolean value of content.boolean
parseElementBoolean
(String ns, String tag, boolean dflt) Parse entire element, returning boolean value of optional content.byte
parseElementByte
(String ns, String tag) Parse entire element, returning byte value of content.byte
parseElementByte
(String ns, String tag, byte dflt) Parse entire element, returning byte value of optional content.char
parseElementChar
(String ns, String tag) Parse entire element, returning char value of content.char
parseElementChar
(String ns, String tag, char dflt) Parse entire element, returning char value of optional content.parseElementDate
(String ns, String tag) Parse past end of element, returningjava.util.Date
value of content.parseElementDate
(String ns, String tag, Date dflt) Parse entire element, returningjava.util.Date
value of optional content.double
parseElementDouble
(String ns, String tag) Parse past end of element, returning double value of content.double
parseElementDouble
(String ns, String tag, double dflt) Parse entire element, returning double value of optional content.int
parseElementEnumeration
(String ns, String tag, String[] enums, int[] vals, int dflt) Parse entire element, returning enumeration value of optional content.parseElementExistingIDREF
(String ns, String tag, int index) Parse entire element, returning previously defined object corresponding to content interpreted as IDREF.float
parseElementFloat
(String ns, String tag) Parse past end of element, returning float value of content.float
parseElementFloat
(String ns, String tag, float dflt) Parse entire element, returning float value of optional content.parseElementForwardIDREF
(String ns, String tag, int index) Parse entire element, returning object (if defined yet) corresponding to content interpreted as IDREF.int
parseElementInt
(String ns, String tag) Parse entire element, returning integer value of content.int
parseElementInt
(String ns, String tag, int dflt) Parse entire optional element, returning integer value of content.long
parseElementLong
(String ns, String tag) Parse past end of element, returning long value of content.long
parseElementLong
(String ns, String tag, long dflt) Parse entire element, returning long value of optional content.short
parseElementShort
(String ns, String tag) Parse entire element, returning short value of content.short
parseElementShort
(String ns, String tag, short dflt) Parse entire element, returning short value of optional content.parseElementText
(String ns, String tag) Parse entire element, returning text content.parseElementText
(String ns, String tag, String dflt) Parse entire element, returning optional text content.boolean
parseIfStartTag
(String ns, String name) Parse past start of expected element.void
parsePastCurrentEndTag
(String ns, String name) Parse past current end of element.void
parsePastElement
(String ns, String tag) Parse past element, ignoring all content.void
parsePastEndTag
(String ns, String name) Parse past end of element.void
parsePastStartTag
(String ns, String name) Parse past start of element.void
parseToStartTag
(String ns, String name) Parse to start of element.void
Pop unmarshalled object from stack.void
pushObject
(Object obj) Push created object to unmarshalling stack.void
pushTrackedObject
(Object obj) Push created object to unmarshalling stack with position tracking.void
registerBackFill
(int index, BackFillReference fill) Register back fill item for last parsed ID value.void
registerBackFill
(String id, int index, BackFillReference fill) Register back fill item for undefined ID value.void
removeUnmarshalling
(String mapname) Undefine unmarshalling for element.void
reset()
Reset unmarshalling information.void
setDocument
(InputStream ins, String enc) Set document to be parsed from stream.void
setDocument
(InputStream ins, String name, String enc) Set named document to be parsed from stream.void
setDocument
(InputStream ins, String name, String enc, boolean nsa) Set document to be parsed from stream.void
setDocument
(Reader rdr) Set document to be parsed from reader.void
setDocument
(Reader rdr, String name) Set named document to be parsed from reader.void
setDocument
(Reader rdr, String name, boolean nsa) Set document to be parsed from reader.void
setDocument
(IXMLReader rdr) Set input document parse source directly.void
setFromContext
(UnmarshallingContext parent) Initializes the context to use the same parser and document as another unmarshalling context.void
setUserContext
(Object obj) Set a user context object.void
Skip past current element.void
throwEndTagNameError
(String ns, String name) Throw exception for expected element end tag not found.void
throwException
(String msg) Throw exception with position information.void
throwException
(String msg, Exception ex) Throw exception with position information and nested exception.void
throwNameException
(String msg, String ns, String name) Throw exception including a name and position information.void
Throw exception with start tag and position information.void
throwStartTagException
(String msg, Exception ex) Throw exception with start tag, position information, and nested exception.void
throwStartTagNameError
(String ns, String name) Throw exception for expected element start tag not found.toEnd()
Parse to end tag.toStart()
Parse to start tag.int
toTag()
Parse to start or end tag.void
trackObject
(Object obj) Set position tracking information for object, if supported.unmarshalDocument
(InputStream ins, String enc) Unmarshal document from stream to object.unmarshalDocument
(InputStream ins, String name, String enc) Unmarshal named document from stream to object.unmarshalDocument
(Reader rdr) Unmarshal document from reader to object.unmarshalDocument
(Reader rdr, String name) Unmarshal named document from reader to object.Unmarshal required element.unmarshalElement
(Class clas) Unmarshal required element of specified type.Unmarshal optional element.private boolean
Verify namespace.
-
Field Details
-
INITIAL_STACK_SIZE
private static final int INITIAL_STACK_SIZEStarting size for object stack.- See Also:
-
s_readerFactory
Factory for creating XML readers. -
m_factory
Binding factory used to create this unmarshaller. -
m_classIndexMap
Map from fully-qualified class name to index in internal tables. -
m_reader
Parser in use. -
m_transientBase
private int m_transientBaseIndex past end of last fixed marshaller class. -
m_transientUnmarshallerClasses
Transient unmarshaller classes for mapping definition (null
for mappings out of context). -
m_unmarshallers
Unmarshallers for classes in mapping definition (lazy create of actual unmarshaller instances) -
m_namespaces
Namespaces for elements associated with class mappings. -
m_names
Names for elements associated with class mappings. -
m_idMaps
ID maps for finding references. -
m_idClasses
Class names of referenced types (null
unless class-specific IDs used). -
m_stackDepth
protected int m_stackDepthCurrent unmarshalling stack depth. -
m_objectStack
Stack of objects being unmarshalled. -
m_unmarshalMap
Mapping from element name to class index for global mappings (cached from binding factory). Entries areInteger
values if single match,int[]
if multiple matches, giving the mapping index. -
m_transientUnmarshalMap
Mapping from element name to class index for transient mappings. Entries areInteger
values if single match,ArrayList
if multiple matches, giving the mapping index. -
m_idref
Last IDREF value parsed. -
m_userContext
User context object (not used by JiBX, only for user convenience).
-
-
Constructor Details
-
UnmarshallingContext
public UnmarshallingContext(int nmap, String[] umcs, String[] nss, String[] names, String[] idcs, IBindingFactory ifact) Constructor. Builds the actual parser and initializes internal data structures.- Parameters:
nmap
- number of mapping definitions includedumcs
- names of unmarshaller classes for indexes with fixed unmarshallers (as opposed to mapping slots, which may be overridden; reference kept, must be constant)nss
- namespaces for elements of classes with global definitionsnames
- names for elements of classes with global definitionsidcs
- array of class names with IDs (null
if no IDs or global IDs)ifact
- binding factory creating this unmarshaller
-
UnmarshallingContext
public UnmarshallingContext()Default constructor. This can be used for creating a context outside of the generated code for special purposes.
-
-
Method Details
-
buildNameString
Build name with optional namespace. Just returns the appropriate name format.- Parameters:
ns
- namespace URI of namename
- local name part of name- Returns:
- formatted name string
-
currentNameString
Build current element name, with optional namespace.- Returns:
- formatted name string
-
buildPositionString
Build current parse input position description.- Returns:
- text description of current parse position
-
throwStartTagNameError
Throw exception for expected element start tag not found.- Parameters:
ns
- namespace URI of namename
- local name part of name- Throws:
JiBXException
- always thrown
-
throwEndTagNameError
Throw exception for expected element end tag not found.- Parameters:
ns
- namespace URI of namename
- local name part of name- Throws:
JiBXException
- always thrown
-
throwNameException
Throw exception including a name and position information.- Parameters:
msg
- leading message textns
- namespace URI of namename
- local name part of name- Throws:
JiBXException
- always thrown
-
advance
Advance to next parse item. This wraps the base parser call in order to catch and handle exceptions.- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
verifyNamespace
Verify namespace. This is a simple utility method that allows multiple representations for the empty namespace as a convenience for generated code.- Parameters:
ns
- namespace URI expected (may benull
or the empty string for the empty namespace)- Returns:
true
if the current namespace matches that expected,false
if not
-
getAttributeValue
Get attribute value from parser.- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expected- Returns:
- attribute value text, or
null
if missing
-
setDocument
Set document to be parsed from stream. This call is not part of the interface definition, but is supplied to allow direct control of the namespace processing by the compiler. The option of disabling namespaces should be considered experimental and may not be supported in the future.- Parameters:
ins
- stream supplying document dataname
- document name (null
if unknown)enc
- document input encoding, ornull
if to be determined by parsernsa
- enable namespace processing for parser flag- Throws:
JiBXException
- if error creating parser
-
setDocument
Set document to be parsed from stream.- Specified by:
setDocument
in interfaceIUnmarshallingContext
- Parameters:
ins
- stream supplying document dataenc
- document input encoding, ornull
if to be determined by parser- Throws:
JiBXException
- if error creating parser
-
setDocument
Set document to be parsed from reader. This call is not part of the interface definition, but is supplied to allow direct control of the namespace processing by the compiler. The option of disabling namespaces should be considered experimental and may not be supported in the future.- Parameters:
rdr
- reader supplying document dataname
- document name (null
if unknown)nsa
- enable namespace processing for parser flag- Throws:
JiBXException
- if error creating parser
-
setDocument
Set document to be parsed from reader.- Specified by:
setDocument
in interfaceIUnmarshallingContext
- Parameters:
rdr
- reader supplying document data- Throws:
JiBXException
- if error creating parser
-
setDocument
Set named document to be parsed from stream.- Specified by:
setDocument
in interfaceIUnmarshallingContext
- Parameters:
ins
- stream supplying document dataname
- document nameenc
- document input encoding, ornull
if to be determined by parser- Throws:
JiBXException
- if error creating parser
-
setDocument
Set named document to be parsed from reader.- Specified by:
setDocument
in interfaceIUnmarshallingContext
- Parameters:
rdr
- reader supplying document dataname
- document name- Throws:
JiBXException
- if error creating parser
-
setDocument
Set input document parse source directly.- Parameters:
rdr
- document parse event reader
-
setFromContext
Initializes the context to use the same parser and document as another unmarshalling context. This method is designed for use when an initial context needs to create and invoke a secondary context in the course of an unmarshalling operation.- Parameters:
parent
- context supplying parser and document to be unmarshalled
-
reset
public void reset()Reset unmarshalling information. This releases all references to unmarshalled objects and prepares the context for potential reuse. It is automatically called when input is set.- Specified by:
reset
in interfaceIUnmarshallingContext
-
toStart
Parse to start tag. Ignores character data seen prior to a start tag, but throws exception if an end tag or the end of the document is seen before a start tag. Leaves the parser positioned at the start tag.- Returns:
- element name of start tag found
- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
toEnd
Parse to end tag. Ignores character data seen prior to an end tag, but throws exception if a start tag or the end of the document is seen before an end tag. Leaves the parser positioned at the end tag.- Returns:
- element name of end tag found
- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
toTag
Parse to start or end tag. If not currently positioned at a start or end tag this first advances the parse to the next start or end tag.- Returns:
- parser event type for start tag or end tag
- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
isAt
Check if next tag is start of element. If not currently positioned at a start or end tag this first advances the parse to the next start or end tag.- Specified by:
isAt
in interfaceIUnmarshallingContext
- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)name
- element name expected- Returns:
true
if at start of element with supplied name,false
if not- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
hasAttribute
Check if attribute is present on current start tag. Throws an exception if not currently positioned on a start tag.- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expected- Returns:
true
if named attribute is present,false
if not- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
hasAnyAttribute
Check if any of several attributes is present on current start tag. Throws an exception if not currently positioned on a start tag.- Parameters:
nss
- namespace URIs for expected attributes (each may benull
or the empty string for the empty namespace)names
- attribute names expected- Returns:
true
if at least one of the named attributes is present,false
if not- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
checkAllowedAttributes
Check that only allowed attributes are present on current start tag. Throws an exception if not currently positioned on a start tag, or if an attribute is present which is not in the list.- Parameters:
nss
- namespace URIs for allowed attributes (each may benull
or the empty string for the empty namespace)names
- alphabetical list of attribute names expected (duplicates names are ordered by namespace URI)- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
matchStart
Internal parse to expected start tag. Ignores character data seen prior to a start tag, but throws exception if an end tag or the end of the document is seen before a start tag. Leaves the parser positioned at the start tag.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)name
- element name expected- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
parseToStartTag
Parse to start of element. Ignores character data to next start or end tag, but throws exception if an end tag is seen before a start tag, or if the start tag seen does not match the expected name. Leaves the parse positioned at the start tag.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)name
- element name expected- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
parsePastStartTag
Parse past start of element. Ignores character data to next start or end tag, but throws exception if an end tag is seen before a start tag, or if the start tag seen does not match the expected name. Leaves the parse positioned following the start tag.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)name
- element name expected- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
parseIfStartTag
Parse past start of expected element. If not currently positioned at a start or end tag this first advances the parser to the next tag. If the expected start tag is found it is skipped and the parse is left positioned following the start tag.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)name
- element name expected- Returns:
true
if start tag found,false
if not- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
parsePastCurrentEndTag
Parse past current end of element. Ignores character data to next start or end tag, but throws exception if a start tag is seen before a end tag, or if the end tag seen does not match the expected name. Leaves the parse positioned following the end tag.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)name
- element name expected- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
parsePastEndTag
Parse past end of element. If currently at a start tag parses past that start tag, then ignores character data to next start or end tag, and throws exception if a start tag is seen before a end tag, or if the end tag seen does not match the expected name. Leaves the parse positioned following the end tag.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)name
- element name expected- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
isStart
Check if next tag is a start tag. If not currently positioned at a start or end tag this first advances the parse to the next start or end tag.- Specified by:
isStart
in interfaceIUnmarshallingContext
- Returns:
true
if at start of element,false
if at end- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
isEnd
Check if next tag is an end tag. If not currently positioned at a start or end tag this first advances the parse to the next start or end tag.- Specified by:
isEnd
in interfaceIUnmarshallingContext
- Returns:
true
if at end of element,false
if at start- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
accumulateText
Accumulate text content. This skips past comments and processing instructions, and consolidates text and entities to a single string. Any unexpanded entity references found are treated as errors.- Returns:
- consolidated text string (empty string if no text components)
- Throws:
JiBXException
- on error in unmarshalling
-
parseContentText
Parse required text content. Assumes the parse is already positioned at the text content, so just returns the text.- Returns:
- content text found
- Throws:
JiBXException
- on any error (possible wrapping other exception)
-
parseContentText
Parse past end of element, returning optional text content. Assumes you've already parsed past the start tag of the element, so it just looks for text content followed by the end tag, and returns with the parser positioned after the end tag.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expected- Returns:
- content text from element
- Throws:
JiBXException
- on any error (possible wrapping other exception)
-
parseContentInt
Parse past end of element, returning integer value of content. Assumes you've already parsed past the start tag of the element, so it just looks for text content followed by the end tag.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expected- Returns:
- converted value from element text
- Throws:
JiBXException
- on any error (possible wrapping other exception)
-
parseElementText
Parse entire element, returning text content. Expects to find the element start tag, text content, and end tag, in that order, and returns with the parser positioned following the end tag.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expected- Returns:
- content text from element
- Throws:
JiBXException
- on any error (possible wrapping other exception)
-
parseElementText
Parse entire element, returning optional text content. Expects to find the element start tag, text content, and end tag, in that order, and returns with the parser positioned following the end tag. Returns the default text if the element is not found.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expecteddflt
- default text value- Returns:
- content text from element
- Throws:
JiBXException
- on any error (possible wrapping other exception)
-
attributeText
Get text value of attribute from current start tag. Throws an exception if the attribute value is not found in the start tag.- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expected- Returns:
- attribute value text
- Throws:
JiBXException
- if attribute not present
-
attributeText
Get text value of optional attribute from current start tag. If the attribute is not present the supplied default value is returned instead.- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expecteddflt
- value to be returned if attribute is not present- Returns:
- attribute value text
-
findID
Find the object corresponding to an ID. This method just handles the lookup and checks the object type.- Parameters:
id
- ID textindex
- expected reference type index- Returns:
- object corresponding to IDREF, or
null
if not yet defined - Throws:
JiBXException
- on any error
-
findDefinedID
Find previously defined object corresponding to an ID. This does the lookup and checks that the referenced object has been defined.- Parameters:
id
- ID textindex
- expected reference type index- Returns:
- object corresponding to IDREF
- Throws:
JiBXException
- on any error
-
parseElementForwardIDREF
Parse entire element, returning object (if defined yet) corresponding to content interpreted as IDREF. Expects to find the element start tag, text content, and end tag, in that order, and returns with the parser positioned following the end tag.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- attribute name expectedindex
- expected reference type index- Returns:
- object corresponding to IDREF, or
null
if not yet defined - Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
attributeForwardIDREF
Get object (if defined yet) corresponding to IDREF attribute from current start tag.- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expectedindex
- expected reference type index- Returns:
- object corresponding to IDREF, or
null
if not yet defined - Throws:
JiBXException
- if attribute not present, or ID mapped to a different type of object than expected
-
parseElementExistingIDREF
Parse entire element, returning previously defined object corresponding to content interpreted as IDREF. Expects to find the element start tag, text content, and end tag, in that order, and returns with the parser positioned following the end tag.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- attribute name expectedindex
- expected reference type index- Returns:
- object corresponding to IDREF
- Throws:
JiBXException
- if attribute not present, ID not defined, or mapped to a different type of object than expected
-
attributeExistingIDREF
Get previously defined object corresponding to IDREF attribute from current start tag.- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expectedindex
- expected reference type index- Returns:
- object corresponding to IDREF
- Throws:
JiBXException
- if attribute not present, ID not defined, or mapped to a different type of object than expected
-
attributeInt
Get integer value of attribute from current start tag. Throws an exception if the attribute is not found in the start tag, or if it is not a valid integer value.- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expected- Returns:
- attribute integer value
- Throws:
JiBXException
- if attribute not present or not a valid integer value
-
attributeInt
Get integer value of optional attribute from current start tag. If the attribute is not present the supplied default value is returned instead.- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expecteddflt
- value to be returned if attribute is not present- Returns:
- attribute integer value
- Throws:
JiBXException
- if attribute value is not a valid integer
-
parseElementInt
Parse entire element, returning integer value of content. Expects to find the element start tag, text content, and end tag, in that order, and returns with the parser positioned following the end tag.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expected- Returns:
- content text from element
- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
parseElementInt
Parse entire optional element, returning integer value of content. Expects to find the element start tag, text content, and end tag, in that order, and returns with the parser positioned following the end tag. Returns the default value if the element is missing or has no content.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expecteddflt
- default value- Returns:
- content text from element
- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
convertEnum
Find required text value in enumeration. Looks up and returns the enumeration value corresponding to the target text.- Parameters:
target
- text to be found in enumerationenums
- ordered array of texts included in enumerationvals
- array of values to be returned for corresponding text match positions (position returned directly if this isnull
)- Returns:
- enumeration value for target text
- Throws:
JiBXException
- if target text not found in enumeration
-
convertEnum
Find optional text value in enumeration. Looks up and returns the enumeration value corresponding to the target text, or the default value if the text isnull
.- Parameters:
target
- text to be found in enumeration (may benull
)enums
- ordered array of texts included in enumerationvals
- array of values to be returned for corresponding text match positions (position returned directly if this isnull
)dflt
- default value returned if target text isnull
- Returns:
- enumeration value for target text
- Throws:
JiBXException
- if target text not found in enumeration
-
attributeEnumeration
public int attributeEnumeration(String ns, String name, String[] enums, int[] vals) throws JiBXException Get enumeration attribute value from current start tag. Throws an exception if the attribute value is not found in the start tag or the text does not match a value defined in the enumeration table.- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expectedenums
- ordered array of texts included in enumerationvals
- array of values to be returned for corresponding text match positions (position returned directly if this isnull
)- Returns:
- enumeration value for target text
- Throws:
JiBXException
- if attribute not present or value not found in enumeration list
-
attributeEnumeration
public int attributeEnumeration(String ns, String name, String[] enums, int[] vals, int dflt) throws JiBXException Get optional enumeration attribute value from current start tag. Throws an exception if the attribute value is present but does not match a value defined in the enumeration table.- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expectedenums
- ordered array of texts included in enumerationvals
- array of values to be returned for corresponding text match positions (position returned directly if this isnull
)dflt
- default value returned if attribute is not present- Returns:
- enumeration value for target text
- Throws:
JiBXException
- if attribute not present or value not found in enumeration list
-
parseContentEnumeration
public int parseContentEnumeration(String ns, String tag, String[] enums, int[] vals) throws JiBXException Parse past end of element, returning enumeration value of content. Assumes you've already parsed past the start tag of the element, so it just looks for text content followed by the end tag, and returns with the parser positioned after the end tag.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expectedenums
- ordered array of texts included in enumerationvals
- array of values to be returned for corresponding text match positions (position returned directly if this isnull
)- Returns:
- enumeration value for element text
- Throws:
JiBXException
- on any error (possible wrapping other exception)
-
parseElementEnumeration
public int parseElementEnumeration(String ns, String tag, String[] enums, int[] vals, int dflt) throws JiBXException Parse entire element, returning enumeration value of optional content. Expects to find the element start tag, text content, and end tag, in that order, and returns with the parser positioned following the end tag. Returns the default value if no content is present.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expectedenums
- ordered array of texts included in enumerationvals
- array of values to be returned for corresponding text match positions (position returned directly if this isnull
)dflt
- default value- Returns:
- enumeration value for element text
- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
convertByte
Convert byte value with exception wrapper. This internal method is used by all the byte unmarshalling calls. It adds position information to any exceptions that occur.- Parameters:
text
- text for value to be converted- Returns:
- converted byte value
- Throws:
JiBXException
- if not a valid byte value
-
attributeByte
Get byte value of attribute from current start tag. Throws an exception if the attribute is not found in the start tag, or if it is not a valid integer value.- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expected- Returns:
- attribute byte value
- Throws:
JiBXException
- if attribute not present or not a valid byte value
-
attributeByte
Get byte value of optional attribute from current start tag. If the attribute is not present the supplied default value is returned instead.- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expecteddflt
- value to be returned if attribute is not present- Returns:
- attribute byte value
- Throws:
JiBXException
- if attribute value is not a valid byte
-
parseContentByte
Parse past end of element, returning byte value of content. Assumes you've already parsed past the start tag of the element, so it just looks for text content followed by the end tag, and returns with the parser positioned after the end tag.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expected- Returns:
- converted value from element text
- Throws:
JiBXException
- on any error (possible wrapping other exception)
-
parseElementByte
Parse entire element, returning byte value of content. Expects to find the element start tag, text content, and end tag, in that order, and returns with the parser positioned following the end tag.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expected- Returns:
- content text from element
- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
parseElementByte
Parse entire element, returning byte value of optional content. Expects to find the element start tag, text content, and end tag, in that order, and returns with the parser positioned following the end tag. Returns the default value if no content is present.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expecteddflt
- default value- Returns:
- content text from element
- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
convertShort
Convert short value with exception wrapper. This internal method is used by all the short unmarshalling calls. It adds position information to any exceptions that occur.- Parameters:
text
- text for value to be converted- Returns:
- converted short value
- Throws:
JiBXException
- if not a valid short value
-
attributeShort
Get short value of attribute from current start tag. Throws an exception if the attribute is not found in the start tag, or if it is not a valid integer value.- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expected- Returns:
- attribute short value
- Throws:
JiBXException
- if attribute not present or not a valid short value
-
attributeShort
Get short value of optional attribute from current start tag. If the attribute is not present the supplied default value is returned instead.- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expecteddflt
- value to be returned if attribute is not present- Returns:
- attribute short value
- Throws:
JiBXException
- if attribute value is not a valid short
-
parseContentShort
Parse past end of element, returning short value of content. Assumes you've already parsed past the start tag of the element, so it just looks for text content followed by the end tag, and returns with the parser positioned after the end tag.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expected- Returns:
- converted value from element text
- Throws:
JiBXException
- on any error (possible wrapping other exception)
-
parseElementShort
Parse entire element, returning short value of content. Expects to find the element start tag, text content, and end tag, in that order, and returns with the parser positioned following the end tag.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expected- Returns:
- content text from element
- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
parseElementShort
Parse entire element, returning short value of optional content. Expects to find the element start tag, text content, and end tag, in that order, and returns with the parser positioned following the end tag. Returns the default value if no content is present.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expecteddflt
- default value- Returns:
- content text from element
- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
convertChar
Convert char value with exception wrapper. This internal method is used by all the char unmarshalling calls. It adds position information to any exceptions that occur.- Parameters:
text
- text for value to be converted- Returns:
- converted char value
- Throws:
JiBXException
- if not a valid char value
-
attributeChar
Get char value of attribute from current start tag. Throws an exception if the attribute is not found in the start tag, or if it is not a valid integer value.- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expected- Returns:
- attribute char value
- Throws:
JiBXException
- if attribute not present or not a valid char value
-
attributeChar
Get char value of optional attribute from current start tag. If the attribute is not present the supplied default value is returned instead.- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expecteddflt
- value to be returned if attribute is not present- Returns:
- attribute char value
- Throws:
JiBXException
- if attribute value is not a valid char
-
parseContentChar
Parse past end of element, returning char value of content. Assumes you've already parsed past the start tag of the element, so it just looks for text content followed by the end tag, and returns with the parser positioned after the end tag.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expected- Returns:
- converted value from element text
- Throws:
JiBXException
- on any error (possible wrapping other exception)
-
parseElementChar
Parse entire element, returning char value of content. Expects to find the element start tag, text content, and end tag, in that order, and returns with the parser positioned following the end tag.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expected- Returns:
- content text from element
- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
parseElementChar
Parse entire element, returning char value of optional content. Expects to find the element start tag, text content, and end tag, in that order, and returns with the parser positioned following the end tag. Returns the default value if the element is not present.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expecteddflt
- default value- Returns:
- content text from element
- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
convertLong
Convert long value with exception wrapper. This internal method is used by all the long unmarshalling calls. It adds position information to any exceptions that occur.- Parameters:
text
- text for value to be converted- Returns:
- converted long value
- Throws:
JiBXException
- if not a valid long value
-
attributeLong
Get long value of attribute from current start tag. Throws an exception if the attribute is not found in the start tag, or if it is not a valid integer value.- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expected- Returns:
- attribute long value
- Throws:
JiBXException
- if attribute not present or not a valid long value
-
attributeLong
Get long value of optional attribute from current start tag. If the attribute is not present the supplied default value is returned instead.- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expecteddflt
- value to be returned if attribute is not present- Returns:
- attribute long value
- Throws:
JiBXException
- if attribute value is not a valid long
-
parseElementLong
Parse past end of element, returning long value of content. Expects to find the element start tag, text content, and end tag, in that order, and returns with the parser positioned following the end tag.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expected- Returns:
- converted value from element text
- Throws:
JiBXException
- on any error (possible wrapping other exception)
-
parseElementLong
Parse entire element, returning long value of optional content. Expects to find the element start tag, text content, and end tag, in that order, and returns with the parser positioned following the end tag. Returns the default value if the element is not present.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expecteddflt
- default value- Returns:
- content text from element
- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
convertBoolean
Convert boolean value. This internal method is used by all the boolean unmarshalling calls. It accepts "true" or "1" as equivalent, and "false" or "0" as equivalent, and throws exceptions for anything else.- Parameters:
text
- text for value to be converted- Returns:
- converted boolean value
- Throws:
JiBXException
- if not a valid boolean value
-
attributeBoolean
Get boolean value of attribute from current start tag. Throws an exception if the attribute is not found in the start tag, or if it is not a valid integer value.- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expected- Returns:
- attribute boolean value
- Throws:
JiBXException
- if attribute not present or not a valid boolean value
-
attributeBoolean
Get boolean value of optional attribute from current start tag. If the attribute is not present the supplied default value is returned instead.- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expecteddflt
- value to be returned if attribute is not present- Returns:
- attribute boolean value
- Throws:
JiBXException
- if attribute value is not a valid boolean
-
parseElementBoolean
Parse entire element, returning boolean value of content. Expects to find the element start tag, text content, and end tag, in that order, and returns with the parser positioned following the end tag.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expected- Returns:
- converted value from element text
- Throws:
JiBXException
- on any error (possible wrapping other exception)
-
parseElementBoolean
Parse entire element, returning boolean value of optional content. Expects to find the element start tag, text content, and end tag, in that order, and returns with the parser positioned following the end tag. Returns the default value if the element is not present.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expecteddflt
- default value- Returns:
- content text from element
- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
convertFloat
Convert float value with exception wrapper. This internal method is used by all the float unmarshalling calls. It adds position information to any exceptions that occur.- Parameters:
text
- text for value to be converted- Returns:
- converted float value
- Throws:
JiBXException
- if not a valid float value
-
attributeFloat
Get float value of attribute from current start tag. Throws an exception if the attribute is not found in the start tag, or if it is not a valid integer value.- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expected- Returns:
- attribute float value
- Throws:
JiBXException
- if attribute not present or not a valid float value
-
attributeFloat
Get float value of optional attribute from current start tag. If the attribute is not present the supplied default value is returned instead.- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expecteddflt
- value to be returned if attribute is not present- Returns:
- attribute float value
- Throws:
JiBXException
- if attribute value is not a valid float
-
parseElementFloat
Parse past end of element, returning float value of content. Expects to find the element start tag, text content, and end tag, in that order, and returns with the parser positioned following the end tag.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expected- Returns:
- converted value from element text
- Throws:
JiBXException
- on any error (possible wrapping other exception)
-
parseElementFloat
Parse entire element, returning float value of optional content. Expects to find the element start tag, text content, and end tag, in that order, and returns with the parser positioned following the end tag. Returns the default value if the element is not present.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expecteddflt
- default value- Returns:
- content text from element
- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
convertDouble
Convert double value with exception wrapper. This internal method is used by all the double unmarshalling calls. It adds position information to any exceptions that occur.- Parameters:
text
- text for value to be converted- Returns:
- converted double value
- Throws:
JiBXException
- if not a valid double value
-
attributeDouble
Get double value of attribute from current start tag. Throws an exception if the attribute is not found in the start tag, or if it is not a valid integer value.- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expected- Returns:
- attribute double value
- Throws:
JiBXException
- if attribute not present or not a valid double value
-
attributeDouble
Get double value of optional attribute from current start tag. If the attribute is not present the supplied default value is returned instead.- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expecteddflt
- value to be returned if attribute is not present- Returns:
- attribute double value
- Throws:
JiBXException
- if attribute value is not a valid double
-
parseElementDouble
Parse past end of element, returning double value of content. Expects to find the element start tag, text content, and end tag, in that order, and returns with the parser positioned following the end tag.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expected- Returns:
- converted value from element text
- Throws:
JiBXException
- on any error (possible wrapping other exception)
-
parseElementDouble
Parse entire element, returning double value of optional content. Expects to find the element start tag, text content, and end tag, in that order, and returns with the parser positioned following the end tag. Returns the default value if the element is not present.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expecteddflt
- default value- Returns:
- content text from element
- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
convertDate
Convertjava.util.Date
value with exception wrapper. This internal method is used by all the Date unmarshalling calls. It adds position information to any exceptions that occur.- Parameters:
text
- text for value to be converted- Returns:
- converted Date value
- Throws:
JiBXException
- if not a valid Date value
-
attributeDate
Getjava.util.Date
value of attribute from current start tag. Throws an exception if the attribute is not found in the start tag, or if it is not a valid integer value.- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expected- Returns:
- attribute Date value
- Throws:
JiBXException
- if attribute not present or not a valid Date value
-
attributeDate
Getjava.util.Date
value of optional attribute from current start tag. If the attribute is not present the supplied default value is returned instead.- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expecteddflt
- value to be returned if attribute is not present- Returns:
- attribute Date value
- Throws:
JiBXException
- if attribute value is not a valid Date
-
parseElementDate
Parse past end of element, returningjava.util.Date
value of content. Expects to find the element start tag, text content, and end tag, in that order, and returns with the parser positioned following the end tag.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expected- Returns:
- converted value from element text
- Throws:
JiBXException
- on any error (possible wrapping other exception)
-
parseElementDate
Parse entire element, returningjava.util.Date
value of optional content. Expects to find the element start tag, text content, and end tag, in that order, and returns with the parser positioned following the end tag. Returns the default value if the element is not present.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expecteddflt
- default value- Returns:
- content text from element
- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
registerBackFill
Register back fill item for undefined ID value. This adds a holder to the mapping table if not already present, then adds the back fill item to the holder.- Parameters:
id
- target undefined ID valueindex
- target reference type indexfill
- back fill item- Throws:
JiBXException
- if attribute not present, or ID already defined
-
registerBackFill
Register back fill item for last parsed ID value. This adds a holder to the mapping table if not already present, then adds the back fill item to the holder. This form of call always applies to the last IDREF value parsed (from either an element or an attribute).- Parameters:
index
- target reference type indexfill
- back fill item- Throws:
JiBXException
- if attribute not present, or ID already defined
-
defineID
Define object for ID. Adds the owning object to a map with the ID value as key. Throws an exception if the object class does not match that expected from forward references, or if another object has previously been registered with the same ID.- Parameters:
id
- text ID valueindex
- ID class index numberobj
- object corresponding to element- Throws:
JiBXException
- if duplicate ID or wrong class
-
mapUnmarshalling
protected void mapUnmarshalling(int index) Map unmarshalling for element. Adds the entry for a particular class index to the unmarshalling map.- Parameters:
index
- class index for unmarshalling definition to be added
-
addUnmarshalling
public void addUnmarshalling(String mapname, String ns, String name, String cname) throws JiBXException Define unmarshalling for element. Enables the unmarshalling definition linking an element name (including namespace) with a handler.- Parameters:
mapname
- mapping name associated with unmarshallerns
- namespace for element (may benull
or the empty string for the empty namespace)name
- name for elementcname
- unmarshaller class name- Throws:
JiBXException
- if unknown mapping name
-
removeUnmarshalling
Undefine unmarshalling for element. Disables the unmarshalling definition for a particular mapping name.- Parameters:
mapname
- mapping name associated with unmarshaller- Throws:
JiBXException
- if unknown mapping name
-
getUnmarshaller
Find the unmarshaller for a particular class index in the current context.- Parameters:
index
- class index for unmarshalling definition- Returns:
- unmarshalling handler for class
- Throws:
JiBXException
- if unable to create unmarshaller
-
getUnmarshaller
Find the unmarshaller for a particular class in the current context.- Specified by:
getUnmarshaller
in interfaceIUnmarshallingContext
- Parameters:
mapname
- unmarshaller mapping name (generally the class name to be handled, or abstract mapping type name)- Returns:
- unmarshalling handler for class
- Throws:
JiBXException
- if unable to create unmarshaller
-
getUnmarshaller
Find the unmarshaller for a particular element name (including namespace) in the current context.- Parameters:
ns
- namespace for element (may benull
or the empty string for the empty namespace)name
- name for element- Returns:
- unmarshalling handler for element, or
null
if none found - Throws:
JiBXException
- if unable to create unmarshaller
-
unmarshalOptionalElement
Unmarshal optional element. If not currently positioned at a start or end tag this first advances the parse to the next start or end tag.- Returns:
- unmarshalled object from element, or
null
if end tag rather than start tag seen - Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
unmarshalElement
Unmarshal required element of specified type. If not currently positioned at a start or end tag this first advances the parse to the next start or end tag. The returned object will always be assignable to the specified type.- Parameters:
clas
- expected class of unmarshalled object- Returns:
- unmarshalled object from element
- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
unmarshalElement
Unmarshal required element. If not currently positioned at a start or end tag this first advances the parse to the next start or end tag.- Specified by:
unmarshalElement
in interfaceIUnmarshallingContext
- Returns:
- unmarshalled object from element
- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
parsePastElement
Parse past element, ignoring all content. This may be used while positioned either before or on the element start tag. It checks if currently positioned at the element start tag, and if so advances to the next parse event. Then looks for the next end tag, ignoring character data and skipping child elements. Leaves the parse positioned following the end tag.- Parameters:
ns
- namespace URI for expected element (may benull
or the empty string for the empty namespace)tag
- element name expected- Throws:
JiBXException
- on any error (possible wrapping other exception)
-
getElementName
Returns current element name.- Returns:
- local name part of name, or
null
if not at a start or end tag - Throws:
JiBXException
- if error from parser
-
getElementNamespace
Returns current element namespace URI.- Returns:
- namespace URI of name, or
null
if not at a start or end tag - Throws:
JiBXException
- if error from parser
-
throwStartTagException
Throw exception with start tag and position information.- Parameters:
msg
- exception message text- Throws:
JiBXException
- always thrown
-
throwStartTagException
Throw exception with start tag, position information, and nested exception.- Parameters:
msg
- exception message textex
- nested exception- Throws:
JiBXException
- always thrown
-
throwException
Throw exception with position information.- Parameters:
msg
- exception message text- Throws:
JiBXException
- always thrown
-
throwException
Throw exception with position information and nested exception.- Parameters:
msg
- exception message textex
- nested exception- Throws:
JiBXException
- always thrown
-
unmarshalDocument
Unmarshal document from stream to object. The effect of this is the same as ifsetDocument(java.io.InputStream, java.lang.String, java.lang.String, boolean)
were called, followed byunmarshalElement(java.lang.Class)
- Specified by:
unmarshalDocument
in interfaceIUnmarshallingContext
- Parameters:
ins
- stream supplying document dataenc
- document input encoding, ornull
if to be determined by parser- Returns:
- unmarshalled object
- Throws:
JiBXException
- if error creating parser
-
unmarshalDocument
Unmarshal document from reader to object. The effect of this is the same as ifsetDocument(java.io.InputStream, java.lang.String, java.lang.String, boolean)
were called, followed byunmarshalElement(java.lang.Class)
- Specified by:
unmarshalDocument
in interfaceIUnmarshallingContext
- Parameters:
rdr
- reader supplying document data- Returns:
- unmarshalled object
- Throws:
JiBXException
- if error creating parser
-
unmarshalDocument
Unmarshal named document from stream to object. The effect of this is the same as ifsetDocument(java.io.InputStream, java.lang.String, java.lang.String, boolean)
were called, followed byunmarshalElement(java.lang.Class)
- Specified by:
unmarshalDocument
in interfaceIUnmarshallingContext
- Parameters:
ins
- stream supplying document dataname
- document nameenc
- document input encoding, ornull
if to be determined by parser- Returns:
- unmarshalled object
- Throws:
JiBXException
- if error creating parser
-
unmarshalDocument
Unmarshal named document from reader to object. The effect of this is the same as ifsetDocument(java.io.InputStream, java.lang.String, java.lang.String, boolean)
were called, followed byunmarshalElement(java.lang.Class)
- Specified by:
unmarshalDocument
in interfaceIUnmarshallingContext
- Parameters:
rdr
- reader supplying document dataname
- document name- Returns:
- unmarshalled object
- Throws:
JiBXException
- if error creating parser
-
getFactory
Return the binding factory used to create this unmarshaller.- Returns:
- binding factory
-
getDocumentName
Return the supplied document name.- Specified by:
getDocumentName
in interfaceIUnmarshallingContext
- Returns:
- supplied document name (
null
if none)
-
getInputEncoding
Return the input encoding, if known. This is only valid after parsing of a document has been started.- Returns:
- input encoding (
null
if unknown)
-
setUserContext
Set a user context object. This context object is not used directly by JiBX, but can be accessed by all types of user extension methods. The context object is automatically cleared by thereset()
method, so to make use of this you need to first call the appropriate version of thesetDocument()
method, then this method, and finally theunmarshalElement(java.lang.Class)
method.- Specified by:
setUserContext
in interfaceIUnmarshallingContext
- Parameters:
obj
- user context object, ornull
if clearing existing context object- See Also:
-
getUserContext
Get the user context object.- Specified by:
getUserContext
in interfaceIUnmarshallingContext
- Returns:
- user context object, or
null
if no context object set - See Also:
-
pushObject
Push created object to unmarshalling stack. This must be called before beginning the unmarshalling of the object. It is only called for objects with structure, not for those converted directly to and from text.- Specified by:
pushObject
in interfaceIUnmarshallingContext
- Parameters:
obj
- object being unmarshalled
-
trackObject
Set position tracking information for object, if supported.- Parameters:
obj
- object being tracked
-
pushTrackedObject
Push created object to unmarshalling stack with position tracking. If the object supports setting source location information, the location is also set by this method.- Parameters:
obj
- object being unmarshalled
-
popObject
Pop unmarshalled object from stack.- Specified by:
popObject
in interfaceIUnmarshallingContext
- Throws:
JiBXException
- if no object on stack
-
getStackDepth
public int getStackDepth()Get current unmarshalling object stack depth. This allows tracking nested calls to unmarshal one object while in the process of unmarshalling another object. The bottom item on the stack is always the root object being unmarshalled.- Specified by:
getStackDepth
in interfaceIUnmarshallingContext
- Returns:
- number of objects in unmarshalling stack
-
getStackObject
Get object from unmarshalling stack. This stack allows tracking nested calls to unmarshal one object while in the process of unmarshalling another object. The bottom item on the stack is always the root object being unmarshalled.- Specified by:
getStackObject
in interfaceIUnmarshallingContext
- Parameters:
depth
- object depth in stack to be retrieved (must be in the range of zero to the current depth minus one).- Returns:
- object from unmarshalling stack
-
getStackTop
Get top object on unmarshalling stack. This is safe to call even when no objects are on the stack.- Specified by:
getStackTop
in interfaceIUnmarshallingContext
- Returns:
- object from unmarshalling stack, or
null
if none
-
getActiveNamespaceCount
public int getActiveNamespaceCount()Get count of active namespaces.- Returns:
- number of active namespaces in stack
-
getActiveNamespaceUri
Get URI for an active namespace.- Parameters:
index
- index number of namespace to be returned- Returns:
- URI for namespace at position
- Throws:
IllegalArgumentException
- if invalid index
-
getActiveNamespacePrefix
Get prefix for an active namespace.- Parameters:
index
- stack position of namespace to be returned- Returns:
- prefix for namespace at position
- Throws:
IllegalArgumentException
- if invalid index
-
skipElement
Skip past current element.- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
next
Advance to next major parse event. This wraps the base parser call in order to catch and handle exceptions, and to preserve a reasonable level of parser independence.- Returns:
- event type for next major parse event (START_TAG, TEXT, END_TAG, or END_DOCUMENT)
- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
nextToken
Advance to next parse event. This wraps the base parser call in order to catch and handle exceptions, and to preserve a reasonable level of parser independence.- Returns:
- event type for next parse event
- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
currentEvent
Get the current parse event type. This wraps the base parser call in order to catch and handle exceptions, and to preserve a reasonable level of parser independence.- Returns:
- event type for current parse event
- Throws:
JiBXException
- on any error (possibly wrapping other exception)
-
getName
Get name associated with current parse event.- Returns:
- name text for name associated with event (START_ELEMENT, END_ELEMENT, or ENTITY_REF only)
- Throws:
IllegalStateException
- if not at a start or end tag (optional)
-
getNamespace
Get namespace associated with current parse event.- Returns:
- URI for namespace associated with event (START_ELEMENT or END_ELEMENT only), empty string if none
- Throws:
IllegalStateException
- if not at a start or end tag (optional)
-
getPrefix
Get namespace prefix associated with current parse event.- Returns:
- prefix for namespace associated with event (START_ELEMENT or
END_ELEMENT only),
null
if none - Throws:
IllegalStateException
- if not at a start or end tag (optional)
-
getAttributeCount
public int getAttributeCount()Get number of attributes for current START_ELEMENT event. The results are undefined if called when not at a START_ELEMENT event.- Returns:
- number of attributes, or
-1
if not at START_ELEMENT - Throws:
IllegalStateException
- if not at a start tag (optional)
-
getAttributeName
Get attribute name for current START_ELEMENT event. The results are undefined if called when not at a START_ELEMENT event.- Parameters:
index
- index number of attribute to be returned- Returns:
- name of attribute at position
- Throws:
IllegalStateException
- if not at a start tag or invalid index
-
getAttributeNamespace
Get attribute namespace for current START_ELEMENT event. The results are undefined if called when not at a START_ELEMENT event.- Parameters:
index
- index number of attribute to be returned- Returns:
- namespace URI of attribute at position, empty string if none
- Throws:
IllegalStateException
- if not at a start tag or invalid index
-
getAttributePrefix
Get attribute namespace prefix for current START_ELEMENT event. The results are undefined if called when not at a START_ELEMENT event.- Parameters:
index
- index number of attribute to be returned- Returns:
- prefix for namespace of attribute at position,
null
if none - Throws:
IllegalStateException
- if not at a start tag or invalid index
-
getAttributeValue
Get attribute value for current START_ELEMENT event. The results are undefined if called when not at a START_ELEMENT event.- Parameters:
index
- index number of attribute to be returned- Returns:
- value of attribute at position
- Throws:
IllegalStateException
- if not at a start tag or invalid index
-
getNamespaceCount
public int getNamespaceCount()Get number of namespace declarations for current START_ELEMENT event. The results are undefined if called when not at a START_ELEMENT event.- Returns:
- number of namespace declarations, or
-1
if not at START_ELEMENT
-
getNamespaceUri
Get namespace URI for namespace declaration on current START_ELEMENT event. The results are undefined if called when not at a START_ELEMENT event.- Parameters:
index
- index number of declaration to be returned- Returns:
- namespace URI for declaration at position
- Throws:
IllegalArgumentException
- if invalid index
-
getNamespacePrefix
Get namespace prefix for namespace declaration on current START_ELEMENT event. The results are undefined if called when not at a START_ELEMENT event.- Parameters:
index
- index number of declaration to be returned- Returns:
- namespace prefix for declaration at position,
- Throws:
IllegalArgumentException
- if invalid index
-
getNamespaceUri
Get namespace URI matching prefix.- Parameters:
prefix
- namespace prefix to be matched (null
for default namespace)- Returns:
- namespace URI for prefix
-
getText
Get text value for current event.- Returns:
- text value for event
-