|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jibx.runtime.impl.UnmarshallingContext
public class UnmarshallingContext
Pull parser wrapper supplying convenience methods for access. Most of these methods are designed for use in code generated by the binding generator.
Constructor Summary | |
---|---|
UnmarshallingContext()
Default constructor. |
|
UnmarshallingContext(int nmap,
java.lang.String[] umcs,
java.lang.String[] nss,
java.lang.String[] names,
java.lang.String[] idcs,
IBindingFactory ifact)
Constructor. |
Method Summary | |
---|---|
java.lang.String |
accumulateText()
Accumulate text content. |
void |
addUnmarshalling(java.lang.String mapname,
java.lang.String ns,
java.lang.String name,
java.lang.String cname)
Define unmarshalling for element. |
boolean |
attributeBoolean(java.lang.String ns,
java.lang.String name)
Get boolean value of attribute from current start tag. |
boolean |
attributeBoolean(java.lang.String ns,
java.lang.String name,
boolean dflt)
Get boolean value of optional attribute from current start tag. |
byte |
attributeByte(java.lang.String ns,
java.lang.String name)
Get byte value of attribute from current start tag. |
byte |
attributeByte(java.lang.String ns,
java.lang.String name,
byte dflt)
Get byte value of optional attribute from current start tag. |
char |
attributeChar(java.lang.String ns,
java.lang.String name)
Get char value of attribute from current start tag. |
char |
attributeChar(java.lang.String ns,
java.lang.String name,
char dflt)
Get char value of optional attribute from current start tag. |
java.util.Date |
attributeDate(java.lang.String ns,
java.lang.String name)
Get java.util.Date value of attribute from current start
tag. |
java.util.Date |
attributeDate(java.lang.String ns,
java.lang.String name,
java.util.Date dflt)
Get java.util.Date value of optional attribute from current
start tag. |
double |
attributeDouble(java.lang.String ns,
java.lang.String name)
Get double value of attribute from current start tag. |
double |
attributeDouble(java.lang.String ns,
java.lang.String name,
double dflt)
Get double value of optional attribute from current start tag. |
int |
attributeEnumeration(java.lang.String ns,
java.lang.String name,
java.lang.String[] enums,
int[] vals)
Get enumeration attribute value from current start tag. |
int |
attributeEnumeration(java.lang.String ns,
java.lang.String name,
java.lang.String[] enums,
int[] vals,
int dflt)
Get optional enumeration attribute value from current start tag. |
java.lang.Object |
attributeExistingIDREF(java.lang.String ns,
java.lang.String name,
int index)
Get previously defined object corresponding to IDREF attribute from current start tag. |
float |
attributeFloat(java.lang.String ns,
java.lang.String name)
Get float value of attribute from current start tag. |
float |
attributeFloat(java.lang.String ns,
java.lang.String name,
float dflt)
Get float value of optional attribute from current start tag. |
java.lang.Object |
attributeForwardIDREF(java.lang.String ns,
java.lang.String name,
int index)
Get object (if defined yet) corresponding to IDREF attribute from current start tag. |
int |
attributeInt(java.lang.String ns,
java.lang.String name)
Get integer value of attribute from current start tag. |
int |
attributeInt(java.lang.String ns,
java.lang.String name,
int dflt)
Get integer value of optional attribute from current start tag. |
long |
attributeLong(java.lang.String ns,
java.lang.String name)
Get long value of attribute from current start tag. |
long |
attributeLong(java.lang.String ns,
java.lang.String name,
long dflt)
Get long value of optional attribute from current start tag. |
short |
attributeShort(java.lang.String ns,
java.lang.String name)
Get short value of attribute from current start tag. |
short |
attributeShort(java.lang.String ns,
java.lang.String name,
short dflt)
Get short value of optional attribute from current start tag. |
java.lang.String |
attributeText(java.lang.String ns,
java.lang.String name)
Get text value of attribute from current start tag. |
java.lang.String |
attributeText(java.lang.String ns,
java.lang.String name,
java.lang.String dflt)
Get text value of optional attribute from current start tag. |
static java.lang.String |
buildNameString(java.lang.String ns,
java.lang.String name)
Build name with optional namespace. |
java.lang.String |
buildPositionString()
Build current parse input position description. |
void |
checkAllowedAttributes(java.lang.String[] nss,
java.lang.String[] names)
Check that only allowed attributes are present on current start tag. |
boolean |
convertBoolean(java.lang.String text)
Convert boolean value. |
byte |
convertByte(java.lang.String text)
Convert byte value with exception wrapper. |
char |
convertChar(java.lang.String text)
Convert char value with exception wrapper. |
java.util.Date |
convertDate(java.lang.String text)
Convert java.util.Date value with exception wrapper. |
double |
convertDouble(java.lang.String text)
Convert double value with exception wrapper. |
int |
convertEnum(java.lang.String target,
java.lang.String[] enums,
int[] vals)
Find required text value in enumeration. |
int |
convertEnum(java.lang.String target,
java.lang.String[] enums,
int[] vals,
int dflt)
Find optional text value in enumeration. |
float |
convertFloat(java.lang.String text)
Convert float value with exception wrapper. |
long |
convertLong(java.lang.String text)
Convert long value with exception wrapper. |
short |
convertShort(java.lang.String text)
Convert short value with exception wrapper. |
int |
currentEvent()
Get the current parse event type. |
java.lang.String |
currentNameString()
Build current element name, with optional namespace. |
void |
defineID(java.lang.String id,
int index,
java.lang.Object obj)
Define object for ID. |
java.lang.Object |
findDefinedID(java.lang.String id,
int index)
Find previously defined object corresponding to an ID. |
java.lang.Object |
findID(java.lang.String id,
int index)
Find the object corresponding to an ID. |
int |
getActiveNamespaceCount()
Get count of active namespaces. |
java.lang.String |
getActiveNamespacePrefix(int index)
Get prefix for an active namespace. |
java.lang.String |
getActiveNamespaceUri(int index)
Get URI for an active namespace. |
int |
getAttributeCount()
Get number of attributes for current START_ELEMENT event. |
java.lang.String |
getAttributeName(int index)
Get attribute name for current START_ELEMENT event. |
java.lang.String |
getAttributeNamespace(int index)
Get attribute namespace for current START_ELEMENT event. |
java.lang.String |
getAttributePrefix(int index)
Get attribute namespace prefix for current START_ELEMENT event. |
java.lang.String |
getAttributeValue(int index)
Get attribute value for current START_ELEMENT event. |
java.lang.String |
getDocumentName()
Return the supplied document name. |
java.lang.String |
getElementName()
Returns current element name. |
java.lang.String |
getElementNamespace()
Returns current element namespace URI. |
IBindingFactory |
getFactory()
Return the binding factory used to create this unmarshaller. |
java.lang.String |
getInputEncoding()
Return the input encoding, if known. |
java.lang.String |
getName()
Get name associated with current parse event. |
java.lang.String |
getNamespace()
Get namespace associated with current parse event. |
int |
getNamespaceCount()
Get number of namespace declarations for current START_ELEMENT event. |
java.lang.String |
getNamespacePrefix(int index)
Get namespace prefix for namespace declaration on current START_ELEMENT event. |
java.lang.String |
getNamespaceUri(int index)
Get namespace URI for namespace declaration on current START_ELEMENT event. |
java.lang.String |
getNamespaceUri(java.lang.String prefix)
Get namespace URI matching prefix. |
java.lang.String |
getPrefix()
Get namespace prefix associated with current parse event. |
int |
getStackDepth()
Get current unmarshalling object stack depth. |
java.lang.Object |
getStackObject(int depth)
Get object from unmarshalling stack. |
java.lang.Object |
getStackTop()
Get top object on unmarshalling stack. |
java.lang.String |
getText()
Get text value for current event. |
IUnmarshaller |
getUnmarshaller(java.lang.String mapname)
Find the unmarshaller for a particular class in the current context. |
IUnmarshaller |
getUnmarshaller(java.lang.String ns,
java.lang.String name)
Find the unmarshaller for a particular element name (including namespace) in the current context. |
java.lang.Object |
getUserContext()
Get the user context object. |
boolean |
hasAnyAttribute(java.lang.String[] nss,
java.lang.String[] names)
Check if any of several attributes is present on current start tag. |
boolean |
hasAttribute(java.lang.String ns,
java.lang.String name)
Check if attribute is present on current start tag. |
boolean |
isAt(java.lang.String ns,
java.lang.String name)
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. |
int |
next()
Advance to next major parse event. |
int |
nextToken()
Advance to next parse event. |
byte |
parseContentByte(java.lang.String ns,
java.lang.String tag)
Parse past end of element, returning byte value of content. |
char |
parseContentChar(java.lang.String ns,
java.lang.String tag)
Parse past end of element, returning char value of content. |
int |
parseContentEnumeration(java.lang.String ns,
java.lang.String tag,
java.lang.String[] enums,
int[] vals)
Parse past end of element, returning enumeration value of content. |
int |
parseContentInt(java.lang.String ns,
java.lang.String tag)
Parse past end of element, returning integer value of content. |
short |
parseContentShort(java.lang.String ns,
java.lang.String tag)
Parse past end of element, returning short value of content. |
java.lang.String |
parseContentText()
Parse required text content. |
java.lang.String |
parseContentText(java.lang.String ns,
java.lang.String tag)
Parse past end of element, returning optional text content. |
boolean |
parseElementBoolean(java.lang.String ns,
java.lang.String tag)
Parse entire element, returning boolean value of content. |
boolean |
parseElementBoolean(java.lang.String ns,
java.lang.String tag,
boolean dflt)
Parse entire element, returning boolean value of optional content. |
byte |
parseElementByte(java.lang.String ns,
java.lang.String tag)
Parse entire element, returning byte value of content. |
byte |
parseElementByte(java.lang.String ns,
java.lang.String tag,
byte dflt)
Parse entire element, returning byte value of optional content. |
char |
parseElementChar(java.lang.String ns,
java.lang.String tag)
Parse entire element, returning char value of content. |
char |
parseElementChar(java.lang.String ns,
java.lang.String tag,
char dflt)
Parse entire element, returning char value of optional content. |
java.util.Date |
parseElementDate(java.lang.String ns,
java.lang.String tag)
Parse past end of element, returning java.util.Date value
of content. |
java.util.Date |
parseElementDate(java.lang.String ns,
java.lang.String tag,
java.util.Date dflt)
Parse entire element, returning java.util.Date value of
optional content. |
double |
parseElementDouble(java.lang.String ns,
java.lang.String tag)
Parse past end of element, returning double value of content. |
double |
parseElementDouble(java.lang.String ns,
java.lang.String tag,
double dflt)
Parse entire element, returning double value of optional content. |
int |
parseElementEnumeration(java.lang.String ns,
java.lang.String tag,
java.lang.String[] enums,
int[] vals,
int dflt)
Parse entire element, returning enumeration value of optional content. |
java.lang.Object |
parseElementExistingIDREF(java.lang.String ns,
java.lang.String tag,
int index)
Parse entire element, returning previously defined object corresponding to content interpreted as IDREF. |
float |
parseElementFloat(java.lang.String ns,
java.lang.String tag)
Parse past end of element, returning float value of content. |
float |
parseElementFloat(java.lang.String ns,
java.lang.String tag,
float dflt)
Parse entire element, returning float value of optional content. |
java.lang.Object |
parseElementForwardIDREF(java.lang.String ns,
java.lang.String tag,
int index)
Parse entire element, returning object (if defined yet) corresponding to content interpreted as IDREF. |
int |
parseElementInt(java.lang.String ns,
java.lang.String tag)
Parse entire element, returning integer value of content. |
int |
parseElementInt(java.lang.String ns,
java.lang.String tag,
int dflt)
Parse entire optional element, returning integer value of content. |
long |
parseElementLong(java.lang.String ns,
java.lang.String tag)
Parse past end of element, returning long value of content. |
long |
parseElementLong(java.lang.String ns,
java.lang.String tag,
long dflt)
Parse entire element, returning long value of optional content. |
short |
parseElementShort(java.lang.String ns,
java.lang.String tag)
Parse entire element, returning short value of content. |
short |
parseElementShort(java.lang.String ns,
java.lang.String tag,
short dflt)
Parse entire element, returning short value of optional content. |
java.lang.String |
parseElementText(java.lang.String ns,
java.lang.String tag)
Parse entire element, returning text content. |
java.lang.String |
parseElementText(java.lang.String ns,
java.lang.String tag,
java.lang.String dflt)
Parse entire element, returning optional text content. |
boolean |
parseIfStartTag(java.lang.String ns,
java.lang.String name)
Parse past start of expected element. |
void |
parsePastCurrentEndTag(java.lang.String ns,
java.lang.String name)
Parse past current end of element. |
void |
parsePastElement(java.lang.String ns,
java.lang.String tag)
Parse past element, ignoring all content. |
void |
parsePastEndTag(java.lang.String ns,
java.lang.String name)
Parse past end of element. |
void |
parsePastStartTag(java.lang.String ns,
java.lang.String name)
Parse past start of element. |
void |
parseToStartTag(java.lang.String ns,
java.lang.String name)
Parse to start of element. |
void |
popObject()
Pop unmarshalled object from stack. |
void |
pushObject(java.lang.Object obj)
Push created object to unmarshalling stack. |
void |
pushTrackedObject(java.lang.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(java.lang.String id,
int index,
BackFillReference fill)
Register back fill item for undefined ID value. |
void |
removeUnmarshalling(java.lang.String mapname)
Undefine unmarshalling for element. |
void |
reset()
Reset unmarshalling information. |
void |
setDocument(java.io.InputStream ins,
java.lang.String enc)
Set document to be parsed from stream. |
void |
setDocument(java.io.InputStream ins,
java.lang.String name,
java.lang.String enc)
Set named document to be parsed from stream. |
void |
setDocument(java.io.InputStream ins,
java.lang.String name,
java.lang.String enc,
boolean nsa)
Set document to be parsed from stream. |
void |
setDocument(IXMLReader rdr)
Set input document parse source directly. |
void |
setDocument(java.io.Reader rdr)
Set document to be parsed from reader. |
void |
setDocument(java.io.Reader rdr,
java.lang.String name)
Set named document to be parsed from reader. |
void |
setDocument(java.io.Reader rdr,
java.lang.String name,
boolean nsa)
Set document to be parsed from reader. |
void |
setFromContext(UnmarshallingContext parent)
Initializes the context to use the same parser and document as another unmarshalling context. |
void |
setUserContext(java.lang.Object obj)
Set a user context object. |
void |
skipElement()
Skip past current element. |
void |
throwEndTagNameError(java.lang.String ns,
java.lang.String name)
Throw exception for expected element end tag not found. |
void |
throwException(java.lang.String msg)
Throw exception with position information. |
void |
throwException(java.lang.String msg,
java.lang.Exception ex)
Throw exception with position information and nested exception. |
void |
throwNameException(java.lang.String msg,
java.lang.String ns,
java.lang.String name)
Throw exception including a name and position information. |
void |
throwStartTagException(java.lang.String msg)
Throw exception with start tag and position information. |
void |
throwStartTagException(java.lang.String msg,
java.lang.Exception ex)
Throw exception with start tag, position information, and nested exception. |
void |
throwStartTagNameError(java.lang.String ns,
java.lang.String name)
Throw exception for expected element start tag not found. |
java.lang.String |
toEnd()
Parse to end tag. |
java.lang.String |
toStart()
Parse to start tag. |
int |
toTag()
Parse to start or end tag. |
void |
trackObject(java.lang.Object obj)
Set position tracking information for object, if supported. |
java.lang.Object |
unmarshalDocument(java.io.InputStream ins,
java.lang.String enc)
Unmarshal document from stream to object. |
java.lang.Object |
unmarshalDocument(java.io.InputStream ins,
java.lang.String name,
java.lang.String enc)
Unmarshal named document from stream to object. |
java.lang.Object |
unmarshalDocument(java.io.Reader rdr)
Unmarshal document from reader to object. |
java.lang.Object |
unmarshalDocument(java.io.Reader rdr,
java.lang.String name)
Unmarshal named document from reader to object. |
java.lang.Object |
unmarshalElement()
Unmarshal required element. |
java.lang.Object |
unmarshalElement(java.lang.Class clas)
Unmarshal required element of specified type. |
java.lang.Object |
unmarshalOptionalElement()
Unmarshal optional element. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public UnmarshallingContext(int nmap, java.lang.String[] umcs, java.lang.String[] nss, java.lang.String[] names, java.lang.String[] idcs, IBindingFactory ifact)
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 unmarshallerpublic UnmarshallingContext()
Method Detail |
---|
public static java.lang.String buildNameString(java.lang.String ns, java.lang.String name)
ns
- namespace URI of namename
- local name part of name
public java.lang.String currentNameString()
public java.lang.String buildPositionString()
public void throwStartTagNameError(java.lang.String ns, java.lang.String name) throws JiBXException
ns
- namespace URI of namename
- local name part of name
JiBXException
- always thrownpublic void throwEndTagNameError(java.lang.String ns, java.lang.String name) throws JiBXException
ns
- namespace URI of namename
- local name part of name
JiBXException
- always thrownpublic void throwNameException(java.lang.String msg, java.lang.String ns, java.lang.String name) throws JiBXException
msg
- leading message textns
- namespace URI of namename
- local name part of name
JiBXException
- always thrownpublic void setDocument(java.io.InputStream ins, java.lang.String name, java.lang.String enc, boolean nsa) throws JiBXException
ins
- stream supplying document dataname
- document name (null
if unknown)enc
- document input encoding, or null
if to be
determined by parsernsa
- enable namespace processing for parser flag
JiBXException
- if error creating parserpublic void setDocument(java.io.InputStream ins, java.lang.String enc) throws JiBXException
setDocument
in interface IUnmarshallingContext
ins
- stream supplying document dataenc
- document input encoding, or null
if to be
determined by parser
JiBXException
- if error creating parserpublic void setDocument(java.io.Reader rdr, java.lang.String name, boolean nsa) throws JiBXException
rdr
- reader supplying document dataname
- document name (null
if unknown)nsa
- enable namespace processing for parser flag
JiBXException
- if error creating parserpublic void setDocument(java.io.Reader rdr) throws JiBXException
setDocument
in interface IUnmarshallingContext
rdr
- reader supplying document data
JiBXException
- if error creating parserpublic void setDocument(java.io.InputStream ins, java.lang.String name, java.lang.String enc) throws JiBXException
setDocument
in interface IUnmarshallingContext
ins
- stream supplying document dataname
- document nameenc
- document input encoding, or null
if to be
determined by parser
JiBXException
- if error creating parserpublic void setDocument(java.io.Reader rdr, java.lang.String name) throws JiBXException
setDocument
in interface IUnmarshallingContext
rdr
- reader supplying document dataname
- document name
JiBXException
- if error creating parserpublic void setDocument(IXMLReader rdr)
rdr
- document parse event readerpublic void setFromContext(UnmarshallingContext parent)
parent
- context supplying parser and document to be unmarshalledpublic void reset()
reset
in interface IUnmarshallingContext
public java.lang.String toStart() throws JiBXException
JiBXException
- on any error (possibly wrapping other exception)public java.lang.String toEnd() throws JiBXException
JiBXException
- on any error (possibly wrapping other exception)public int toTag() throws JiBXException
JiBXException
- on any error (possibly wrapping other exception)public boolean isAt(java.lang.String ns, java.lang.String name) throws JiBXException
isAt
in interface IUnmarshallingContext
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)name
- element name expected
true
if at start of element with supplied name,
false
if not
JiBXException
- on any error (possibly wrapping other exception)public boolean hasAttribute(java.lang.String ns, java.lang.String name) throws JiBXException
ns
- namespace URI for expected attribute (may be null
or the empty string for the empty namespace)name
- attribute name expected
true
if named attribute is present,
false
if not
JiBXException
- on any error (possibly wrapping other exception)public boolean hasAnyAttribute(java.lang.String[] nss, java.lang.String[] names) throws JiBXException
nss
- namespace URIs for expected attributes (each may be
null
or the empty string for the empty namespace)names
- attribute names expected
true
if at least one of the named attributes is
present, false
if not
JiBXException
- on any error (possibly wrapping other exception)public void checkAllowedAttributes(java.lang.String[] nss, java.lang.String[] names) throws JiBXException
nss
- namespace URIs for allowed attributes (each may be
null
or the empty string for the empty namespace)names
- alphabetical list of attribute names expected (duplicates
names are ordered by namespace URI)
JiBXException
- on any error (possibly wrapping other exception)public void parseToStartTag(java.lang.String ns, java.lang.String name) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)name
- element name expected
JiBXException
- on any error (possibly wrapping other exception)public void parsePastStartTag(java.lang.String ns, java.lang.String name) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)name
- element name expected
JiBXException
- on any error (possibly wrapping other exception)public boolean parseIfStartTag(java.lang.String ns, java.lang.String name) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)name
- element name expected
true
if start tag found, false
if not
JiBXException
- on any error (possibly wrapping other exception)public void parsePastCurrentEndTag(java.lang.String ns, java.lang.String name) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)name
- element name expected
JiBXException
- on any error (possibly wrapping other exception)public void parsePastEndTag(java.lang.String ns, java.lang.String name) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)name
- element name expected
JiBXException
- on any error (possibly wrapping other exception)public boolean isStart() throws JiBXException
isStart
in interface IUnmarshallingContext
true
if at start of element, false
if
at end
JiBXException
- on any error (possibly wrapping other exception)public boolean isEnd() throws JiBXException
isEnd
in interface IUnmarshallingContext
true
if at end of element, false
if
at start
JiBXException
- on any error (possibly wrapping other exception)public java.lang.String accumulateText() throws JiBXException
JiBXException
- on error in unmarshallingpublic java.lang.String parseContentText() throws JiBXException
JiBXException
- on any error (possible wrapping other exception)public java.lang.String parseContentText(java.lang.String ns, java.lang.String tag) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- element name expected
JiBXException
- on any error (possible wrapping other exception)public int parseContentInt(java.lang.String ns, java.lang.String tag) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- element name expected
JiBXException
- on any error (possible wrapping other exception)public java.lang.String parseElementText(java.lang.String ns, java.lang.String tag) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- element name expected
JiBXException
- on any error (possible wrapping other exception)public java.lang.String parseElementText(java.lang.String ns, java.lang.String tag, java.lang.String dflt) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- element name expecteddflt
- default text value
JiBXException
- on any error (possible wrapping other exception)public java.lang.String attributeText(java.lang.String ns, java.lang.String name) throws JiBXException
ns
- namespace URI for expected attribute (may be null
or the empty string for the empty namespace)name
- attribute name expected
JiBXException
- if attribute not presentpublic java.lang.String attributeText(java.lang.String ns, java.lang.String name, java.lang.String dflt)
ns
- namespace URI for expected attribute (may be null
or the empty string for the empty namespace)name
- attribute name expecteddflt
- value to be returned if attribute is not present
public java.lang.Object findID(java.lang.String id, int index) throws JiBXException
id
- ID textindex
- expected reference type index
null
if not
yet defined
JiBXException
- on any errorpublic java.lang.Object findDefinedID(java.lang.String id, int index) throws JiBXException
id
- ID textindex
- expected reference type index
JiBXException
- on any errorpublic java.lang.Object parseElementForwardIDREF(java.lang.String ns, java.lang.String tag, int index) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- attribute name expectedindex
- expected reference type index
null
if not
yet defined
JiBXException
- on any error (possibly wrapping other exception)public java.lang.Object attributeForwardIDREF(java.lang.String ns, java.lang.String name, int index) throws JiBXException
ns
- namespace URI for expected attribute (may be null
or the empty string for the empty namespace)name
- attribute name expectedindex
- expected reference type index
null
if not
yet defined
JiBXException
- if attribute not present, or ID mapped to a
different type of object than expectedpublic java.lang.Object parseElementExistingIDREF(java.lang.String ns, java.lang.String tag, int index) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- attribute name expectedindex
- expected reference type index
JiBXException
- if attribute not present, ID not defined, or
mapped to a different type of object than expectedpublic java.lang.Object attributeExistingIDREF(java.lang.String ns, java.lang.String name, int index) throws JiBXException
ns
- namespace URI for expected attribute (may be null
or the empty string for the empty namespace)name
- attribute name expectedindex
- expected reference type index
JiBXException
- if attribute not present, ID not defined, or
mapped to a different type of object than expectedpublic int attributeInt(java.lang.String ns, java.lang.String name) throws JiBXException
ns
- namespace URI for expected attribute (may be null
or the empty string for the empty namespace)name
- attribute name expected
JiBXException
- if attribute not present or not a valid integer
valuepublic int attributeInt(java.lang.String ns, java.lang.String name, int dflt) throws JiBXException
ns
- namespace URI for expected attribute (may be null
or the empty string for the empty namespace)name
- attribute name expecteddflt
- value to be returned if attribute is not present
JiBXException
- if attribute value is not a valid integerpublic int parseElementInt(java.lang.String ns, java.lang.String tag) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- element name expected
JiBXException
- on any error (possibly wrapping other exception)public int parseElementInt(java.lang.String ns, java.lang.String tag, int dflt) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- element name expecteddflt
- default value
JiBXException
- on any error (possibly wrapping other exception)public int convertEnum(java.lang.String target, java.lang.String[] enums, int[] vals) throws JiBXException
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 is null
)
JiBXException
- if target text not found in enumerationpublic int convertEnum(java.lang.String target, java.lang.String[] enums, int[] vals, int dflt) throws JiBXException
null
.
target
- text to be found in enumeration (may be null
)enums
- ordered array of texts included in enumerationvals
- array of values to be returned for corresponding text match
positions (position returned directly if this is null
)dflt
- default value returned if target text is null
JiBXException
- if target text not found in enumerationpublic int attributeEnumeration(java.lang.String ns, java.lang.String name, java.lang.String[] enums, int[] vals) throws JiBXException
ns
- namespace URI for expected attribute (may be null
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 is null
)
JiBXException
- if attribute not present or value not found in
enumeration listpublic int attributeEnumeration(java.lang.String ns, java.lang.String name, java.lang.String[] enums, int[] vals, int dflt) throws JiBXException
ns
- namespace URI for expected attribute (may be null
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 is null
)dflt
- default value returned if attribute is not present
JiBXException
- if attribute not present or value not found in
enumeration listpublic int parseContentEnumeration(java.lang.String ns, java.lang.String tag, java.lang.String[] enums, int[] vals) throws JiBXException
ns
- namespace URI for expected element (may be null
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 is null
)
JiBXException
- on any error (possible wrapping other exception)public int parseElementEnumeration(java.lang.String ns, java.lang.String tag, java.lang.String[] enums, int[] vals, int dflt) throws JiBXException
ns
- namespace URI for expected element (may be null
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 is null
)dflt
- default value
JiBXException
- on any error (possibly wrapping other exception)public byte convertByte(java.lang.String text) throws JiBXException
text
- text for value to be converted
JiBXException
- if not a valid byte valuepublic byte attributeByte(java.lang.String ns, java.lang.String name) throws JiBXException
ns
- namespace URI for expected attribute (may be null
or the empty string for the empty namespace)name
- attribute name expected
JiBXException
- if attribute not present or not a valid byte valuepublic byte attributeByte(java.lang.String ns, java.lang.String name, byte dflt) throws JiBXException
ns
- namespace URI for expected attribute (may be null
or the empty string for the empty namespace)name
- attribute name expecteddflt
- value to be returned if attribute is not present
JiBXException
- if attribute value is not a valid bytepublic byte parseContentByte(java.lang.String ns, java.lang.String tag) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- element name expected
JiBXException
- on any error (possible wrapping other exception)public byte parseElementByte(java.lang.String ns, java.lang.String tag) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- element name expected
JiBXException
- on any error (possibly wrapping other exception)public byte parseElementByte(java.lang.String ns, java.lang.String tag, byte dflt) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- element name expecteddflt
- default value
JiBXException
- on any error (possibly wrapping other exception)public short convertShort(java.lang.String text) throws JiBXException
text
- text for value to be converted
JiBXException
- if not a valid short valuepublic short attributeShort(java.lang.String ns, java.lang.String name) throws JiBXException
ns
- namespace URI for expected attribute (may be null
or the empty string for the empty namespace)name
- attribute name expected
JiBXException
- if attribute not present or not a valid short valuepublic short attributeShort(java.lang.String ns, java.lang.String name, short dflt) throws JiBXException
ns
- namespace URI for expected attribute (may be null
or the empty string for the empty namespace)name
- attribute name expecteddflt
- value to be returned if attribute is not present
JiBXException
- if attribute value is not a valid shortpublic short parseContentShort(java.lang.String ns, java.lang.String tag) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- element name expected
JiBXException
- on any error (possible wrapping other exception)public short parseElementShort(java.lang.String ns, java.lang.String tag) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- element name expected
JiBXException
- on any error (possibly wrapping other exception)public short parseElementShort(java.lang.String ns, java.lang.String tag, short dflt) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- element name expecteddflt
- default value
JiBXException
- on any error (possibly wrapping other exception)public char convertChar(java.lang.String text) throws JiBXException
text
- text for value to be converted
JiBXException
- if not a valid char valuepublic char attributeChar(java.lang.String ns, java.lang.String name) throws JiBXException
ns
- namespace URI for expected attribute (may be null
or the empty string for the empty namespace)name
- attribute name expected
JiBXException
- if attribute not present or not a valid char valuepublic char attributeChar(java.lang.String ns, java.lang.String name, char dflt) throws JiBXException
ns
- namespace URI for expected attribute (may be null
or the empty string for the empty namespace)name
- attribute name expecteddflt
- value to be returned if attribute is not present
JiBXException
- if attribute value is not a valid charpublic char parseContentChar(java.lang.String ns, java.lang.String tag) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- element name expected
JiBXException
- on any error (possible wrapping other exception)public char parseElementChar(java.lang.String ns, java.lang.String tag) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- element name expected
JiBXException
- on any error (possibly wrapping other exception)public char parseElementChar(java.lang.String ns, java.lang.String tag, char dflt) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- element name expecteddflt
- default value
JiBXException
- on any error (possibly wrapping other exception)public long convertLong(java.lang.String text) throws JiBXException
text
- text for value to be converted
JiBXException
- if not a valid long valuepublic long attributeLong(java.lang.String ns, java.lang.String name) throws JiBXException
ns
- namespace URI for expected attribute (may be null
or the empty string for the empty namespace)name
- attribute name expected
JiBXException
- if attribute not present or not a valid long valuepublic long attributeLong(java.lang.String ns, java.lang.String name, long dflt) throws JiBXException
ns
- namespace URI for expected attribute (may be null
or the empty string for the empty namespace)name
- attribute name expecteddflt
- value to be returned if attribute is not present
JiBXException
- if attribute value is not a valid longpublic long parseElementLong(java.lang.String ns, java.lang.String tag) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- element name expected
JiBXException
- on any error (possible wrapping other exception)public long parseElementLong(java.lang.String ns, java.lang.String tag, long dflt) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- element name expecteddflt
- default value
JiBXException
- on any error (possibly wrapping other exception)public boolean convertBoolean(java.lang.String text) throws JiBXException
text
- text for value to be converted
JiBXException
- if not a valid boolean valuepublic boolean attributeBoolean(java.lang.String ns, java.lang.String name) throws JiBXException
ns
- namespace URI for expected attribute (may be null
or the empty string for the empty namespace)name
- attribute name expected
JiBXException
- if attribute not present or not a valid boolean
valuepublic boolean attributeBoolean(java.lang.String ns, java.lang.String name, boolean dflt) throws JiBXException
ns
- namespace URI for expected attribute (may be null
or the empty string for the empty namespace)name
- attribute name expecteddflt
- value to be returned if attribute is not present
JiBXException
- if attribute value is not a valid booleanpublic boolean parseElementBoolean(java.lang.String ns, java.lang.String tag) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- element name expected
JiBXException
- on any error (possible wrapping other exception)public boolean parseElementBoolean(java.lang.String ns, java.lang.String tag, boolean dflt) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- element name expecteddflt
- default value
JiBXException
- on any error (possibly wrapping other exception)public float convertFloat(java.lang.String text) throws JiBXException
text
- text for value to be converted
JiBXException
- if not a valid float valuepublic float attributeFloat(java.lang.String ns, java.lang.String name) throws JiBXException
ns
- namespace URI for expected attribute (may be null
or the empty string for the empty namespace)name
- attribute name expected
JiBXException
- if attribute not present or not a valid float valuepublic float attributeFloat(java.lang.String ns, java.lang.String name, float dflt) throws JiBXException
ns
- namespace URI for expected attribute (may be null
or the empty string for the empty namespace)name
- attribute name expecteddflt
- value to be returned if attribute is not present
JiBXException
- if attribute value is not a valid floatpublic float parseElementFloat(java.lang.String ns, java.lang.String tag) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- element name expected
JiBXException
- on any error (possible wrapping other exception)public float parseElementFloat(java.lang.String ns, java.lang.String tag, float dflt) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- element name expecteddflt
- default value
JiBXException
- on any error (possibly wrapping other exception)public double convertDouble(java.lang.String text) throws JiBXException
text
- text for value to be converted
JiBXException
- if not a valid double valuepublic double attributeDouble(java.lang.String ns, java.lang.String name) throws JiBXException
ns
- namespace URI for expected attribute (may be null
or the empty string for the empty namespace)name
- attribute name expected
JiBXException
- if attribute not present or not a valid double
valuepublic double attributeDouble(java.lang.String ns, java.lang.String name, double dflt) throws JiBXException
ns
- namespace URI for expected attribute (may be null
or the empty string for the empty namespace)name
- attribute name expecteddflt
- value to be returned if attribute is not present
JiBXException
- if attribute value is not a valid doublepublic double parseElementDouble(java.lang.String ns, java.lang.String tag) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- element name expected
JiBXException
- on any error (possible wrapping other exception)public double parseElementDouble(java.lang.String ns, java.lang.String tag, double dflt) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- element name expecteddflt
- default value
JiBXException
- on any error (possibly wrapping other exception)public java.util.Date convertDate(java.lang.String text) throws JiBXException
java.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.
text
- text for value to be converted
JiBXException
- if not a valid Date valuepublic java.util.Date attributeDate(java.lang.String ns, java.lang.String name) throws JiBXException
java.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.
ns
- namespace URI for expected attribute (may be null
or the empty string for the empty namespace)name
- attribute name expected
JiBXException
- if attribute not present or not a valid Date
valuepublic java.util.Date attributeDate(java.lang.String ns, java.lang.String name, java.util.Date dflt) throws JiBXException
java.util.Date
value of optional attribute from current
start tag. If the attribute is not present the supplied default value is
returned instead.
ns
- namespace URI for expected attribute (may be null
or the empty string for the empty namespace)name
- attribute name expecteddflt
- value to be returned if attribute is not present
JiBXException
- if attribute value is not a valid Datepublic java.util.Date parseElementDate(java.lang.String ns, java.lang.String tag) throws JiBXException
java.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.
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- element name expected
JiBXException
- on any error (possible wrapping other exception)public java.util.Date parseElementDate(java.lang.String ns, java.lang.String tag, java.util.Date dflt) throws JiBXException
java.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.
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- element name expecteddflt
- default value
JiBXException
- on any error (possibly wrapping other exception)public void registerBackFill(java.lang.String id, int index, BackFillReference fill) throws JiBXException
id
- target undefined ID valueindex
- target reference type indexfill
- back fill item
JiBXException
- if attribute not present, or ID already definedpublic void registerBackFill(int index, BackFillReference fill) throws JiBXException
index
- target reference type indexfill
- back fill item
JiBXException
- if attribute not present, or ID already definedpublic void defineID(java.lang.String id, int index, java.lang.Object obj) throws JiBXException
id
- text ID valueindex
- ID class index numberobj
- object corresponding to element
JiBXException
- if duplicate ID or wrong classpublic void addUnmarshalling(java.lang.String mapname, java.lang.String ns, java.lang.String name, java.lang.String cname) throws JiBXException
mapname
- mapping name associated with unmarshallerns
- namespace for element (may be null
or the empty string for the empty namespace)name
- name for elementcname
- unmarshaller class name
JiBXException
- if unknown mapping namepublic void removeUnmarshalling(java.lang.String mapname) throws JiBXException
mapname
- mapping name associated with unmarshaller
JiBXException
- if unknown mapping namepublic IUnmarshaller getUnmarshaller(java.lang.String mapname) throws JiBXException
getUnmarshaller
in interface IUnmarshallingContext
mapname
- unmarshaller mapping name (generally the class name to be
handled, or abstract mapping type name)
JiBXException
- if unable to create unmarshallerpublic IUnmarshaller getUnmarshaller(java.lang.String ns, java.lang.String name) throws JiBXException
ns
- namespace for element (may be null
or the empty string for the empty namespace)name
- name for element
null
if none
found
JiBXException
- if unable to create unmarshallerpublic java.lang.Object unmarshalOptionalElement() throws JiBXException
null
if end tag
rather than start tag seen
JiBXException
- on any error (possibly wrapping other exception)public java.lang.Object unmarshalElement(java.lang.Class clas) throws JiBXException
clas
- expected class of unmarshalled object
JiBXException
- on any error (possibly wrapping other exception)public java.lang.Object unmarshalElement() throws JiBXException
unmarshalElement
in interface IUnmarshallingContext
JiBXException
- on any error (possibly wrapping other exception)public void parsePastElement(java.lang.String ns, java.lang.String tag) throws JiBXException
ns
- namespace URI for expected element (may be null
or the empty string for the empty namespace)tag
- element name expected
JiBXException
- on any error (possible wrapping other exception)public java.lang.String getElementName() throws JiBXException
null
if not at a start
or end tag
JiBXException
- if error from parserpublic java.lang.String getElementNamespace() throws JiBXException
null
if not at a start
or end tag
JiBXException
- if error from parserpublic void throwStartTagException(java.lang.String msg) throws JiBXException
msg
- exception message text
JiBXException
- always thrownpublic void throwStartTagException(java.lang.String msg, java.lang.Exception ex) throws JiBXException
msg
- exception message textex
- nested exception
JiBXException
- always thrownpublic void throwException(java.lang.String msg) throws JiBXException
msg
- exception message text
JiBXException
- always thrownpublic void throwException(java.lang.String msg, java.lang.Exception ex) throws JiBXException
msg
- exception message textex
- nested exception
JiBXException
- always thrownpublic java.lang.Object unmarshalDocument(java.io.InputStream ins, java.lang.String enc) throws JiBXException
setDocument(java.io.InputStream, java.lang.String, java.lang.String, boolean)
were called, followed by unmarshalElement(java.lang.Class)
unmarshalDocument
in interface IUnmarshallingContext
ins
- stream supplying document dataenc
- document input encoding, or null
if to be
determined by parser
JiBXException
- if error creating parserpublic java.lang.Object unmarshalDocument(java.io.Reader rdr) throws JiBXException
setDocument(java.io.InputStream, java.lang.String, java.lang.String, boolean)
were called, followed by unmarshalElement(java.lang.Class)
unmarshalDocument
in interface IUnmarshallingContext
rdr
- reader supplying document data
JiBXException
- if error creating parserpublic java.lang.Object unmarshalDocument(java.io.InputStream ins, java.lang.String name, java.lang.String enc) throws JiBXException
setDocument(java.io.InputStream, java.lang.String, java.lang.String, boolean)
were called, followed by unmarshalElement(java.lang.Class)
unmarshalDocument
in interface IUnmarshallingContext
ins
- stream supplying document dataname
- document nameenc
- document input encoding, or null
if to be
determined by parser
JiBXException
- if error creating parserpublic java.lang.Object unmarshalDocument(java.io.Reader rdr, java.lang.String name) throws JiBXException
setDocument(java.io.InputStream, java.lang.String, java.lang.String, boolean)
were called, followed by unmarshalElement(java.lang.Class)
unmarshalDocument
in interface IUnmarshallingContext
rdr
- reader supplying document dataname
- document name
JiBXException
- if error creating parserpublic IBindingFactory getFactory()
public java.lang.String getDocumentName()
getDocumentName
in interface IUnmarshallingContext
null
if none)public java.lang.String getInputEncoding()
null
if unknown)public void setUserContext(java.lang.Object obj)
reset()
method,
so to make use of this you need to first call the appropriate version of
the setDocument()
method, then this method, and finally the
unmarshalElement(java.lang.Class)
method.
setUserContext
in interface IUnmarshallingContext
obj
- user context object, or null
if clearing existing
context objectgetUserContext()
public java.lang.Object getUserContext()
getUserContext
in interface IUnmarshallingContext
null
if no context object
setsetUserContext(Object)
public void pushObject(java.lang.Object obj)
pushObject
in interface IUnmarshallingContext
obj
- object being unmarshalledpublic void trackObject(java.lang.Object obj)
obj
- object being trackedpublic void pushTrackedObject(java.lang.Object obj)
obj
- object being unmarshalledpublic void popObject() throws JiBXException
popObject
in interface IUnmarshallingContext
JiBXException
- if no object on stackpublic int getStackDepth()
getStackDepth
in interface IUnmarshallingContext
public java.lang.Object getStackObject(int depth)
getStackObject
in interface IUnmarshallingContext
depth
- object depth in stack to be retrieved (must be in the range
of zero to the current depth minus one).
public java.lang.Object getStackTop()
getStackTop
in interface IUnmarshallingContext
null
if nonepublic int getActiveNamespaceCount()
public java.lang.String getActiveNamespaceUri(int index)
index
- index number of namespace to be returned
java.lang.IllegalArgumentException
- if invalid indexpublic java.lang.String getActiveNamespacePrefix(int index)
index
- stack position of namespace to be returned
java.lang.IllegalArgumentException
- if invalid indexpublic void skipElement() throws JiBXException
JiBXException
- on any error (possibly wrapping other exception)public int next() throws JiBXException
JiBXException
- on any error (possibly wrapping other exception)public int nextToken() throws JiBXException
JiBXException
- on any error (possibly wrapping other exception)public int currentEvent() throws JiBXException
JiBXException
- on any error (possibly wrapping other exception)public java.lang.String getName()
java.lang.IllegalStateException
- if not at a start or end tag (optional)public java.lang.String getNamespace()
java.lang.IllegalStateException
- if not at a start or end tag (optional)public java.lang.String getPrefix()
null
if none
java.lang.IllegalStateException
- if not at a start or end tag (optional)public int getAttributeCount()
-1
if not at START_ELEMENT
java.lang.IllegalStateException
- if not at a start tag (optional)public java.lang.String getAttributeName(int index)
index
- index number of attribute to be returned
java.lang.IllegalStateException
- if not at a start tag or invalid indexpublic java.lang.String getAttributeNamespace(int index)
index
- index number of attribute to be returned
java.lang.IllegalStateException
- if not at a start tag or invalid indexpublic java.lang.String getAttributePrefix(int index)
index
- index number of attribute to be returned
null
if none
java.lang.IllegalStateException
- if not at a start tag or invalid indexpublic java.lang.String getAttributeValue(int index)
index
- index number of attribute to be returned
java.lang.IllegalStateException
- if not at a start tag or invalid indexpublic int getNamespaceCount()
-1
if not at
START_ELEMENTpublic java.lang.String getNamespaceUri(int index)
index
- index number of declaration to be returned
java.lang.IllegalArgumentException
- if invalid indexpublic java.lang.String getNamespacePrefix(int index)
index
- index number of declaration to be returned
java.lang.IllegalArgumentException
- if invalid indexpublic java.lang.String getNamespaceUri(java.lang.String prefix)
prefix
- namespace prefix to be matched (null
for
default namespace)
public java.lang.String getText()
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |