libjibx-java-1.1.6a/ 0000755 0001750 0001750 00000000000 11023302622 014071 5 ustar moeller moeller libjibx-java-1.1.6a/build/ 0000755 0001750 0001750 00000000000 11023035622 015173 5 ustar moeller moeller libjibx-java-1.1.6a/build/extras/ 0000755 0001750 0001750 00000000000 11021525446 016507 5 ustar moeller moeller libjibx-java-1.1.6a/build/extras/org/ 0000755 0001750 0001750 00000000000 11021525446 017276 5 ustar moeller moeller libjibx-java-1.1.6a/build/extras/org/jibx/ 0000755 0001750 0001750 00000000000 11021525446 020232 5 ustar moeller moeller libjibx-java-1.1.6a/build/extras/org/jibx/extras/ 0000755 0001750 0001750 00000000000 11023035622 021532 5 ustar moeller moeller libjibx-java-1.1.6a/build/extras/org/jibx/extras/BindingSelector.java 0000644 0001750 0001750 00000020144 10071714102 025450 0 ustar moeller moeller /*
Copyright (c) 2003-2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.extras;
import java.io.OutputStream;
import java.io.Writer;
import org.jibx.runtime.BindingDirectory;
import org.jibx.runtime.IBindingFactory;
import org.jibx.runtime.IMarshallable;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.impl.MarshallingContext;
import org.jibx.runtime.impl.UnmarshallingContext;
/**
* Binding selector that supports versioned XML documents. This looks for a
* version attribute on the root element of the document, and selects the
* mapping to be used for unmarshalling based on the value. It also supports
* selecting the version for marshalling based on a supplied version argument
* value.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class BindingSelector
{
/** URI of version selection attribute. */
private final String m_attributeUri;
/** Name of version selection attribute. */
private final String m_attributeName;
/** Array of version names. */
private final String[] m_versionTexts;
/** Array of bindings corresponding to versions. */
private final String[] m_versionBindings;
/** Basic unmarshalling context used to determine document version. */
private final UnmarshallingContext m_context;
/** Stream for marshalling output. */
private OutputStream m_outputStream;
/** Encoding for output stream. */
private String m_outputEncoding;
/** Output writer for marshalling. */
private Writer m_outputWriter;
/** Indentation for marshalling. */
private int m_outputIndent;
/**
* Constructor.
*
* @param uri version selection attribute URI (null if none)
* @param name version selection attribute name
* @param versions array of version texts (first is default)
* @param bindings array of binding names corresponding to versions
*/
public BindingSelector(String uri, String name, String[] versions,
String[] bindings) {
m_attributeUri = uri;
m_attributeName = name;
m_versionTexts = versions;
m_versionBindings = bindings;
m_context = new UnmarshallingContext();
m_outputIndent = -1;
}
/**
* Get initial unmarshalling context. This gives access to the unmarshalling
* context used before the specific version is determined. The document
* information must be set for this context before calling {@link
* #unmarshalVersioned}.
*
* @return initial unmarshalling context
*/
public IUnmarshallingContext getContext() {
return m_context;
}
/**
* Set output stream and encoding.
*
* @param outs stream for document data output
* @param enc document output encoding, or null for default
*/
public void setOutput(OutputStream outs, String enc) {
m_outputStream = outs;
m_outputEncoding = enc;
}
/**
* Set output writer.
*
* @param outw writer for document data output
*/
public void setOutput(Writer outw) {
m_outputWriter = outw;
}
/**
* Set nesting indent spaces.
*
* @param indent number of spaces to indent per level, or disable
* indentation if negative
*/
public void setIndent(int indent) {
m_outputIndent = indent;
}
/**
* Marshal according to supplied version.
*
* @param obj root object to be marshalled
* @param version identifier for version to be used in marshalling
* @throws JiBXException if error in marshalling
*/
public void marshalVersioned(Object obj, String version)
throws JiBXException {
// look up version in defined list
String match = (version == null) ? m_versionTexts[0] : version;
for (int i = 0; i < m_versionTexts.length; i++) {
if (match.equals(m_versionTexts[i])) {
// version found, create marshaller for the associated binding
IBindingFactory fact = BindingDirectory.
getFactory(m_versionBindings[i], obj.getClass());
MarshallingContext context =
(MarshallingContext)fact.createMarshallingContext();
// configure marshaller for writing document
context.setIndent(m_outputIndent);
if (m_outputWriter == null) {
if (m_outputStream == null) {
throw new JiBXException("Output not configured");
} else {
context.setOutput(m_outputStream, m_outputEncoding);
}
} else {
context.setOutput(m_outputWriter);
}
// output object as document
context.startDocument(m_outputEncoding, null);
((IMarshallable)obj).marshal(context);
context.endDocument();
return;
}
}
// error if unknown version in document
throw new JiBXException("Unrecognized document version " + version);
}
/**
* Unmarshal according to document version.
*
* @param clas expected class mapped to root element of document (used only
* to look up the binding)
* @return root object unmarshalled from document
* @throws JiBXException if error in unmarshalling
*/
public Object unmarshalVersioned(Class clas) throws JiBXException {
// get the version attribute value (using first value as default)
m_context.toStart();
String version = m_context.attributeText(m_attributeUri,
m_attributeName, m_versionTexts[0]);
// look up version in defined list
for (int i = 0; i < m_versionTexts.length; i++) {
if (version.equals(m_versionTexts[i])) {
// version found, create unmarshaller for the associated binding
IBindingFactory fact = BindingDirectory.
getFactory(m_versionBindings[i], clas);
UnmarshallingContext context =
(UnmarshallingContext)fact.createUnmarshallingContext();
// return object unmarshalled using binding for document version
context.setFromContext(m_context);
return context.unmarshalElement();
}
}
// error if unknown version in document
throw new JiBXException("Unrecognized document version " + version);
}
} libjibx-java-1.1.6a/build/extras/org/jibx/extras/DiscardElementMapper.java 0000644 0001750 0001750 00000006026 10221060356 026432 0 ustar moeller moeller /*
Copyright (c) 2004-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.extras;
import org.jibx.runtime.IMarshaller;
import org.jibx.runtime.IMarshallingContext;
import org.jibx.runtime.IUnmarshaller;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.impl.UnmarshallingContext;
/**
*
Custom marshaller/unmarshaller for arbitrary ignored element. This ignores
* an element when unmarshalling, if one is present, and does nothing when
* marshalling.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class DiscardElementMapper implements IMarshaller, IUnmarshaller
{
/* (non-Javadoc)
* @see org.jibx.runtime.IMarshaller#isExtension(int)
*/
public boolean isExtension(int index) {
return false;
}
/* (non-Javadoc)
* @see org.jibx.runtime.IMarshaller#marshal(java.lang.Object,
* org.jibx.runtime.IMarshallingContext)
*/
public void marshal(Object obj, IMarshallingContext ictx) {}
/* (non-Javadoc)
* @see org.jibx.runtime.IUnmarshaller#isPresent(org.jibx.runtime.IUnmarshallingContext)
*/
public boolean isPresent(IUnmarshallingContext ctx) throws JiBXException {
return !ctx.isEnd();
}
/* (non-Javadoc)
* @see org.jibx.runtime.IUnmarshaller#unmarshal(java.lang.Object,
* org.jibx.runtime.IUnmarshallingContext)
*/
public Object unmarshal(Object obj, IUnmarshallingContext ictx)
throws JiBXException {
// just discard and return null
((UnmarshallingContext)ictx).skipElement();
return null;
}
} libjibx-java-1.1.6a/build/extras/org/jibx/extras/DiscardListMapper.java 0000644 0001750 0001750 00000006162 10221060356 025755 0 ustar moeller moeller /*
Copyright (c) 2004-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.extras;
import org.jibx.runtime.IMarshaller;
import org.jibx.runtime.IMarshallingContext;
import org.jibx.runtime.IUnmarshaller;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.impl.UnmarshallingContext;
/**
*
Custom marshaller/unmarshaller for arbitrary ignored content to end of
* element. This ignores all content to the end of the enclosing element when
* unmarshalling, and does nothing with marshalling.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class DiscardListMapper implements IMarshaller, IUnmarshaller
{
/* (non-Javadoc)
* @see org.jibx.runtime.IMarshaller#isExtension(int)
*/
public boolean isExtension(int index) {
return false;
}
/* (non-Javadoc)
* @see org.jibx.runtime.IMarshaller#marshal(java.lang.Object,
* org.jibx.runtime.IMarshallingContext)
*/
public void marshal(Object obj, IMarshallingContext ictx) {}
/* (non-Javadoc)
* @see org.jibx.runtime.IUnmarshaller#isPresent(org.jibx.runtime.IUnmarshallingContext)
*/
public boolean isPresent(IUnmarshallingContext ctx) throws JiBXException {
return !ctx.isEnd();
}
/* (non-Javadoc)
* @see org.jibx.runtime.IUnmarshaller#unmarshal(java.lang.Object,
* org.jibx.runtime.IUnmarshallingContext)
*/
public Object unmarshal(Object obj, IUnmarshallingContext ictx)
throws JiBXException {
// just discard all elements and return null
while (!ictx.isEnd()) {
((UnmarshallingContext)ictx).skipElement();
}
return null;
}
} libjibx-java-1.1.6a/build/extras/org/jibx/extras/DocumentComparator.java 0000644 0001750 0001750 00000026264 10767277422 026241 0 ustar moeller moeller /*
Copyright (c) 2003-2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.extras;
import java.io.IOException;
import java.io.PrintStream;
import java.io.Reader;
import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.XmlPullParserException;
import org.xmlpull.v1.XmlPullParserFactory;
/**
* XML document comparator. This uses XMLPull parsers to read a pair of
* documents in parallel, comparing the streams of components seen from the two
* documents. The comparison ignores differences in whitespace separating
* elements, but treats whitespace as significant within elements with only
* character data content.
*
* @author Dennis M. Sosnoski
*/
public class DocumentComparator
{
/** Parser for first document. */
protected XmlPullParser m_parserA;
/** Parser for second document. */
protected XmlPullParser m_parserB;
/** Print stream for reporting differences. */
protected PrintStream m_differencePrint;
/**
* Constructor. Builds the actual parser.
*
* @param print print stream for reporting differences
* @throws XmlPullParserException on error creating parsers
*/
public DocumentComparator(PrintStream print) throws XmlPullParserException {
XmlPullParserFactory factory = XmlPullParserFactory.newInstance();
factory.setNamespaceAware(true);
m_parserA = factory.newPullParser();
m_parserB = factory.newPullParser();
m_differencePrint = print;
}
/**
* Build parse input position description.
*
* @param parser for which to build description
* @return text description of current parse position
*/
protected String buildPositionString(XmlPullParser parser) {
return " line " + parser.getLineNumber() + ", col " +
parser.getColumnNumber();
}
/**
* Build name string.
*
* @param ns namespace URI
* @param name local name
* @return printable names string
*/
protected String buildName(String ns, String name) {
if ("".equals(ns)) {
return name;
} else {
return "{" + ns + '}' + name;
}
}
/**
* Prints error description text. The generated text include position
* information from both documents.
*
* @param msg error message text
*/
protected void printError(String msg) {
if (m_differencePrint != null) {
m_differencePrint.println(msg + " - from " +
buildPositionString(m_parserA) + " to " +
buildPositionString(m_parserB));
}
}
/**
* Verifies that the attributes on the current start tags match. Any
* mismatches are printed immediately.
*
* @return true if the attributes match, false if
* not
*/
protected boolean matchAttributes() {
int counta = m_parserA.getAttributeCount();
int countb = m_parserB.getAttributeCount();
boolean[] flags = new boolean[countb];
boolean match = true;
for (int i = 0; i < counta; i++) {
String name = m_parserA.getAttributeName(i);
String ns = m_parserA.getAttributeNamespace(i);
String value = m_parserA.getAttributeValue(i);
boolean found = false;
for (int j = 0; j < countb; j++) {
if (name.equals(m_parserB.getAttributeName(j)) &&
ns.equals(m_parserB.getAttributeNamespace(j))) {
flags[j] = true;
if (!value.equals(m_parserB.getAttributeValue(j))) {
if (match) {
printError("Attribute mismatch");
match = false;
}
m_differencePrint.println(" attribute " +
buildName(ns, name) + " value '" + value +
"' != '" + m_parserB.getAttributeValue(j) + '\'');
}
found = true;
break;
}
}
if (!found) {
if (match) {
printError("Attribute mismatch");
match = false;
}
m_differencePrint.println(" attribute " +
buildName(ns, name) + "=\"" + value +
"\" is missing from second document");
}
}
for (int i = 0; i < countb; i++) {
if (!flags[i]) {
if (match) {
printError("Attribute mismatch");
match = false;
}
m_differencePrint.println(" attribute " +
buildName(m_parserB.getAttributeNamespace(i),
m_parserB.getAttributeName(i)) +
" is missing from first document");
}
}
return match;
}
/**
* Check if two text strings match, ignoring leading and trailing spaces.
* Any mismatch is printed immediately, with the supplied lead text.
*
* @param texta
* @param textb
* @param lead error text lead
* @return true if the texts match, false if
* not
*/
protected boolean matchText(String texta, String textb, String lead) {
if (texta.trim().equals(textb.trim())) {
return true;
} else {
printError(lead);
if (m_differencePrint != null) {
m_differencePrint.println(" \"" + texta +
"\" (length " + texta.length() + " vs. \"" +
textb + "\" (length " + textb.length() + ')');
}
return false;
}
}
/**
* Verifies that the current start or end tag names match.
*
* @return true if the names match, false if not
*/
protected boolean matchNames() {
return m_parserA.getName().equals(m_parserB.getName()) &&
m_parserA.getNamespace().equals(m_parserB.getNamespace());
}
/**
* Compares a pair of documents by reading them in parallel from a pair of
* parsers. The comparison ignores differences in whitespace separating
* elements, but treats whitespace as significant within elements with only
* character data content.
*
* @param rdra reader for first document to be compared
* @param rdrb reader for second document to be compared
* @return true if the documents are the same,
* false if they're different
*/
public boolean compare(Reader rdra, Reader rdrb) {
try {
// set the documents and initialize
m_parserA.setInput(rdra);
m_parserB.setInput(rdrb);
boolean content = false;
String texta = "";
String textb = "";
boolean same = true;
while (true) {
// start by collecting and moving past text content
if (m_parserA.getEventType() == XmlPullParser.TEXT) {
texta = m_parserA.getText();
m_parserA.next();
}
if (m_parserB.getEventType() == XmlPullParser.TEXT) {
textb = m_parserB.getText();
m_parserB.next();
}
// now check actual tag state
int typea = m_parserA.getEventType();
int typeb = m_parserB.getEventType();
if (typea != typeb) {
printError("Different document structure");
return false;
} else if (typea == XmlPullParser.START_TAG) {
// compare start tags, attributes, and prior text
content = true;
if (!matchNames()) {
printError("Different start tags");
return false;
} else {
if (!matchAttributes()) {
same = false;
}
if (!matchText(texta, textb,
"Different text content between elements")) {
same = false;
}
}
texta = textb = "";
} else if (typea == XmlPullParser.END_TAG) {
// compare end tags and prior text
if (!matchNames()) {
printError("Different end tags");
return false;
}
if (content) {
if (!matchText(texta, textb, "Different text content")) {
same = false;
}
content = false;
} else {
if (!matchText(texta, textb,
"Different text content between elements")) {
same = false;
}
}
texta = textb = "";
} else if (typea == XmlPullParser.END_DOCUMENT) {
return same;
}
// advance both parsers to next component
m_parserA.next();
m_parserB.next();
}
} catch (IOException ex) {
if (m_differencePrint != null) {
ex.printStackTrace(m_differencePrint);
}
return false;
} catch (XmlPullParserException ex) {
if (m_differencePrint != null) {
ex.printStackTrace(m_differencePrint);
}
return false;
}
}
} libjibx-java-1.1.6a/build/extras/org/jibx/extras/DocumentModelMapperBase.java 0000644 0001750 0001750 00000011775 10434260002 027104 0 ustar moeller moeller /*
Copyright (c) 2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.extras;
import org.jibx.runtime.IXMLReader;
import org.jibx.runtime.IXMLWriter;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.impl.UnmarshallingContext;
/**
*
Base implementation for custom marshaller/unmarshallers to any document
* model representation. This class just provides a few basic operations that
* are used by the representation-specific subclasses.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class DocumentModelMapperBase
{
/** Fixed XML namespace. */
public static final String XML_NAMESPACE =
"http://www.w3.org/XML/1998/namespace";
/** Fixed XML namespace namespace. */
public static final String XMLNS_NAMESPACE =
"http://www.w3.org/2000/xmlns/";
/** Writer for direct output as XML. */
protected IXMLWriter m_xmlWriter;
/** Context being used for unmarshalling. */
protected UnmarshallingContext m_unmarshalContext;
/**
* Get namespace URI for index.
*
* @param index namespace index to look up
* @return uri namespace URI at index position
*/
protected String getNamespaceUri(int index) {
String[] uris = m_xmlWriter.getNamespaces();
if (index < uris.length) {
return uris[index];
} else {
index -= uris.length;
String[][] uriss = m_xmlWriter.getExtensionNamespaces();
if (uriss != null) {
for (int i = 0; i < uriss.length; i++) {
uris = uriss[i];
if (index < uris.length) {
return uris[index];
} else {
index -= uris.length;
}
}
}
}
return null;
}
/**
* Get next namespace index.
*
* @return next namespace index
*/
protected int getNextNamespaceIndex() {
int count = m_xmlWriter.getNamespaces().length;
String[][] uriss = m_xmlWriter.getExtensionNamespaces();
if (uriss != null) {
for (int i = 0; i < uriss.length; i++) {
count += uriss[i].length;
}
}
return count;
}
/**
* Accumulate text content. This consolidates consecutive text and entities
* to a single string.
*
* @return consolidated text string
* @exception JiBXException on error in unmarshalling
*/
protected String accumulateText() throws JiBXException {
String text = m_unmarshalContext.getText();
StringBuffer buff = null;
while (true) {
int cev = m_unmarshalContext.nextToken();
if (cev == IXMLReader.TEXT ||
(cev == IXMLReader.ENTITY_REF &&
m_unmarshalContext.getText() != null)) {
if (buff == null) {
buff = new StringBuffer(text);
}
buff.append(m_unmarshalContext.getText());
} else {
break;
}
}
if (buff == null) {
return text;
} else {
return buff.toString();
}
}
/**
* Check if a character is a space character.
*
* @param chr character to be checked
* @return true if whitespace, false if not
*/
protected boolean isWhitespace(char chr) {
if (chr <= 0x20) {
return chr == 0x20 || chr == 0x09 || chr == 0x0A || chr == 0x0D;
} else {
return false;
}
}
} libjibx-java-1.1.6a/build/extras/org/jibx/extras/Dom4JElementMapper.java 0000644 0001750 0001750 00000014460 10071714104 025777 0 ustar moeller moeller /*
Copyright (c) 2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.extras;
import java.io.IOException;
import org.dom4j.Element;
import org.jibx.runtime.IAliasable;
import org.jibx.runtime.IMarshaller;
import org.jibx.runtime.IMarshallingContext;
import org.jibx.runtime.IUnmarshaller;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.impl.UnmarshallingContext;
/**
*
Custom element marshaller/unmarshaller to dom4j representation. This
* allows you to mix data binding and document model representations for XML
* within the same application. You simply use this marshaller/unmarshaller with
* a linked object type of org.dom4j.Element (the actual runtime
* type - the declared type is ignored and can be anything). If a name is
* supplied on a reference that element name will always be matched when
* unmarshalling but will be ignored when marshalling (with the actual dom4j
* element name used). If no name is supplied this will unmarshal a single
* element with any name.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class Dom4JElementMapper extends Dom4JMapperBase
implements IMarshaller, IUnmarshaller, IAliasable
{
/** Root element namespace URI. */
private final String m_uri;
/** Namespace URI index in binding. */
private final int m_index;
/** Root element name. */
private final String m_name;
/**
* Default constructor.
*/
public Dom4JElementMapper() {
m_uri = null;
m_index = -1;
m_name = null;
}
/**
* Aliased constructor. This takes a name definition for the element. It'll
* be used by JiBX when a name is supplied by the mapping which references
* this custom marshaller/unmarshaller.
*
* @param uri namespace URI for the top-level element
* @param index namespace index corresponding to the defined URI within the
* marshalling context definitions
* @param name local name for the top-level element
*/
public Dom4JElementMapper(String uri, int index, String name) {
// save the simple values
m_uri = uri;
m_index = index;
m_name = name;
}
/* (non-Javadoc)
* @see org.jibx.runtime.IMarshaller#isExtension(int)
*/
public boolean isExtension(int index) {
return false;
}
/* (non-Javadoc)
* @see org.jibx.runtime.IMarshaller#marshal(java.lang.Object,
* org.jibx.runtime.IMarshallingContext)
*/
public void marshal(Object obj, IMarshallingContext ictx)
throws JiBXException {
// make sure the parameters are as expected
if (!(obj instanceof Element)) {
throw new JiBXException("Mapped object not an org.dom4j.Element");
} else {
try {
// marshal element and all content with only leading indentation
m_xmlWriter = ictx.getXmlWriter();
m_xmlWriter.indent();
int indent = ictx.getIndent();
ictx.setIndent(-1);
m_defaultNamespaceURI = null;
marshalElement((Element)obj);
ictx.setIndent(indent);
} catch (IOException e) {
throw new JiBXException("Error writing to document", e);
}
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IUnmarshaller#isPresent(org.jibx.runtime.IUnmarshallingContext)
*/
public boolean isPresent(IUnmarshallingContext ctx) throws JiBXException {
if (m_name == null) {
if (!(ctx instanceof UnmarshallingContext)) {
throw new JiBXException
("Unmarshalling context not of expected type");
} else {
return !((UnmarshallingContext)ctx).isEnd();
}
} else {
return ctx.isAt(m_uri, m_name);
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IUnmarshaller#unmarshal(java.lang.Object,
* org.jibx.runtime.IUnmarshallingContext)
*/
public Object unmarshal(Object obj, IUnmarshallingContext ictx)
throws JiBXException {
// verify the entry conditions
if (!(ictx instanceof UnmarshallingContext)) {
throw new JiBXException
("Unmarshalling context not of expected type");
} else if (m_name != null && !ictx.isAt(m_uri, m_name)) {
((UnmarshallingContext)ictx).throwStartTagNameError(m_uri, m_name);
}
// position to element start tag
m_unmarshalContext = (UnmarshallingContext)ictx;
m_unmarshalContext.toStart();
// unmarshal element to document model
try {
return unmarshalElement();
} catch (IOException e) {
throw new JiBXException("Error reading from document", e);
}
}
} libjibx-java-1.1.6a/build/extras/org/jibx/extras/Dom4JListMapper.java 0000644 0001750 0001750 00000012656 10434260002 025322 0 ustar moeller moeller /*
Copyright (c) 2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.extras;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import org.jibx.runtime.IMarshaller;
import org.jibx.runtime.IMarshallingContext;
import org.jibx.runtime.IUnmarshaller;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.IXMLReader;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.impl.UnmarshallingContext;
/**
*
Custom content list marshaller/unmarshaller to dom4j representation. This
* allows you to mix data binding and document model representations for XML
* within the same application. You simply use this marshaller/unmarshaller with
* a linked object type that implements java.util.List (the actual
* runtime type - the declared type is ignored and can be anything). When
* unmarshalling it will create an instance of java.util.ArrayList
* if a list is not passed in and any content is present, then return all the
* content up to the close tag for the enclosing element in the list. When
* marshalling, it will simply write out any content directly.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class Dom4JListMapper extends Dom4JMapperBase
implements IMarshaller, IUnmarshaller
{
/* (non-Javadoc)
* @see org.jibx.runtime.IMarshaller#isExtension(int)
*/
public boolean isExtension(int index) {
return false;
}
/* (non-Javadoc)
* @see org.jibx.runtime.IMarshaller#marshal(java.lang.Object,
* org.jibx.runtime.IMarshallingContext)
*/
public void marshal(Object obj, IMarshallingContext ictx)
throws JiBXException {
// make sure the parameters are as expected
if (!(obj instanceof List)) {
throw new JiBXException("Mapped object not a java.util.List");
} else {
try {
// marshal all content with no indentation
m_xmlWriter = ictx.getXmlWriter();
int indent = ictx.getIndent();
ictx.setIndent(-1);
m_defaultNamespaceURI = null;
marshalContent((List)obj);
ictx.setIndent(indent);
} catch (IOException e) {
throw new JiBXException("Error writing to document", e);
}
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IUnmarshaller#isPresent(org.jibx.runtime.IUnmarshallingContext)
*/
public boolean isPresent(IUnmarshallingContext ctx) throws JiBXException {
if (!(ctx instanceof UnmarshallingContext)) {
throw new JiBXException
("Unmarshalling context not of expected type");
} else {
return ((UnmarshallingContext)ctx).currentEvent() !=
IXMLReader.END_TAG;
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IUnmarshaller#unmarshal(java.lang.Object,
* org.jibx.runtime.IUnmarshallingContext)
*/
public Object unmarshal(Object obj, IUnmarshallingContext ictx)
throws JiBXException {
// verify the entry conditions
boolean created = false;
List list = null;
if (obj == null) {
list = new ArrayList();
created = true;
} else if (obj instanceof List) {
list = (List)obj;
} else {
throw new JiBXException("Supplied object is not a java.util.List");
}
if (!(ictx instanceof UnmarshallingContext)) {
throw new JiBXException
("Unmarshalling context not of expected type");
}
// unmarshal content to document model
m_unmarshalContext = (UnmarshallingContext)ictx;
try {
unmarshalContent(list);
if (created && list.isEmpty()) {
return null;
} else {
return list;
}
} catch (IOException e) {
throw new JiBXException("Error reading from document", e);
}
}
} libjibx-java-1.1.6a/build/extras/org/jibx/extras/Dom4JMapperBase.java 0000644 0001750 0001750 00000033364 10434260002 025260 0 ustar moeller moeller /*
Copyright (c) 2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.extras;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import org.dom4j.Attribute;
import org.dom4j.DocumentFactory;
import org.dom4j.Element;
import org.dom4j.Namespace;
import org.dom4j.Node;
import org.dom4j.ProcessingInstruction;
import org.dom4j.QName;
import org.jibx.runtime.IXMLReader;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.impl.UnmarshallingContext;
/**
*
Base implementation for custom marshaller/unmarshallers to dom4j
* representation. This provides the basic code used for both single element and
* content list handling.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class Dom4JMapperBase extends DocumentModelMapperBase
{
/** dom4j component construction factory. */
private static DocumentFactory s_factory = DocumentFactory.getInstance();
/** Current default namespace URI (null if not determined). */
protected String m_defaultNamespaceURI;
/** Current default namespace index. */
protected int m_defaultNamespaceIndex;
/**
* Get index number for declared namespace.
*
* @param ns namespace of interest
* @return namespace index number, or -1 if not declared or
* masked
*/
private int findNamespaceIndex(Namespace ns) {
if (Namespace.NO_NAMESPACE.equals(ns)) {
return 0;
} else if (Namespace.XML_NAMESPACE.equals(ns)) {
return 1;
} else {
String prefix = ns.getPrefix();
if (prefix == null || prefix.length() == 0) {
if (m_defaultNamespaceURI == null) {
int index = m_xmlWriter.getPrefixIndex("");
if (index >= 0) {
m_defaultNamespaceURI = getNamespaceUri(index);
m_defaultNamespaceIndex = index;
if (m_defaultNamespaceURI.equals(ns.getURI())) {
return index;
} else {
return -1;
}
} else {
return -1;
}
} else {
return m_defaultNamespaceURI.equals(ns.getURI()) ?
m_defaultNamespaceIndex : -1;
}
} else {
int index = m_xmlWriter.getPrefixIndex(prefix);
if (index >= 0) {
return getNamespaceUri(index).equals(ns.getURI()) ?
index : -1;
} else {
return -1;
}
}
}
}
/**
* Marshal content list.
*
* @param content list of content items to marshal
* @exception JiBXException on error in marshalling
* @exception IOException on error writing to output
*/
protected void marshalContent(List content)
throws JiBXException, IOException {
int size = content.size();
for (int i = 0; i < size; i++) {
Node node = (Node)content.get(i);
switch (node.getNodeType()) {
case Node.CDATA_SECTION_NODE:
m_xmlWriter.writeCData(node.getText());
break;
case Node.COMMENT_NODE:
m_xmlWriter.writeComment(node.getText());
break;
case Node.ELEMENT_NODE:
marshalElement((Element)node);
break;
case Node.ENTITY_REFERENCE_NODE:
m_xmlWriter.writeEntityRef(node.getName());
break;
case Node.PROCESSING_INSTRUCTION_NODE:
m_xmlWriter.writePI(((ProcessingInstruction)node).
getTarget(), node.getText());
break;
case Node.TEXT_NODE:
m_xmlWriter.writeTextContent(node.getText());
break;
default:
break;
}
}
}
/**
* Marshal element with all attributes and content.
*
* @param element element to be marshalled
* @exception JiBXException on error in marshalling
* @exception IOException on error writing to output
*/
protected void marshalElement(Element element)
throws JiBXException, IOException {
// accumulate all needed namespace declarations
int size = element.nodeCount();
Namespace ns = element.getNamespace();
int nsi = findNamespaceIndex(ns);
ArrayList nss = null;
boolean hascontent = false;
int defind = -1;
String defuri = null;
for (int i = 0; i < size; i++) {
Node node = element.node(i);
if (node instanceof Namespace) {
Namespace dns = (Namespace)node;
if (findNamespaceIndex(dns) < 0) {
if (nss == null) {
nss = new ArrayList();
}
nss.add(dns);
String prefix = dns.getPrefix();
if (prefix == null || prefix.length() == 0) {
defind = nss.size() - 1;
defuri = dns.getURI();
}
}
} else {
hascontent = true;
}
}
// check for namespace declarations required
String[] uris = null;
if (nss == null) {
m_xmlWriter.startTagOpen(nsi, element.getName());
} else {
int base = getNextNamespaceIndex();
if (defind >= 0) {
m_defaultNamespaceIndex = base + defind;
m_defaultNamespaceURI = defuri;
}
uris = new String[nss.size()];
int[] nums = new int[nss.size()];
String[] prefs = new String[nss.size()];
for (int i = 0; i < uris.length; i++) {
Namespace addns = (Namespace)nss.get(i);
uris[i] = addns.getURI();
nums[i] = base + i;
prefs[i] = addns.getPrefix();
if (nsi < 0 && ns.equals(addns)) {
nsi = base + i;
}
}
m_xmlWriter.pushExtensionNamespaces(uris);
m_xmlWriter.startTagNamespaces(nsi, element.getName(), nums, prefs);
if (defind >= 0) {
m_defaultNamespaceIndex = defind;
m_defaultNamespaceURI = defuri;
}
}
// add attributes if present
if (element.attributeCount() > 0) {
for (int i = 0; i < element.attributeCount(); i++) {
Attribute attr = element.attribute(i);
int index = findNamespaceIndex(attr.getNamespace());
m_xmlWriter.addAttribute(index, attr.getName(),
attr.getValue());
}
}
// check for content present
if (hascontent) {
m_xmlWriter.closeStartTag();
marshalContent(element.content());
m_xmlWriter.endTag(nsi, element.getName());
} else {
m_xmlWriter.closeEmptyTag();
}
// pop namespaces if defined by element
if (nss != null) {
m_xmlWriter.popExtensionNamespaces();
if (defind >= 0) {
m_defaultNamespaceURI = null;
}
}
}
/**
* Unmarshal element content. This unmarshals everything up to the
* containing element close tag, adding each component to the content list
* supplied. On return, the parse position will always be at an END_TAG.
*
* @param content list for unmarshalled content
* @exception JiBXException on error in unmarshalling
* @exception IOException on error reading input
*/
protected void unmarshalContent(List content)
throws JiBXException, IOException {
// loop until end of containing element found
loop: while (true) {
int cev = m_unmarshalContext.currentEvent();
switch (cev) {
case IXMLReader.CDSECT:
content.add(s_factory.
createCDATA(m_unmarshalContext.getText()));
break;
case IXMLReader.COMMENT:
content.add(s_factory.
createComment(m_unmarshalContext.getText()));
break;
case IXMLReader.END_TAG:
break loop;
case IXMLReader.ENTITY_REF:
if (m_unmarshalContext.getText() == null) {
content.add(s_factory.
createEntity(m_unmarshalContext.getName(), null));
break;
} else {
content.add(s_factory.createText(accumulateText()));
continue loop;
}
case IXMLReader.PROCESSING_INSTRUCTION:
{
String text = m_unmarshalContext.getText();
int index = 0;
while (++index < text.length() &&
!isWhitespace(text.charAt(index)));
if (index < text.length()) {
String target = text.substring(0, index);
while (++index < text.length() &&
isWhitespace(text.charAt(index)));
String data = text.substring(index);
content.add(s_factory.
createProcessingInstruction(target, data));
} else {
content.add(s_factory.
createProcessingInstruction(text, ""));
}
}
break;
case IXMLReader.START_TAG:
content.add(unmarshalElement());
continue loop;
case IXMLReader.TEXT:
content.add(s_factory.createText(accumulateText()));
continue loop;
}
m_unmarshalContext.nextToken();
}
}
/**
* Unmarshal element with all attributes and content. This must be called
* with the unmarshalling context positioned at a START_TAG event.
*
* @return unmarshalled element
* @exception JiBXException on error in unmarshalling
* @exception IOException on error reading input
*/
protected Element unmarshalElement() throws JiBXException, IOException {
// start by creating the actual element
QName qname = QName.get(m_unmarshalContext.getName(),
m_unmarshalContext.getPrefix(), m_unmarshalContext.getNamespace());
Element element = s_factory.createElement(qname);
// add all namespace declarations to element
int ncount = m_unmarshalContext.getNamespaceCount();
for (int i = 0; i < ncount; i++) {
String prefix = m_unmarshalContext.getNamespacePrefix(i);
String uri = m_unmarshalContext.getNamespaceUri(i);
element.addNamespace(prefix, uri);
}
// add all attributes to element
int acount = m_unmarshalContext.getAttributeCount();
for (int i = 0; i < acount; i++) {
String prefix = m_unmarshalContext.getAttributePrefix(i);
String uri = m_unmarshalContext.getAttributeNamespace(i);
String name = m_unmarshalContext.getAttributeName(i);
String value = m_unmarshalContext.getAttributeValue(i);
qname = QName.get(name, prefix, uri);
element.addAttribute(qname, value);
}
// add all content to element
int event = m_unmarshalContext.nextToken();
if (event != IXMLReader.END_TAG) {
unmarshalContent(element.content());
}
m_unmarshalContext.nextToken();
return element;
}
} libjibx-java-1.1.6a/build/extras/org/jibx/extras/DomElementMapper.java 0000644 0001750 0001750 00000014715 10071714110 025601 0 ustar moeller moeller /*
Copyright (c) 2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.extras;
import java.io.IOException;
import org.jibx.runtime.IAliasable;
import org.jibx.runtime.IMarshaller;
import org.jibx.runtime.IMarshallingContext;
import org.jibx.runtime.IUnmarshaller;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.impl.UnmarshallingContext;
import org.w3c.dom.Element;
/**
*
Custom element marshaller/unmarshaller to DOM representation. This allows
* you to mix data binding and document model representations for XML within the
* same application. You simply use this marshaller/unmarshaller with a linked
* object of type org.w3c.dom.Element (the actual runtime type -
* the declared type is ignored and can be anything). If a name is supplied on a
* reference that element name will always be matched when unmarshalling but
* will be ignored when marshalling (with the actual DOM element name used). If
* no name is supplied this will unmarshal a single element with any name.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class DomElementMapper extends DomMapperBase
implements IMarshaller, IUnmarshaller, IAliasable
{
/** Root element namespace URI. */
private final String m_uri;
/** Namespace URI index in binding. */
private final int m_index;
/** Root element name. */
private final String m_name;
/**
* Default constructor.
*
* @throws JiBXException on error creating document
*/
public DomElementMapper() throws JiBXException {
m_uri = null;
m_index = -1;
m_name = null;
}
/**
* Aliased constructor. This takes a name definition for the element. It'll
* be used by JiBX when a name is supplied by the mapping which references
* this custom marshaller/unmarshaller.
*
* @param uri namespace URI for the top-level element
* @param index namespace index corresponding to the defined URI within the
* marshalling context definitions
* @param name local name for the top-level element
* @throws JiBXException on error creating document
*/
public DomElementMapper(String uri, int index, String name)
throws JiBXException {
// save the simple values
m_uri = uri;
m_index = index;
m_name = name;
}
/* (non-Javadoc)
* @see org.jibx.runtime.IMarshaller#isExtension(int)
*/
public boolean isExtension(int index) {
return false;
}
/* (non-Javadoc)
* @see org.jibx.runtime.IMarshaller#marshal(java.lang.Object,
* org.jibx.runtime.IMarshallingContext)
*/
public void marshal(Object obj, IMarshallingContext ictx)
throws JiBXException {
// make sure the parameters are as expected
if (!(obj instanceof Element)) {
throw new JiBXException("Mapped object not an org.w3c.dom.Element");
} else {
try {
// marshal element and all content with only leading indentation
m_xmlWriter = ictx.getXmlWriter();
m_xmlWriter.indent();
int indent = ictx.getIndent();
ictx.setIndent(-1);
m_defaultNamespaceURI = null;
marshalElement((Element)obj);
ictx.setIndent(indent);
} catch (IOException e) {
throw new JiBXException("Error writing to document", e);
}
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IUnmarshaller#isPresent(org.jibx.runtime.IUnmarshallingContext)
*/
public boolean isPresent(IUnmarshallingContext ctx) throws JiBXException {
if (m_name == null) {
if (!(ctx instanceof UnmarshallingContext)) {
throw new JiBXException
("Unmarshalling context not of expected type");
} else {
return !((UnmarshallingContext)ctx).isEnd();
}
} else {
return ctx.isAt(m_uri, m_name);
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IUnmarshaller#unmarshal(java.lang.Object,
* org.jibx.runtime.IUnmarshallingContext)
*/
public Object unmarshal(Object obj, IUnmarshallingContext ictx)
throws JiBXException {
// verify the entry conditions
if (!(ictx instanceof UnmarshallingContext)) {
throw new JiBXException
("Unmarshalling context not of expected type");
} else if (m_name != null && !ictx.isAt(m_uri, m_name)) {
((UnmarshallingContext)ictx).throwStartTagNameError(m_uri, m_name);
}
// position to element start tag
m_unmarshalContext = (UnmarshallingContext)ictx;
m_unmarshalContext.toStart();
// unmarshal element to document model
try {
return unmarshalElement();
} catch (IOException e) {
throw new JiBXException("Error reading from document", e);
}
}
} libjibx-java-1.1.6a/build/extras/org/jibx/extras/DomFragmentMapper.java 0000644 0001750 0001750 00000013437 10434260002 025752 0 ustar moeller moeller /*
Copyright (c) 2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.extras;
import java.io.IOException;
import org.jibx.runtime.IMarshaller;
import org.jibx.runtime.IMarshallingContext;
import org.jibx.runtime.IUnmarshaller;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.IXMLReader;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.impl.UnmarshallingContext;
import org.w3c.dom.DocumentFragment;
import org.w3c.dom.Node;
/**
*
Custom content list marshaller/unmarshaller to DOM representation. This
* allows you to mix data binding and document model representations for XML
* within the same application. You simply use this marshaller/unmarshaller with
* a linked object type of org.w3c.dom.DocumentFragment (the actual
* runtime type - the declared type is ignored and can be anything). When
* unmarshalling it will create a fragment to hold any content up to the close
* tag for the enclosing element in the list. When marshalling, it will simply
* write out any content directly.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class DomFragmentMapper extends DomMapperBase
implements IMarshaller, IUnmarshaller
{
/**
* Default constructor.
*
* @throws JiBXException on configuration error
*/
public DomFragmentMapper() throws JiBXException {
super();
}
/* (non-Javadoc)
* @see org.jibx.runtime.IMarshaller#isExtension(int)
*/
public boolean isExtension(int index) {
return false;
}
/* (non-Javadoc)
* @see org.jibx.runtime.IMarshaller#marshal(java.lang.Object,
* org.jibx.runtime.IMarshallingContext)
*/
public void marshal(Object obj, IMarshallingContext ictx)
throws JiBXException {
// make sure the parameters are as expected
if (!(obj instanceof DocumentFragment)) {
throw new JiBXException
("Mapped object not an org.w3c.dom.DocumentFragment");
} else {
try {
// marshal document fragment with no indentation
m_xmlWriter = ictx.getXmlWriter();
int indent = ictx.getIndent();
ictx.setIndent(-1);
m_defaultNamespaceURI = null;
marshalContent(((DocumentFragment)obj).getChildNodes());
ictx.setIndent(indent);
} catch (IOException e) {
throw new JiBXException("Error writing to document", e);
}
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IUnmarshaller#isPresent(org.jibx.runtime.IUnmarshallingContext)
*/
public boolean isPresent(IUnmarshallingContext ctx) throws JiBXException {
if (!(ctx instanceof UnmarshallingContext)) {
throw new JiBXException
("Unmarshalling context not of expected type");
} else {
return ((UnmarshallingContext)ctx).currentEvent() !=
IXMLReader.END_TAG;
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IUnmarshaller#unmarshal(java.lang.Object,
* org.jibx.runtime.IUnmarshallingContext)
*/
public Object unmarshal(Object obj, IUnmarshallingContext ictx)
throws JiBXException {
// verify the entry conditions
boolean created = false;
DocumentFragment frag = null;
if (obj == null) {
frag = m_document.createDocumentFragment();
created = true;
} else if (obj instanceof DocumentFragment) {
frag = (DocumentFragment)obj;
} else {
throw new JiBXException
("Supplied object is not an org.w3c.dom.DocumentFragment");
}
if (!(ictx instanceof UnmarshallingContext)) {
throw new JiBXException
("Unmarshalling context not of expected type");
}
// unmarshal content to document model
m_unmarshalContext = (UnmarshallingContext)ictx;
try {
Node node;
while ((node = unmarshalNode()) != null) {
frag.appendChild(node);
}
if (created && !frag.hasChildNodes()) {
return null;
} else {
return frag;
}
} catch (IOException e) {
throw new JiBXException("Error reading from document", e);
}
}
} libjibx-java-1.1.6a/build/extras/org/jibx/extras/DomListMapper.java 0000644 0001750 0001750 00000014140 10434260002 025112 0 ustar moeller moeller /*
Copyright (c) 2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.extras;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import org.jibx.runtime.IMarshaller;
import org.jibx.runtime.IMarshallingContext;
import org.jibx.runtime.IUnmarshaller;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.IXMLReader;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.impl.UnmarshallingContext;
import org.w3c.dom.Node;
/**
*
Custom content list marshaller/unmarshaller to DOM representation. This
* allows you to mix data binding and document model representations for XML
* within the same application. You simply use this marshaller/unmarshaller with
* a linked object type that implements java.util.List (the actual
* runtime type - the declared type is ignored and can be anything). When
* unmarshalling it will create an instance of java.util.ArrayList
* if a list is not passed in and any content is present, then return all the
* content up to the close tag for the enclosing element in the list. When
* marshalling, it will simply write out any content directly.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class DomListMapper extends DomMapperBase
implements IMarshaller, IUnmarshaller
{
/**
* Default constructor.
*
* @throws JiBXException on configuration error
*/
public DomListMapper() throws JiBXException {
super();
}
/* (non-Javadoc)
* @see org.jibx.runtime.IMarshaller#isExtension(int)
*/
public boolean isExtension(int index) {
return false;
}
/* (non-Javadoc)
* @see org.jibx.runtime.IMarshaller#marshal(java.lang.Object,
* org.jibx.runtime.IMarshallingContext)
*/
public void marshal(Object obj, IMarshallingContext ictx)
throws JiBXException {
// make sure the parameters are as expected
if (!(obj instanceof List)) {
throw new JiBXException("Mapped object not a java.util.List");
} else {
try {
// marshal content list with no indentation
m_xmlWriter = ictx.getXmlWriter();
int indent = ictx.getIndent();
ictx.setIndent(-1);
m_defaultNamespaceURI = null;
for (Iterator iter = ((List)obj).iterator(); iter.hasNext();) {
Object item = iter.next();
if (item instanceof Node) {
marshalNode((Node)item);
} else {
throw new JiBXException
("List item is not an org.w3c.dom.Node");
}
}
ictx.setIndent(indent);
} catch (IOException e) {
throw new JiBXException("Error writing to document", e);
}
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IUnmarshaller#isPresent(org.jibx.runtime.IUnmarshallingContext)
*/
public boolean isPresent(IUnmarshallingContext ctx) throws JiBXException {
if (!(ctx instanceof UnmarshallingContext)) {
throw new JiBXException
("Unmarshalling context not of expected type");
} else {
return ((UnmarshallingContext)ctx).currentEvent() !=
IXMLReader.END_TAG;
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IUnmarshaller#unmarshal(java.lang.Object,
* org.jibx.runtime.IUnmarshallingContext)
*/
public Object unmarshal(Object obj, IUnmarshallingContext ictx)
throws JiBXException {
// verify the entry conditions
boolean created = false;
List list = null;
if (obj == null) {
list = new ArrayList();
created = true;
} else if (obj instanceof List) {
list = (List)obj;
} else {
throw new JiBXException("Supplied object is not a java.util.List");
}
if (!(ictx instanceof UnmarshallingContext)) {
throw new JiBXException
("Unmarshalling context not of expected type");
}
// unmarshal content to document model
m_unmarshalContext = (UnmarshallingContext)ictx;
try {
Node node;
while ((node = unmarshalNode()) != null) {
list.add(node);
}
if (created && list.isEmpty()) {
return null;
} else {
return list;
}
} catch (IOException e) {
throw new JiBXException("Error reading from document", e);
}
}
} libjibx-java-1.1.6a/build/extras/org/jibx/extras/DomMapperBase.java 0000644 0001750 0001750 00000040422 10434260002 025053 0 ustar moeller moeller /*
Copyright (c) 2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.extras;
import java.io.IOException;
import java.util.ArrayList;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import org.jibx.runtime.IXMLReader;
import org.jibx.runtime.JiBXException;
import org.w3c.dom.Attr;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
/**
*
Base implementation for custom marshaller/unmarshallers to DOM
* representation. This provides the basic code used for both single element and
* content list handling.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class DomMapperBase extends DocumentModelMapperBase
{
/** Actual document instance (required by DOM). */
protected Document m_document;
/** Current default namespace URI (null if not determined). */
protected String m_defaultNamespaceURI;
/** Current default namespace index. */
protected int m_defaultNamespaceIndex;
/**
* Constructor. Initializes the document used by this
* marshaller/unmarshaller instance as the owner of all DOM components.
*
* @throws JiBXException on error creating document
*/
protected DomMapperBase() throws JiBXException {
DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
dbf.setNamespaceAware(true);
try {
m_document = dbf.newDocumentBuilder().newDocument();
} catch (ParserConfigurationException e) {
throw new JiBXException("Unable to create DOM document", e);
}
}
/**
* Get index number for declared namespace.
*
* @param prefix namespace prefix (null if none)
* @param uri namespace URI (empty string if none)
* @return namespace index number, or -1 if not declared or
* masked
*/
private int findNamespaceIndex(String prefix, String uri) {
if ((prefix == null || "".equals(prefix)) &&
(uri == null || "".equals(uri))) {
return 0;
} else if ("xml".equals(prefix) && XML_NAMESPACE.equals(uri)) {
return 1;
} else {
if (prefix == null) {
if (m_defaultNamespaceURI == null) {
int index = m_xmlWriter.getPrefixIndex("");
if (index >= 0) {
m_defaultNamespaceURI = getNamespaceUri(index);
m_defaultNamespaceIndex = index;
if (m_defaultNamespaceURI.equals(uri)) {
return index;
} else {
return -1;
}
} else {
return -1;
}
} else {
return m_defaultNamespaceURI.equals(uri) ?
m_defaultNamespaceIndex : -1;
}
} else {
int index = m_xmlWriter.getPrefixIndex(prefix);
if (index >= 0) {
return getNamespaceUri(index).equals(uri) ?
index : -1;
} else {
return -1;
}
}
}
}
/**
* Marshal node.
*
* @param node node to be marshalled
* @exception JiBXException on error in marshalling
* @exception IOException on error writing to output
*/
protected void marshalNode(Node node) throws JiBXException, IOException {
switch (node.getNodeType()) {
case Node.CDATA_SECTION_NODE:
m_xmlWriter.writeCData(node.getNodeValue());
break;
case Node.COMMENT_NODE:
m_xmlWriter.writeComment(node.getNodeValue());
break;
case Node.ELEMENT_NODE:
marshalElement((Element)node);
break;
case Node.ENTITY_REFERENCE_NODE:
m_xmlWriter.writeEntityRef(node.getNodeName());
break;
case Node.PROCESSING_INSTRUCTION_NODE:
m_xmlWriter.writePI(node.getNodeName(),
node.getNodeValue());
break;
case Node.TEXT_NODE:
m_xmlWriter.writeTextContent(node.getNodeValue());
break;
default:
break;
}
}
/**
* Marshal node list.
*
* @param content list of nodes to marshal
* @exception JiBXException on error in marshalling
* @exception IOException on error writing to output
*/
protected void marshalContent(NodeList content)
throws JiBXException, IOException {
int size = content.getLength();
for (int i = 0; i < size; i++) {
marshalNode(content.item(i));
}
}
/**
* Marshal element with all attributes and content.
*
* @param element element to be marshalled
* @exception JiBXException on error in marshalling
* @exception IOException on error writing to output
*/
protected void marshalElement(Element element)
throws JiBXException, IOException {
// accumulate all needed namespace declarations
String prefix = element.getPrefix();
String uri = element.getNamespaceURI();
int nsi = findNamespaceIndex(prefix, uri);
ArrayList nss = null;
int defind = -1;
String defuri = null;
NamedNodeMap attrs = element.getAttributes();
int size = attrs.getLength();
for (int i = 0; i < size; i++) {
Attr attr = (Attr)attrs.item(i);
if (XMLNS_NAMESPACE.equals(attr.getNamespaceURI())) {
// found namespace declaration, convert to simple prefix
String declpref = attr.getLocalName();
if ("xmlns".equals(declpref)) {
declpref = null;
}
String decluri = attr.getValue();
if (findNamespaceIndex(declpref, decluri) < 0) {
if (nss == null) {
nss = new ArrayList();
}
nss.add(declpref == null ? "" : declpref);
nss.add(decluri == null ? "" : decluri);
if (declpref == null) {
defind = (nss.size() / 2) - 1;
defuri = decluri;
}
if (uri == decluri) {
nsi = defind;
}
}
}
}
// check for namespace declarations required
String[] uris = null;
if (nss == null) {
m_xmlWriter.startTagOpen(nsi, element.getLocalName());
} else {
int base = getNextNamespaceIndex();
if (defind >= 0) {
m_defaultNamespaceIndex = base + defind;
m_defaultNamespaceURI = defuri;
}
int length = nss.size() / 2;
uris = new String[length];
int[] nums = new int[length];
String[] prefs = new String[length];
for (int i = 0; i < length; i++) {
prefs[i] = (String)nss.get(i*2);
uris[i] = (String)nss.get(i*2+1);
nums[i] = base + i;
if (nsi < 0 && uri.equals(uris[i])) {
if ((prefix == null && prefs[i] == "") ||
(prefix != null && prefix.equals(prefs[i]))) {
nsi = base + i;
}
}
}
m_xmlWriter.pushExtensionNamespaces(uris);
m_xmlWriter.startTagNamespaces(nsi, element.getLocalName(),
nums, prefs);
if (defind >= 0) {
m_defaultNamespaceIndex = defind;
m_defaultNamespaceURI = defuri;
}
}
// add attributes if present
for (int i = 0; i < size; i++) {
Attr attr = (Attr)attrs.item(i);
if (!XMLNS_NAMESPACE.equals(attr.getNamespaceURI())) {
int index = 0;
String apref = attr.getPrefix();
if (apref != null) {
index = findNamespaceIndex(apref, attr.getNamespaceURI());
}
m_xmlWriter.addAttribute(index, attr.getLocalName(),
attr.getValue());
}
}
// check for content present
NodeList nodes = element.getChildNodes();
size = nodes.getLength();
if (size > 0) {
m_xmlWriter.closeStartTag();
marshalContent(element.getChildNodes());
m_xmlWriter.endTag(nsi, element.getLocalName());
} else {
m_xmlWriter.closeEmptyTag();
}
// pop namespaces if defined by element
if (nss != null) {
m_xmlWriter.popExtensionNamespaces();
if (defind >= 0) {
m_defaultNamespaceURI = null;
}
}
}
/**
* Unmarshal single node. This unmarshals the next node from the input
* stream, up to the close tag of the containing element.
*
* @return unmarshalled node
* @exception JiBXException on error in unmarshalling
* @exception IOException on error reading input
*/
protected Node unmarshalNode() throws JiBXException, IOException {
while (true) {
int cev = m_unmarshalContext.currentEvent();
switch (cev) {
case IXMLReader.CDSECT:
{
String text = m_unmarshalContext.getText();
m_unmarshalContext.nextToken();
return m_document.createCDATASection(text);
}
case IXMLReader.COMMENT:
{
String text = m_unmarshalContext.getText();
m_unmarshalContext.nextToken();
return m_document.createComment(text);
}
case IXMLReader.END_TAG:
return null;
case IXMLReader.ENTITY_REF:
if (m_unmarshalContext.getText() == null) {
String name = m_unmarshalContext.getName();
m_unmarshalContext.nextToken();
return m_document.createEntityReference(name);
} else {
String text = accumulateText();
return m_document.createTextNode(text);
}
case IXMLReader.PROCESSING_INSTRUCTION:
{
String text = m_unmarshalContext.getText();
m_unmarshalContext.nextToken();
int index = 0;
while (++index < text.length() &&
!isWhitespace(text.charAt(index)));
if (index < text.length()) {
String target = text.substring(0, index);
while (++index < text.length() &&
isWhitespace(text.charAt(index)));
String data = text.substring(index);
return m_document.
createProcessingInstruction(target, data);
} else {
return m_document.
createProcessingInstruction(text, "");
}
}
case IXMLReader.START_TAG:
return unmarshalElement();
case IXMLReader.TEXT:
return m_document.createTextNode(accumulateText());
default:
m_unmarshalContext.nextToken();
}
}
}
/**
* Unmarshal node content. This unmarshals everything up to the containing
* element close tag, adding each component to the content list supplied. On
* return, the parse position will always be at an END_TAG.
*
* @param parent node to which children are to be added
* @exception JiBXException on error in unmarshalling
* @exception IOException on error reading input
*/
protected void unmarshalContent(Node parent)
throws JiBXException, IOException {
Node node;
while ((node = unmarshalNode()) != null) {
parent.appendChild(node);
}
}
/**
* Unmarshal element with all attributes and content. This must be called
* with the unmarshalling context positioned at a START_TAG event.
*
* @return unmarshalled element
* @exception JiBXException on error in unmarshalling
* @exception IOException on error reading input
*/
protected Element unmarshalElement() throws JiBXException, IOException {
// start by creating the actual element
String uri = m_unmarshalContext.getNamespace();
String prefix = m_unmarshalContext.getPrefix();
String name = m_unmarshalContext.getName();
if (prefix != null) {
name = prefix + ':' + name;
}
Element element = m_document.createElementNS(uri, name);
// add all namespace declarations to element
int ncount = m_unmarshalContext.getNamespaceCount();
for (int i = 0; i < ncount; i++) {
prefix = m_unmarshalContext.getNamespacePrefix(i);
uri = m_unmarshalContext.getNamespaceUri(i);
if (prefix == null) {
element.setAttributeNS(XMLNS_NAMESPACE, "xmlns", uri);
} else {
element.setAttributeNS(XMLNS_NAMESPACE, "xmlns:" + prefix, uri);
}
}
// add all attributes to element
int acount = m_unmarshalContext.getAttributeCount();
for (int i = 0; i < acount; i++) {
prefix = m_unmarshalContext.getAttributePrefix(i);
uri = m_unmarshalContext.getAttributeNamespace(i);
name = m_unmarshalContext.getAttributeName(i);
if (prefix != null) {
name = prefix + ':' + name;
}
String value = m_unmarshalContext.getAttributeValue(i);
element.setAttributeNS(uri, name, value);
}
// add all content to element
int event = m_unmarshalContext.nextToken();
if (event != IXMLReader.END_TAG) {
unmarshalContent(element);
}
m_unmarshalContext.nextToken();
return element;
}
} libjibx-java-1.1.6a/build/extras/org/jibx/extras/HashMapperStringToComplex.java 0000644 0001750 0001750 00000023072 10222700114 027446 0 ustar moeller moeller /*
Copyright (c) 2003-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.extras;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import org.jibx.runtime.IAliasable;
import org.jibx.runtime.IMarshallable;
import org.jibx.runtime.IMarshaller;
import org.jibx.runtime.IMarshallingContext;
import org.jibx.runtime.IUnmarshaller;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.impl.MarshallingContext;
import org.jibx.runtime.impl.UnmarshallingContext;
/**
*
Custom marshaller/unmarshaller for java.util.Map
* instances. This handles mapping hash maps with simple keys and complex values
* to and from XML. There are a number of limitations, though. First off, the
* key objects are marshalled as simple text values, using the
* toString() method to convert them to String. When
* unmarshalling the keys are always treated as String values. The
* corresponding values can be any complex type with a <mapping> defined in
* the binding. The name of the top-level element in the XML structure can be
* configured in the binding definition, but the rest of the names are
* predefined and set in the code (though the namespace configured for the
* top-level element will be used with all the names).
*
*
The net effect is that the XML structure will always be of the form:
where "map-name" is the configured top-level element name, the "size"
* attribute is the number of pairs in the hash map, and the "entry" elements
* are the actual entries in the hash map.
*
*
This is obviously not intended to handle all types of hash maps, but it
* should be useful as written for many applications and easily customized to
* handle other requirements.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class HashMapperStringToComplex
implements IMarshaller, IUnmarshaller, IAliasable {
private static final int DEFAULT_SIZE = 10;
private String m_uri;
private int m_index;
private String m_name;
/**
* Default constructor. This uses a pre-defined name for the top-level
* element. It'll be used by JiBX when no name information is supplied by
* the mapping which references this custom marshaller/unmarshaller.
*/
public HashMapperStringToComplex() {
m_uri = null;
m_index = 0;
m_name = "hashmap";
}
/**
* Aliased constructor. This takes a name definition for the top-level
* element. It'll be used by JiBX when a name is supplied by the mapping
* which references this custom marshaller/unmarshaller.
*
* @param uri namespace URI for the top-level element (also used for all
* other names within the binding)
* @param index namespace index corresponding to the defined URI within the
* marshalling context definitions
* @param name local name for the top-level element
*/
public HashMapperStringToComplex(String uri, int index, String name) {
m_uri = uri;
m_index = index;
m_name = name;
}
/**
* Method which can be overridden to supply a different name for the wrapper
* element attribute used to give the number of items present. If present,
* this attribute is used when unmarshalling to set the initial size of the
* hashmap. It will be generated when marshalling if the supplied name is
* non-null.
*/
protected String getSizeAttributeName() {
return "size";
}
/**
* Method which can be overridden to supply a different name for the element
* used to represent each item in the map.
*/
protected String getEntryElementName() {
return "entry";
}
/**
* Method which can be overridden to supply a different name for the
* attribute defining the key value for each item in the map.
*/
protected String getKeyAttributeName() {
return "key";
}
/* (non-Javadoc)
* @see org.jibx.runtime.IMarshaller#isExtension(int)
*/
public boolean isExtension(int index) {
return false;
}
/* (non-Javadoc)
* @see org.jibx.runtime.IMarshaller#marshal(java.lang.Object,
* org.jibx.runtime.IMarshallingContext)
*/
public void marshal(Object obj, IMarshallingContext ictx)
throws JiBXException {
// make sure the parameters are as expected
if (!(obj instanceof Map)) {
throw new JiBXException("Invalid object type for marshaller");
} else if (!(ictx instanceof MarshallingContext)) {
throw new JiBXException("Invalid object type for marshaller");
} else {
// start by generating start tag for container
MarshallingContext ctx = (MarshallingContext)ictx;
Map map = (Map)obj;
ctx.startTagAttributes(m_index, m_name).
attribute(m_index, getSizeAttributeName(), map.size()).
closeStartContent();
// loop through all entries in map
Iterator iter = map.entrySet().iterator();
while (iter.hasNext()) {
Map.Entry entry = (Map.Entry)iter.next();
ctx.startTagAttributes(m_index, getEntryElementName());
ctx.attribute(m_index, getKeyAttributeName(),
entry.getKey().toString());
ctx.closeStartContent();
if (entry.getValue() instanceof IMarshallable) {
((IMarshallable)entry.getValue()).marshal(ctx);
ctx.endTag(m_index, getEntryElementName());
} else {
throw new JiBXException("Mapped value is not marshallable");
}
}
// finish with end tag for container element
ctx.endTag(m_index, m_name);
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IUnmarshaller#isPresent(org.jibx.runtime.IUnmarshallingContext)
*/
public boolean isPresent(IUnmarshallingContext ctx) throws JiBXException {
return ctx.isAt(m_uri, m_name);
}
/* (non-Javadoc)
* @see org.jibx.runtime.IUnmarshaller#unmarshal(java.lang.Object,
* org.jibx.runtime.IUnmarshallingContext)
*/
public Object unmarshal(Object obj, IUnmarshallingContext ictx)
throws JiBXException {
// make sure we're at the appropriate start tag
UnmarshallingContext ctx = (UnmarshallingContext)ictx;
if (!ctx.isAt(m_uri, m_name)) {
ctx.throwStartTagNameError(m_uri, m_name);
}
// create new hashmap if needed
int size = ctx.attributeInt(m_uri,
getSizeAttributeName(), DEFAULT_SIZE);
Map map = (Map)obj;
if (map == null) {
map = new HashMap(size);
}
// process all entries present in document
ctx.parsePastStartTag(m_uri, m_name);
while (ctx.isAt(m_uri, getEntryElementName())) {
Object key = ctx.attributeText(m_uri, getKeyAttributeName(), null);
ctx.parsePastStartTag(m_uri, getEntryElementName());
Object value = ctx.unmarshalElement();
map.put(key, value);
ctx.parsePastEndTag(m_uri, getEntryElementName());
}
ctx.parsePastEndTag(m_uri, m_name);
return map;
}
} libjibx-java-1.1.6a/build/extras/org/jibx/extras/HashMapperStringToSchemaType.java 0000644 0001750 0001750 00000046563 10434260002 030115 0 ustar moeller moeller /*
Copyright (c) 2004-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.extras;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.util.Date;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import org.jibx.runtime.EnumSet;
import org.jibx.runtime.IAliasable;
import org.jibx.runtime.IMarshaller;
import org.jibx.runtime.IMarshallingContext;
import org.jibx.runtime.IUnmarshaller;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.IXMLWriter;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.Utility;
import org.jibx.runtime.impl.MarshallingContext;
import org.jibx.runtime.impl.UnmarshallingContext;
/**
*
Custom marshaller/unmarshaller for java.util.Map
* instances. This handles mapping hash maps with string keys and values that
* match basic schema datatypes to and from XML. The key objects are marshalled
* as simple text values, using the toString() method to convert
* them to String if they are not already of that type. When
* unmarshalling the keys are always treated as String values. The
* corresponding values can be any of the object types corresponding to basic
* schema data types, and are marshalled with xsi:type attributes to specify the
* type of each value. The types currently supported are Byte,
* Double, Float, Integer,
* Long, java.util.Date (as xsd:dateTime),
* java.sql.Date (as xsd:date), java.sql.Time (as
* xsd:time), java.math.BigDecimal (with no exponent allowed, as
* xsd:decimal), and java.math.BigInteger (as xsd:integer). The
* xsd:type attribute is checked when unmarshalling values to select the proper
* deserialization and value type. The name of the top-level element in the XML
* structure can be configured in the binding definition, but the rest of the
* names are predefined and set in the code (though the namespace configured for
* the top-level element will be used with all the names).
*
*
The net effect is that the XML structure will always be of the form:
where "map-name" is the configured top-level element name, the "size"
* attribute is the number of pairs in the hash map, and the "entry" elements
* are the actual entries in the hash map.
*
*
For unmarshalling this requires an active namespace declaration with a
* prefix for the schema namespace. All xsi:type attribute values must use this
* prefix. If more than one prefix is declared for the schema namespace, the
* innermost one declared must be used.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class HashMapperStringToSchemaType
implements IMarshaller, IUnmarshaller, IAliasable {
//
// Basic constants used in code
private static final String SIZE_ATTRIBUTE_NAME = "size";
private static final String ENTRY_ELEMENT_NAME = "entry";
private static final String KEY_ATTRIBUTE_NAME = "key";
private static final String TYPE_ATTRIBUTE_NAME = "type";
private static final String XSI_NAMESPACE_URI =
"http://www.w3.org/2001/XMLSchema-instance";
private static final String XSD_NAMESPACE_URI =
"http://www.w3.org/2001/XMLSchema";
private static final String[] SCHEMA_NAMESPACE_URIS =
{
XSI_NAMESPACE_URI, XSD_NAMESPACE_URI
};
private static final String XSI_NAMESPACE_PREFIX = "xsi";
private static final String XSD_NAMESPACE_PREFIX = "xsd";
private static final String[] SCHEMA_NAMESPACE_PREFIXES =
{
XSI_NAMESPACE_PREFIX, XSD_NAMESPACE_PREFIX
};
private static final String XSD_PREFIX_LEAD = "xsd:";
private static final int DEFAULT_SIZE = 10;
//
// Supported XML schema type correspondences enumeration
// numeric values for types
public static final int BOOLEAN_TYPE = 0;
public static final int BYTE_TYPE = 1;
public static final int DOUBLE_TYPE = 2;
public static final int FLOAT_TYPE = 3;
public static final int INT_TYPE = 4;
public static final int LONG_TYPE = 5;
public static final int SHORT_TYPE = 6;
public static final int DATETIME_TYPE = 7;
public static final int DECIMAL_TYPE = 8;
public static final int INTEGER_TYPE = 9;
public static final int BYTERRAY_TYPE = 10;
public static final int STRING_TYPE = 11;
//#!j2me{
public static final int DATE_TYPE = 12;
public static final int TIME_TYPE = 13;
//#j2me}
// enumeration definition (string order must match numeric list, above)
private static final EnumSet s_javaTypesEnum = new EnumSet(BOOLEAN_TYPE,
new String[] { "java.lang.Boolean", "java.lang.Byte",
"java.lang.Double", "java.lang.Float", "java.lang.Integer",
"java.lang.Long", "java.lang.Short", "java.util.Date",
"java.math.BigDecimal", "java.math.BigInteger", "byte[]",
"java.lang.String",
//#!j2me{
"java.sql.Date", "java.sql.Time",
//#j2me}
} );
// corresponding schema types (string order must match numeric list, above)
private static final EnumSet s_schemaTypesEnum = new EnumSet(BOOLEAN_TYPE,
new String[] { "boolean", "byte", "double", "float", "int", "long",
"short", "dateTime", "decimal", "integer", "base64Binary", "string",
//#!j2me{
"date", "time",
//#j2me}
} );
//
// Member fields
private String m_uri;
private int m_index;
private String m_name;
/**
* Default constructor. This uses a pre-defined name for the top-level
* element. It'll be used by JiBX when no name information is supplied by
* the mapping which references this custom marshaller/unmarshaller.
*/
public HashMapperStringToSchemaType() {
m_uri = null;
m_index = 0;
m_name = "hashmap";
}
/**
* Aliased constructor. This takes a name definition for the top-level
* element. It'll be used by JiBX when a name is supplied by the mapping
* which references this custom marshaller/unmarshaller.
*
* @param uri namespace URI for the top-level element (also used for all
* other names within the binding)
* @param index namespace index corresponding to the defined URI within the
* marshalling context definitions
* @param name local name for the top-level element
*/
public HashMapperStringToSchemaType(String uri, int index, String name) {
m_uri = uri;
m_index = index;
m_name = name;
}
/* (non-Javadoc)
* @see org.jibx.runtime.IMarshaller#isExtension(int)
*/
public boolean isExtension(int index) {
return false;
}
/* (non-Javadoc)
* @see org.jibx.runtime.IMarshaller#marshal(java.lang.Object,
* org.jibx.runtime.IMarshallingContext)
*/
public void marshal(Object obj, IMarshallingContext ictx)
throws JiBXException {
// make sure the parameters are as expected
if (!(obj instanceof Map)) {
throw new JiBXException("Invalid object type for marshaller");
} else if (!(ictx instanceof MarshallingContext)) {
throw new JiBXException("Invalid object type for marshaller");
} else {
// start by setting up added namespaces
MarshallingContext ctx = (MarshallingContext)ictx;
IXMLWriter xwrite = ctx.getXmlWriter();
int ixsi = xwrite.getNamespaces().length;
String[][] extens = xwrite.getExtensionNamespaces();
if (extens != null) {
for (int i = 0; i < extens.length; i++) {
ixsi += extens[i].length;
}
}
xwrite.pushExtensionNamespaces(SCHEMA_NAMESPACE_URIS);
// generate start tag for containing element
Map map = (Map)obj;
ctx.startTagNamespaces(m_index, m_name, new int[] { ixsi, ixsi+1 },
SCHEMA_NAMESPACE_PREFIXES).
attribute(m_index, SIZE_ATTRIBUTE_NAME, map.size()).
closeStartContent();
// loop through all entries in hashmap
Iterator iter = map.entrySet().iterator();
while (iter.hasNext()) {
// first make sure we have a value
Map.Entry entry = (Map.Entry)iter.next();
Object value = entry.getValue();
if (value != null) {
// write element with key attribute
ctx.startTagAttributes(m_index, ENTRY_ELEMENT_NAME);
ctx.attribute(m_index, KEY_ATTRIBUTE_NAME,
entry.getKey().toString());
// translate value object class to schema type
String tname = value.getClass().getName();
int type = s_javaTypesEnum.getValue(tname);
if (type < 0) {
throw new JiBXException("Value of type " + tname +
" with key " + entry.getKey() +
" is not a supported type");
}
// generate xsi:type attribute for value
ctx.attribute(ixsi, TYPE_ATTRIBUTE_NAME,
XSD_PREFIX_LEAD + s_schemaTypesEnum.getName(type));
ctx.closeStartContent();
// handle the actual value conversion based on type
switch (type) {
case BOOLEAN_TYPE:
ctx.content(Utility.serializeBoolean
(((Boolean)value).booleanValue()));
break;
case BYTE_TYPE:
ctx.content(Utility.
serializeByte(((Byte)value).byteValue()));
break;
case DOUBLE_TYPE:
ctx.content(Utility.
serializeDouble(((Double)value).doubleValue()));
break;
case FLOAT_TYPE:
ctx.content(Utility.
serializeFloat(((Float)value).floatValue()));
break;
case INT_TYPE:
ctx.content(((Integer)value).intValue());
break;
case LONG_TYPE:
ctx.content(Utility.
serializeLong(((Long)value).longValue()));
break;
case SHORT_TYPE:
ctx.content(Utility.
serializeShort(((Short)value).shortValue()));
break;
case DATETIME_TYPE:
ctx.content(Utility.serializeDateTime((Date)value));
break;
//#!j2me{
case DATE_TYPE:
ctx.content(Utility.
serializeSqlDate((java.sql.Date)value));
break;
case TIME_TYPE:
ctx.content(Utility.
serializeSqlTime((java.sql.Time)value));
break;
//#j2me}
case BYTERRAY_TYPE:
ctx.content(Utility.serializeBase64((byte[])value));
break;
case DECIMAL_TYPE:
case INTEGER_TYPE:
case STRING_TYPE:
ctx.content(value.toString());
break;
}
// finish with close tag for entry element
ctx.endTag(m_index, ENTRY_ELEMENT_NAME);
}
}
// finish with end tag for container element
ctx.endTag(m_index, m_name);
xwrite.popExtensionNamespaces();
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IUnmarshaller#isPresent(org.jibx.runtime.IUnmarshallingContext)
*/
public boolean isPresent(IUnmarshallingContext ctx) throws JiBXException {
return ctx.isAt(m_uri, m_name);
}
/* (non-Javadoc)
* @see org.jibx.runtime.IUnmarshaller#unmarshal(java.lang.Object,
* org.jibx.runtime.IUnmarshallingContext)
*/
public Object unmarshal(Object obj, IUnmarshallingContext ictx)
throws JiBXException {
// make sure we're at the appropriate start tag
UnmarshallingContext ctx = (UnmarshallingContext)ictx;
if (!ctx.isAt(m_uri, m_name)) {
ctx.throwStartTagNameError(m_uri, m_name);
}
// lookup the prefixes assigned to required namespaces
int nscnt = ctx.getActiveNamespaceCount();
String xsdlead = null;
for (int i = nscnt-1; i >= 0; i--) {
String uri = ctx.getActiveNamespaceUri(i);
if (XSD_NAMESPACE_URI.equals(uri)) {
String prefix = ctx.getActiveNamespacePrefix(i);
if (!"".equals(prefix)) {
xsdlead = prefix + ':';
break;
}
}
}
if (xsdlead == null) {
throw new JiBXException
("Missing required schema namespace declaration");
}
// create new hashmap if needed
int size = ctx.attributeInt(m_uri, SIZE_ATTRIBUTE_NAME, DEFAULT_SIZE);
Map map = (Map)obj;
if (map == null) {
map = new HashMap(size);
}
// process all entries present in document
ctx.parsePastStartTag(m_uri, m_name);
String tdflt = xsdlead + "string";
while (ctx.isAt(m_uri, ENTRY_ELEMENT_NAME)) {
// unmarshal key and type from start tag attributes
Object key = ctx.attributeText(m_uri, KEY_ATTRIBUTE_NAME);
String tname = ctx.attributeText(XSI_NAMESPACE_URI,
TYPE_ATTRIBUTE_NAME, tdflt);
// convert type name to type index number
int type = -1;
if (tname.startsWith(xsdlead)) {
type = s_schemaTypesEnum.
getValue(tname.substring(xsdlead.length()));
}
if (type < 0) {
throw new JiBXException("Value of type " + tname +
" with key " + key + " is not a supported type");
}
// deserialize content as specified type
String text = ctx.parseElementText(m_uri, ENTRY_ELEMENT_NAME);
Object value = null;
switch (type) {
case BOOLEAN_TYPE:
value = Utility.parseBoolean(text) ?
Boolean.TRUE : Boolean.FALSE;
break;
case BYTE_TYPE:
value = new Byte(Utility.parseByte(text));
break;
case DOUBLE_TYPE:
value = new Double(Utility.parseDouble(text));
break;
case FLOAT_TYPE:
value = new Float(Utility.parseFloat(text));
break;
case INT_TYPE:
value = new Integer(Utility.parseInt(text));
break;
case LONG_TYPE:
value = new Long(Utility.parseLong(text));
break;
case SHORT_TYPE:
value = new Short(Utility.parseShort(text));
break;
case DATETIME_TYPE:
value = Utility.deserializeDateTime(text);
break;
//#!j2me{
case DATE_TYPE:
value = Utility.deserializeSqlDate(text);
break;
case TIME_TYPE:
value = Utility.deserializeSqlTime(text);
break;
//#j2me}
case BYTERRAY_TYPE:
value = Utility.deserializeBase64(text);
break;
case DECIMAL_TYPE:
value = new BigDecimal(text);
break;
case INTEGER_TYPE:
value = new BigInteger(text);
break;
case STRING_TYPE:
value = text;
break;
}
// add key-value pair to map
map.put(key, value);
}
// finish by skipping past wrapper end tag
ctx.parsePastEndTag(m_uri, m_name);
return map;
}
}
libjibx-java-1.1.6a/build/extras/org/jibx/extras/IdDefRefMapperBase.java 0000644 0001750 0001750 00000016242 10270750710 025757 0 ustar moeller moeller /*
Copyright (c) 2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.extras;
import java.util.HashMap;
import org.jibx.runtime.IAliasable;
import org.jibx.runtime.IMarshallable;
import org.jibx.runtime.IMarshaller;
import org.jibx.runtime.IMarshallingContext;
import org.jibx.runtime.IUnmarshaller;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.impl.MarshallingContext;
import org.jibx.runtime.impl.UnmarshallingContext;
/**
*
Abstract base custom marshaller/unmarshaller for an object that may have
* multiple references. The first time an object is seen when marshalling the
* full XML representation is generated; successive uses of the same object then
* use XML references to the object ID. To use this class you need to create a
* subclass with a constructor using the same signature as the one provided
* (calling the base class constructor from your subclass constructor) and
* implement the abstract {@link #getIdValue(java.lang.Object)} method in your subclass. You can
* also override the provided {@link #getAttributeName()} method to change the
* name used for the IDREF attribute, which must not match the name of an
* attribute used in the normal marshalled form of the object. The name used for
* this marshaller/unmarshaller in the mapping definition must match the name
* used for the base object type being handled.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public abstract class IdDefRefMapperBase
implements IMarshaller, IUnmarshaller, IAliasable {
private String m_uri;
private int m_index;
private String m_name;
/**
* Aliased constructor taking a name definition for reference elements. The
* subclass version will be used by JiBX to define the element name to be
* used with this custom marshaller/unmarshaller.
*
* @param uri namespace URI for the top-level element
* @param index namespace index corresponding to the defined URI within the
* marshalling context definitions
* @param name local name for the reference element
*/
public IdDefRefMapperBase(String uri, int index, String name) {
m_uri = uri;
m_index = index;
m_name = name;
}
/**
* Get the ID value from object being marshalled.
*
* @return ID value
*/
protected abstract String getIdValue(Object item);
/**
* Method which can be overridden to supply a different name for the ID
* reference attribute. The attribute name used by default is just "ref".
*/
protected String getAttributeName() {
return "ref";
}
/* (non-Javadoc)
* @see org.jibx.runtime.IMarshaller#isExtension(int)
*/
public boolean isExtension(int index) {
return false;
}
/* (non-Javadoc)
* @see org.jibx.runtime.IMarshaller#marshal(java.lang.Object,
* org.jibx.runtime.IMarshallingContext)
*/
public void marshal(Object obj, IMarshallingContext ictx)
throws JiBXException {
// make sure the parameters are as expected
if (obj == null) {
return;
} else if (!(ictx instanceof MarshallingContext)) {
throw new JiBXException("Invalid context type for marshaller");
} else {
// check if ID already defined
MarshallingContext ctx = (MarshallingContext)ictx;
HashMap map = ctx.getIdMap();
String id = getIdValue(obj);
Object value = map.get(id);
if (value == null) {
if (obj instanceof IMarshallable) {
// new id, write full representation and add to map
map.put(id, obj);
((IMarshallable)obj).marshal(ctx);
} else {
throw new JiBXException("Object of type " +
obj.getClass().getName() + " is not marshallable");
}
} else if (value.equals(obj)) {
// generate reference to previously-defined item
ctx.startTagAttributes(m_index, m_name);
ctx.attribute(0, getAttributeName(), id);
ctx.closeStartEmpty();
} else {
throw new JiBXException("Duplicate definition for ID " + id);
}
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IUnmarshaller#isPresent(org.jibx.runtime.IUnmarshallingContext)
*/
public boolean isPresent(IUnmarshallingContext ictx) throws JiBXException {
return ictx.isAt(m_uri, m_name);
}
/* (non-Javadoc)
* @see org.jibx.runtime.IUnmarshaller#unmarshal(java.lang.Object,
* org.jibx.runtime.IUnmarshallingContext)
*/
public Object unmarshal(Object obj, IUnmarshallingContext ictx)
throws JiBXException {
// make sure we're at the appropriate start tag
UnmarshallingContext ctx = (UnmarshallingContext)ictx;
if (!ctx.isAt(m_uri, m_name)) {
return null;
} else {
// check for reference to existing ID
String id = ctx.attributeText(null, getAttributeName(), null);
if (id == null) {
// no ID value supplied, unmarshal full definition
obj = ctx.unmarshalElement();
} else {
// find object based on ID
obj = ctx.findID(id, 0);
ctx.parsePastEndTag(m_uri, m_name);
if (obj == null) {
ctx.throwStartTagException("Reference to undefined ID " +
id);
}
}
}
return obj;
}
} libjibx-java-1.1.6a/build/extras/org/jibx/extras/IdRefMapperBase.java 0000644 0001750 0001750 00000013511 10217761632 025342 0 ustar moeller moeller /*
Copyright (c) 2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.extras;
import org.jibx.runtime.IAliasable;
import org.jibx.runtime.IMarshaller;
import org.jibx.runtime.IMarshallingContext;
import org.jibx.runtime.IUnmarshaller;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.impl.MarshallingContext;
import org.jibx.runtime.impl.UnmarshallingContext;
/**
*
Abstract base custom marshaller/unmarshaller for an object reference. This
* marshals the reference as an empty element with a single IDREF attribute, and
* unmarshals an element with the same structure to create a reference to the
* object with that ID value. To use this class you need to create a subclass
* with a constructor using the same signature as the one provided (calling the
* base class constructor from your subclass constructor) and implement the
* abstract {@link #getIdValue} method in your subclass. You can also override
* the provided {@link #getAttributeName} method to change the name used for the
* IDREF attribute. Note that this class can only be used when the definitions
* precede the references in the XML document; if a referenced ID is not defined
* the unmarshaller throws an exception.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public abstract class IdRefMapperBase
implements IMarshaller, IUnmarshaller, IAliasable {
private String m_uri;
private int m_index;
private String m_name;
/**
* Aliased constructor taking a name definition for the element. The
* subclass version will be used by JiBX to define the element name to be
* used with this custom marshaller/unmarshaller.
*
* @param uri namespace URI for the top-level element
* @param index namespace index corresponding to the defined URI within the
* marshalling context definitions
* @param name local name for the top-level element
*/
public IdRefMapperBase(String uri, int index, String name) {
m_uri = uri;
m_index = index;
m_name = name;
}
/**
* Get the ID value from object being marshalled.
*
* @return ID value
*/
protected abstract String getIdValue(Object item);
/**
* Method which can be overridden to supply a different name for the ID
* reference attribute. The attribute name used by default is just "ref".
*/
protected String getAttributeName() {
return "ref";
}
/* (non-Javadoc)
* @see org.jibx.runtime.IMarshaller#isExtension(int)
*/
public boolean isExtension(int index) {
return false;
}
/* (non-Javadoc)
* @see org.jibx.runtime.IMarshaller#marshal(java.lang.Object,
* org.jibx.runtime.IMarshallingContext)
*/
public void marshal(Object obj, IMarshallingContext ictx)
throws JiBXException {
// make sure the parameters are as expected
if (obj == null) {
return;
} else if (!(ictx instanceof MarshallingContext)) {
throw new JiBXException("Invalid context type for marshaller");
} else {
// generate the element start tag
MarshallingContext ctx = (MarshallingContext)ictx;
ctx.startTagAttributes(m_index, m_name);
// add attribute reference to object ID
ctx.attribute(0, getAttributeName(), getIdValue(obj));
// close start tag for empty element
ctx.closeStartEmpty();
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IUnmarshaller#isPresent(org.jibx.runtime.IUnmarshallingContext)
*/
public boolean isPresent(IUnmarshallingContext ctx) throws JiBXException {
return ctx.isAt(m_uri, m_name);
}
/* (non-Javadoc)
* @see org.jibx.runtime.IUnmarshaller#unmarshal(java.lang.Object,
* org.jibx.runtime.IUnmarshallingContext)
*/
public Object unmarshal(Object obj, IUnmarshallingContext ictx)
throws JiBXException {
// make sure we're at the appropriate start tag
UnmarshallingContext ctx = (UnmarshallingContext)ictx;
if (!ctx.isAt(m_uri, m_name)) {
return null;
}
// get object reference for ID
obj = ctx.attributeExistingIDREF(null, getAttributeName(), 0);
// skip past the element
ctx.parsePastEndTag(m_uri, m_name);
return obj;
}
} libjibx-java-1.1.6a/build/extras/org/jibx/extras/JDOMWriter.java 0000644 0001750 0001750 00000017145 10270321622 024334 0 ustar moeller moeller /*
Copyright (c) 2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.extras;
import java.io.IOException;
import org.jdom.CDATA;
import org.jdom.Comment;
import org.jdom.DocType;
import org.jdom.Document;
import org.jdom.Element;
import org.jdom.EntityRef;
import org.jdom.Namespace;
import org.jdom.ProcessingInstruction;
import org.jdom.Text;
import org.jibx.runtime.impl.XMLWriterNamespaceBase;
/**
* JDOM implementation of XML writer interface. The Document that is
* created can be accessed by using getDocument().
*
* @author Andreas Brenk
* @version 1.0
*/
public class JDOMWriter extends XMLWriterNamespaceBase {
/**
* The JDOM Document this writer is creating.
*/
private Document document;
/**
* The currently open Element that is used for add* methods.
*/
private Element currentElement;
/**
* Creates a new instance with the given namespace URIs.
*/
public JDOMWriter(String[] namespaces) {
super(namespaces);
reset();
}
/**
* Creates a new instance with the given Document as target for marshalling.
*
* @param document must not be null
*/
public JDOMWriter(String[] namespaces, Document document) {
this(namespaces);
this.document = document;
if(document.hasRootElement()) {
this.currentElement = document.getRootElement();
}
}
/**
* Creates a new instance with the given Element as target for marshalling.
*
* @param currentElement must not be null
*/
public JDOMWriter(String[] namespaces, Element currentElement) {
this(namespaces, currentElement.getDocument());
this.currentElement = currentElement;
}
/**
* Does nothing.
*/
public void setIndentSpaces(int count, String newline, char indent) {
// do nothing
}
/**
* Does nothing.
*/
public void writeXMLDecl(String version, String encoding, String standalone) throws IOException {
// do nothing
}
public void startTagOpen(int index, String name) throws IOException {
Element newElement = new Element(name, getNamespace(index));
if(this.currentElement == null) {
this.document.setRootElement(newElement);
} else {
this.currentElement.addContent(newElement);
}
this.currentElement = newElement;
}
public void startTagNamespaces(int index, String name, int[] nums, String[] prefs) throws IOException {
// find the namespaces actually being declared
int[] deltas = openNamespaces(nums, prefs);
// create the start tag for element
startTagOpen(index, name);
// add namespace declarations to open element
for (int i = 0; i < deltas.length; i++) {
int slot = deltas[i];
this.currentElement.addNamespaceDeclaration(getNamespace(slot));
}
}
public void addAttribute(int index, String name, String value)
throws IOException {
this.currentElement.setAttribute(name, value, getNamespace(index));
}
public void closeStartTag() throws IOException {
incrementNesting();
}
public void closeEmptyTag() throws IOException {
incrementNesting();
decrementNesting();
this.currentElement = this.currentElement.getParentElement();
}
public void startTagClosed(int index, String name) throws IOException {
startTagOpen(index, name);
closeStartTag();
}
public void endTag(int index, String name) throws IOException {
decrementNesting();
this.currentElement = this.currentElement.getParentElement();
}
public void writeTextContent(String text) throws IOException {
this.currentElement.addContent(new Text(text));
}
public void writeCData(String text) throws IOException {
this.currentElement.addContent(new CDATA(text));
}
public void writeComment(String text) throws IOException {
this.currentElement.addContent(new Comment(text));
}
public void writeEntityRef(String name) throws IOException {
this.currentElement.addContent(new EntityRef(name));
}
public void writeDocType(String name, String sys, String pub, String subset)
throws IOException {
DocType docType;
if(null != pub) {
docType = new DocType(name, pub, sys);
} else if(null != sys) {
docType = new DocType(name, sys);
} else {
docType = new DocType(name);
}
if(null != subset) {
docType.setInternalSubset(subset);
}
this.document.setDocType(docType);
}
public void writePI(String target, String data) throws IOException {
this.currentElement.addContent(new ProcessingInstruction(target, data));
}
/**
* Does nothing.
*/
public void indent() throws IOException {
// do nothing
}
/**
* Does nothing.
*/
public void flush() throws IOException {
// do nothing
}
/**
* Does nothing.
*/
public void close() throws IOException {
// do nothing
}
public void reset() {
super.reset();
this.document = new Document();
this.currentElement = null;
}
/**
* @return the JDOM Document this writer created.
*/
public Document getDocument() {
return document;
}
/**
* Does nothing.
*/
protected void defineNamespace(int index, String prefix) throws IOException {
// do nothing
}
/**
* Does nothing.
*/
protected void undefineNamespace(int index) {
// do nothing
}
/**
* This will retrieve (if in existence) or create (if not) a
* Namespace for the supplied namespace index.
*/
private Namespace getNamespace(int index) {
String prefix = getNamespacePrefix(index);
String uri = getNamespaceUri(index);
if(prefix == null) {
return Namespace.getNamespace(uri);
} else {
return Namespace.getNamespace(prefix, uri);
}
}
}
libjibx-java-1.1.6a/build/extras/org/jibx/extras/ObjectArrayMapper.java 0000644 0001750 0001750 00000016035 10071714112 025754 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.extras;
import java.util.ArrayList;
import org.jibx.runtime.IAliasable;
import org.jibx.runtime.IMarshallable;
import org.jibx.runtime.IMarshaller;
import org.jibx.runtime.IMarshallingContext;
import org.jibx.runtime.IUnmarshaller;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.impl.MarshallingContext;
import org.jibx.runtime.impl.UnmarshallingContext;
/**
*
Custom marshaller/unmarshaller for Object[] instances. This
* handles mapping arrays typed as java.lang.Object[], where each
* item in the array must be of a mapped type. If a name is specified by the
* mapping definition that name is used as a wrapper around the elements
* representing the items in the array; otherwise, the elements are just handled
* inline.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class ObjectArrayMapper
implements IMarshaller, IUnmarshaller, IAliasable {
private static final Object[] DUMMY_ARRAY = {};
private String m_uri;
private int m_index;
private String m_name;
private ArrayList m_holder;
/**
* Default constructor. This just sets up for an XML representation with no
* element wrapping the actual item structures. It'll be used by JiBX when
* no name information is supplied by the mapping which references this
* custom marshaller/unmarshaller.
*/
public ObjectArrayMapper() {
m_uri = null;
m_index = 0;
m_name = null;
}
/**
* Aliased constructor. This takes a name definition for the top-level
* wrapper element. It'll be used by JiBX when a name is supplied by the
* mapping which references this custom marshaller/unmarshaller.
*
* @param uri namespace URI for the top-level element
* @param index namespace index corresponding to the defined URI within the
* marshalling context definitions
* @param name local name for the top-level element
*/
public ObjectArrayMapper(String uri, int index, String name) {
m_uri = uri;
m_index = index;
m_name = name;
}
/* (non-Javadoc)
* @see org.jibx.runtime.IMarshaller#isExtension(int)
*/
public boolean isExtension(int index) {
return false;
}
/* (non-Javadoc)
* @see org.jibx.runtime.IMarshaller#marshal(java.lang.Object,
* org.jibx.runtime.IMarshallingContext)
*/
public void marshal(Object obj, IMarshallingContext ictx)
throws JiBXException {
// make sure the parameters are as expected
if (obj == null) {
if (m_name == null) {
throw new JiBXException
("null array not allowed without wrapper");
}
} else if (!(DUMMY_ARRAY.getClass().isInstance(obj))) {
throw new JiBXException("Invalid object type for marshaller");
} else if (!(ictx instanceof MarshallingContext)) {
throw new JiBXException("Invalid object type for marshaller");
} else {
// start by generating start tag for container
MarshallingContext ctx = (MarshallingContext)ictx;
Object[] array = (Object[])obj;
if (m_name != null) {
ctx.startTag(m_index, m_name);
}
// loop through all entries in array
for (int i = 0; i < array.length; i++) {
Object item = array[i];
if (item instanceof IMarshallable) {
((IMarshallable)item).marshal(ctx);
} else if (item == null) {
throw new JiBXException("Null value at offset " + i +
" not supported");
} else {
throw new JiBXException("Array value of type " +
item.getClass().getName() + " at offset " + i +
" is not marshallable");
}
}
// finish with end tag for container element
if (m_name != null) {
ctx.endTag(m_index, m_name);
}
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IUnmarshaller#isPresent(org.jibx.runtime.IUnmarshallingContext)
*/
public boolean isPresent(IUnmarshallingContext ctx) throws JiBXException {
return ctx.isAt(m_uri, m_name);
}
/* (non-Javadoc)
* @see org.jibx.runtime.IUnmarshaller#unmarshal(java.lang.Object,
* org.jibx.runtime.IUnmarshallingContext)
*/
public Object unmarshal(Object obj, IUnmarshallingContext ictx)
throws JiBXException {
// make sure we're at the appropriate start tag
UnmarshallingContext ctx = (UnmarshallingContext)ictx;
if (m_name != null) {
if (ctx.isAt(m_uri, m_name)) {
ctx.parsePastStartTag(m_uri, m_name);
} else {
return null;
}
}
// create new array if needed
if (m_holder == null) {
m_holder = new ArrayList();
}
// process all items present in document
while (!ctx.isEnd()) {
Object item = ctx.unmarshalElement();
m_holder.add(item);
}
// discard close tag if used
if (m_name != null) {
ctx.parsePastEndTag(m_uri, m_name);
}
// return array containing all items
Object[] result = m_holder.toArray();
m_holder.clear();
return result;
}
} libjibx-java-1.1.6a/build/extras/org/jibx/extras/QName.java 0000644 0001750 0001750 00000016772 10434260002 023410 0 ustar moeller moeller /*
Copyright (c) 2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.extras;
import org.jibx.runtime.IMarshallingContext;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.IXMLWriter;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.impl.MarshallingContext;
import org.jibx.runtime.impl.UnmarshallingContext;
/**
* Representation of a qualified name. This includes the serializer/deserializer
* methods for the representation. It assumes that the actual namespace
* declarations are being handled separately for marshalling.
*
* @author Dennis M. Sosnoski
*/
public class QName
{
private String m_uri;
private String m_prefix;
private String m_name;
/**
* Default constructor.
*/
public QName() {}
/**
* Constructor from full set of components.
*
* @param uri
* @param prefix
* @param name
*/
public QName(String uri, String prefix, String name) {
m_uri = uri;
m_prefix = prefix;
m_name = name;
}
/**
* Get local name.
*
* @return name
*/
public String getName() {
return m_name;
}
/**
* Set local name.
*
* @param name name
*/
public void setName(String name) {
m_name = name;
}
/**
* Get namespace prefix.
*
* @return prefix
*/
public String getPrefix() {
return m_prefix;
}
/**
* Set namespace prefix.
*
* @param prefix prefix
*/
public void setPrefix(String prefix) {
m_prefix = prefix;
}
/**
* Get namespace URI.
*
* @return uri
*/
public String getUri() {
return m_uri;
}
/**
* Set namespace URI.
*
* @param uri uri
*/
public void setUri(String uri) {
m_uri = uri;
}
/**
* JiBX deserializer method. This is intended for use as a deserializer for
* instances of the class.
*
* @param text value text
* @param ictx unmarshalling context
* @return created class instance
* @throws JiBXException on error in unmarshalling
*/
public static QName deserialize(String text, IUnmarshallingContext ictx)
throws JiBXException {
// check for prefix used in text representation
int split = text.indexOf(':');
if (split > 0) {
// strip off prefix
String prefix = text.substring(0, split);
text = text.substring(split+1);
// make sure there aren't multiple colons
if (text.indexOf(':') >= 0) {
throw new JiBXException("Not a valid QName");
} else {
// look up the namespace URI associated with the prefix
String uri =
((UnmarshallingContext)ictx).getNamespaceUri(prefix);
if (uri == null) {
throw new JiBXException("Undefined prefix " + prefix);
} else {
// create an instance of class to hold all components
return new QName(uri, prefix, text);
}
}
} else {
// get the default namespace URI
String uri = ((UnmarshallingContext)ictx).getNamespaceUri("");
if (uri == null) {
uri = "";
}
// create an instance of class to hold all components
return new QName(uri, "", text);
}
}
/**
* JiBX serializer method. This is intended for use as a serializer for
* instances of the class. The namespace must be active in the output
* document at the point where this is called.
*
* @param qname instance to be serialized
* @param ictx unmarshalling context
* @return created class instance
* @throws JiBXException on error in marshalling
*/
public static String serialize(QName qname, IMarshallingContext ictx)
throws JiBXException {
// check if prefix is alread defined in document with correct URI
IXMLWriter ixw = ((MarshallingContext)ictx).getXmlWriter();
int index = -1;
int tryidx = ixw.getPrefixIndex(qname.m_prefix);
if (tryidx >= 0 &&
qname.m_uri.equals(ixw.getNamespaceUri(tryidx))) {
index = tryidx;
}
if (index < 0) {
// prefix not defined, find the namespace index in binding
String[] nss = ixw.getNamespaces();
for (int i = 0; i < nss.length; i++) {
if (nss[i].equals(qname.m_uri)) {
index = i;
break;
}
}
if (index < 0) {
// namespace not in binding, check extensions
String[][] nsss = ixw.getExtensionNamespaces();
if (nsss != null) {
int base = nss.length;
outer: for (int i = 0; i < nsss.length; i++) {
nss = nsss[i];
for (int j = 0; j < nss.length; j++) {
if (nss[j].equals(qname.m_uri)) {
index = base + j;
break outer;
}
}
base += nss.length;
}
}
}
}
if (index >= 0) {
// get prefix defined for namespace
String prefix = ixw.getNamespacePrefix(index);
if (prefix == null) {
throw new JiBXException("Namespace URI " + qname.m_uri +
" cannot be used since it is not active");
} else if (prefix.length() > 0) {
return prefix + ':' + qname.m_name;
} else {
return qname.m_name;
}
} else {
throw new JiBXException("Unknown namespace URI " + qname.m_uri);
}
}
} libjibx-java-1.1.6a/build/extras/org/jibx/extras/TestMultRoundtrip.java 0000644 0001750 0001750 00000010300 10267760304 026072 0 ustar moeller moeller /*
Copyright (c) 2003-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.extras;
import java.io.File;
/**
* Test program for the JiBX framework. Works with three or four command line
* arguments: mapped-class, binding-name, in-file, and out-file (optional, only
* needed if different from in-file). You can also supply a multiple of four
* input arguments, in which case each set of four is processed in turn (in this
* case the out-file is required). Unmarshals documents from files using the
* specified bindings for the mapped classes, then marshals them back out using
* the same bindings and compares the results. In case of a comparison error the
* output file is left as temp.xml .
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class TestMultRoundtrip {
public static void main(String[] args) {
if (args.length == 3 || (args.length > 0 && args.length % 4 == 0)) {
// delete generated output file if present
File temp = new File("temp.xml");
if (temp.exists()) {
temp.delete();
}
// process input arguments
int base = 0;
boolean err = false;
String fin = null;
String fout = null;
while (base < args.length) {
// run test with one argument set
fin = args[base+2];
fout = (args.length < base+4) ? fin : args[base+3];
try {
if (!TestRoundtrip.runTest(args[base], args[base+1], fin,
fout)) {
err = true;
}
} catch (Exception ex) {
ex.printStackTrace();
// System.err.println(ex.getMessage());
err = true;
}
// take error exit if difference found
if (err) {
System.err.println("Error round-tripping class: " + args[base] +
"\n with input file " + fin + " and output compared to " +
fout);
System.err.println("Saved output document file path " +
temp.getAbsolutePath());
System.exit(1);
}
// advance to next argument set
base += 4;
}
} else {
System.err.println("Usage: java TestMultRoundtrip mapped-class" +
" binding-name in-file [out-file]\n where out-file is only" +
" required if the output document is different from\nthe" +
" input document. Leaves output as temp.xml in case of error");
System.exit(1);
}
}
}
libjibx-java-1.1.6a/build/extras/org/jibx/extras/TestRoundtrip.java 0000644 0001750 0001750 00000016133 10767277356 025261 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.extras;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.FileReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.URLClassLoader;
import org.jibx.runtime.*;
import org.jibx.runtime.impl.UnmarshallingContext;
import org.xmlpull.v1.XmlPullParserException;
/**
* Test program for the JiBX framework. Works with two or three command line
* arguments: mapped-class, in-file, and out-file (optional, only needed if
* different from in-file). You can also supply a multiple of three input
* arguments, in which case each set of three is processed in turn (in this case
* the out-file is required). Unmarshals documents from files using the binding
* defined for the mapped class, then marshals them back out using the same
* bindings and compares the results. In case of a comparison error the output
* file is left as temp.xml.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class TestRoundtrip {
protected static boolean runTest(String mname, String bname, String fin,
String fout) throws IOException, JiBXException, XmlPullParserException {
// look up the mapped class and associated binding factory
Class mclas;
try {
URL[] urls = new URL[] { new File(".").toURL() };
ClassLoader parent = Thread.currentThread().getContextClassLoader();
if (parent == null) {
parent = TestMultRoundtrip.class.getClassLoader();
}
ClassLoader loader = new URLClassLoader(urls, parent);
Thread.currentThread().setContextClassLoader(loader);
mclas = loader.loadClass(mname);
} catch (ClassNotFoundException ex) {
System.err.println("Class " + mname + " not found");
return false;
}
IBindingFactory bfact;
if (bname == null) {
bfact = BindingDirectory.getFactory(mclas);
} else {
bfact = BindingDirectory.getFactory(bname, mclas);
}
// unmarshal document to construct objects
IUnmarshallingContext uctx = bfact.createUnmarshallingContext();
Object obj = uctx.unmarshalDocument(new FileInputStream(fin), null);
String encoding = ((UnmarshallingContext)uctx).getInputEncoding();
if (!mclas.isInstance(obj)) {
System.err.println("Unmarshalled result not expected type");
return false;
}
// marshal root object back out to document in memory
IMarshallingContext mctx = bfact.createMarshallingContext();
mctx.setIndent(2);
ByteArrayOutputStream bos = new ByteArrayOutputStream();
mctx.marshalDocument(obj, "UTF-8", null, bos);
// compare with output document to be matched
InputStreamReader brdr = new InputStreamReader
(new ByteArrayInputStream(bos.toByteArray()), "UTF-8");
InputStreamReader frdr = new InputStreamReader
(new FileInputStream(fout), encoding);
DocumentComparator comp = new DocumentComparator(System.err);
if (comp.compare(frdr, brdr)) {
return true;
} else {
// save file before returning failure
try {
FileOutputStream fos = new FileOutputStream("temp.xml");
fos.write(bos.toByteArray());
fos.close();
} catch (IOException ex) {
System.err.println("Error writing to temp.xml: " +
ex.getMessage());
}
return false;
}
}
public static void main(String[] args) {
if (args.length == 2 || (args.length > 0 && args.length % 3 == 0)) {
// delete generated output file if present
File temp = new File("temp.xml");
if (temp.exists()) {
temp.delete();
}
// process input arguments
int base = 0;
boolean err = false;
String fin = null;
String fout = null;
while (base < args.length) {
// run test with one argument set
fin = args[base+1];
fout = (args.length < base+3) ? fin : args[base+2];
try {
if (!runTest(args[base], null, fin, fout)) {
err = true;
}
} catch (Exception ex) {
ex.printStackTrace();
// System.err.println(ex.getMessage());
err = true;
}
// take error exit if difference found
if (err) {
System.err.println("Error round-tripping class: " + args[base] +
"\n with input file " + fin + " and output compared to " +
fout);
System.err.println("Saved output document file path " +
temp.getAbsolutePath());
System.exit(1);
}
// advance to next argument set
base += 3;
}
} else {
System.err.println("Usage: java TestRoundtrip mapped-class" +
" in-file [out-file]\n where out-file is only required if the" +
" output document is different from\nthe input document. " +
"Leaves output as temp.xml in case of error");
System.exit(1);
}
}
}
libjibx-java-1.1.6a/build/extras/org/jibx/extras/TypedArrayMapper.java 0000644 0001750 0001750 00000021572 10264402766 025652 0 ustar moeller moeller /*
Copyright (c) 2003-2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.extras;
import java.lang.reflect.Array;
import java.util.ArrayList;
import org.jibx.runtime.IAliasable;
import org.jibx.runtime.IMarshallable;
import org.jibx.runtime.IMarshaller;
import org.jibx.runtime.IMarshallingContext;
import org.jibx.runtime.IUnmarshaller;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.impl.MarshallingContext;
import org.jibx.runtime.impl.UnmarshallingContext;
/**
*
Custom marshaller/unmarshaller for reference arrays of a particular type.
* This handles mapping arrays typed as object-type[], where the
* object-type is any class name (not a primitive type). All items in the
* array must be of a mapped type. If a name is specified by the mapping
* definition that name is used as a wrapper around the elements representing
* the items in the array; otherwise, the elements are just handled inline.
*
* The token strings to be processed are specified on the command line as
* either enabled or disabled. See the program documentation for more details
* of the command line options and usage.
*
* Nested option blocks are allowed, but overlapping option blocks are an
* error. In order to ensure proper processing of nested option blocks, the
* user should generally specify every token used for the nested blocks
* as either enabled or disabled if any of them are either enabled or
* disabled. It is an error if an indeterminant beginning of block token (one
* with a token which is not on either list) is immediately contained within
* a block with an enabled token. In other words, the case:
*
* //#a{
* //#b{
* //#c{
* //#c}
* //#b}
* //#a}
*
* gives an error if "a" is on the enabled list and "b" is not on either list,
* or if "a" is not on the disabled list, "b" is on the enabled list, and "c"
* is not on either list.
*
* @author Dennis M. Sosnoski
* @version 0.8
*/
public class JEnable
{
/** Lead text for option token. */
protected static final String OPTION_LEAD = "//#";
/** Length of lead text for option token. */
protected static final int LEAD_LENGTH = OPTION_LEAD.length();
/** Size of buffer used to copy file. */
protected static final int COPY_BUFFER_SIZE = 4096;
/** Return code for not an option line. */
protected static final int NOT_OPTION = 0;
/** Return code for file option line. */
protected static final int FILE_OPTION = 1;
/** Return code for block start option line. */
protected static final int BLOCK_START_OPTION = 2;
/** Return code for block else option line. */
protected static final int BLOCK_ELSE_OPTION = 3;
/** Return code for block end option line. */
protected static final int BLOCK_END_OPTION = 4;
/** Return code for block comment option line. */
protected static final int BLOCK_COMMENT_OPTION = 5;
/** Error text for file option not on first line. */
protected static final String FILE_OPTION_ERR =
"file option token must be first line of file";
/** Error text for token nested within block for same token. */
protected static final String NESTED_SAME_ERR =
"block option start cannot be nested within block with same token";
/** Error text for indeterminant token nested in enabled block. */
protected static final String INDETERM_ERR =
"block option token within enabled block must be enabled or disabled";
/** Error text for block end token not matching block start token. */
protected static final String UNBALANCED_ERR =
"block option end without matching start";
/** Error text for block else token not matching block start token. */
protected static final String BADELSE_ERR =
"block option else without matching start";
/** Error text for end of file with open block. */
protected static final String UNCLOSED_ERR =
"end of file with open block";
/** Error text for unknown option token type. */
protected static final String UNKNOWN_OPTION_ERR =
"unknown option line type";
/** Error text for file option line with unknown file extension. */
protected static final String EXTENSION_ERR =
"unknown file option line extension";
/** Error text for unable to rename file to backup directory. */
protected static final String BACKUP_DIR_ERR =
"unable to create backup directory";
/** Error text for unable to delete old backup file. */
protected static final String OLD_BACKUP_ERR =
"unable to delete old backup file";
/** Error text for unable to rename file within directory. */
protected static final String BACKUP_FILE_ERR =
"unable to rename file for backup";
/** Error text for unable to delete original file. */
protected static final String DELETE_ERR =
"unable to delete input file";
/** Error text for unable to rename original file. */
protected static final String RENAME_ERR =
"unable to rename source file";
/** Error text for unable to rename temp file. */
protected static final String TEMP_RENAME_ERR =
"unable to rename temp file";
/** Error text for unable to delete temporary file. */
protected static final String TEMP_DELETE_ERR =
"unable to delete temporary output file";
/** Error text for unable to change file modify timestamp. */
protected static final String STAMP_ERR =
"unable to change file modify timestamp";
/** Error text for token in both sets. */
protected static final String DUAL_USE_ERR =
"Same token cannot be both enabled and disabled";
/** Preserve timestamp on modified files flag. */
protected boolean m_keepStamp;
/** Mark backup file with tilde flag. */
protected boolean m_markBackup;
/** List modified files flag. */
protected boolean m_listModified;
/** List all files processed flag. */
protected boolean m_listProcessed;
/** List file summary by path flag. */
protected boolean m_listSummary;
/** Backup root path (null if not backing up). */
protected File m_backupDir;
/** Map for enabled tokens (values same as keys). */
protected Hashtable m_enabledTokens;
/** Map for disabled tokens (values same as keys). */
protected Hashtable m_disabledTokens;
/** Number of files matched. */
protected int m_matchedCount;
/** Number of files modified. */
protected int m_modifiedCount;
/** Current option token, set by check method. */
private String m_token;
/** Inverted token flag, set by check method. */
private boolean m_invert;
/** Offset past end of token in line, set by check method. */
private int m_endOffset;
/**
* Constructor.
*
* @param keep preserve timestamp on modified files flag
* @param mark mark backup files with tilde flag
* @param mods list modified files flag
* @param quiet do not list file summaries by path flag
* @param verbose list all files processed flag
* @param backup root back for backup directory tree (null if
* no backups)
* @param enabled map of enabled tokens
* @param disabled map of disabled tokens
*/
protected JEnable(boolean keep, boolean mark, boolean mods, boolean quiet,
boolean verbose, File backup, Hashtable enabled, Hashtable disabled) {
m_keepStamp = keep;
m_markBackup = mark;
m_listModified = mods;
m_listProcessed = verbose;
m_listSummary = !quiet;
m_backupDir = backup;
m_enabledTokens = enabled;
m_disabledTokens = disabled;
}
/**
* Checks for valid first character of token. The first character must be
* an alpha or underscore.
*
* @param chr character to be validated
* @return true if valid first character, false
* if not
*/
protected static boolean isTokenLeadChar(char chr) {
return (chr >= 'a' && chr <= 'z') || (chr >= 'A' && chr <= 'Z') ||
chr == '_';
}
/**
* Checks for valid body character of token. All body characters must be
* an alpha, digits, or underscore.
*
* @param chr character to be validated
* @return true if valid body character, false
* if not
*/
protected static boolean isTokenBodyChar(char chr) {
return (chr >= 'a' && chr <= 'z') || (chr >= 'A' && chr <= 'Z') ||
chr == '_' || (chr >= '0' && chr <= '9');
}
/**
* Convenience method for generating an error report exception.
*
* @param lnum line number within file
* @param line source line to check for option
* @param msg error message text
* @throws IOException wrapping the error information
*/
protected void throwError(int lnum, String line, String msg)
throws IOException {
throw new IOException("Error on input line " + lnum + ", " +
msg + ":\n" + line);
}
/**
* Check if line is an option. Returns a code for the option line type
* (or "not an option line"), with the actual token from the line stored
* in the instance variable. Ugly technique, but the only easy way to
* return multiple results without using another class.
*
* @param lnum line number within file (used for error reporting)
* @param line source line to check for option
* @return return code for option line type
* @throws IOException on option line error
*/
protected int checkOptionLine(int lnum, String line) throws IOException {
// check if line is a candidate for option token
int type = NOT_OPTION;
m_token = null;
m_invert = false;
m_endOffset = 0;
if (line.length() > LEAD_LENGTH && line.startsWith(OPTION_LEAD)) {
// check for special leading character before token
int offset = LEAD_LENGTH;
char lead = line.charAt(offset);
if (lead == '!' || lead == '}') {
offset++;
} else {
lead = 0;
}
// make sure a valid token start character follows
int start = offset;
if (isTokenLeadChar(line.charAt(start))) {
// parse the token characters
int scan = LEAD_LENGTH+1;
while (scan < line.length()) {
char chr = line.charAt(scan++);
if (!isTokenBodyChar(chr)) {
// token found, classify and set type
m_token = line.substring(start, scan-1);
m_endOffset = scan;
switch (chr) {
case '*':
// file option, inverted token is only variation
type = FILE_OPTION;
if (lead == '!') {
m_invert = true;
} else if (lead != 0) {
throwError(lnum, line, UNKNOWN_OPTION_ERR);
}
break;
case '{':
// block start option, check variations
if (lead == '}') {
type = BLOCK_ELSE_OPTION;
} else {
if (lead == '!') {
m_invert = true;
}
type = BLOCK_START_OPTION;
}
break;
case '}':
// block end option, no variations allowed
type = BLOCK_END_OPTION;
if (lead != 0) {
throwError(lnum, line, UNKNOWN_OPTION_ERR);
}
break;
case ':':
// block comment option, no variations allowed
type = BLOCK_COMMENT_OPTION;
if (lead != 0) {
throwError(lnum, line, UNKNOWN_OPTION_ERR);
}
break;
default:
// no idea what this is supposed to be
throwError(lnum, line, UNKNOWN_OPTION_ERR);
break;
}
break;
}
}
}
}
return type;
}
/**
* Processes source options for a text stream. If an error occurs in
* processing, this generates an IOException with the error
* information (including input line number).
*
* @param in input reader for source data
* @param lead first line of file (previously read for checking file enable
* or disable)
* @param out output writer for modified source data
* @return true if source modified, false if not
*/
protected boolean processStream(BufferedReader in, String lead,
BufferedWriter out) throws IOException {
// initialize state information
Stack enables = new Stack();
Stack nests = new Stack();
String disable = null;
boolean changed = false;
// basic file line copy loop
String line = lead;
int lnum = 1;
while (line != null) {
// process based on option type
boolean option = true;
int type = checkOptionLine(lnum, line);
switch (type) {
case NOT_OPTION:
option = false;
break;
case FILE_OPTION:
// file option processed outside, but must be first line
if (lnum > 1) {
throwError(lnum, line, FILE_OPTION_ERR);
}
break;
case BLOCK_START_OPTION:
// option block start token, must not be duplicated
if (nests.indexOf(m_token) >= 0) {
throwError(lnum, line, NESTED_SAME_ERR);
} else {
// push to nesting stack and check if we're handling
nests.push(m_token);
if (disable == null) {
// see if we know about this token
boolean on = m_enabledTokens.containsKey(m_token);
boolean off = m_disabledTokens.containsKey(m_token);
// swap flags if inverted token
if (m_invert) {
boolean hold = on;
on = off;
off = hold;
}
// handle start of block
if (off) {
// set disabling option
disable = m_token;
} else if (on) {
// stack enabled option
enables.push(m_token);
} else if (!enables.empty()) {
// error if unknown inside enable
throwError(lnum, line, INDETERM_ERR);
}
}
}
break;
case BLOCK_ELSE_OPTION:
// option block else, must match top of nesting stack
if (nests.empty() || !nests.peek().equals(m_token)) {
throwError(lnum, line, BADELSE_ERR);
} else {
// reverse current state, if known
if (disable == null) {
// enabled state, check if top of stack
if (!enables.empty()) {
if (enables.peek().equals(m_token)) {
// flip to disable state
enables.pop();
disable = m_token;
}
}
} else if (disable.equals(m_token)) {
// flip to enable state
disable = null;
enables.push(m_token);
}
}
break;
case BLOCK_END_OPTION:
// option block end, must match top of nesting stack
if (nests.empty() || !nests.peek().equals(m_token)) {
throwError(lnum, line, UNBALANCED_ERR);
} else {
// remove from nesting stack and check state
nests.pop();
if (disable == null) {
// enabled state, check if top of stack
if (!enables.empty()) {
if (enables.peek().equals(m_token)) {
enables.pop();
}
}
} else if (disable.equals(m_token)) {
disable = null;
}
}
break;
case BLOCK_COMMENT_OPTION:
// disabled line option, check if clearing
if ((disable != null && !disable.equals(m_token)) ||
(disable == null && enables.contains(m_token))) {
// clear disabled line option
line = line.substring(m_endOffset);
option = false;
changed = true;
}
break;
default:
throwError(lnum, line, UNKNOWN_OPTION_ERR);
}
// check for disabling lines
if (!option && disable != null) {
// change line to disabled state
line = OPTION_LEAD + disable + ':' + line;
changed = true;
}
// write (possibly modified) line to output
out.write(line);
out.newLine();
// read next line of input
line = in.readLine();
lnum++;
}
// check for valid end state
if (nests.size() > 0) {
throwError(lnum, (String)nests.pop(), UNCLOSED_ERR);
}
out.flush();
return changed;
}
/**
* Processes source options for a file. Starts by checking the first line
* of the file for a file option and processing that. If, after processing
* the file option, the file has a ".java" extension, it is processed for
* other option lines.
*
* This saves the output to a temporary file, then if processing is
* completed successfully first renames or moves the original file (if
* backup has been requested), or deletes it (if backup not requested),
* and then renames the temporary file to the original file name.
*
* Processing errors are printed to System.err, and any
* results are discarded without being saved.
*
* @param file source file to be processed
* @return true if source modified, false if not
*/
protected boolean processFile(File file) {
File temp = null;
try {
// set up basic information
String name = file.getName();
String dir = file.getParent();
int split = name.lastIndexOf('.');
String ext = (split >= 0) ? name.substring(split+1) : "";
String toext = ext;
long stamp = m_keepStamp ? file.lastModified() : 0;
File target = file;
// check first line for file option
BufferedReader in = new BufferedReader(new FileReader(file));
String line = in.readLine();
int type = checkOptionLine(1, line);
if (type == FILE_OPTION) {
// make sure we have one of the extensions we know about
if (ext.equals("java") || ext.equals("javx")) {
// set "to" extension based on option setting
if (m_enabledTokens.contains(m_token)) {
toext = m_invert ? "javx" : "java";
} else if (m_disabledTokens.contains(m_token)) {
toext = m_invert ? "java" : "javx";
}
// generate new target file name if different extension
if (!toext.equals(ext)) {
split = name.indexOf('.');
name = name.substring(0, split) + '.' + toext;
target = new File(dir, name);
}
} else {
throw new IOException(EXTENSION_ERR);
}
}
// check if extension valid for processing
boolean changed = false;
if (!toext.equals("javx")) {
// set up output to temporary file in same directory
temp = File.createTempFile("sop", null, file.getParentFile());
BufferedWriter out = new BufferedWriter(new FileWriter(temp));
// process the file for changes
changed = processStream(in, line, out);
in.close();
out.close();
if (changed) {
// handle backup of original file
if (m_backupDir != null) {
// construct path within backup directory
String extra = file.getCanonicalPath();
int mark = extra.indexOf(File.separatorChar);
if (mark >= 0) {
extra = extra.substring(mark+1);
}
File backup = new File(m_backupDir, extra);
// copy file to backup directory
File backdir = backup.getParentFile();
if (!backdir.exists() && !backdir.mkdirs()) {
throw new IOException(BACKUP_DIR_ERR + '\n' +
backdir.getPath());
}
if (backup.exists()) {
if (!backup.delete()) {
throw new IOException(OLD_BACKUP_ERR);
}
}
byte[] buff = new byte[COPY_BUFFER_SIZE];
InputStream is = new FileInputStream(file);
OutputStream os = new FileOutputStream(backup);
int bytes;
while ((bytes = is.read(buff)) >= 0) {
os.write(buff, 0, bytes);
}
is.close();
os.close();
backup.setLastModified(file.lastModified());
}
if (m_markBackup) {
// suffix file name with tilde
File backup = new File(dir, name+'~');
if (backup.exists()) {
if (!backup.delete()) {
throw new IOException(OLD_BACKUP_ERR);
}
}
if (!file.renameTo(backup)) {
throw new IOException(BACKUP_FILE_ERR);
}
} else {
// just delete the original file
if (!file.delete()) {
throw new IOException(DELETE_ERR);
}
}
// rename temp to target name
if (temp.renameTo(target)) {
if (m_keepStamp && !target.setLastModified(stamp)) {
throw new IOException(STAMP_ERR);
}
} else {
throw new IOException(TEMP_RENAME_ERR);
}
} else {
// just discard the temporary output file
if (!temp.delete()) {
throw new IOException(TEMP_DELETE_ERR);
}
// check if file needs to be renamed
if (!toext.equals(ext)) {
// just rename file for file option result
if (file.renameTo(target)) {
changed = true;
if (m_keepStamp && !target.setLastModified(stamp)) {
throw new IOException(STAMP_ERR);
}
} else {
throw new IOException(RENAME_ERR);
}
}
}
} else if (!toext.equals(ext)) {
// just rename file for file option result
in.close();
if (file.renameTo(target)) {
changed = true;
if (m_keepStamp && !target.setLastModified(stamp)) {
throw new IOException(STAMP_ERR);
}
} else {
throw new IOException(RENAME_ERR);
}
}
// check file listing
if (changed && (m_listProcessed || m_listModified)) {
System.out.println(" modified file " + file.getPath());
} else if (m_listProcessed) {
System.out.println(" checked file " + file.getPath());
}
return changed;
} catch (Exception ex) {
// report error
System.err.println("Error processing " + file.getPath());
System.err.println(ex.getMessage());
// discard temporary output file
if (temp != null) {
try {
temp.delete();
} catch (Exception ex2) {}
}
return false;
}
}
/**
* Checks if file or directory name directly matches a pattern. This
* method accepts one or more '*' wildcard characters in the pattern,
* calling itself recursively in order to handle multiple wildcards.
*
* @param name file or directory name
* @param pattern match pattern
* @return true if any pattern matched, false
* if not
*/
protected boolean isPathMatch(String name, String pattern) {
// check special match cases first
if (pattern.length() == 0) {
return name.length() == 0;
} else if (pattern.charAt(0) == '*') {
// check if the wildcard is all that's left of pattern
if (pattern.length() == 1) {
return true;
} else {
// check if another wildcard follows next segment of text
pattern = pattern.substring(1);
int split = pattern.indexOf('*');
if (split > 0) {
// recurse on each match to text segment
String piece = pattern.substring(0, split);
pattern = pattern.substring(split);
int offset = -1;
while ((offset = name.indexOf(piece, ++offset)) > 0) {
int end = offset + piece.length();
if (isPathMatch(name.substring(end), pattern)) {
return true;
}
}
} else {
// no more wildcards, need exact match to end of name
return name.endsWith(pattern);
}
}
} else {
// check for leading text before first wildcard
int split = pattern.indexOf('*');
if (split > 0) {
// match leading text to start of name
String piece = pattern.substring(0, split);
if (name.startsWith(piece)) {
return isPathMatch(name.substring(split),
pattern.substring(split));
} else {
return false;
}
} else {
// no wildcards, need exact match
return name.equals(pattern);
}
}
return false;
}
/**
* Checks if file name matches a pattern. This works a little differently
* from the general path matching in that if the pattern does not include
* an extension both ".java" and ".javx" file extensions are matched. If
* the pattern includes an extension ending in '*' it is blocked from
* matching with a tilde final character in the file name as a special case.
*
* @param name file or directory name
* @param pattern match pattern
* @return true if any file modified, false if not
*/
protected boolean isNameMatch(String name, String pattern) {
// check for extension included in pattern
if (pattern.indexOf('.') >= 0) {
// pattern includes extension, use as is except for tilde endings
if (name.charAt(name.length()-1) != '~' ||
pattern.charAt(pattern.length()-1) == '~') {
return isPathMatch(name, pattern);
}
} else {
// split extension from file name
int split = name.lastIndexOf('.');
if (split >= 0) {
// check for valid extension with match on name
String ext = name.substring(split+1);
if (ext.equals("java") || ext.equals("javx")) {
return isPathMatch(name.substring(0, split), pattern);
}
}
}
return false;
}
/**
* Process files matching path segment. This method matches a single step
* (directory specification) in a path for each call, calling itself
* recursively to match the complete path.
*
* @param base base directory for path match
* @param path file path remaining to be processed
*/
protected void matchPathSegment(File base, String path) {
// find break for leading directory if any in path
File[] files = base.listFiles();
int split = path.indexOf('/');
if (split >= 0) {
// split off the directory and check it
String dir = path.substring(0, split);
String next = path.substring(split+1);
if (dir.equals("**")) {
// match directly against files in this directory
matchPathSegment(base, next);
// walk all directories in tree under this one
for (int i = 0; i < files.length; i++) {
if (files[i].isDirectory()) {
matchPathSegment(files[i], path);
}
}
} else {
// try for concrete match to directory
for (int i = 0; i < files.length; i++) {
if (files[i].isDirectory()) {
if (isPathMatch(files[i].getName(), dir)) {
matchPathSegment(files[i], next);
}
}
}
}
} else {
// match directly against files in this directory
for (int i = 0; i < files.length; i++) {
if (!files[i].isDirectory()) {
if (isNameMatch(files[i].getName(), path)) {
m_matchedCount++;
if (processFile(files[i])) {
m_modifiedCount++;
}
}
}
}
}
}
/**
* Process all files matching path and print summary. The file path
* format is similar to Ant, supporting arbitrary directory recursion using
* '**' separators between '/' separators. Single '*'s may be used within
* names for wildcarding, but aside from the special case of the directory
* recursion matcher only one '*' may be used per name.
*
* If an extension is
* not specified for the final name in the path both ".java" and ".javx"
* extensions are checked, but after checking for file option lines (which
* may change the file extension) only ".java" extensions are processed for
* other source options.
*
* @param path file path to be processed
*/
protected void processPath(String path) {
// make sure we have something to process
if (path.length() > 0) {
// begin matching from root or current directory
if (path.charAt(0) == '/') {
matchPathSegment(new File(File.separator), path.substring(1));
} else {
matchPathSegment(new File("."), path);
}
// print summary information for path
if (m_listSummary) {
System.out.println(" matched " + m_matchedCount +
" files and modified " + m_modifiedCount +
" for path: " + path);
m_matchedCount = 0;
m_modifiedCount = 0;
}
}
}
/**
* Parse comma-separated token list. Parses and validates the tokens,
* adding them to the supplied list. errors are signalled by throwing
* IllegalArgumentException.
*
* @param list comma-separated token list to be parsed
* @param tokens list of tokens to add to
* @throws IllegalArgumentException on error in supplied list
*/
protected static void parseTokenList(String list, Vector tokens) {
// accumulate comma-delimited tokens from list
while (list.length() > 0) {
// find end for next token
int mark = list.indexOf(',');
String token;
if (mark == 0) {
throw new IllegalArgumentException("Empty token not " +
"allowed: \"" + list + '"');
} else if (mark > 0) {
// split token off list
token = list.substring(0, mark);
list = list.substring(mark+1);
} else {
// use rest of list as final token
token = list;
list = "";
}
// validate the token
for (int i = 0; i < token.length(); i++) {
char chr = token.charAt(i);
if ((i == 0 && !isTokenLeadChar(chr)) ||
(i > 0 && !isTokenBodyChar(chr))) {
throw new IllegalArgumentException("Illegal " +
"character in token: \"" + token + '"');
}
}
// add validated token to list
tokens.add(token);
}
}
/**
* Test driver, just reads the input parameters and executes the source
* checks.
*
* @param argv command line arguments
*/
public static void main(String[] argv) {
if (argv.length > 0) {
// parse the leading command line parameters
boolean valid = true;
boolean keep = false;
boolean listmod = false;
boolean quiet = false;
boolean tilde = false;
boolean verbose = false;
File backup = null;
Vector enables = new Vector();
Vector disables = new Vector();
int anum = 0;
while (anum < argv.length && argv[anum].charAt(0) == '-') {
String arg = argv[anum++];
int cnum = 1;
while (cnum < arg.length()) {
char option = Character.toLowerCase(arg.charAt(cnum++));
switch (option) {
case 'b':
if (anum < argv.length) {
try {
backup = new File(argv[anum++]);
if (!backup.isDirectory()) {
System.err.println("Backup directory " +
"path must be a directory");
}
} catch (SecurityException ex) {
System.err.println("Unable to access " +
"backup directory");
}
} else {
System.err.println("Missing directory path " +
"for -b option");
}
break;
case 'd':
case 'e':
if (anum < argv.length) {
// accumulate comma-delimited tokens from list
Vector tokens = (option == 'd') ?
disables : enables;
try {
parseTokenList(argv[anum++], tokens);
} catch (IllegalArgumentException ex) {
System.err.println(ex.getMessage());
return;
}
if (option == 'd') {
disables = tokens;
} else {
enables = tokens;
}
} else {
System.err.println("Missing token list for -" +
option + " option");
return;
}
break;
case 'p':
keep = true;
break;
case 'q':
quiet = true;
break;
case 'm':
listmod = true;
break;
case 't':
tilde = true;
break;
case 'v':
verbose = true;
break;
default:
System.err.println("Unknown option -" + option);
return;
}
}
}
// build hashsets of the tokens, checking for overlap
Hashtable enabled = new Hashtable();
for (int i = 0; i < enables.size(); i++) {
Object token = enables.elementAt(i);
enabled.put(token, token);
}
Hashtable disabled = new Hashtable();
for (int i = 0; i < disables.size(); i++) {
Object token = disables.elementAt(i);
disabled.put(token, token);
if (enabled.containsKey(token)) {
System.err.println(DUAL_USE_ERR + ": " + token);
return;
}
}
// construct an instance of class
JEnable opt = new JEnable(keep, tilde, listmod, quiet, verbose,
backup, enabled, disabled);
// check if we have file paths
if (anum < argv.length) {
// process each file path supplied
while (anum < argv.length) {
String arg = argv[anum++];
int split;
while ((split = arg.indexOf(',')) > 0) {
String path = arg.substring(0, split);
opt.processPath(path);
arg = arg.substring(split+1);
}
opt.processPath(arg);
}
} else {
// just process standard input to standard output
BufferedReader in = new BufferedReader
(new InputStreamReader(System.in));
BufferedWriter out = new BufferedWriter
(new OutputStreamWriter(System.out));
// check first line for disabled token
try {
String line = in.readLine();
int type = opt.checkOptionLine(1, line);
if (type == FILE_OPTION) {
boolean discard = opt.m_invert ?
enabled.contains(opt.m_token) :
disabled.contains(opt.m_token);
if (discard) {
return;
}
}
opt.processStream(in, line, out);
} catch (IOException ex) {
System.err.println(ex.getMessage());
}
}
} else {
System.err.println
("\nJEnable Java source configuration processor version " +
"0.8\nUsage: JEnable [-options] path-list\n" +
"Options are:\n" +
" -b backup directory tree (base directory is next " +
"argument)\n" +
" -d disabled token list (comma-separated token name list" +
" is next argument)\n" +
" -e enabled token list (comma-separated token name list" +
" is next argument)\n" +
" -m list modified files as they're processed\n" +
" -p preserve timestamp on modified files\n" +
" -q quiet mode, do not print file summary by path\n" +
" -t backup modified files in same directory with '~' " +
"suffix\n" +
" -v verbose listing of all files processed (modified or " +
"not)\n" +
"These options may be concatenated together with a single" +
" leading dash.\n\n" +
"Path lists may include '*' wildcards, and may consist of " +
"multiple paths\n" +
"separated by ',' characters. The special directory " +
"pattern '**' matches\n" +
"any number of intervening directories. Any number of path " +
"list parameters may\n" +
"be supplied.\n");
}
}
}
libjibx-java-1.1.6a/build/maven2/ 0000755 0001750 0001750 00000000000 11023035452 016364 5 ustar moeller moeller libjibx-java-1.1.6a/build/maven2/build-remote-maven-repository.sh 0000644 0001750 0001750 00000001767 11023022262 024637 0 ustar moeller moeller # Hack: I don't know why jibx-extras upload the POM whereas jibx-run and jibx-bind don't!
scp jibx-run.pom $username@shell.sf.net:/home/groups/j/ji/jibx/htdocs/maven2/org/jibx/jibx-run/1.1.6/jibx-run-1.1.6.pom
scp jibx-bind.pom $username@shell.sf.net:/home/groups/j/ji/jibx/htdocs/maven2/org/jibx/jibx-bind/1.1.6/jibx-bind-1.1.6.pom
# Regular deployment on Maven 2 repository
mvn deploy:deploy-file -Dversion=1.1.6 -Dfile=../../lib/jibx-run.jar -DpomFile=jibx-run.pom -Dpackaging=jar -DrepositoryId=sf.net -DgeneratePom=true -Durl=scp://shell.sf.net/home/groups/j/ji/jibx/htdocs/maven2
mvn deploy:deploy-file -Dversion=1.1.6 -Dfile=../../lib/jibx-bind.jar -DpomFile=jibx-bind.pom -Dpackaging=jar -DrepositoryId=sf.net -DgeneratePom=true -Durl=scp://shell.sf.net/home/groups/j/ji/jibx/htdocs/maven2
mvn deploy:deploy-file -Dversion=1.1.6 -Dfile=../../lib/jibx-extras.jar -DpomFile=jibx-extras.pom -Dpackaging=jar -DrepositoryId=sf.net -DgeneratePom=true -Durl=scp://shell.sf.net/home/groups/j/ji/jibx/htdocs/maven2
libjibx-java-1.1.6a/build/maven2/jibx-bind.pom 0000644 0001750 0001750 00000004016 11023022264 020745 0 ustar moeller moeller 4.0.0org.jibxjibx-bind1.1.6jarjibx-bindhttp://jibx.sourceforge.netJiBX bindBSDhttp://jibx.sourceforge.net/jibx-license.htmlrepoorg.jibxjibx-run1.1.6bcelbcel5.1sf.netscp://shell.sf.net/home/groups/j/ji/jibx/htdocs/maven2sf.netscp://shell.sf.net/home/groups/j/ji/jibx/htdocs/maven-jibx-pluginjirahttp://jira.codehaus.org/browse/JIBXorg.apache.maven.pluginsmaven-project-info-reports-pluginjibx.sf.netJiBX repositoryhttp://jibx.sf.net/maven2neverfalsescm:cvs:pserver:anonymous@cvs.sourceforge.net:/cvsroot/jibx:maven-jibx-pluginscm:cvs:ext:developername@cvs.sourceforge.net:/cvsroot/jibx:maven-jibx-pluginhttp://cvs.sourceforge.net/viewcvs.py/jibx/maven-jibx-plugin/ libjibx-java-1.1.6a/build/maven2/jibx-extras.pom 0000644 0001750 0001750 00000003644 11023022264 021345 0 ustar moeller moeller 4.0.0org.jibxjibx-extras1.1.6jarjibx-extrashttp://jibx.sourceforge.netJiBX extrasBSDhttp://jibx.sourceforge.net/jibx-license.htmlrepoorg.jibxjibx-run1.1.6sf.netscp://shell.sf.net/home/groups/j/ji/jibx/htdocs/maven2sf.netscp://shell.sf.net/home/groups/j/ji/jibx/htdocs/maven-jibx-pluginjirahttp://jira.codehaus.org/browse/JIBXorg.apache.maven.pluginsmaven-project-info-reports-pluginjibx.sf.netJiBX repositoryhttp://jibx.sf.net/maven2neverfalsescm:cvs:pserver:anonymous@cvs.sourceforge.net:/cvsroot/jibx:maven-jibx-pluginscm:cvs:ext:developername@cvs.sourceforge.net:/cvsroot/jibx:maven-jibx-pluginhttp://cvs.sourceforge.net/viewcvs.py/jibx/maven-jibx-plugin/ libjibx-java-1.1.6a/build/maven2/jibx-run.pom 0000644 0001750 0001750 00000003653 11023022264 020643 0 ustar moeller moeller 4.0.0org.jibxjibx-run1.1.6jarjibx-runhttp://jibx.sourceforge.netJiBX runBSDhttp://jibx.sourceforge.net/jibx-license.htmlrepoorg.codehaus.woodstoxwstx-asl3.2.1sf.netscp://shell.sf.net/home/groups/j/ji/jibx/htdocs/maven2sf.netscp://shell.sf.net/home/groups/j/ji/jibx/htdocs/maven-jibx-pluginjirahttp://jira.codehaus.org/browse/JIBXorg.apache.maven.pluginsmaven-project-info-reports-pluginjibx.sf.netJiBX repositoryhttp://jibx.sf.net/maven2neverfalsescm:cvs:pserver:anonymous@cvs.sourceforge.net:/cvsroot/jibx:maven-jibx-pluginscm:cvs:ext:developername@cvs.sourceforge.net:/cvsroot/jibx:maven-jibx-pluginhttp://cvs.sourceforge.net/viewcvs.py/jibx/maven-jibx-plugin/ libjibx-java-1.1.6a/build/src/ 0000755 0001750 0001750 00000000000 11021525446 015770 5 ustar moeller moeller libjibx-java-1.1.6a/build/src/org/ 0000755 0001750 0001750 00000000000 11021525446 016557 5 ustar moeller moeller libjibx-java-1.1.6a/build/src/org/jibx/ 0000755 0001750 0001750 00000000000 11021525452 017510 5 ustar moeller moeller libjibx-java-1.1.6a/build/src/org/jibx/binding/ 0000755 0001750 0001750 00000000000 11023035620 021115 5 ustar moeller moeller libjibx-java-1.1.6a/build/src/org/jibx/binding/ant/ 0000755 0001750 0001750 00000000000 11023035622 021701 5 ustar moeller moeller libjibx-java-1.1.6a/build/src/org/jibx/binding/ant/CompileTask.java 0000644 0001750 0001750 00000025177 10221057702 024775 0 ustar moeller moeller /*
Copyright (c) 2003, Andrew J. Glover
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.ant;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
import org.apache.tools.ant.AntClassLoader;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.DirectoryScanner;
import org.apache.tools.ant.Task;
import org.apache.tools.ant.types.FileSet;
import org.apache.tools.ant.types.Path;
import org.jibx.binding.Compile;
import org.jibx.runtime.JiBXException;
/**
* Class alters user defined class files for JiBX functionality.
* @author aglover
* @author pledbrook
*/
public class CompileTask extends Task {
private boolean m_load;
private boolean m_verbose;
private Path m_classpath;
private List m_fileSet;
private List m_bindingFileSet;
private String m_bindingFile;
/**
* Hook method called by ant framework to handle
* task initialization.
*
*/
public void init() throws BuildException {
//
// Do aprent initialisation first.
//
super.init();
//
// Now create the lists that store the classpathsets and
// the bindingsets.
//
m_fileSet = new ArrayList();
m_bindingFileSet = new ArrayList();
}
/**
* Returns an array of paths of all the files specified by the
* or tags. Note that the
* and tags cannot both be specified.
*/
private String[] getPaths() {
String[] pathArray = null;
if (m_classpath != null) {
//
// If a tag has been set, m_classpath will
// not be null. In this case, just return the array of
// paths directly.
//
pathArray = m_classpath.list();
} else {
//
// Store the directory paths specified by each of the
// tags.
//
pathArray = new String[m_fileSet.size()];
for(int i = 0; i < m_fileSet.size(); i++) {
FileSet fileSet = (FileSet)m_fileSet.get(i);
File directory = fileSet.getDir(project);
pathArray[i] = directory.getAbsolutePath();
}
}
// make Ant classpath usable by application
try {
System.setProperty("java.class.path",
((AntClassLoader)CompileTask.class.getClassLoader()).getClasspath());
} catch (Exception e) {
System.err.println("Failed setting classpath from Ant task");
}
//
// If verbose mode is on, print out the paths we are using.
//
if (m_verbose) {
log("Using the following paths:");
for (int i = 0; i < pathArray.length; i++) {
log(" " + pathArray[i]);
}
}
return pathArray;
}
/**
* Returns an array of all the paths specified by the "binding"
* attribute or the tags.
*/
private String[] getBindings() {
String[] bindings = null;
if (m_bindingFileSet.size() == 0) {
//
// No tags have been specified, so use
// the task's "binding" attribute instead.
//
bindings = new String[] { m_bindingFile };
} else {
//
// For each fileset, get all the file paths included by it.
//
ArrayList paths = new ArrayList();
for(int i = 0; i < m_bindingFileSet.size(); i++){
FileSet bPath = (FileSet)m_bindingFileSet.get(i);
DirectoryScanner dirScn = bPath.getDirectoryScanner(project);
String[] bndingFiles = dirScn.getIncludedFiles();
for(int x = 0; x < bndingFiles.length; x++){
String fullPath = dirScn.getBasedir()
+ System.getProperty("file.separator")
+ bndingFiles[x];
paths.add(fullPath);
}
}
//
// Convert the ArrayList of binding files into a native array.
//
bindings = (String[])paths.toArray(new String[paths.size()]);
}
//
// If verbose mode is on, print out the binding files
// we are using.
//
if (m_verbose) {
log("Using the following binding paths:");
for (int i = 0; i < bindings.length; i++) {
log(" " + bindings[i]);
}
}
return bindings;
}
/**
* This checks that the build file has specified the correct
* mix of <classpath>, <classpathset>, <bindingfileset>
* and "binding". The rules are as follows:
*
*
Either the "binding" attribute or <bindingfileset>
* tags must be set. Not both.
*
Either a single <classpath> tag or multiple
* <classpathset> tags must be set. Not both.
*
* @throws BuildException
*/
private void validateRequiredFields() throws BuildException {
//
// Check at least one of the binding file properties is set.
//
if (m_bindingFileSet.isEmpty() && m_bindingFile == null) {
throw new BuildException("Either the binding attribute or at "
+ "least one bindingset nested element "
+ "must be defined.");
}
//
// Make sure that the "binding" attribute has not been used with the
// nested element.
//
if (!m_bindingFileSet.isEmpty() && m_bindingFile != null) {
throw new BuildException("You cannot specify both a binding attribute and a "
+ "bindingset nested element.");
}
//
// Check either or has been set.
//
if(m_classpath == null && m_fileSet.isEmpty()) {
throw new BuildException("You must specify either a classpath "
+ "or at least one nested classpathset element.");
}
//
// Make sure that only one of the above is specified.
//
if (m_classpath != null && !m_fileSet.isEmpty()) {
throw new BuildException("You cannot specify both a classpath and a "
+ "classpathset nested element.");
}
}
/**
*
* Hook method called by Ant. Method first determines
* class file path from user defined value, then
* determines all binding files for class file weaving.
*
*/
public void execute() throws BuildException{
try{
validateRequiredFields();
String[] pathArr = getPaths();
String[] bindings = getBindings();
Compile compiler = new Compile();
//right now there is an issue with dynamically loading
//class files with ant. it doesnt work unless the class
//files are part of ANT's classpath. so I am forcing this
//to always be false until we can come up with a better solution.
compiler.setLoad(m_load);
compiler.setVerbose(m_verbose);
compiler.compile(pathArr, bindings);
} catch(JiBXException jEx) {
jEx.printStackTrace();
throw new BuildException("JiBXException in JiBX binding compilation", jEx);
}
}
/**
*
* @param fSet
*/
public void addClassPathSet(FileSet fSet){
m_fileSet.add(fSet);
}
/**
* Returns the current classpath.
*/
public Path getClasspath() {
return m_classpath;
}
/**
* Sets the classpath for this task. Multiple calls append the
* new classpath to the current one, rather than overwriting it.
* @param classpath The new classpath as a Path object.
*/
public void setClasspath(Path classpath) {
if (m_classpath == null) {
m_classpath = classpath;
}
else {
m_classpath.append(classpath);
}
}
/**
* Creates the classpath for this task and returns
* it. If the classpath has already been created,
* the method just returns that one.
*/
public Path createClasspath() {
if (m_classpath == null) {
m_classpath = new Path(project);
}
return m_classpath;
}
/**
* @param file
*/
public void setBinding(String file) {
m_bindingFile = file;
}
/**
*
* @param bfSet
*/
public void addBindingFileSet(FileSet bfSet) {
m_bindingFileSet.add(bfSet);
}
/**
* @param bool
*/
public void setLoad(boolean bool) {
m_load = bool;
}
/**
* @param bool
*/
public void setVerbose(boolean bool) {
m_verbose = bool;
}
}
libjibx-java-1.1.6a/build/src/org/jibx/binding/classes/ 0000755 0001750 0001750 00000000000 11023035622 022554 5 ustar moeller moeller libjibx-java-1.1.6a/build/src/org/jibx/binding/classes/BindingMethod.java 0000644 0001750 0001750 00000015737 10210703666 026156 0 ustar moeller moeller /*
Copyright (c) 2003-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.classes;
import org.apache.bcel.Constants;
import org.apache.bcel.classfile.ExceptionTable;
import org.apache.bcel.classfile.Method;
/**
* Binding method information. Tracks a method used by the binding code,
* supplying hash code and equality checking based on the method signature and
* actual byte code of the method, ignoring the method name. This allows
* comparisons between methods generated by different bindings, and between
* generated and existing methods.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public abstract class BindingMethod
{
/** Owning class file information. */
private ClassFile m_classFile;
/**
* Constructor.
*
* @param cf owning class file information
*/
protected BindingMethod(ClassFile cf) {
m_classFile = cf;
}
/**
* Get class file containing method.
*
* @return class file owning this method
*/
public ClassFile getClassFile() {
return m_classFile;
}
/**
* Get name of method. This abstract method must be implemented by every
* subclass.
*
* @return method name
*/
public abstract String getName();
/**
* Get signature. This abstract method must be implemented by every
* subclass.
*
* @return signature for method
*/
public abstract String getSignature();
/**
* Get access flags. This abstract method must be implemented by every
* subclass.
*
* @return flags for access type of method
*/
public abstract int getAccessFlags();
/**
* Set access flags. This abstract method must be implemented by every
* subclass.
*
* @param flags access type to be set
*/
public abstract void setAccessFlags(int flags);
/**
* Get the actual method.
*
* @return method information
*/
public abstract Method getMethod();
/**
* Get the method item.
*
* @return method item information
*/
public abstract ClassItem getItem();
/**
* Make accessible method. Check if this method is accessible from another
* class, and if not decreases the access restrictions to make it
* accessible.
*
* @param src class file for required access
*/
public void makeAccessible(ClassFile src) {
// no need to change if already public access
int access = getAccessFlags();
if ((access & Constants.ACC_PUBLIC) == 0) {
// check for same package as most restrictive case
ClassFile dest = getClassFile();
if (dest.getPackage().equals(src.getPackage())) {
if ((access & Constants.ACC_PRIVATE) != 0) {
access = access - Constants.ACC_PRIVATE;
}
} else {
// check if access is from a subclass of this method class
ClassFile ancestor = src;
while ((ancestor = ancestor.getSuperFile()) != null) {
if (ancestor == dest) {
break;
}
}
// handle access adjustments based on subclass status
if (ancestor == null) {
int clear = Constants.ACC_PRIVATE |
Constants.ACC_PROTECTED;
access = (access & ~clear) | Constants.ACC_PUBLIC;
} else if ((access & Constants.ACC_PROTECTED) == 0) {
access = (access & ~Constants.ACC_PRIVATE) |
Constants.ACC_PROTECTED;
}
}
// set new access flags
if (access != getAccessFlags()) {
setAccessFlags(access);
}
}
}
/**
* Computes the hash code for a method. The hash code is based on the
* method signature, the exceptions thrown, and the actual byte code
* (including the exception handlers).
*
* @return computed hash code for method
*/
public static int computeMethodHash(Method method) {
int hash = method.getSignature().hashCode();
ExceptionTable etab = method.getExceptionTable();
if (etab != null) {
String[] excepts = etab.getExceptionNames();
for (int i = 0; i < excepts.length; i++) {
hash += excepts[i].hashCode();
}
}
byte[] code = method.getCode().getCode();
for (int i = 0; i < code.length; i++) {
hash = hash * 49 + code[i];
}
return hash;
}
/**
* Get hash code. This abstract method must be implemented by every
* subclass, using the same algorithm in each case. See one of the existing
* subclasses for details.
*
* @return hash code for this method
*/
public abstract int hashCode();
/**
* Check if objects are equal. Compares first based on hash code, then on
* the actual byte code sequence.
*
* @return true if equal objects, false if not
*/
public boolean equals(Object obj) {
if (obj instanceof BindingMethod) {
BindingMethod comp = (BindingMethod)obj;
if (hashCode() == comp.hashCode() &&
getSignature().equals(comp.getSignature())) {
return ClassFile.equalMethods
(this.getMethod(), comp.getMethod());
}
}
return false;
}
}
libjibx-java-1.1.6a/build/src/org/jibx/binding/classes/BoundClass.java 0000644 0001750 0001750 00000043130 10752421336 025466 0 ustar moeller moeller /*
* Copyright (c) 2003-2008, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer. Redistributions in binary
* form must reproduce the above copyright notice, this list of conditions and
* the following disclaimer in the documentation and/or other materials provided
* with the distribution. Neither the name of JiBX nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.classes;
import java.io.File;
import java.util.HashMap;
import org.apache.bcel.Constants;
import org.apache.bcel.classfile.Utility;
import org.apache.bcel.generic.Type;
import org.jibx.binding.def.BindingDefinition;
import org.jibx.runtime.JiBXException;
/**
* Bound class handler. Each instance controls and organizes information for a
* class included in one or more binding definitions.
*
* @author Dennis M. Sosnoski
*/
public class BoundClass
{
//
// Constants and such related to code generation.
/** Class used for code munging when no specific class available. */
private static final String GENERIC_MUNGE_CLASS = BindingDefinition.GENERATE_PREFIX
+ "MungeAdapter";
/** Prefix used for access methods. */
private static final String ACCESS_PREFIX = BindingDefinition.GENERATE_PREFIX
+ "access_";
/** Empty argument type array. */
private static final Type[] EMPTY_TYPE_ARGS = {};
//
// Static data.
/**
* Map from bound class name (or bound and munged combination) to binding
* information.
*/
private static HashMap s_nameMap;
/** Package of first modifiable class. */
private static String s_modifyPackage;
/** Root for package of first modifiable class. */
private static File s_modifyRoot;
/** Class used for code generation proxy with unmodifiable classes. */
private static MungedClass s_genericMunge;
//
// Actual instance data.
/** Bound class file information. */
private final ClassFile m_boundClass;
/** Class receiving code generated for target class. */
private final MungedClass m_mungedClass;
/**
* Map from field or method to load access method (lazy create,
* null if not used).
*/
private HashMap m_loadMap;
/**
* Map from field or method to store access method (lazy create,
* null if not used).
*/
private HashMap m_storeMap;
/**
* Constructor.
*
* @param bound target class file information
* @param munge class file for class hosting generated code
*/
private BoundClass(ClassFile bound, MungedClass munge) {
m_boundClass = bound;
m_mungedClass = munge;
}
/**
* Get bound class file information.
*
* @return class file information for bound class
*/
public ClassFile getClassFile() {
return m_boundClass;
}
/**
* Get bound class file name.
*
* @return name of bound class
*/
public String getClassName() {
return m_boundClass.getName();
}
/**
* Get munged class file information.
*
* @return class file information for class being modified
*/
public ClassFile getMungedFile() {
return m_mungedClass.getClassFile();
}
/**
* Check if class being changed directly.
*
* @return true if bound class is being modified,
* false if using a surrogate
*/
public boolean isDirectAccess() {
return m_boundClass == m_mungedClass.getClassFile();
}
/**
* Get load access method for member of this class. If the access method
* does not already exist it's created by this call. If the access method
* does exist but without access from the context class, the access
* permission on the method is broadened (from package to protected or
* public, or from protected to public).
*
* @param item field or method to be accessed
* @param from context class from which access is required
* @return the item itself if it's accessible from the required context, an
* access method that is accessible if the item is not itself
* @throws JiBXException on configuration error
*/
public ClassItem getLoadMethod(ClassItem item, ClassFile from)
throws JiBXException {
// initialize tracking information for access methods if first time
if (m_loadMap == null) {
m_loadMap = new HashMap();
}
// check if a new access method needed
BindingMethod method = (BindingMethod)m_loadMap.get(item);
if (method == null) {
// set up for constructing new method
String name = ACCESS_PREFIX + "load_" + item.getName();
ClassFile cf = item.getClassFile();
Type type = Type.getType(Utility.getSignature(item.getTypeName()));
MethodBuilder mb = new ExceptionMethodBuilder(name, type,
EMPTY_TYPE_ARGS, cf, (short)0);
// add the actual access method code
mb.appendLoadLocal(0);
if (item.isMethod()) {
mb.addMethodExceptions(item);
mb.appendCall(item);
} else {
mb.appendGetField(item);
}
mb.appendReturn(type);
// track unique instance of this method
method = m_mungedClass.getUniqueMethod(mb, true);
m_loadMap.put(item, method);
}
// make sure method is accessible
method.makeAccessible(from);
return method.getItem();
}
/**
* Get store access method for member of this class. If the access method
* does not already exist it's created by this call. If the access method
* does exist but without access from the context class, the access
* permission on the method is broadened (from package to protected or
* public, or from protected to public).
*
* @param item field or method to be accessed
* @param from context class from which access is required
* @return the item itself if it's accessible from the required context, an
* access method that is accessible if the item is not itself
* @throws JiBXException on configuration error
*/
public ClassItem getStoreMethod(ClassItem item, ClassFile from)
throws JiBXException {
// initialize tracking information for access methods if first time
if (m_storeMap == null) {
m_storeMap = new HashMap();
}
// check if a new access method needed
BindingMethod method = (BindingMethod)m_storeMap.get(item);
if (method == null) {
// set up for constructing new method
String name = ACCESS_PREFIX + "store_" + item.getName();
ClassFile cf = item.getClassFile();
Type type;
if (item.isMethod()) {
String sig = item.getSignature();
int start = sig.indexOf('(');
int end = sig.indexOf(')');
type = Type.getType(sig.substring(start + 1, end));
} else {
type = Type.getType(Utility.getSignature(item.getTypeName()));
}
MethodBuilder mb = new ExceptionMethodBuilder(name, Type.VOID,
new Type[] { type }, cf, (short)0);
// add the actual access method code
mb.appendLoadLocal(0);
mb.appendLoadLocal(1);
if (item.isMethod()) {
mb.addMethodExceptions(item);
mb.appendCall(item);
} else {
mb.appendPutField(item);
}
mb.appendReturn();
// track unique instance of this method
method = m_mungedClass.getUniqueMethod(mb, true);
m_storeMap.put(item, method);
}
// make sure method is accessible
method.makeAccessible(from);
return method.getItem();
}
/**
* Get unique method. Just delegates to the modified class handling, with
* unique suffix appended to method name.
*
* @param builder method to be defined
* @return defined method item
* @throws JiBXException on configuration error
*/
public BindingMethod getUniqueMethod(MethodBuilder builder)
throws JiBXException {
return m_mungedClass.getUniqueMethod(builder, true);
}
/**
* Get unique method. Just delegates to the modified class handling. The
* supplied name is used without change.
*
* @param builder method to be defined
* @return defined method item
* @throws JiBXException on configuration error
*/
public BindingMethod getUniqueNamed(MethodBuilder builder)
throws JiBXException {
return m_mungedClass.getUniqueMethod(builder, false);
}
/**
* Add binding factory to class. Makes sure that there's no surrogate class
* for code generation, then delegates to the modified class handling.
*
* @param fact binding factory name
*/
public void addFactory(String fact) {
if (isDirectAccess()) {
m_mungedClass.addFactory(fact);
} else {
throw new IllegalStateException(
"Internal error: not directly modifiable class");
}
}
/**
* Generate factory list. Makes sure that there's no surrogate class for
* code generation, then delegates to the modified class handling.
*
* @throws JiBXException on configuration error
*/
public void setFactoryList() throws JiBXException {
if (isDirectAccess()) {
m_mungedClass.setFactoryList();
} else {
throw new IllegalStateException(
"Internal error: not directly modifiable class");
}
}
/**
* Create binding information for class. This creates the combination of
* bound class and (if different) munged class and adds it to the internal
* tables.
*
* @param key text identifier for this bound class and munged class
* combination
* @param bound class information for bound class
* @param munge information for surrogate class receiving generated code, or
* null if no separate class
* @return binding information for class
*/
private static BoundClass createInstance(String key, ClassFile bound,
MungedClass munge) {
BoundClass inst = new BoundClass(bound, munge);
s_nameMap.put(key, inst);
return inst;
}
/**
* Find or create binding information for class. If the combination of bound
* class and munged class already exists it's returned directly, otherwise
* it's created and returned.
*
* @param bound class information for bound class
* @param munge information for surrogate class receiving generated code
* @return binding information for class
*/
private static BoundClass findOrCreateInstance(ClassFile bound,
MungedClass munge) {
String key = bound.getName() + ':' + munge.getClassFile().getName();
BoundClass inst = (BoundClass)s_nameMap.get(key);
if (inst == null) {
inst = createInstance(key, bound, munge);
}
return inst;
}
/**
* Get binding information for class. This finds the class in which code
* generation for the target class takes place. Normally this class will be
* the target class itself, but in cases where the target class is not
* modifiable an alternate class will be used. This can take two forms. If
* the context class is provided and it is a subclass of the target class,
* code for the target class is instead added to the context class. If there
* is no context class, or if the context class is not a subclass of the
* target class, a unique catch-all class is used.
*
* @param cf bound class information
* @param context context class for code generation, or null
* if no context
* @return binding information for class
* @throws JiBXException on configuration error
*/
public static BoundClass getInstance(ClassFile cf, BoundClass context)
throws JiBXException {
// check if new instance needed for this class
BoundClass inst = (BoundClass)s_nameMap.get(cf.getName());
if (inst == null) {
// load the basic class information and check for modifiable
if (!cf.isInterface() && cf.isModifiable()) {
// return instance directly
inst = createInstance(cf.getName(), cf, MungedClass
.getInstance(cf));
} else {
// see if the context class is a subclass
if (context != null
&& context.getClassFile().isSuperclass(cf.getName())) {
// find or create munge with subclass as surrogate
inst = findOrCreateInstance(cf, context.m_mungedClass);
} else {
// use catch-all munge class as surrogate for all else
if (s_genericMunge == null) {
String mname;
if (s_modifyPackage == null) {
mname = GENERIC_MUNGE_CLASS;
MungedClass.checkDirectory(s_modifyRoot, "");
} else {
mname = s_modifyPackage + '.' + GENERIC_MUNGE_CLASS;
MungedClass.checkDirectory(s_modifyRoot,
s_modifyPackage);
}
ClassFile base = ClassCache
.getClassFile("java.lang.Object");
int acc = Constants.ACC_PUBLIC | Constants.ACC_ABSTRACT;
ClassFile gen = new ClassFile(mname, s_modifyRoot,
base, acc, new String[0]);
gen.addDefaultConstructor();
s_genericMunge = MungedClass.getInstance(gen);
MungedClass.delayedAddUnique(gen);
}
inst = findOrCreateInstance(cf, s_genericMunge);
}
}
}
return inst;
}
/**
* Get binding information for class. This version takes a fully-qualified
* class name, calling the paired method if necessary to create a new
* instance.
*
* @param name fully qualified name of bound class
* @param context context class for code generation, or null
* if no context
* @return binding information for class
* @throws JiBXException on configuration error
*/
public static BoundClass getInstance(String name, BoundClass context)
throws JiBXException {
// check if new instance needed for this class
BoundClass inst = (BoundClass)s_nameMap.get(name);
if (inst == null) {
ClassFile cf = ClassCache.getClassFile(name);
return getInstance(cf, context);
}
return inst;
}
/**
* Discard cached information and reset in preparation for a new binding
* run.
*/
public static void reset() {
s_nameMap = new HashMap();
s_modifyPackage = null;
s_modifyRoot = null;
s_genericMunge = null;
}
/**
* Set override modification information. This allows the binding to
* control directly the root directory and package for added classes.
*
* @param root classpath root directory for added classes
* @param pkg package for added classes
*/
public static void setModify(File root, String pkg) {
s_modifyRoot = root;
s_modifyPackage = pkg;
if (s_modifyPackage.length() == 0) {
s_modifyPackage = null;
}
}
/**
* Derive generated class name for bound class. This generates a JiBX class
* name from the name of this class, using the supplied prefix and suffix
* information. The derived class name is always in the same package as the
* munged class for this class.
*
* @param prefix generated class name prefix
* @param suffix generated class name suffix
* @return derived class name
*/
public String deriveClassName(String prefix, String suffix) {
String pack = m_mungedClass.getClassFile().getPackage();
if (pack.length() > 0) {
pack += '.';
}
String tname = m_boundClass.getName();
int split = tname.lastIndexOf('.');
if (split >= 0) {
tname = tname.substring(split + 1);
}
return pack + prefix + tname + suffix;
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/classes/BranchTarget.java 0000644 0001750 0001750 00000006434 10071714136 026000 0 ustar moeller moeller /*
Copyright (c) 2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.classes;
import org.apache.bcel.generic.InstructionHandle;
/**
* Wrapper for branch target information. This preserves a snapshot of the stack
* state for the branch target, allowing it to be matched against the stack
* state for the branch source.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class BranchTarget
{
/** Actual wrapped instruction handle. */
private final InstructionHandle m_targetHandle;
/** Stack state for branch target. */
private final String[] m_stackTypes;
/**
* Constructor.
*
* @param hand instruction handle
* @param types array of types of values on stack
*/
/*package*/ BranchTarget(InstructionHandle hand, String[] types) {
m_targetHandle = hand;
m_stackTypes = types;
}
/**
* Get actual target instruction.
*
* @return handle for target instruction
*/
/*package*/ InstructionHandle getInstruction() {
return m_targetHandle;
}
/**
* Get stack state information.
*
* @return array of type names on stack
*/
/*package*/ String[] getStack() {
return m_stackTypes;
}
/**
* Matches the branch target stack state against the supplied stack state.
*
* @param types array of types of values on stack
* @return true if stack states match, false if
* not
*/
/*package*/ boolean matchStacks(String[] types) {
// match stack states
if (types.length == m_stackTypes.length) {
for (int i = 0; i < types.length; i++) {
if (!types[i].equals(m_stackTypes[i])) {
return false;
}
}
return true;
} else {
return false;
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/classes/BranchWrapper.java 0000644 0001750 0001750 00000017661 10270431156 026175 0 ustar moeller moeller /*
Copyright (c) 2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.classes;
import org.apache.bcel.generic.BranchHandle;
import org.apache.bcel.generic.InstructionHandle;
/**
* Wrapper for branch handle. This preserves a snapshot of the stack state for
* the branch instruction, matching it against the stack state for the target
* instruction when set.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class BranchWrapper
{
/** Track source code location for generated branches. */
private static boolean s_trackSource;
/** Continue on after code generation error flag. */
private static boolean s_errorOverride;
/** Actual wrapped instruction handle. */
private final BranchHandle m_branchHandle;
/** Stack state for branch origin. */
private final String[] m_stackTypes;
/** Object that generated branch. */
private final Object m_sourceObject;
/** Code generation backtrace for source of branch. */
private final Throwable m_sourceTrace;
/**
* Constructor.
*
* @param hand branch handle
* @param types array of types of values on stack
* @param src object responsible for generating branch
*/
/*package*/ BranchWrapper(BranchHandle hand, String[] types, Object src) {
m_branchHandle = hand;
m_stackTypes = types;
m_sourceObject = src;
if (s_trackSource) {
m_sourceTrace = new Throwable();
} else {
m_sourceTrace = null;
}
}
/**
* Get branch origin stack state information.
*
* @return array of types of values on stack
*/
/*package*/ String[] getStackState() {
return m_stackTypes;
}
/**
* Generate description of stack state.
*
* @param types array of types on stack
* @return stack state description
*/
private String describeStack(String[] types) {
StringBuffer buff = new StringBuffer();
for (int i = 0; i < types.length; i++) {
buff.append(" ");
buff.append(i);
buff.append(": ");
buff.append(types[i]);
buff.append('\n');
}
return buff.toString();
}
/**
* Report branch target error. Dumps the stack trace for the source of the
* branch, if source tracking is enabled, and generates an exception that
* includes the stack state information.
*
* @param text basic error message text
* @param types stack state description
* @param mb method builder using this code
* @return complete error description text
*/
private String buildReport(String text, String[] types, MethodBuilder mb) {
// start by dumping branch generation source trace
if (m_sourceTrace != null) {
System.err.println("Backtrack for branch source:");
m_sourceTrace.printStackTrace(System.err);
}
// generate error message leading text
StringBuffer buff = new StringBuffer(text);
buff.append("\n in method ");
buff.append(mb.getClassFile().getName());
buff.append('.');
buff.append(mb.getName());
buff.append("\n generated by ");
buff.append(m_sourceObject.toString());
buff.append("\n from stack:\n");
buff.append(describeStack(m_stackTypes));
buff.append(" to stack:\n");
buff.append(describeStack(types));
return buff.toString();
}
/**
* Set target instruction for branch. Validates the branch source stack
* state against the branch target stack state.
*
* @param hand target branch instruction handle
* @param types stack state description
* @param mb method builder using this code
*/
/*package*/ void setTarget(InstructionHandle hand, String[] types,
MethodBuilder mb) {
// match stack states
if (types.length == m_stackTypes.length) {
for (int i = 0; i < types.length; i++) {
String stype = m_stackTypes[i];
if (!types[i].equals(stype)) {
if (!"".equals(types[i]) && !"".equals(stype)) {
if (m_sourceTrace != null) {
System.err.println("Backtrack for branch source:");
m_sourceTrace.printStackTrace(System.err);
}
String text = buildReport
("Stack value type mismatch on branch", types, mb);
if (s_errorOverride) {
new Throwable(text).printStackTrace(System.err);
} else {
throw new IllegalStateException(text);
}
}
}
}
} else {
String text =
buildReport("Stack size mismatch on branch", types, mb);
if (s_errorOverride) {
new Throwable(text).printStackTrace(System.err);
} else {
throw new IllegalStateException(text);
}
}
// set the branch target
m_branchHandle.setTarget(hand);
}
/**
* Set target instruction for branch. Validates the branch source stack
* state against the branch target stack state.
*
* @param target branch target wrapper
* @param mb method builder using this code
*/
public void setTarget(BranchTarget target, MethodBuilder mb) {
setTarget(target.getInstruction(), target.getStack(), mb);
}
/**
* Set branch code generation tracking state. When set, this saves a stack
* trace for each generated branch instruction, allowing the source of a
* branch to be traced when an error occurs in setting the branch target.
*
* @param track true to enable branch code generation tracking,
* false to disable it
*/
public static void setTracking(boolean track) {
s_trackSource = track;
}
/**
* Set target setting error override state. When set, this blocks throwing
* an exception when an error occurs on setting the branch target, instead
* just printing the information to the console.
*
* @param over true to override exception on target error,
* false to allow it
*/
public static void setErrorOverride(boolean over) {
s_errorOverride = over;
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/classes/ClassCache.java 0000644 0001750 0001750 00000017411 10602524416 025422 0 ustar moeller moeller /*
Copyright (c) 2003-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.classes;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import org.apache.bcel.classfile.Utility;
import org.jibx.runtime.JiBXException;
/**
* Cache for class files being modified. Handles loading and saving of class
* files. Classes are loaded directly from the file system paths supplied on
* initialization in preference to the system class path.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class ClassCache
{
/** Singleton instance of class (created when paths set) */
private static ClassCache s_instance;
/** Paths to be searched for class files. */
private String[] m_paths;
/** Root directories corresponding to paths. */
private File[] m_roots;
/** Map from class names to actual class information. */
private HashMap m_classMap;
/**
* Constructor. Discards jar file paths and normalizes all other paths
* (except the empty path) to end with the system path separator character.
*
* @param paths ordered set of paths to be searched for class files
*/
private ClassCache(String[] paths) {
ArrayList keepers = new ArrayList();
for (int i = 0; i < paths.length; i++) {
File file = new File(paths[i]);
if (file.isDirectory() && file.canWrite()) {
keepers.add(paths[i]);
}
}
m_paths = new String[keepers.size()];
m_roots = new File[keepers.size()];
for (int i = 0; i < keepers.size(); i++) {
String path = (String)keepers.get(i);
int length = path.length();
if (length > 0) {
if (path.charAt(length-1) != File.separatorChar) {
path = path + File.separator;
}
}
m_paths[i] = path;
m_roots[i] = new File(path);
}
m_classMap = new HashMap();
}
/**
* Get class information. Looks up the class in cache, and if not already
* present tries to find it based on the class file search path list. If
* the class file is found it is loaded and this method calls itself
* recursively to load the whole hierarchy of superclasses.
*
* @param name fully-qualified name of class to be found
* @return class information, or null if class not found
* @throws JiBXException on any error accessing class file
*/
private ClassFile getClassFileImpl(String name) throws JiBXException {
// first try for match on fully-qualified class name
Object match = m_classMap.get(name);
if (match != null) {
return (ClassFile)match;
} else if (ClassItem.isPrimitive(name) || name.endsWith("[]")) {
// create synthetic class file for array type
ClassFile cf = new ClassFile(name, Utility.getSignature(name));
m_classMap.put(name, cf);
return cf;
} else {
try {
// got to load it, convert to file path format
ClassFile cf = null;
String path = name.replace('.', File.separatorChar) + ".class";
for (int i = 0; i < m_paths.length; i++) {
// check for file found off search path
File file = new File(m_paths[i], path);
if (file.exists()) {
// load file information
cf = new ClassFile(name, m_roots[i], file);
break;
}
}
// finally try loading (non-modifiable) class from classpath
if (cf == null) {
cf = new ClassFile(name);
}
// check for class found
if (cf != null) {
// force loading of superclass as well (to root)
String sname = cf.getSuperName();
if (!name.equals(sname) && sname != null) {
ClassFile sf = getClassFileImpl(sname);
if (sf == null) {
throw new JiBXException("Superclass " + sname +
" of class " + name + " not found");
}
cf.setSuperFile(sf);
}
// add class information to cache
m_classMap.put(name, cf);
}
return cf;
} catch (IOException ex) {
throw new JiBXException("Error loading class " + name);
}
}
}
/**
* Get class information. Looks up the class in cache, and if not already
* present tries to find it based on the class file search path list. If
* the class file is found it is loaded along with all superclasses.
*
* @param name fully-qualified name of class to be found
* @return class information, or null if class not found
* @throws JiBXException on any error accessing class file
*/
public static ClassFile getClassFile(String name) throws JiBXException {
return s_instance.getClassFileImpl(name);
}
/**
* Check if class information has been loaded.
*
* @param name full-qualified name of class to be checked
* @return true if found
*/
public static boolean hasClassFile(String name) {
return s_instance.m_classMap.containsKey(name);
}
/**
* Add created class information to cache.
*
* @param cf information for class to be added
*/
/*package*/ static void addClassFile(ClassFile cf) {
s_instance.m_classMap.put(cf.getName(), cf);
}
/**
* Set class paths to be searched. Discards jar file paths and normalizes
* all other paths (except the empty path) to end with the system path
* separator character.
*
* @param paths ordered set of paths to be searched for class files
*/
public static void setPaths(String[] paths) {
s_instance = new ClassCache(paths);
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/classes/ClassFile.java 0000644 0001750 0001750 00000213126 11021732036 025272 0 ustar moeller moeller /*
Copyright (c) 2003-2008, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.classes;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import org.apache.bcel.Constants;
import org.apache.bcel.classfile.ClassParser;
import org.apache.bcel.classfile.Code;
import org.apache.bcel.classfile.CodeException;
import org.apache.bcel.classfile.Constant;
import org.apache.bcel.classfile.ConstantDouble;
import org.apache.bcel.classfile.ConstantFloat;
import org.apache.bcel.classfile.ConstantInteger;
import org.apache.bcel.classfile.ConstantLong;
import org.apache.bcel.classfile.ConstantPool;
import org.apache.bcel.classfile.ConstantString;
import org.apache.bcel.classfile.ConstantUtf8;
import org.apache.bcel.classfile.ConstantValue;
import org.apache.bcel.classfile.ExceptionTable;
import org.apache.bcel.classfile.Field;
import org.apache.bcel.classfile.FieldOrMethod;
import org.apache.bcel.classfile.JavaClass;
import org.apache.bcel.classfile.Method;
import org.apache.bcel.classfile.Synthetic;
import org.apache.bcel.classfile.Utility;
import org.apache.bcel.generic.ClassGen;
import org.apache.bcel.generic.ConstantPoolGen;
import org.apache.bcel.generic.FieldGen;
import org.apache.bcel.generic.Type;
import org.apache.bcel.util.ClassPath;
import org.jibx.runtime.JiBXException;
/**
* Class file information. Wraps the actual class file data as well as
* associated management information.
*
* @author Dennis M. Sosnoski
*/
public class ClassFile
{
//
// Constants for code generation.
public static final int PRIVATE_ACCESS = 0;
public static final int PACKAGE_ACCESS = 1;
public static final int PROTECTED_ACCESS = 2;
public static final int PUBLIC_ACCESS = 3;
public static final int SYNTHETIC_ACCESS_FLAG = 0x1000;
protected static final int PRIVATEFIELD_ACCESS =
Constants.ACC_PRIVATE | SYNTHETIC_ACCESS_FLAG;
protected static final ExistingMethod[] EMPTY_METHOD_ARRAY = {};
protected static final byte[] EMPTY_BYTES = new byte[0];
public static final ClassItem[] EMPTY_CLASS_ITEMS = new ClassItem[0];
//
// Class data.
/** Singleton loader from classpath. */
private static ClassPath s_loader;
/** Direct class loader. */
private static ClassLoader s_directLoader;
//
// Actual instance data.
/** Fully qualified class name. */
private String m_name;
/** Signature for class as type. */
private String m_signature;
/** Class as type. */
private Type m_type;
/** Directory root for class. */
private File m_root;
/** Actual class file information. */
private File m_file;
/** Class in same package as superclass flag. */
private boolean m_isSamePackage;
/** File is writable flag. */
private boolean m_isWritable;
/** Super class of this class (set by caller, since it may require
additional information to find the class file). */
protected ClassFile m_superClass;
/** Names of all interfaces directly implemented by this class. */
protected String[] m_interfaceNames;
/** Class files of interfaces extended by interface. */
private ClassFile[] m_superInterfaces;
/** All classes and interfaces of which this is an instance (lazy create,
only if needed. */
private String[] m_instanceOfs;
/** All methods defined by this class or interface (lazy create, only if
needed). */
private Method[] m_methods;
/** Base class information as loaded by BCEL. */
private JavaClass m_curClass;
/** Modified class generator (lazy create, only if needed). */
private ClassGen m_genClass;
/** Constant pool generator for modified class (lazy create, only if
needed). */
private ConstantPoolGen m_genPool;
/** Instruction factory for modified class (lazy create, only if needed). */
protected InstructionBuilder m_instBuilder;
/** Map for method names with possibly generated suffixes (lazy create, only
if needed). */
private HashMap m_suffixMap;
/** Map to class item information. */
private HashMap m_itemMap;
/** Flag for class modified. */
private boolean m_isModified;
/** Usage count for this class. */
private int m_useCount;
/** Hash code computation for class is current flag. */
private boolean m_isHashCurrent;
/** Cached hash code value for class. */
private int m_hashCode;
/** Depth of superclass hierarchy for class (lazy computation). */
private int m_inheritDepth;
/** Suffix number for making method names unique (lazy computation). */
private int m_uniqueIndex;
/** Added default constructor for class. */
private ClassItem m_defaultConstructor;
/**
* Constructor for class file loaded from a stream. Loads the class data
* and prepares it for use.
*
* @param name fully qualified class name
* @param path class file path
* @param ins input stream for class file data
* @throws JiBXException if unable to load class file
*/
public ClassFile(String name, String path, InputStream ins)
throws JiBXException {
init(name, path, ins);
}
/**
* Constructor for preexisting class file. Loads the class data and
* prepares it for use.
*
* @param name fully qualified class name
* @param root directory root from class loading path list
* @param file actual class file
* @throws IOException if unable to open file
* @throws JiBXException if error in reading class file
*/
public ClassFile(String name, File root, File file)
throws IOException, JiBXException {
init(name, root.getPath(), new FileInputStream(file));
m_root = root;
m_file = file;
m_isWritable = file.canWrite();
}
/**
* Constructor for preexisting class file from classpath. Loads the class
* data and prepares it for use.
*
* @param name fully qualified class name
* @throws IOException if unable to open file
* @throws JiBXException if error in reading class file
*/
public ClassFile(String name) throws IOException, JiBXException {
// try out class path first, then BCEL system path
ClassPath.ClassFile cf = null;
try {
cf = s_loader.getClassFile(name);
} catch (IOException ex) {
try {
cf = ClassPath.SYSTEM_CLASS_PATH.getClassFile(name);
} catch (IOException ex1) { /* deliberately left empty */ }
}
if (cf == null) {
throw new JiBXException("Class " + name +
" not found in any classpath");
} else {
init(name, cf.getPath(), cf.getInputStream());
}
}
/**
* Constructor for synthetic placeholder classfile with no backing class
* data.
*
* @param name fully qualified class name
* @param sig corresponding class signature
*/
public ClassFile(String name, String sig) {
m_name = name;
m_signature = sig;
m_type = Type.getType(sig);
m_interfaceNames = new String[0];
m_superInterfaces = new ClassFile[0];
m_itemMap = new HashMap();
}
/**
* Constructor for new class file. Initializes the class data and
* prepares it for use.
*
* @param name fully qualified class name
* @param root directory root from class loading path list
* @param sclas superclass of new class
* @param access access flags for class
* @param impls array of interfaces implemented by new class
* @throws JiBXException on error loading interface information
*/
public ClassFile(String name, File root, ClassFile sclas, int access,
String[] impls) throws JiBXException {
String fname = name.replace('.', File.separatorChar)+".class";
File file = new File(root, fname);
m_name = name;
m_signature = Utility.getSignature(name);
m_type = ClassItem.typeFromName(name);
m_root = root;
m_superClass = sclas;
m_interfaceNames = impls;
m_file = file;
m_isWritable = true;
m_genClass = new ClassGen(name, sclas.getName(), "",
access | SYNTHETIC_ACCESS_FLAG, impls);
m_genPool = m_genClass.getConstantPool();
int index = m_genPool.addUtf8("Synthetic");
m_genClass.addAttribute(new Synthetic(index, 0, EMPTY_BYTES,
m_genPool.getConstantPool()));
m_instBuilder = new InstructionBuilder(m_genClass, m_genPool);
m_itemMap = new HashMap();
initInterface();
ClassCache.addClassFile(this);
}
/**
* Internal initialization method. This is used to handle common
* initialization for the constructors.
*
* @param name fully qualified class name
* @param path class file path
* @param ins input stream for class file data
* @throws JiBXException if unable to load class file
*/
private void init(String name, String path, InputStream ins)
throws JiBXException {
m_name = name;
m_signature = Utility.getSignature(name);
m_type = ClassItem.typeFromName(name);
m_itemMap = new HashMap();
if (path == null) {
m_interfaceNames = new String[0];
} else {
String fname = name.replace('.', File.separatorChar) + ".class";
ClassParser parser = new ClassParser(ins, fname);
try {
m_curClass = parser.parse();
m_interfaceNames = m_curClass.getInterfaceNames();
} catch (Exception ex) {
throw new JiBXException("Error reading path " +
path + " for class " + name);
}
}
initInterface();
}
/**
* Retrieve superinterfaces for an interface class. These are collected at
* initialization so that we can support getting the full set of methods
* later without worrying about throwing an exception.
*
* @throws JiBXException on error loading interface information
*/
private void initInterface() throws JiBXException {
if (isInterface() && m_interfaceNames.length > 0) {
ClassFile[] supers = new ClassFile[m_interfaceNames.length];
for (int i = 0; i < m_interfaceNames.length; i++) {
supers[i] = ClassCache.getClassFile(m_interfaceNames[i]);
}
m_superInterfaces = supers;
} else {
m_superInterfaces = new ClassFile[0];
}
}
/**
* Check if class is an interface. This only checks existing classes,
* assuming that no generated classes are interfaces.
*
* @return true if an interface, false if not
*/
public boolean isInterface() {
return m_curClass != null && m_curClass.isInterface();
}
/**
* Check if class is abstract. This only checks existing classes,
* assuming that no generated classes are abstract.
*
* @return true if an abstract class, false if not
*/
public boolean isAbstract() {
return m_curClass != null && m_curClass.isAbstract();
}
/**
* Check if class is an array. This only checks existing classes,
* assuming that no generated classes are arrays.
*
* @return true if an array class, false if not
*/
public boolean isArray() {
return m_name.endsWith("[]");
}
/**
* Check if class is modifiable.
*
* @return true if class is modifiable, false if
* not
*/
public boolean isModifiable() {
return m_isWritable && !isInterface();
}
/**
* Get fully qualified class name.
*
* @return fully qualified name for class
*/
public String getName() {
return m_name;
}
/**
* Get signature for class as type.
*
* @return signature for class used as type
*/
public String getSignature() {
return m_signature;
}
/**
* Get class as type.
*
* @return class as type
*/
public Type getType() {
return m_type;
}
/**
* Get package name.
*
* @return package name for class
*/
public String getPackage() {
int split = m_name.lastIndexOf('.');
if (split >= 0) {
return m_name.substring(0, split);
} else {
return "";
}
}
/**
* Get root directory for load path.
*
* @return root directory in path used for loading file
*/
public File getRoot() {
return m_root;
}
/**
* Get actual file for class.
*
* @return file used for class
*/
public File getFile() {
return m_file;
}
/**
* Get raw current class information.
*
* @return raw current class information
*/
public JavaClass getRawClass() {
if (m_curClass == null) {
throw new IllegalStateException
("No loadable class information for " + m_name);
} else {
return m_curClass;
}
}
/**
* Get superclass name.
*
* @return fully qualified name of superclass
*/
public String getSuperName() {
if (m_curClass == null) {
return null;
} else {
return m_curClass.getSuperclassName();
}
}
/**
* Set superclass information.
*
* @param sclas superclass information
*/
public void setSuperFile(ClassFile sclas) {
m_superClass = sclas;
m_isSamePackage = getPackage().equals(sclas.getPackage());
}
/**
* Get superclass information.
*
* @return super class information as loaded (null if no
* superclass - java.lang.Object, interface, or primitive)
*/
public ClassFile getSuperFile() {
return m_superClass;
}
/**
* Get names of all interfaces implemented by class.
*
* @return names of all interfaces implemented directly by class
*/
public String[] getInterfaces() {
return m_interfaceNames;
}
/**
* Add interface to class. The interface is added to the class if not
* already defined.
*
* @param intf fully qualified interface name
* @return true if added, false if already present
* @throws JiBXException on configuration error
*/
public boolean addInterface(String intf) throws JiBXException {
ClassGen gen = getClassGen();
String[] intfs = gen.getInterfaceNames();
for (int i = 0; i < intfs.length; i++) {
if (intf.equals(intfs[i])) {
return false;
}
}
gen.addInterface(intf);
m_isModified = true;
m_instanceOfs = null;
return true;
}
/**
* Accumulate interface signatures recursively.
*
* @param intfs names of interfaces implemented
* @param map map for interfaces already accumulated
* @param accs accumulated interface names
* @throws JiBXException if configuration error
*/
protected void accumulateInterfaces(String[] intfs, HashMap map,
ArrayList accs) throws JiBXException {
for (int i = 0; i < intfs.length; i++) {
String name = intfs[i];
if (map.get(name) == null) {
ClassFile cf = ClassCache.getClassFile(name);
String sig = cf.getSignature();
map.put(name, sig);
accs.add(sig);
String[] inherits = cf.m_curClass.getInterfaceNames();
accumulateInterfaces(inherits, map, accs);
}
}
}
/**
* Get signatures for all types of which instances of this type are
* instances.
*
* @return all signatures suppored by instances
* @throws JiBXException if configuration error
*/
public String[] getInstanceSigs() throws JiBXException {
if (m_instanceOfs == null) {
// check for an array class
String name = getName();
if (name.endsWith("[]")) {
// accumulate prefix by stripping suffixes
String prefix = "";
do {
name = name.substring(0, name.length()-2);
prefix = prefix + '[';
} while (name.endsWith("[]"));
// check for a primitive base type on array
String[] bsigs;
if (ClassItem.isPrimitive(name)) {
bsigs = new String[1];
bsigs[0] = ClassItem.getPrimitiveSignature(name);
} else {
ClassFile bcf = ClassCache.getClassFile(name);
bsigs = bcf.getInstanceSigs();
}
// derive array signatures from signatures for base type
String[] asigs = new String[bsigs.length+1];
for (int i = 0; i < bsigs.length; i++) {
asigs[i] = prefix + bsigs[i];
}
asigs[bsigs.length] = "Ljava/lang/Object;";
m_instanceOfs = asigs;
} else {
// walk all classes and interfaces to find signatures
HashMap map = new HashMap();
ArrayList iofs = new ArrayList();
ClassFile cur = this;
while (cur != null) {
String sig = cur.getSignature();
map.put(name, sig);
iofs.add(sig);
accumulateInterfaces(cur.getInterfaces(), map, iofs);
cur = cur.getSuperFile();
}
String[] sigs = new String[iofs.size()];
m_instanceOfs = (String[])iofs.toArray(sigs);
}
}
return m_instanceOfs;
}
/**
* Check if class implements an interface.
*
* @param sig signature of interface to be checked
* @return true if interface is implemented by class,
* false if not
* @throws JiBXException if configuration error
*/
public boolean isImplements(String sig) throws JiBXException {
String[] sigs = getInstanceSigs();
for (int i = 0; i < sigs.length; i++) {
if (sig.equals(sigs[i])) {
return true;
}
}
return false;
}
/**
* Check if another class is a superclass of this one.
*
* @param name of superclass to be checked
* @return true if named class is a superclass of this one,
* false if not
*/
public boolean isSuperclass(String name) {
ClassFile cur = this;
while (cur != null) {
if (cur.getName().equals(name)) {
return true;
} else {
cur = cur.getSuperFile();
}
}
return false;
}
/**
* Get array of fields defined by class.
*
* @return array of fields defined by class
*/
public ClassItem[] getFieldItems() {
if (m_curClass == null) {
return EMPTY_CLASS_ITEMS;
} else {
Field[] fields = m_curClass.getFields();
ClassItem[] items = new ClassItem[fields.length];
for (int i = 0; i < fields.length; i++) {
Field field = fields[i];
items[i] = new ClassItem(field.getName(), this, field);
}
return items;
}
}
/**
* Get internal information for field. This can only be used with
* existing classes, and only checks for fields that are actually members
* of the class (not superclasses).
*
* @param name field name
* @return field information, or null if field not found
*/
protected Field getDefinedField(String name) {
// check for match to field name defined in class
Field[] fields = m_curClass.getFields();
for (int i = 0; i < fields.length; i++) {
if (fields[i].getName().equals(name)) {
return fields[i];
}
}
return null;
}
/**
* Get internal information for field. This can only be used with existing
* classes. If the field is not found directly, superclasses are checked for
* inherited fields matching the supplied name.
*
* @param name field name
* @return field information, or null if field not found
*/
protected Field getAccessibleField(String name) {
// always return not found for unloadable class
if (m_curClass == null) {
return null;
} else {
// check for match to field name defined in class
Field field = getDefinedField(name);
if (field == null) {
// try match to field inherited from superclass
if (m_superClass != null) {
field = m_superClass.getAccessibleField(name);
if (field != null && (!m_isSamePackage ||
field.isPrivate()) && !field.isPublic() &&
!field.isProtected()) {
field = null;
}
}
}
return field;
}
}
/**
* Get information for field. This can only be used with existing classes,
* and only checks for fields that are actually members of the class (not
* superclasses).
*
* @param name field name
* @return field information, or null if field not found
*/
public ClassItem getDirectField(String name) {
Field field = getAccessibleField(name);
if (field == null) {
return null;
} else {
ClassItem item = (ClassItem)m_itemMap.get(field);
if (item == null) {
item = new ClassItem(name, this, field);
m_itemMap.put(field, item);
}
return item;
}
}
/**
* Get information for field. This can only be used with existing classes.
* If the field is not found directly, superclasses are checked for
* inherited fields matching the supplied name.
*
* @param name field name
* @return field information
* @throws JiBXException if field not found
*/
public ClassItem getField(String name) throws JiBXException {
Field field = getAccessibleField(name);
if (field == null) {
throw new JiBXException("Field " + name +
" not found in class " + m_name);
} else {
ClassItem item = (ClassItem)m_itemMap.get(field);
if (item == null) {
item = new ClassItem(name, this, field);
m_itemMap.put(field, item);
}
return item;
}
}
/**
* Get array of methods defined by class or interface. In the case of an
* interface, this merges all methods from superinterfaces in the array
* returned.
*
* @return array of methods defined by class
*/
private Method[] getMethods() {
if (m_methods == null) {
// start with methods defined directly
Method[] methods = null;
if (m_genClass != null) {
methods = m_genClass.getMethods();
} else {
methods = m_curClass.getMethods();
}
if (m_curClass.isInterface() && m_superInterfaces.length > 0) {
// for interface extending other interfaces, merge methods
ArrayList merges = new ArrayList();
for (int i = 0; i < methods.length; i++) {
merges.add(methods[i]);
}
for (int i = 0; i < m_superInterfaces.length; i++) {
methods = m_superInterfaces[i].getMethods();
for (int j = 0; j < methods.length; j++) {
merges.add(methods[j]);
}
}
// set merged array
methods = (Method[])merges.toArray(new Method[merges.size()]);
}
// cache the created method array
m_methods = methods;
}
return m_methods;
}
/**
* Get array of methods defined by class.
*
* @return array of methods defined by class
*/
public ClassItem[] getMethodItems() {
if (m_curClass == null) {
return EMPTY_CLASS_ITEMS;
} else {
Method[] methods = getMethods();
ClassItem[] items = new ClassItem[methods.length];
for (int i = 0; i < methods.length; i++) {
Method method = methods[i];
items[i] = new ClassItem(method.getName(), this, method);
}
return items;
}
}
/**
* Get internal information for method without respect to potential trailing
* arguments or return value. This can only be used with existing classes.
* If the method is not found directly, superclasses are checked for
* inherited methods matching the supplied name. This compares the supplied
* partial signature against the actual method signature, and considers it
* a match if the actual sigature starts with the supplied signature..
*
* @param name method name
* @param sig partial method signature to be matched
* @return method information, or null if method not found
*/
protected Method getAccessibleMethod(String name, String sig) {
// only check loadable classes
if (m_curClass != null) {
// check for match to method defined in class
Method[] methods = getMethods();
for (int i = 0; i < methods.length; i++) {
Method method = methods[i];
if (method.getName().equals(name)) {
if (method.getSignature().startsWith(sig)) {
return method;
}
}
}
// try match to method inherited from superclass
if (m_superClass != null) {
Method method = m_superClass.getAccessibleMethod(name, sig);
if (method != null && ((m_isSamePackage &&
!method.isPrivate()) || method.isPublic() ||
method.isProtected())) {
return method;
}
}
}
return null;
}
/**
* Get information for method without respect to potential trailing
* arguments or return value. This can only be used with existing classes.
* If the method is not found directly, superclasses are checked for
* inherited methods matching the supplied name. This compares the supplied
* partial signature against the actual method signature, and considers it
* a match if the actual sigature starts with the supplied signature..
*
* @param name method name
* @param sig partial method signature to be matched
* @return method information, or null if method not found
*/
public ClassItem getMethod(String name, String sig) {
Method method = getAccessibleMethod(name, sig);
if (method == null) {
return null;
} else {
ClassItem item = (ClassItem)m_itemMap.get(method);
if (item == null) {
item = new ClassItem(name, this, method);
m_itemMap.put(method, item);
}
return item;
}
}
/**
* Get information for method matching one of several possible signatures.
* This can only be used with existing classes. If a match is not found
* directly, superclasses are checked for inherited methods matching the
* supplied name and signatures. The signature variations are checked in
* the order supplied.
*
* @param name method name
* @param sigs possible signatures for method (including return type)
* @return method information, or null if method not found
*/
public ClassItem getMethod(String name, String[] sigs) {
Method method = null;
for (int i = 0; method == null && i < sigs.length; i++) {
method = getAccessibleMethod(name, sigs[i]);
}
if (method == null) {
return null;
} else {
ClassItem item = (ClassItem)m_itemMap.get(method);
if (item == null) {
item = new ClassItem(name, this, method);
m_itemMap.put(method, item);
}
return item;
}
}
/**
* Check for match to specified access level. This treats a field or method
* as matching if the access level is the same as or more open than the
* required level.
*
* @param item information for field or method to be checked
* @param access required access level for match
* @return true if access level match, false if
* not
*/
private static boolean matchAccess(FieldOrMethod item, int access) {
if (item.isPublic()) {
return true;
} else if (item.isProtected()) {
return access <= PROTECTED_ACCESS;
} else if (item.isPrivate()) {
return access == PRIVATE_ACCESS;
} else {
return access <= PACKAGE_ACCESS;
}
}
/**
* Check if one type is assignment compatible with another type. This is an
* ugly replacement for apparently broken BCEL code.
*
* @param have type being checked
* @param need type needed
* @return true if compatible, false if not
*/
private static boolean isAssignmentCompatible(Type have, Type need) {
if (have.equals(need)) {
return true;
} else {
try {
return ClassItem.isAssignable(have.toString(), need.toString());
} catch (JiBXException e) {
throw new IllegalStateException
("Internal error: Unable to access data for " +
have.toString() + " or " + need.toString() + ":\n" +
e.getMessage());
}
}
}
/**
* Get information for best matching method. This tries to find a method
* which matches the specified name, return type, and argument types. If an
* exact match is not found it looks for a method with a return type that
* is extended or implemented by the specified type and arguments that are
* extended or implemented by the specified types. This can only be used
* with existing classes. If the method is not found directly, superclasses
* are checked for inherited methods.
*
* @param name method name
* @param access access level required for matching methods
* @param ret return value type (null if indeterminant)
* @param args argument value types
* @return method information, or null if method not found
*/
private Method getBestAccessibleMethod(String name, int access, Type ret,
Type[] args) {
// just fail for classes that aren't loadable
if (m_curClass == null) {
return null;
}
// check for match to method defined in class
Method[] methods = getMethods();
Method best = null;
int diff = Integer.MAX_VALUE;
for (int i = 0; i < methods.length; i++) {
Method method = methods[i];
if (method.getName().equals(name) && matchAccess(method, access)) {
// make sure the return type is compatible
boolean match = true;
int ndiff = 0;
if (ret != null) {
Type type = method.getReturnType();
match = isAssignmentCompatible(ret, type);
}
if (match) {
// check closeness of argument types
Type[] types = method.getArgumentTypes();
if (args.length == types.length) {
for (int j = 0; j < args.length; j++) {
Type type = types[j];
Type arg = args[j];
if (!type.equals(arg)) {
ndiff++;
match = isAssignmentCompatible(arg, type);
if (!match) {
break;
}
}
}
} else {
match = false;
}
}
if (match && ndiff < diff) {
best = method;
}
}
}
if (best != null) {
return best;
}
// try methods inherited from superclass if no match found
if (m_superClass != null) {
if (access < PROTECTED_ACCESS) {
if (m_isSamePackage) {
access = PACKAGE_ACCESS;
} else {
access = PROTECTED_ACCESS;
}
}
return m_superClass.getBestAccessibleMethod(name, access, ret, args);
} else {
return null;
}
}
/**
* Get information for best matching method. This tries to find a method
* which matches the specified name, return type, and argument types. If an
* exact match is not found it looks for a method with a return type that
* is extended or implemented by the specified type and arguments that are
* extended or implemented by the specified types. This can only be used
* with existing classes. If the method is not found directly, superclasses
* are checked for inherited methods.
*
* @param name method name
* @param ret return value type (null if indeterminant)
* @param args argument value types
* @return method information, or null if method not found
*/
public ClassItem getBestMethod(String name, String ret, String[] args) {
Type rtype = null;
if (ret != null) {
rtype = ClassItem.typeFromName(ret);
}
Type[] atypes = new Type[args.length];
for (int i = 0; i < args.length; i++) {
atypes[i] = ClassItem.typeFromName(args[i]);
}
Method method =
getBestAccessibleMethod(name, PRIVATE_ACCESS, rtype, atypes);
if (method == null) {
return null;
}
ClassItem item = (ClassItem)m_itemMap.get(method);
if (item == null) {
item = new ClassItem(name, this, method);
m_itemMap.put(method, item);
}
return item;
}
/**
* Get information for initializer. This can only be used with existing
* classes. Only the class itself is checked for an initializer matching
* the argument list signature.
*
* @param sig encoded argument list signature
* @return method information, or null if method not found
*/
public ClassItem getInitializerMethod(String sig) {
// only check if loadable class
if (m_curClass != null) {
// check for match to method defined in class
Method[] methods = getMethods();
for (int i = 0; i < methods.length; i++) {
Method method = methods[i];
if (method.getName().equals("")) {
if (method.getSignature().startsWith(sig)) {
ClassItem item = (ClassItem)m_itemMap.get(method);
if (item == null) {
item = new ClassItem("", this, method);
m_itemMap.put(method, item);
}
return item;
}
}
}
}
return null;
}
/**
* Get information for static method without respect to return value. This
* can only be used with existing classes. Only the class itself is checked
* for a method matching the supplied name and argument list signature.
*
* @param name method name
* @param sig encoded argument list signature
* @return method information, or null if method not found
*/
public ClassItem getStaticMethod(String name, String sig) {
// only check if loadable class
if (m_curClass != null) {
// check for match to method defined in class
Method[] methods = getMethods();
for (int i = 0; i < methods.length; i++) {
Method method = methods[i];
if (method.getName().equals(name) && method.isStatic()) {
if (method.getSignature().startsWith(sig)) {
ClassItem item = (ClassItem)m_itemMap.get(method);
if (item == null) {
item = new ClassItem(name, this, method);
m_itemMap.put(method, item);
}
return item;
}
}
}
}
return null;
}
/**
* Get all binding methods currently defined in class. Binding methods are
* generally identified by a supplied prefix, but additional methods
* can be specified the the combination of exact name and signature. This
* is a little kludgy, but necessary to handle the "marshal" method added
* to mapped classes.
*
* @param prefix identifying prefix for binding methods
* @param matches pairs of method name and signature to be matched as
* exceptions to the prefix matching
* @return existing binding methods
*/
public ExistingMethod[] getBindingMethods(String prefix, String[] matches) {
// return empty array if newly created class or unloadable class
if (m_curClass == null) {
return EMPTY_METHOD_ARRAY;
}
// check for binding methods defined in class
Method[] methods = getMethods();
int count = 0;
for (int i = 0; i < methods.length; i++) {
Method method = methods[i];
String name = method.getName();
if (name.startsWith(prefix)) {
count++;
} else {
String sig = method.getSignature();
for (int j = 0; j < matches.length; j += 2) {
if (name.equals(matches[j]) && sig.equals(matches[j+1])) {
count++;
break;
}
}
}
}
// generate array of methods found
if (count == 0) {
return EMPTY_METHOD_ARRAY;
} else {
ExistingMethod[] exists = new ExistingMethod[count];
int fill = 0;
for (int i = 0; i < methods.length; i++) {
Method method = methods[i];
String name = method.getName();
boolean match = name.startsWith(prefix);
if (!match) {
String sig = method.getSignature();
for (int j = 0; j < matches.length; j += 2) {
if (name.equals(matches[j]) &&
sig.equals(matches[j+1])) {
match = true;
break;
}
}
}
if (match) {
ClassItem item = (ClassItem)m_itemMap.get(method);
if (item == null) {
item = new ClassItem(name, this, method);
m_itemMap.put(method, item);
}
exists[fill++] = new ExistingMethod(method, item, this);
}
}
return exists;
}
}
/**
* Check accessible method. Check if a field or method in another class is
* accessible from within this class.
*
* @param item field or method information
* @return true if accessible, false if not
*/
public boolean isAccessible(ClassItem item) {
if (item.getClassFile() == this) {
return true;
} else {
int access = item.getAccessFlags();
if ((access & Constants.ACC_PUBLIC) != 0) {
return true;
} else if ((access & Constants.ACC_PRIVATE) != 0) {
return false;
} else if (getPackage().equals(item.getClassFile().getPackage())) {
return true;
} else if ((access & Constants.ACC_PROTECTED) != 0) {
ClassFile target = item.getClassFile();
ClassFile ancestor = this;
while ((ancestor = ancestor.getSuperFile()) != null) {
if (ancestor == target) {
return true;
}
}
return false;
} else {
return false;
}
}
}
/**
* Get generator for modifying class.
*
* @return generator for class
* @throws JiBXException if class not modifiable
*/
private ClassGen getClassGen() throws JiBXException {
if (m_genClass == null) {
if (m_isWritable) {
m_genClass = new ClassGen(m_curClass);
m_genPool = m_genClass.getConstantPool();
m_instBuilder = new InstructionBuilder(m_genClass, m_genPool);
m_isHashCurrent = false;
} else {
throw new JiBXException("Cannot modify class " + m_name);
}
}
return m_genClass;
}
/**
* Get constant pool generator for modifying class.
*
* @return constant pool generator for class
* @throws JiBXException if class not modifiable
*/
public ConstantPoolGen getConstPoolGen() throws JiBXException {
if (m_genPool == null) {
getClassGen();
}
return m_genPool;
}
/**
* Get instruction builder for modifying class.
*
* @return instruction builder for class
* @throws JiBXException if class not modifiable
*/
public InstructionBuilder getInstructionBuilder() throws JiBXException {
if (m_instBuilder == null) {
getClassGen();
}
return m_instBuilder;
}
/**
* Add method to class.
*
* @param method method to be added
* @return added method information
* @throws JiBXException on error in adding method
*/
public ClassItem addMethod(Method method) throws JiBXException {
getClassGen().addMethod(method);
setModified();
String mname = method.getName();
if (m_suffixMap != null && isSuffixName(mname)) {
m_suffixMap.put(mname, method);
}
m_methods = null;
return new ClassItem(mname, this, method);
}
/**
* Remove method from class.
*
* @param method method to be removed
* @throws JiBXException on error in removing method
*/
public void removeMethod(Method method) throws JiBXException {
getClassGen().removeMethod(method);
setModified();
String mname = method.getName();
if (m_suffixMap != null && isSuffixName(mname)) {
m_suffixMap.remove(mname);
}
m_methods = null;
}
/**
* Add field to class with initial String value. If a field
* with the same name already exists, it is overwritten.
*
* @param type fully qualified class name of field type
* @param name field name
* @param access access flags for field
* @param init initial value for field
* @return field information
* @throws JiBXException if unable to add field
*/
public ClassItem addField(String type, String name, int access, String init)
throws JiBXException {
deleteField(name);
FieldGen fgen = new FieldGen(access,
Type.getType(Utility.getSignature(type)), name, getConstPoolGen());
fgen.setInitValue(init);
Field field = fgen.getField();
getClassGen().addField(field);
m_isModified = true;
m_isHashCurrent = false;
return new ClassItem(name, this, field);
}
/**
* Update class field with initial String value. If the field
* already exists with the same characteristics it is left unchanged;
* otherwise any existing field with the same name is overwritten.
*
* @param type fully qualified class name of field type
* @param name field name
* @param access access flags for field
* @param init initial value for field
* @return field information
* @throws JiBXException if unable to add field
*/
public ClassItem updateField(String type, String name, int access,
String init) throws JiBXException {
// first check for match with existing field
Field[] fields = m_curClass.getFields();
for (int i = 0; i < fields.length; i++) {
Field field = fields[i];
if (field.getName().equals(name) &&
field.getAccessFlags() == access) {
String sig = field.getSignature();
if (type.equals(Utility.signatureToString(sig, false))) {
ConstantValue cval = field.getConstantValue();
if (cval != null) {
int index = cval.getConstantValueIndex();
ConstantPool cp = m_curClass.getConstantPool();
Constant cnst = cp.getConstant(index);
if (cnst instanceof ConstantString) {
Object value = ((ConstantString)cnst).
getConstantValue(cp);
if (init.equals(value)) {
return new ClassItem(name,this, field);
}
}
}
}
}
}
// no exact match, so replace any existing field with same name
deleteField(name);
FieldGen fgen = new FieldGen(access,
Type.getType(Utility.getSignature(type)), name, getConstPoolGen());
fgen.setInitValue(init);
Field field = fgen.getField();
getClassGen().addField(field);
m_isModified = true;
m_isHashCurrent = false;
return new ClassItem(name, this, field);
}
/**
* Add field to class without initialization. If a field with the same name
* already exists, it is overwritten.
*
* @param type fully qualified class name of field type
* @param name field name
* @param access access flags for field
* @return field information
* @throws JiBXException if unable to add field
*/
public ClassItem addField(String type, String name, int access)
throws JiBXException {
deleteField(name);
FieldGen fgen = new FieldGen(access,
Type.getType(Utility.getSignature(type)), name, getConstPoolGen());
Field field = fgen.getField();
getClassGen().addField(field);
m_isModified = true;
m_isHashCurrent = false;
return new ClassItem(name, this, field);
}
/**
* Add private field to class without initialization. If a field
* with the same name already exists, it is overwritten.
*
* @param type fully qualified class name of field type
* @param name field name
* @return field information
* @throws JiBXException if unable to add field
*/
public ClassItem addPrivateField(String type, String name)
throws JiBXException {
return addField(type, name, PRIVATEFIELD_ACCESS);
}
/**
* Add default constructor to a class. The added default constructor just
* calls the default constructor for the superclass. If the superclass
* doesn't have a default constructor, this method is called recursively to
* add one if possible.
*
* @return constructor information
* @throws JiBXException if unable to add constructor
*/
public ClassItem addDefaultConstructor() throws JiBXException {
if (m_defaultConstructor == null) {
// check for default constructor in superclass
ClassItem cons = m_superClass.getInitializerMethod("()V");
if (cons == null) {
if (m_superClass.addDefaultConstructor() == null) {
return null;
}
} else {
cons.makeAccessible(this);
}
// add the public constructor method
ExceptionMethodBuilder mb = new ExceptionMethodBuilder("",
Type.VOID, new Type[0], this, Constants.ACC_PUBLIC);
// call the superclass constructor
mb.appendLoadLocal(0);
mb.appendCallInit(m_superClass.getName(), "()V");
// finish with return
mb.appendReturn();
mb.codeComplete(false);
m_defaultConstructor = mb.addMethod();
}
return m_defaultConstructor;
}
/**
* Check if a method name matches the pattern for a generated unique suffix.
*
* @param name method name to be checked
* @return true if name matches suffix pattern,
* false if not
*/
private static boolean isSuffixName(String name) {
int last = name.length() - 1;
for (int i = last; i > 0; i--) {
char chr = name.charAt(i);
if (chr == '_') {
return i < last;
} else if (!Character.isDigit(chr)) {
break;
}
}
return false;
}
/**
* Make method name unique with generated suffix. The suffixed method name
* is tracked so that it will not be used again.
*
* @param name base name before suffix is appended
* @return name with unique suffix appended
*/
public String makeUniqueMethodName(String name) {
// check if map creation is needed
if (m_suffixMap == null) {
m_suffixMap = new HashMap();
if (m_curClass != null) {
Method[] methods = getMethods();
for (int i = 0; i < methods.length; i++) {
Method method = methods[i];
String mname = method.getName();
if (isSuffixName(mname)) {
m_suffixMap.put(mname, method);
}
}
}
}
// check if inheritance depth is needed
if (m_inheritDepth == 0) {
ClassFile cf = this;
while ((cf = cf.getSuperFile()) != null) {
m_inheritDepth++;
}
}
// generate suffix to make name unique, trying low values first
while (true) {
String uname = name + '_' + m_inheritDepth + '_' + m_uniqueIndex;
if (m_suffixMap.get(uname) == null) {
return uname;
} else {
m_uniqueIndex++;
}
}
}
/**
* Delete field from class.
*
* @param name field name
* @return true if field was present, false if not
* @throws JiBXException if unable to delete field
*/
public boolean deleteField(String name) throws JiBXException {
ClassGen cg = getClassGen();
Field field = cg.containsField(name);
if (field == null) {
return false;
} else {
cg.removeField(field);
m_isModified = true;
m_isHashCurrent = false;
return true;
}
}
/**
* Get use count for class.
*
* @return use count for this class
*/
public int getUseCount() {
return m_useCount;
}
/**
* Increment use count for class.
*
* @return use count (after increment)
*/
public int incrementUseCount() {
return ++m_useCount;
}
/**
* Check if class has been modified.
*
* @return true if class is modified, false if not
*/
public boolean isModified() {
return m_isModified;
}
/**
* Set class modified flag.
*/
public void setModified() {
if (!m_isModified) {
m_isModified = true;
MungedClass.addModifiedClass(this);
}
}
/**
* Check if class is in complete state.
*
* @return true if class is complete, false if not
*/
public boolean isComplete() {
return m_genClass == null;
}
/**
* Computes a hash code based on characteristics of the class. The
* characteristics used in computing the hash code include the base class,
* implemented interfaces, method names, field names, and package, but not
* the actual class name or signature. The current static version of the
* class is used for this computation, so if the class is being modified
* {@link #codeComplete} should be called before this method. Note that this
* is designed for use with the classes generated by JiBX, and is not
* necessarily a good model for general usage.
*
* @return computed hash code value
*/
protected int computeHashCode() {
// start with basic characteristics of class
int hash = getPackage().hashCode();
ClassFile sfile = getSuperFile();
if (sfile != null) {
hash += sfile.getName().hashCode();
}
String[] intfs = getInterfaces();
for (int i = 0; i < intfs.length; i++) {
hash += intfs[i].hashCode();
}
hash += m_curClass.getAccessFlags();
// include field and method names
Field[] fields = m_curClass.getFields();
for (int i = 0; i < fields.length; i++) {
hash = hash * 49 + fields[i].getName().hashCode();
}
Method[] methods = m_curClass.getMethods();
for (int i = 0; i < methods.length; i++) {
hash = hash * 49 + methods[i].getName().hashCode();
}
// finish with constant table simple values (except name and signature)
Constant[] cnsts = m_curClass.getConstantPool().getConstantPool();
for (int i = m_curClass.getClassNameIndex()+1; i < cnsts.length; i++) {
Constant cnst = cnsts[i];
if (cnst != null) {
int value = 0;
switch (cnst.getTag()) {
case Constants.CONSTANT_Double:
value = (int)Double.doubleToRawLongBits
(((ConstantDouble)cnst).getBytes());
break;
case Constants.CONSTANT_Float:
value = Float.floatToRawIntBits
(((ConstantFloat)cnst).getBytes());
break;
case Constants.CONSTANT_Integer:
value = ((ConstantInteger)cnst).getBytes();
break;
case Constants.CONSTANT_Long:
value = (int)((ConstantLong)cnst).getBytes();
break;
case Constants.CONSTANT_Utf8:
String text = ((ConstantUtf8)cnst).getBytes();
if (!text.equals(m_signature)) {
value = text.hashCode();
}
break;
default:
break;
}
hash = hash * 49 + value;
}
}
// System.out.println("Hashed " + m_name + " to value " + hash);
return hash;
}
/**
* Finalize current modified state of class. This converts the modified
* class state into a static form, then computes a hash code based on
* characteristics of the class. If the class has not been modified it
* just computes the hash code. Note that this won't initialize the array
* of superinterfaces if used with an interface, but that shouldn't be a
* problem since we don't create any interfaces.
*/
public void codeComplete() {
if (m_genClass != null) {
m_curClass = m_genClass.getJavaClass();
m_interfaceNames = m_curClass.getInterfaceNames();
m_superInterfaces = new ClassFile[0];
m_genClass = null;
}
}
/**
* Get hash code. This is based on most characteristics of the class,
* including the actual methods, but excluding the class name. It is only
* valid after the {@link #codeComplete} method is called.
*
* @return hash code based on code sequence
*/
public int hashCode() {
if (!m_isHashCurrent) {
if (m_genClass != null) {
throw new IllegalStateException
("Class still being constructed");
}
m_hashCode = computeHashCode();
m_isHashCurrent = true;
}
return m_hashCode;
}
/**
* Compare two field or method items to see if they're equal. This handles
* only the comparisons that apply to both fields and methods. It does not
* include comparing access flags, since these may be different due to
* access requirements.
*
* @param a first field or method item
* @param b second field or method item
* @return true if the equal, false if not
*/
public static boolean equalFieldOrMethods(FieldOrMethod a,
FieldOrMethod b) {
return a.getName().equals(b.getName()) &&
a.getSignature().equals(b.getSignature());
}
/**
* Compare two methods to see if they're equal. This checks only the details
* of the exception handling and actual code, not the name or signature.
*
* @param a first method
* @param b second method
* @return true if the equal, false if not
*/
public static boolean equalMethods(Method a, Method b) {
// check the exceptions thrown by the method
ExceptionTable etaba = a.getExceptionTable();
ExceptionTable etabb = b.getExceptionTable();
if (etaba != null && etabb != null) {
String[] aexcepts = etaba.getExceptionNames();
String[] bexcepts = etabb.getExceptionNames();
if (!Arrays.equals(aexcepts, bexcepts)) {
return false;
}
} else if (etaba != null || etabb != null) {
return false;
}
// compare the exception handling details
Code acode = a.getCode();
Code bcode = b.getCode();
CodeException[] acexs = acode.getExceptionTable();
CodeException[] bcexs = bcode.getExceptionTable();
if (acexs.length == bcexs.length) {
for (int i = 0; i < acexs.length; i++) {
CodeException acex = acexs[i];
CodeException bcex = bcexs[i];
if (acex.getCatchType() != bcex.getCatchType() ||
acex.getStartPC() != bcex.getStartPC() ||
acex.getEndPC() != bcex.getEndPC() ||
acex.getHandlerPC() != bcex.getHandlerPC()) {
return false;
}
}
}
// finally compare the actual byte codes
return Arrays.equals(acode.getCode(), bcode.getCode());
}
/**
* Check if objects are equal. Compares first based on hash code, then on
* the actual contents of the class, including package, implemented
* interfaces, superclass, methods, and fields (but not the actual class
* name). It is only valid after the {@link #codeComplete} method is called.
*
* @param obj
* @return true if equal objects, false if not
*/
public boolean equals(Object obj) {
if (obj instanceof ClassFile && obj.hashCode() == hashCode()) {
// check basic details of the classes
ClassFile comp = (ClassFile)obj;
if (!org.jibx.runtime.Utility.isEqual(getPackage(),
comp.getPackage()) || getSuperFile() != comp.getSuperFile() ||
!Arrays.equals(getInterfaces(), comp.getInterfaces())) {
return false;
}
JavaClass tjc = m_curClass;
JavaClass cjc = comp.m_curClass;
if (tjc.getAccessFlags() != cjc.getAccessFlags()) {
return false;
}
// compare the defined fields
Field[] tfields = tjc.getFields();
Field[] cfields = cjc.getFields();
if (tfields.length != cfields.length) {
return false;
}
for (int i = 0; i < tfields.length; i++) {
if (!equalFieldOrMethods(tfields[i], cfields[i])) {
return false;
}
}
// compare the defined methods
Method[] tmethods = tjc.getMethods();
Method[] cmethods = cjc.getMethods();
if (tmethods.length != cmethods.length) {
return false;
}
for (int i = 0; i < tmethods.length; i++) {
Method tmethod = tmethods[i];
Method cmethod = cmethods[i];
if (!equalFieldOrMethods(tmethod, cmethod) ||
!equalMethods(tmethod, cmethod)) {
return false;
}
}
// finish with constant table values (correcting name and signature)
Constant[] tcnsts = tjc.getConstantPool().getConstantPool();
Constant[] ccnsts = cjc.getConstantPool().getConstantPool();
if (tcnsts.length != ccnsts.length) {
return false;
}
for (int i = tjc.getClassNameIndex()+1; i < tcnsts.length; i++) {
Constant tcnst = tcnsts[i];
Constant ccnst = ccnsts[i];
if (tcnst != null && ccnst != null) {
int tag = tcnst.getTag();
if (tag != ccnst.getTag()) {
return false;
}
boolean equal = true;
switch (tag) {
case Constants.CONSTANT_Double:
equal = ((ConstantDouble)tcnst).getBytes() ==
((ConstantDouble)ccnst).getBytes();
break;
case Constants.CONSTANT_Float:
equal = ((ConstantFloat)tcnst).getBytes() ==
((ConstantFloat)ccnst).getBytes();
break;
case Constants.CONSTANT_Integer:
equal = ((ConstantInteger)tcnst).getBytes() ==
((ConstantInteger)ccnst).getBytes();
break;
case Constants.CONSTANT_Long:
equal = ((ConstantLong)tcnst).getBytes() ==
((ConstantLong)ccnst).getBytes();
break;
case Constants.CONSTANT_Utf8:
String ttext = ((ConstantUtf8)tcnst).getBytes();
String ctext = ((ConstantUtf8)ccnst).getBytes();
if (ttext.equals(m_signature)) {
equal = ctext.equals(comp.m_signature);
} else {
equal = ttext.equals(ctext);
}
break;
default:
break;
}
if (!equal) {
return false;
}
} else if (tcnst != null || ccnst != null) {
return false;
}
}
// if nothing failed, the classes are equal
return true;
} else {
return false;
}
}
/**
* Delete class file information. Deletes the class file for this class,
* if it exists. Does nothing if no class file has been generated.
*/
public void delete() {
if (m_file.exists()) {
m_file.delete();
}
}
/**
* Write out modified class information. Writes the modified class file to
* an output stream.
*
* @param os output stream for writing modified class
* @throws IOException if error writing to file
*/
public void writeFile(OutputStream os) throws IOException {
codeComplete();
m_curClass.dump(new BufferedOutputStream(os));
os.close();
}
/**
* Write out modified class information. Writes the modified class file
* back out to the original file. If the class file has not been modified,
* the original file is kept unchanged.
*
* @throws IOException if error writing to file
*/
public void writeFile() throws IOException {
if (m_isModified) {
OutputStream os = new FileOutputStream(m_file);
writeFile(os);
}
}
/**
* Derive generated class name. This generates a JiBX class name from the
* name of this class, using the supplied prefix and suffix information. The
* derived class name is always in the same package as this class.
*
* @param prefix generated class name prefix
* @param suffix generated class name suffix
* @return derived class name
*/
public String deriveClassName(String prefix, String suffix) {
String pack = "";
String tname = m_name;
int split = tname.lastIndexOf('.');
if (split >= 0) {
pack = tname.substring(0, split+1);
tname = tname.substring(split+1);
}
return pack + prefix + tname + suffix;
}
/**
* Set class paths to be searched.
*
* @param paths ordered set of paths to be searched for class files
*/
public static void setPaths(String[] paths) {
// create full path string with separators for BCEL loader
StringBuffer full = new StringBuffer();
for (int i = 0; i < paths.length; i++) {
if (i > 0) {
full.append(File.pathSeparatorChar);
}
full.append(paths[i]);
}
s_loader = new ClassPath(full.toString());
// create direct classloader for access to classes during binding
URL[] urls = new URL[paths.length];
try {
// generate array of component file or directory URLs
for (int i = 0; i < urls.length; i++) {
urls[i] = new File(paths[i]).toURL();
}
// initialize classloader with full array of path URLs
s_directLoader = new URLClassLoader(urls);
} catch (MalformedURLException ex) {
throw new IllegalArgumentException
("Error initializing classloading: " + ex.getMessage());
}
}
/**
* Try loading class from classpath.
*
* @param name fully qualified name of class to be loaded
* @return loaded class, or null if not found
*/
public static Class loadClass(String name) {
try {
return s_directLoader.loadClass(name);
} catch (ClassNotFoundException ex) {
return null;
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/classes/ClassItem.java 0000644 0001750 0001750 00000046154 10737003264 025325 0 ustar moeller moeller /*
Copyright (c) 2003-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.classes;
import java.util.HashMap;
import org.apache.bcel.Constants;
import org.apache.bcel.classfile.Attribute;
import org.apache.bcel.classfile.ExceptionTable;
import org.apache.bcel.classfile.FieldOrMethod;
import org.apache.bcel.classfile.LocalVariableTable;
import org.apache.bcel.classfile.Method;
import org.apache.bcel.classfile.Utility;
import org.apache.bcel.generic.ArrayType;
import org.apache.bcel.generic.ObjectType;
import org.apache.bcel.generic.Type;
import org.jibx.runtime.JiBXException;
/**
* Wrapper for field or method information. Provides the information needed
* for access to either existing or added methods in existing classes.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class ClassItem
{
/** Empty array of strings. */
private static final String[] EMPTY_STRING_ARRAY = new String[0];
/** Tag value for signature attribute. */
private static final byte SIGNATURE_ATTRIBUTE_TAG = 10;
/** Map for primitive type signature variants. */
private static HashMap s_primitiveMap = new HashMap();
/** Map from type name to BCEL type. */
private static HashMap s_typeMap = new HashMap();
/** Map from method signature to array of argument types. */
private static HashMap s_signatureParamsMap = new HashMap();
/** Map from method signature to return type. */
private static HashMap s_signatureTypeMap = new HashMap();
static {
s_primitiveMap.put("boolean", new String[] { "Z", "I" });
s_primitiveMap.put("byte", new String[] { "B", "S", "I" });
s_primitiveMap.put("char", new String[] { "C", "I" });
s_primitiveMap.put("double", new String[] { "D" });
s_primitiveMap.put("float", new String[] { "F" });
s_primitiveMap.put("int", new String[] { "I" });
s_primitiveMap.put("long", new String[] { "J" });
s_primitiveMap.put("short", new String[] { "S", "I" });
s_primitiveMap.put("void", new String[] { "V" });
s_typeMap.put("boolean", Type.BOOLEAN);
s_typeMap.put("byte", Type.BYTE);
s_typeMap.put("char", Type.CHAR);
s_typeMap.put("double", Type.DOUBLE);
s_typeMap.put("float", Type.FLOAT);
s_typeMap.put("int", Type.INT);
s_typeMap.put("long", Type.LONG);
s_typeMap.put("short", Type.SHORT);
s_typeMap.put("void", Type.VOID);
}
/** Owning class information. */
private ClassFile m_classFile;
/** Item name. */
private String m_name;
/** Encoded signature. */
private String m_signature;
/** Fully qualified class name of item type. */
private String m_typeName;
/** Argument types for method. */
private String[] m_argTypes;
/** Wrapped existing item. */
private FieldOrMethod m_item;
/**
* Constructor. Builds a wrapper for an item based on an existing field or
* method.
*
* @param name field or method name
* @param cf owning class information
* @param item field or method information
*/
public ClassItem(String name, ClassFile cf, FieldOrMethod item) {
m_classFile = cf;
m_name = name;
m_item = item;
m_signature = item.getSignature();
if (item instanceof Method) {
m_typeName = getTypeFromSignature(m_signature);
m_argTypes = getParametersFromSignature(m_signature);
} else {
m_typeName = Utility.signatureToString(m_signature, false);
}
}
/**
* Get owning class information.
*
* @return owning class information
*/
public ClassFile getClassFile() {
return m_classFile;
}
/**
* Get item name.
*
* @return item name
*/
public String getName() {
return m_name;
}
/**
* Get item type as fully qualified class name.
*
* @return item type name
*/
public String getTypeName() {
return m_typeName;
}
/**
* Get number of arguments for method.
*
* @return argument count for method, or zero if not a method
*/
public int getArgumentCount() {
if (m_item instanceof Method) {
return m_argTypes.length;
} else {
return 0;
}
}
/**
* Get argument type as fully qualified class name.
*
* @param index argument number
* @return argument type name
*/
public String getArgumentType(int index) {
if (m_item instanceof Method) {
return m_argTypes[index];
} else {
throw new IllegalArgumentException("Internal error: not a method");
}
}
/**
* Get method parameter name.
*
* @param index parameter index
* @return parameter name
*/
public String getParameterName(int index) {
if (m_item instanceof Method) {
int position = index;
if (!isStatic()) {
position++;
}
LocalVariableTable vtab = ((Method)m_item).getLocalVariableTable();
if (vtab == null) {
return null;
} else {
return vtab.getLocalVariable(position).getName();
}
} else {
throw new IllegalArgumentException("Internal error: not a method");
}
}
/**
* Get argument types as array of fully qualified class names.
*
* @return array of argument types
*/
public String[] getArgumentTypes() {
if (m_item instanceof Method) {
return m_argTypes;
} else {
return null;
}
}
/**
* Get access flags.
*
* @return flags for access type of field or method
*/
public int getAccessFlags() {
return m_item.getAccessFlags();
}
/**
* Set access flags.
*
* @param flags access flags for field or method
*/
public void setAccessFlags(int flags) {
m_item.setAccessFlags(flags);
m_classFile.setModified();
}
/**
* Make accessible item. Check if this field or method is accessible from
* another class, and if not decreases the access restrictions to make it
* accessible.
*
* @param src class file for required access
* @throws JiBXException if cannot be accessed
*/
public void makeAccessible(ClassFile src) throws JiBXException {
// no need to change if already public access
int access = getAccessFlags();
if ((access & Constants.ACC_PUBLIC) == 0) {
// check for same package as most restrictive case
ClassFile dest = getClassFile();
if (dest.getPackage().equals(src.getPackage())) {
if ((access & Constants.ACC_PRIVATE) != 0) {
access = access - Constants.ACC_PRIVATE;
}
} else {
// check if access is from a subclass of this method class
ClassFile ancestor = src;
while ((ancestor = ancestor.getSuperFile()) != null) {
if (ancestor == dest) {
break;
}
}
// handle access adjustments based on subclass status
if (ancestor == null) {
int clear = Constants.ACC_PRIVATE |
Constants.ACC_PROTECTED;
access = (access & ~clear) | Constants.ACC_PUBLIC;
} else if ((access & Constants.ACC_PROTECTED) == 0) {
access = (access & ~Constants.ACC_PRIVATE) |
Constants.ACC_PROTECTED;
}
}
// set new access flags
if (access != getAccessFlags()) {
if (dest.isModifiable()) {
setAccessFlags(access);
} else {
throw new JiBXException
("Unable to change access permissions for " +
getName() + " in class " + src.getName());
}
}
}
}
/**
* Check if item is a static.
*
* @return true if a static, false if member
*/
public boolean isStatic() {
return (getAccessFlags() & Constants.ACC_STATIC) != 0;
}
/**
* Get method signature.
*
* @return encoded method signature
*/
public String getSignature() {
return m_signature;
}
/**
* Check if item is a method.
*
* @return true if a method, false if a field
*/
public boolean isMethod() {
return m_item == null || m_item instanceof Method;
}
/**
* Check if item is an initializer.
*
* @return true if an initializer, false if a
* field or normal method
*/
public boolean isInitializer() {
return m_item != null && m_item.getName().equals("");
}
/**
* Get names of exceptions thrown by method.
*
* @return array of exceptions thrown by method, or null if
* a field
*/
public String[] getExceptions() {
if (m_item instanceof Method) {
ExceptionTable etab = ((Method)m_item).getExceptionTable();
if (etab != null) {
return etab.getExceptionNames();
} else {
return EMPTY_STRING_ARRAY;
}
}
return null;
}
/**
* Get the generics signature information for item.
*
* @return generics signature (null if none)
*/
public String getGenericsSignature() {
Attribute[] attrs = m_item.getAttributes();
for (int j = 0; j < attrs.length; j++) {
Attribute attr = attrs[j];
if (attr.getTag() == SIGNATURE_ATTRIBUTE_TAG) {
return attr.toString();
}
}
return null;
}
/**
* Check if type is a primitive.
*
* @param type
* @return true if a primitive, false if not
*/
public static boolean isPrimitive(String type) {
return s_primitiveMap.get(type) != null;
}
/**
* Get the signature for a primitive.
*
* @param type
* @return signature for a primitive type
*/
public static String getPrimitiveSignature(String type) {
return ((String[])s_primitiveMap.get(type))[0];
}
/**
* Get parameter type names from method signature.
*
* @param sig method signature to be decoded
* @return array of argument type names
*/
public static String[] getParametersFromSignature(String sig) {
String[] types = (String[])s_signatureParamsMap.get(sig);
if (types == null) {
types = Utility.methodSignatureArgumentTypes(sig, false);
s_signatureParamsMap.put(sig, types);
}
return types;
}
/**
* Get return type names from method signature.
*
* @param sig method signature to be decoded
* @return return type name
*/
public static String getTypeFromSignature(String sig) {
String type = (String)s_signatureTypeMap.get(sig);
if (type == null) {
type = Utility.methodSignatureReturnType(sig, false);
s_signatureTypeMap.put(sig, type);
}
return type;
}
/**
* Create type from name.
*
* @param name fully qualified type name
* @return corresponding type
*/
public static Type typeFromName(String name) {
// first check for type already created
Type type = (Type)s_typeMap.get(name);
if (type == null) {
// new type, strip off array dimensions
int dimen = 0;
String base = name;
while (base.endsWith("[]")) {
dimen++;
base = base.substring(0, base.length()-2);
}
// check for base type defined if array
if (dimen > 0) {
type = (Type)s_typeMap.get(base);
}
// create and record base type if new
if (type == null) {
type = new ObjectType(base);
s_typeMap.put(base, type);
}
// create and record array type
if (dimen > 0) {
type = new ArrayType(type, dimen);
s_typeMap.put(name, type);
}
}
return type;
}
/**
* Get virtual method by fully qualified name. This splits the class
* name from the method name, finds the class, and then tries to find a
* matching method name in that class or a superclass.
*
* @param name fully qualified class and method name
* @param sigs possible method signatures
* @return information for the method, or null if not found
* @throws JiBXException if configuration error
*/
public static ClassItem findVirtualMethod(String name, String[] sigs)
throws JiBXException {
// get the class containing the method
int split = name.lastIndexOf('.');
String cname = name.substring(0, split);
String mname = name.substring(split+1);
ClassFile cf = ClassCache.getClassFile(cname);
// find the method in class or superclass
for (int i = 0; i < sigs.length; i++) {
ClassItem method = cf.getMethod(mname, sigs[i]);
if (method != null) {
return method;
}
}
return null;
}
/**
* Get static method by fully qualified name. This splits the class
* name from the method name, finds the class, and then tries to find a
* matching method name in that class.
*
* @param name fully qualified class and method name
* @param sigs possible method signatures
* @return information for the method, or null if not found
* @throws JiBXException if configuration error
*/
public static ClassItem findStaticMethod(String name, String[] sigs)
throws JiBXException {
// get the class containing the method
int split = name.lastIndexOf('.');
String cname = name.substring(0, split);
String mname = name.substring(split+1);
ClassFile cf = ClassCache.getClassFile(cname);
// find the method in class or superclass
for (int i = 0; i < sigs.length; i++) {
ClassItem method = cf.getStaticMethod(mname, sigs[i]);
if (method != null) {
return method;
}
}
return null;
}
/**
* Get all variant signatures for a fully qualified class name. The
* returned array gives all signatures (for interfaces or classes) which
* instances of the class can match.
*
* @param name fully qualified class name
* @return possible signature variations for instances of the class
* @throws JiBXException if configuration error
*/
public static String[] getSignatureVariants(String name)
throws JiBXException {
Object obj = s_primitiveMap.get(name);
if (obj == null) {
ClassFile cf = ClassCache.getClassFile(name);
return cf.getInstanceSigs();
} else {
return (String[])obj;
}
}
/**
* Check if a value of one type can be directly assigned to another type.
* This is basically the equivalent of the instanceof operator, but with
* application to primitive types as well as object types.
*
* @param from fully qualified class name of initial type
* @param to fully qualified class name of assignment type
* @return true if assignable, false if not
* @throws JiBXException if configuration error
*/
public static boolean isAssignable(String from, String to)
throws JiBXException {
// always assignable if the two are the same
if (from.equals(to)) {
return true;
} else {
// try direct lookup for primitive types
Object fobj = s_primitiveMap.get(from);
Object tobj = s_primitiveMap.get(to);
if (fobj == null && tobj == null) {
// assignable if from type has to as a possible signature
ClassFile cf = ClassCache.getClassFile(from);
String[] sigs = cf.getInstanceSigs();
String match = Utility.getSignature(to);
for (int i = 0; i < sigs.length; i++) {
if (match.equals(sigs[i])) {
return true;
}
}
return false;
} else if (fobj != null && tobj != null) {
// assignable if from type has to as a possible signature
String[] fsigs = (String[])fobj;
String[] tsigs = (String[])tobj;
if (tsigs.length == 1) {
for (int i = 0; i < fsigs.length; i++) {
if (fsigs[i] == tsigs[0]) {
return true;
}
}
}
return false;
} else {
// primitive and object types never assignable
return false;
}
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/classes/ContextMethodBuilder.java 0000644 0001750 0001750 00000015776 10270751224 027541 0 ustar moeller moeller /*
Copyright (c) 2003-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.classes;
import org.apache.bcel.Constants;
import org.apache.bcel.generic.*;
import org.jibx.runtime.JiBXException;
/**
* Builder for binding methods with a context and current object. Tracks the
* current object reference and the context object reference positions in the
* local variables table.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class ContextMethodBuilder extends ExceptionMethodBuilder
{
/** Variable slot for current object reference. */
private int m_objectSlot;
/** Object type as accessed by method. */
private String m_objectType;
/** Variable slot for context reference. */
private int m_contextSlot;
/** Context type as accessed by method. */
private String m_contextType;
/** Context type as accessed by method. */
private final boolean m_isStatic;
/**
* Constructor with types specified. This sets up for constructing a
* binding method that uses a current object and a marshalling or
* unmarshalling context.
*
* @param name method name to be built
* @param ret method return type
* @param args types of arguments
* @param cf owning class file information
* @param access flags for method access
* @param obj variable slot for current object (negative value if to be
* defined later)
* @param type current object type as defined in method
* @param ctx variable slot for marshalling/unmarshalling context
* @param ctype context type as defined in method
* @throws JiBXException on error in initializing method construction
*/
public ContextMethodBuilder(String name, Type ret, Type[] args,
ClassFile cf, int access, int obj, String type, int ctx, String ctype)
throws JiBXException {
super(name, ret, args, cf, access);
m_objectSlot = obj;
m_objectType = type;
m_contextSlot = ctx;
m_contextType = ctype;
m_isStatic = (access & Constants.ACC_STATIC) != 0;
addException(FRAMEWORK_EXCEPTION_CLASS);
}
/**
* Constructor from signature.
*
* @param name method name to be built
* @param sig method signature
* @param cf owning class file information
* @param access flags for method access
* @param obj variable slot for current object (negative value if to be
* defined later)
* @param type current object type
* @param ctx variable slot for marshalling/unmarshalling context
* @param ctype context type as defined in method
* @throws JiBXException on error in initializing method construction
*/
public ContextMethodBuilder(String name, String sig,
ClassFile cf, int access, int obj, String type, int ctx, String ctype)
throws JiBXException {
this(name, Type.getReturnType(sig), Type.getArgumentTypes(sig),
cf, access, obj, type, ctx, ctype);
}
/**
* Constructor from signature for public, final method.
*
* @param name method name to be built
* @param sig method signature
* @param cf owning class file information
* @param obj variable slot for current object (negative value if to be
* defined later)
* @param type current object type
* @param ctx variable slot for marshalling/unmarshalling context
* @param ctype context type as defined in method
* @throws JiBXException on error in initializing method construction
*/
public ContextMethodBuilder(String name, String sig, ClassFile cf,
int obj, String type, int ctx, String ctype) throws JiBXException {
this(name, sig, cf, Constants.ACC_PUBLIC|Constants.ACC_FINAL,
obj, type, ctx, ctype);
}
/**
* Set current object slot. Sets the local variable position of the current
* object, as required when the object is actually created within the
* method.
*
* @param slot local variable slot for current object
*/
public void setObjectSlot(int slot) {
m_objectSlot = slot;
}
/**
* Append instruction to load object to stack.
*/
public void loadObject() {
appendLoadLocal(m_objectSlot);
}
/**
* Append instruction to store object from stack.
*/
public void storeObject() {
if (m_objectSlot < 0) {
LocalVariableGen var = createLocal("obj",
ClassItem.typeFromName(m_objectType));
m_objectSlot = var.getIndex();
} else {
appendCreateCast(m_objectType);
appendStoreLocal(m_objectSlot);
}
}
/**
* Append instruction(s) to load object to stack as specified type.
*
* @param type loaded type expected on stack
*/
public void loadObject(String type) {
appendLoadLocal(m_objectSlot);
if (!m_objectType.equals(type)) {
appendCreateCast(m_objectType, type);
}
}
/**
* Append instruction to load context to stack.
*/
public void loadContext() {
appendLoadLocal(m_contextSlot);
}
/**
* Append instruction(s) to load context to stack as specified type.
*
* @param type loaded type expected on stack
*/
public void loadContext(String type) {
appendLoadLocal(m_contextSlot);
if (!m_contextType.equals(type)) {
appendCreateCast(m_contextType, type);
}
}
/**
* Check if method is static.
*
* @return true if static, false if not
*/
public boolean isStaticMethod() {
return m_isStatic;
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/classes/ExceptionMethodBuilder.java 0000644 0001750 0001750 00000012546 10210703666 030044 0 ustar moeller moeller /*
Copyright (c) 2003-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.classes;
import java.util.HashMap;
import org.apache.bcel.Constants;
import org.apache.bcel.generic.*;
import org.jibx.runtime.JiBXException;
/**
* Builder for simple methods that may just pass checked exceptions on to
* caller.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class ExceptionMethodBuilder extends MethodBuilder
{
/** Map for object to variable assignments. */
private HashMap m_slotMap;
/**
* Constructor with types specified.
*
* @param name method name to be built
* @param ret method return type
* @param args types of arguments
* @param cf owning class file information
* @param access flags for method access
* @throws JiBXException on error in initializing method construction
*/
public ExceptionMethodBuilder(String name, Type ret, Type[] args,
ClassFile cf, int access) throws JiBXException {
super(name, ret, args, cf, access);
}
/**
* Constructor from signature.
*
* @param name method name to be built
* @param sig method signature
* @param cf owning class file information
* @param access flags for method access
* @throws JiBXException on error in initializing method construction
*/
public ExceptionMethodBuilder(String name, String sig,
ClassFile cf, int access) throws JiBXException {
super(name, Type.getReturnType(sig), Type.getArgumentTypes(sig),
cf, access);
}
/**
* Constructor from signature for public, final method.
*
* @param name method name to be built
* @param sig method signature
* @param cf owning class file information
* @throws JiBXException on error in initializing method construction
*/
public ExceptionMethodBuilder(String name, String sig, ClassFile cf)
throws JiBXException {
super(name, Type.getReturnType(sig), Type.getArgumentTypes(sig),
cf, Constants.ACC_PUBLIC | Constants.ACC_FINAL);
}
/**
* Define local variable slot for object. The current code in the method
* must have the initial value for the variable on the stack
*
* @param obj owning object of slot
*/
public void defineSlot(Object obj, Type type) {
if (m_slotMap == null) {
m_slotMap = new HashMap();
}
LocalVariableGen var = createLocal("var" + m_slotMap.size(), type);
m_slotMap.put(obj, var);
}
/**
* Check if local variable slot defined for object.
*
* @param obj owning object of slot
* @return local variable slot assigned to object, or -1 if
* none
*/
public int getSlot(Object obj) {
if (m_slotMap != null) {
LocalVariableGen var = (LocalVariableGen)m_slotMap.get(obj);
if (var != null) {
return var.getIndex();
}
}
return -1;
}
/**
* Free local variable slot for object. This clears the usage of the slot
* (if one has been defined for the object) so it can be reused for other
* purposes.
*
* @param obj owning object of slot
*/
public void freeSlot(Object obj) {
if (m_slotMap != null) {
LocalVariableGen var = (LocalVariableGen)m_slotMap.get(obj);
if (var != null) {
var.setEnd(getLastInstruction());
m_slotMap.remove(obj);
}
}
}
/**
* Process accumulated exceptions. Just adds the checked exceptions that
* may be thrown within the body to the list for this method, passing them
* on to the caller for handling.
*
* @throws JiBXException on error in exception handling
*/
protected void handleExceptions() throws JiBXException {
for (int i = 0; i < m_exceptions.size(); i++) {
m_generator.addException((String)m_exceptions.get(i));
}
}
}
libjibx-java-1.1.6a/build/src/org/jibx/binding/classes/ExistingMethod.java 0000644 0001750 0001750 00000010506 10210703666 026363 0 ustar moeller moeller /*
Copyright (c) 2003-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.classes;
import org.apache.bcel.classfile.Method;
import org.jibx.runtime.JiBXException;
/**
* Information for an existing binding method. It supplies hash code and
* equality checking based on the method signature and actual byte code of the
* generated method, ignoring the method name.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class ExistingMethod extends BindingMethod
{
/** Class item information. */
private ClassItem m_item;
/** Actual method information. */
private Method m_method;
/** Accumulated hash code from adding instructions. */
private int m_hashCode;
/** Flag for method used in code. */
private boolean m_used;
/**
* Constructor.
*
* @param method actual method information
* @param item class item information for method
* @param file class file information
*/
public ExistingMethod(Method method, ClassItem item, ClassFile file) {
super(file);
m_item = item;
m_method = method;
m_hashCode = computeMethodHash(method);
// System.out.println("Computed hash for existing method " +
// m_classFile.getName() + '.' + method.getName() + " as " + m_hashCode);
}
/**
* Get name of method.
*
* @return method name
*/
public String getName() {
return m_item.getName();
}
/**
* Get signature.
*
* @return signature for method
*/
public String getSignature() {
return m_item.getSignature();
}
/**
* Get access flags.
*
* @return flags for access type of method
*/
public int getAccessFlags() {
return m_item.getAccessFlags();
}
/**
* Set access flags.
*
* @param flags access type to be set
*/
public void setAccessFlags(int flags) {
m_item.setAccessFlags(flags);
}
/**
* Check method used status.
*
* @return method used status
*/
public boolean isUsed() {
return m_used;
}
/**
* Set method used status.
*/
public void setUsed() {
m_used = true;
}
/**
* Get the actual method.
*
* @return method information
*/
public Method getMethod() {
return m_method;
}
/**
* Get the method item.
*
* @return method item information
*/
public ClassItem getItem() {
return m_item;
}
/**
* Delete method from class.
*
* @throws JiBXException if unable to delete method
*/
public void delete() throws JiBXException {
getClassFile().removeMethod(m_method);
}
/**
* Get hash code.
*
* @return hash code for this method
*/
public int hashCode() {
return m_hashCode;
}
}
libjibx-java-1.1.6a/build/src/org/jibx/binding/classes/InstructionBuilder.java 0000644 0001750 0001750 00000022540 10263161056 027260 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.classes;
import java.security.InvalidParameterException;
import org.apache.bcel.Constants;
import org.apache.bcel.generic.*;
/**
* Instruction builder. Extends the basic instruction construction tools in
* BCEL with some convenience methods.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class InstructionBuilder extends InstructionFactory
{
/**
* Constructor.
*
* @param cg class generation information
* @param cp constant pool generator
*/
public InstructionBuilder(ClassGen cg, ConstantPoolGen cp) {
super(cg, cp);
}
/**
* Get constant pool generator.
*
* @return constant pool generator for class
*/
public ConstantPoolGen getConstantPoolGen() {
return cp;
}
/**
* Create load constant instruction. Builds the most appropriate type of
* instruction for the value.
*
* @param value constant value to be loaded
* @return generated instruction information
*/
public CompoundInstruction createLoadConstant(int value) {
return new PUSH(cp, value);
}
/**
* Create load constant instruction. Loads a String reference
* from the constant pool.
*
* @param value constant value to be loaded
* @return generated instruction information
*/
public CompoundInstruction createLoadConstant(String value) {
return new PUSH(cp, value);
}
/**
* Create load constant instruction. Loads an unwrapped primitive value or
* String from the constant pool.
*
* @param value constant value to be loaded
* @return generated instruction information
*/
public CompoundInstruction createLoadConstant(Object value) {
if (value instanceof Boolean) {
return new PUSH(cp, (Boolean)value);
} else if (value instanceof Character) {
return new PUSH(cp, (Character)value);
} else if (value instanceof Number) {
return new PUSH(cp, (Number)value);
} else if (value instanceof String) {
return new PUSH(cp, (String)value);
} else {
throw new InvalidParameterException
("Internal code generation error!");
}
}
/**
* Create getfield instruction. Uses the field information to generate
* the instruction.
*
* @param item information for field to be set
* @return generated instruction information
*/
public FieldInstruction createGetField(ClassItem item) {
String cname = item.getClassFile().getName();
String fname = item.getName();
return new GETFIELD(cp.addFieldref(cname, fname, item.getSignature()));
}
/**
* Create putfield instruction. Uses the field information to generate
* the instruction.
*
* @param item information for field to be set
* @return generated instruction information
*/
public FieldInstruction createPutField(ClassItem item) {
String cname = item.getClassFile().getName();
String fname = item.getName();
return new PUTFIELD(cp.addFieldref(cname, fname, item.getSignature()));
}
/**
* Create getstatic instruction. Uses the field information to generate
* the instruction.
*
* @param item information for field to be set
* @return generated instruction information
*/
public FieldInstruction createGetStatic(ClassItem item) {
String cname = item.getClassFile().getName();
String fname = item.getName();
return new GETSTATIC(cp.addFieldref(cname, fname, item.getSignature()));
}
/**
* Create putstatic instruction. Uses the field information to generate
* the instruction.
*
* @param item information for field to be set
* @return generated instruction information
*/
public FieldInstruction createPutStatic(ClassItem item) {
String cname = item.getClassFile().getName();
String fname = item.getName();
return new PUTSTATIC(cp.addFieldref(cname, fname, item.getSignature()));
}
/**
* Create invoke instruction for static method. Uses the method information
* to generate the instruction.
*
* @param item information for method to be called
* @return generated instruction information
*/
public InvokeInstruction createCallStatic(ClassItem item) {
String cname = item.getClassFile().getName();
String mname = item.getName();
int index = cp.addMethodref(cname, mname, item.getSignature());
return new INVOKESTATIC(index);
}
/**
* Create invoke instruction for virtual method. Uses the method information
* to generate the instruction.
*
* @param item information for method to be called
* @return generated instruction information
*/
public InvokeInstruction createCallVirtual(ClassItem item) {
String cname = item.getClassFile().getName();
String mname = item.getName();
int index = cp.addMethodref(cname, mname, item.getSignature());
return new INVOKEVIRTUAL(index);
}
/**
* Create invoke instruction for interface method. Uses the method
* information to generate the instruction.
*
* @param item information for method to be called
* @return generated instruction information
*/
public InvokeInstruction createCallInterface(ClassItem item) {
String cname = item.getClassFile().getName();
String mname = item.getName();
String signature = item.getSignature();
return createInvoke(cname, mname, Type.getReturnType(signature),
Type.getArgumentTypes(signature), Constants.INVOKEINTERFACE);
}
/**
* Create invoke static method instruction from signature.
*
* @param method fully qualified class and method name
* @param signature method signature in standard form
* @return generated instruction information
*/
public InvokeInstruction createCallStatic(String method, String signature) {
int split = method.lastIndexOf('.');
String cname = method.substring(0, split);
String mname = method.substring(split+1);
int index = cp.addMethodref(cname, mname, signature);
return new INVOKESTATIC(index);
}
/**
* Create invoke virtual method instruction from signature.
*
* @param method fully qualified class and method name
* @param signature method signature in standard form
* @return generated instruction information
*/
public InvokeInstruction createCallVirtual(String method,
String signature) {
int split = method.lastIndexOf('.');
String cname = method.substring(0, split);
String mname = method.substring(split+1);
int index = cp.addMethodref(cname, mname, signature);
return new INVOKEVIRTUAL(index);
}
/**
* Create invoke interface method instruction from signature.
*
* @param method fully qualified interface and method name
* @param signature method signature in standard form
* @return generated instruction information
*/
public InvokeInstruction createCallInterface(String method,
String signature) {
int split = method.lastIndexOf('.');
String cname = method.substring(0, split);
String mname = method.substring(split+1);
return createInvoke(cname, mname, Type.getReturnType(signature),
Type.getArgumentTypes(signature), Constants.INVOKEINTERFACE);
}
/**
* Create invoke initializer instruction from signature.
*
* @param name fully qualified class name
* @param signature method signature in standard form
* @return generated instruction information
*/
public InvokeInstruction createCallInit(String name, String signature) {
int index = cp.addMethodref(name, "", signature);
return new INVOKESPECIAL(index);
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/classes/MarshalBuilder.java 0000644 0001750 0001750 00000010446 10071714172 026330 0 ustar moeller moeller /*
Copyright (c) 2003-2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.classes;
import org.apache.bcel.Constants;
import org.apache.bcel.generic.*;
import org.jibx.runtime.JiBXException;
/**
* Marshalling method builder. Tracks the creation of a marshalling method,
* including special handling of exceptions that may be generated by object
* accesses during the marshalling process.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class MarshalBuilder extends MarshalUnmarshalBuilder
{
//
// Constants for code generation.
private static final String MARSHALCONTEXT_CLASS =
"org.jibx.runtime.impl.MarshallingContext";
protected static final String MARSHAL_EXCEPTION_TEXT =
"Error while marshalling";
protected static final Type[] MARSHAL_METHOD_ARGS =
{
new ObjectType("org.jibx.runtime.impl.MarshallingContext")
};
/**
* Constructor. This sets up for constructing a marshalling method with
* public access and wrapped exception handling. If the method is being
* generated directly to the class being marshalled it's built as a virtual
* method; otherwise, it's done as a static method.
*
* @param name method name to be built
* @param cf owning class file information
* @param mf method generation class file information
* @throws JiBXException on error in initializing method construction
*/
public MarshalBuilder(String name, ClassFile cf, ClassFile mf)
throws JiBXException {
super(name, Type.VOID,
(mf == cf) ? MARSHAL_METHOD_ARGS :
new Type[] {ClassItem.typeFromName(cf.getName()),
MARSHAL_METHOD_ARGS[0]},
mf, (mf == cf) ? Constants.ACC_PUBLIC | Constants.ACC_FINAL :
Constants.ACC_PUBLIC | Constants.ACC_STATIC, 0, cf.getName(),
1, MARSHALCONTEXT_CLASS);
}
/**
* Add exception handler code. The implementation of this abstract base
* class method provides handling specific to a marshalling method.
*
* @return handle for first instruction in handler
* @throws JiBXException on error in creating exception handler
*/
public InstructionHandle genExceptionHandler() throws JiBXException {
// instruction sequence is create new exception object, duplicate two
// down (below caught exception), swap (so order is new, new, caught),
// load message, swap again, invoke constructor, and throw exception
initStackState(new String[] {"java.lang.Exception"});
InstructionHandle start =
internalAppendCreateNew(FRAMEWORK_EXCEPTION_CLASS);
appendDUP_X1();
appendSWAP();
appendLoadConstant(MARSHAL_EXCEPTION_TEXT);
appendSWAP();
appendCallInit(FRAMEWORK_EXCEPTION_CLASS,
EXCEPTION_CONSTRUCTOR_SIGNATURE2);
appendThrow();
return start;
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/classes/MarshalUnmarshalBuilder.java 0000644 0001750 0001750 00000010230 10071714174 030174 0 ustar moeller moeller /*
Copyright (c) 2003-2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.classes;
import org.apache.bcel.generic.InstructionHandle;
import org.apache.bcel.generic.ObjectType;
import org.apache.bcel.generic.Type;
import org.jibx.runtime.JiBXException;
/**
* Builder for marshal and unmarshal methods. Adds exception accumulation with
* actual handling provided by the subclass.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public abstract class MarshalUnmarshalBuilder extends ContextMethodBuilder
{
/**
* Constructor. This sets up for constructing the marshal or unmarshal
* method.
*
* @param name method name to be built
* @param ret method return type
* @param args types of arguments
* @param mf method generation class file information
* @param access flags for method access
* @param obj variable slot for current object
* @param type marshalled or unmarshalled class name
* @param ctx variable slot for marshalling/unmarshalling context
* @param ctype context type as defined in method
* @throws JiBXException on error in initializing method construction
*/
protected MarshalUnmarshalBuilder(String name, Type ret, Type[] args,
ClassFile mf, int access, int obj, String type, int ctx, String ctype)
throws JiBXException {
super(name, ret, args, mf, access, obj, type, ctx, ctype);
}
/**
* Add exception handler code. This method must be implemented by each
* subclass to provide the appropriate handling code.
*
* @return handle for first instruction in handler
* @throws JiBXException on error in creating exception handler
*/
public abstract InstructionHandle genExceptionHandler()
throws JiBXException;
/**
* Process accumulated exceptions. Sets up an exception handler framework
* and then calls the {@link #genExceptionHandler} method to build the
* handler body.
*
* @throws JiBXException on error in exception handling
*/
protected void handleExceptions() throws JiBXException {
int index = m_exceptions.indexOf(FRAMEWORK_EXCEPTION_CLASS);
if (index >= 0) {
m_generator.addException(FRAMEWORK_EXCEPTION_CLASS);
m_exceptions.remove(index);
}
if (m_exceptions.size() > 0) {
InstructionHandle begin = getFirstInstruction();
InstructionHandle end = getLastInstruction();
InstructionHandle handle = genExceptionHandler();
for (int i = 0; i < m_exceptions.size(); i++) {
m_generator.addExceptionHandler(begin, end, handle,
(ObjectType)ClassItem.
typeFromName((String)m_exceptions.get(i)));
}
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/classes/MethodBuilder.java 0000644 0001750 0001750 00000166003 11006326374 026164 0 ustar moeller moeller /*
Copyright (c) 2003-2008, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.classes;
import java.util.ArrayList;
import java.util.HashMap;
import org.apache.bcel.Constants;
import org.apache.bcel.classfile.Method;
import org.apache.bcel.classfile.Utility;
import org.apache.bcel.generic.ANEWARRAY;
import org.apache.bcel.generic.BranchHandle;
import org.apache.bcel.generic.CompoundInstruction;
import org.apache.bcel.generic.GOTO;
import org.apache.bcel.generic.IFEQ;
import org.apache.bcel.generic.IFGE;
import org.apache.bcel.generic.IFLT;
import org.apache.bcel.generic.IFNE;
import org.apache.bcel.generic.IFNONNULL;
import org.apache.bcel.generic.IFNULL;
import org.apache.bcel.generic.IF_ICMPNE;
import org.apache.bcel.generic.IINC;
import org.apache.bcel.generic.Instruction;
import org.apache.bcel.generic.InstructionConstants;
import org.apache.bcel.generic.InstructionFactory;
import org.apache.bcel.generic.InstructionHandle;
import org.apache.bcel.generic.InstructionList;
import org.apache.bcel.generic.LocalVariableGen;
import org.apache.bcel.generic.MULTIANEWARRAY;
import org.apache.bcel.generic.MethodGen;
import org.apache.bcel.generic.NEWARRAY;
import org.apache.bcel.generic.ReferenceType;
import org.apache.bcel.generic.Type;
import org.jibx.binding.util.StringStack;
import org.jibx.runtime.JiBXException;
/**
* Method builder. Organizes and tracks the creation of a method, providing
* convenience methods for common operations. This is customized for the needs
* of JiBX, with some predetermined settings as appropriate. It supplies hash
* code and equality checking based on the method signature and actual byte
* code of the generated method, ignoring the method name.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public abstract class MethodBuilder extends BindingMethod
{
//
// Constants for code generation.
public static final String FRAMEWORK_EXCEPTION_CLASS =
"org.jibx.runtime.JiBXException";
public static final String EXCEPTION_CONSTRUCTOR_SIGNATURE1 =
"(Ljava/lang/String;)V";
public static final String EXCEPTION_CONSTRUCTOR_SIGNATURE2 =
"(Ljava/lang/String;Ljava/lang/Throwable;)V";
public static final int SYNTHETIC_ACCESS_FLAG = 0x1000;
//
// Static data.
/** Table of argument name lists (generated as needed). */
protected static ArrayList s_argNameLists = new ArrayList();
/** Zero-length string array. */
protected static String[] EMPTY_STRING_ARRAY = new String[0];
//
// Actual instance data
/** Builder for class instructions. */
protected InstructionBuilder m_instructionBuilder;
/** List of instructions in method definition. */
private InstructionList m_instructionList;
/** List of types currently on stack. */
private StringStack m_stackState;
/** Generator for constructing method. */
protected MethodGen m_generator;
/** Actual generated method information. */
protected Method m_method;
/** Method class item information. */
protected ClassItem m_item;
/** Value types associated with local variable slots. */
private ArrayList m_localTypes;
/** Exceptions needing to be handled in method (lazy create,
null if not used). */
protected ArrayList m_exceptions;
/** Accumulated hash code from adding instructions. */
protected int m_hashCode;
/** Branch to be aimed at next appended instruction. */
protected BranchWrapper[] m_targetBranches;
/** Map for initialized properties (lazy create, null if not
used). */
protected HashMap m_valueMap;
/**
* Constructor. This sets up for constructing a method with public access.
*
* @param name method name to be built
* @param ret method return type
* @param args types of arguments
* @param cf owning class file information
* @param access flags for method access
* @throws JiBXException on error in constructing method
*/
protected MethodBuilder(String name, Type ret, Type[] args,
ClassFile cf, int access) throws JiBXException {
super(cf);
// make sure the dummy argument names are defined
if (args.length >= s_argNameLists.size()) {
// append to end of argument names list
for (int i = s_argNameLists.size(); i <= args.length; i++) {
String[] list = new String[i];
if (i > 0) {
Object last = s_argNameLists.get(i-1);
System.arraycopy(last, 0, list, 0, i-1);
list[i-1] = "arg" + i;
}
s_argNameLists.add(list);
}
}
// create the method generator with empty instruction list
String[] names = (String[])s_argNameLists.get(args.length);
m_instructionList = new InstructionList();
m_stackState = new StringStack();
m_instructionBuilder = cf.getInstructionBuilder();
m_generator = new MethodGen(access | SYNTHETIC_ACCESS_FLAG, ret, args,
names, name, cf.getName(), m_instructionList, cf.getConstPoolGen());
// initialize local variables for method parameters
m_localTypes = new ArrayList();
if ((access & Constants.ACC_STATIC) == 0) {
m_localTypes.add(cf.getName());
}
for (int i = 0; i < args.length; i++) {
m_localTypes.add(args[i].toString());
if (args[i].getSize() > 1) {
m_localTypes.add(null);
}
}
}
/**
* Get name of method being constructed.
*
* @return name of method being constructed
*/
public String getName() {
return m_generator.getName();
}
/**
* Get signature.
*
* @return signature for method
*/
public String getSignature() {
return m_generator.getSignature();
}
/**
* Get access flags.
*
* @return flags for access type of method
*/
public int getAccessFlags() {
return m_generator.getAccessFlags();
}
/**
* Set access flags.
*
* @param flags access type to be set
*/
public void setAccessFlags(int flags) {
m_generator.setAccessFlags(flags);
}
/**
* Get the actual method. This can only be called once code generation is
* completed (after the {@link #codeComplete(boolean)} method is called).
*
* @return constructed method information
*/
public Method getMethod() {
if (m_method == null) {
throw new IllegalStateException("Method still under construction");
} else {
return m_method;
}
}
/**
* Add keyed value to method definition.
*
* @param key retrieval key
* @param value keyed value
* @return prior value for key
*/
public Object setKeyValue(Object key, Object value) {
if (m_valueMap == null) {
m_valueMap = new HashMap();
}
return m_valueMap.put(key, value);
}
/**
* Get local variable for object.
*
* @param key object key for local variable
* @return local variable
*/
public Object getKeyValue(Object key) {
return m_valueMap == null ? null : m_valueMap.get(key);
}
/**
* Add exception to those needing handling.
*
* @param name fully qualified name of exception class
*/
public void addException(String name) {
if (m_exceptions == null) {
m_exceptions = new ArrayList();
}
if (!m_exceptions.contains(name)) {
m_exceptions.add(name);
}
}
/**
* Add exceptions thrown by called method to those needing handling.
*
* @param method information for method to be handled
*/
public void addMethodExceptions(ClassItem method) {
String[] excepts = method.getExceptions();
if (excepts != null) {
for (int i = 0; i < excepts.length; i++) {
addException(excepts[i]);
}
}
}
/**
* Get first instruction in method.
*
* @return handle for first instruction in method
*/
protected InstructionHandle getFirstInstruction() {
return m_instructionList.getStart();
}
/**
* Get last instruction in method.
*
* @return handle for last instruction in method
*/
protected InstructionHandle getLastInstruction() {
return m_instructionList.getEnd();
}
/**
* Target branches if pending. This implements setting the target of
* branch instructions supplied using the {@link #targetNext} method.
*
* @param inst handle for appended instruction
*/
protected final void setTarget(InstructionHandle inst) {
if (m_targetBranches != null) {
// TODO: fix this ugly kludge with code rewrite
// adjust stack with POPs if need to match size
String[] types = m_stackState.toArray();
if (m_targetBranches.length > 0) {
boolean match = true;
int depth = m_targetBranches[0].getStackState().length;
for (int i = 1; i < m_targetBranches.length; i++) {
if (depth != m_targetBranches[i].getStackState().length) {
match = false;
break;
}
}
if (match) {
if (depth > types.length) {
BranchWrapper merge = new BranchWrapper
(m_instructionList.insert(inst, new GOTO(null)),
types, this);
String[] stack = m_targetBranches[0].getStackState();
m_stackState = new StringStack(stack);
InstructionHandle poph = m_instructionList.
insert(inst, InstructionConstants.POP);
for (int i = 0; i < m_targetBranches.length; i++) {
m_targetBranches[i].setTarget(poph, stack, this);
}
m_stackState.pop();
while (m_stackState.size() > types.length) {
m_instructionList.insert(inst,
InstructionConstants.POP);
m_stackState.pop();
}
merge.setTarget(inst, m_stackState.toArray(), this);
m_targetBranches = null;
return;
} else {
while (depth < types.length) {
m_instructionList.insert(inst,
InstructionConstants.POP);
m_stackState.pop();
types = m_stackState.toArray();
}
}
}
}
// set all branch targets
for (int i = 0; i < m_targetBranches.length; i++) {
m_targetBranches[i].setTarget(inst, types, this);
}
m_targetBranches = null;
}
}
/**
* Generate description of current stack state.
*
* @return stack state description
*/
private String describeStack() {
StringBuffer buff = new StringBuffer();
String[] types = m_stackState.toArray();
for (int i = 0; i < types.length; i++) {
buff.append(" ");
buff.append(i);
buff.append(": ");
buff.append(types[i]);
buff.append('\n');
}
return buff.toString();
}
/**
* Verify that a pair of value types represent compatible types. This checks
* for equal types or downcast object types.
*
* @param type actual known type of value
* @param need type needed
*/
private void verifyCompatible(String type, String need) {
if (!need.equals(type)) {
try {
if ("".equals(type)) {
if (ClassItem.isPrimitive(need)) {
throw new IllegalStateException
("Internal error: Expected " + need +
" on stack , found null");
}
} else if ("java.lang.Object".equals(need)) {
if (ClassItem.isPrimitive(type)) {
throw new IllegalStateException("Internal error: " +
"Expected object reference on stack, found " +
type + "\n full stack:\n" + describeStack());
}
} else {
boolean match = false;
if ("int".equals(need)) {
match = "boolean".equals(type) ||
"short".equals(type) || "char".equals(type) ||
"byte".equals(type);
} else if ("int".equals(type)) {
match = "boolean".equals(need) ||
"short".equals(need) || "char".equals(need) ||
"byte".equals(need);
}
if (!match && !ClassItem.isAssignable(type, need)) {
throw new IllegalStateException
("Internal error: Expected " + need +
" on stack, found " + type + "\n full stack:\n" +
describeStack());
}
}
} catch (JiBXException e) {
throw new RuntimeException
("Internal error: Attempting to compare types " + need +
" and " + type);
}
}
}
/**
* Verify that at least the specified number of items are present on the
* stack.
*
* @param count minimum number of items required
*/
private void verifyStackDepth(int count) {
if (m_stackState.size() < count) {
throw new IllegalStateException
("Internal error: Too few values on stack\n full stack:\n" +
describeStack());
}
}
/**
* Verify the top value in the stack state resulting from the current
* instruction list.
*
* @param t1 expected type for top item on stack
*/
private void verifyStack(String t1) {
verifyStackDepth(1);
verifyCompatible(m_stackState.peek(), t1);
}
/**
* Verify the top value in the stack state resulting from the current
* instruction list is an array.
*
* @return array item type
*/
private String verifyArray() {
verifyStackDepth(1);
String type = m_stackState.peek();
if (type.endsWith("[]")) {
return type.substring(0, type.length()-2);
} else {
throw new IllegalStateException
("Internal error: Expected array type on stack , found " +
type);
}
}
/**
* Verify the top value in the stack state resulting from the current
* instruction list is an array of the specified type.
*
* @param type array item type
*/
private void verifyArray(String type) {
String atype = verifyArray();
if (!atype.equals(type)) {
throw new IllegalStateException
("Internal error: Expected array of " + type +
" on stack , found array of " + atype);
}
}
/**
* Verify the top two values in the stack state resulting from the current
* instruction list.
*
* @param t1 expected type for first item on stack
* @param t2 expected type for second item on stack
*/
private void verifyStack(String t1, String t2) {
verifyStackDepth(2);
verifyCompatible(m_stackState.peek(), t1);
verifyCompatible(m_stackState.peek(1), t2);
}
/**
* Verify the top values in the stack state resulting from the current
* instruction list. This form checks only the actual call parameters.
*
* @param types expected parameter types on stack
*/
private void verifyCallStack(String[] types) {
// make sure there are enough items on stack
int count = types.length;
verifyStackDepth(count);
// verify all parameter types for call
for (int i = 0; i < count; i++) {
int slot = count - i - 1;
verifyCompatible(m_stackState.peek(slot), types[i]);
}
}
/**
* Verify the top values in the stack state resulting from the current
* instruction list. This form checks both the object being called and the
* actual call parameters.
*
* @param clas name of method class
* @param types expected parameter types on stack
*/
private void verifyCallStack(String clas, String[] types) {
// start by verifying object reference
int count = types.length;
verifyStackDepth(count+1);
verifyCompatible(m_stackState.peek(count), clas);
// check values for call parameters
verifyCallStack(types);
}
/**
* Verify that the top value in the stack state resulting from the current
* instruction list is an object reference.
*/
private void verifyStackObject() {
verifyStackDepth(1);
String top = m_stackState.peek();
if (ClassItem.isPrimitive(top)) {
throw new IllegalStateException("Internal error: " +
"Expected object reference on stack , found " +
m_stackState.peek() + "\n full stack:\n" + describeStack());
}
}
/**
* Append IFEQ branch instruction to method.
*
* @param src object responsible for generating branch
* @return wrapper for appended conditional branch
*/
public BranchWrapper appendIFEQ(Object src) {
verifyStack("int");
BranchHandle hand = m_instructionList.append(new IFEQ(null));
setTarget(hand);
m_stackState.pop();
return new BranchWrapper(hand, m_stackState.toArray(), src);
}
/**
* Append IFGE branch instruction to method.
*
* @param src object responsible for generating branch
* @return wrapper for appended conditional branch
*/
public BranchWrapper appendIFGE(Object src) {
verifyStack("int");
BranchHandle hand = m_instructionList.append(new IFGE(null));
setTarget(hand);
m_stackState.pop();
return new BranchWrapper(hand, m_stackState.toArray(), src);
}
/**
* Append IFLT branch instruction to method.
*
* @param src object responsible for generating branch
* @return wrapper for appended conditional branch
*/
public BranchWrapper appendIFLT(Object src) {
verifyStack("int");
BranchHandle hand = m_instructionList.append(new IFLT(null));
setTarget(hand);
m_stackState.pop();
return new BranchWrapper(hand, m_stackState.toArray(), src);
}
/**
* Append IFNE branch instruction to method.
*
* @param src object responsible for generating branch
* @return wrapper for appended conditional branch
*/
public BranchWrapper appendIFNE(Object src) {
verifyStack("int");
BranchHandle hand = m_instructionList.append(new IFNE(null));
setTarget(hand);
m_stackState.pop();
return new BranchWrapper(hand, m_stackState.toArray(), src);
}
/**
* Append IFNONNULL branch instruction to method.
*
* @param src object responsible for generating branch
* @return wrapper for appended conditional branch
*/
public BranchWrapper appendIFNONNULL(Object src) {
verifyStackObject();
BranchHandle hand = m_instructionList.append(new IFNONNULL(null));
setTarget(hand);
m_stackState.pop();
return new BranchWrapper(hand, m_stackState.toArray(), src);
}
/**
* Append IFNULL branch instruction to method.
*
* @param src object responsible for generating branch
* @return wrapper for appended conditional branch
*/
public BranchWrapper appendIFNULL(Object src) {
verifyStackObject();
BranchHandle hand = m_instructionList.append(new IFNULL(null));
setTarget(hand);
m_stackState.pop();
return new BranchWrapper(hand, m_stackState.toArray(), src);
}
/**
* Append IF_ICMPNE branch instruction to method.
*
* @param src object responsible for generating branch
* @return wrapper for appended conditional branch
*/
public BranchWrapper appendIF_ICMPNE(Object src) {
verifyStack("int", "int");
BranchHandle hand = m_instructionList.append(new IF_ICMPNE(null));
setTarget(hand);
m_stackState.pop(2);
return new BranchWrapper(hand, m_stackState.toArray(), src);
}
/**
* Append unconditional branch instruction to method.
*
* @param src object responsible for generating branch
* @return wrapper for appended unconditional branch
*/
public BranchWrapper appendUnconditionalBranch(Object src) {
BranchHandle hand = m_instructionList.append(new GOTO(null));
setTarget(hand);
BranchWrapper wrapper =
new BranchWrapper(hand, m_stackState.toArray(), src);
m_stackState = null;
return wrapper;
}
/**
* Append compound instruction to method.
*
* @param ins instruction to be appended
*/
private void append(CompoundInstruction ins) {
setTarget(m_instructionList.append(ins));
}
/**
* Append instruction to method.
*
* @param ins instruction to be appended
*/
private void append(Instruction ins) {
setTarget(m_instructionList.append(ins));
}
/**
* Create load constant instruction and append to method. Builds the most
* appropriate type of instruction for the value.
*
* @param value constant value to be loaded
*/
public void appendLoadConstant(int value) {
append(m_instructionBuilder.createLoadConstant(value));
m_stackState.push("int");
}
/**
* Create load constant instruction and append to method. Loads a
* String reference from the constant pool.
*
* @param value constant value to be loaded
*/
public void appendLoadConstant(String value) {
append(m_instructionBuilder.createLoadConstant(value));
m_stackState.push("java.lang.String");
}
/**
* Create load constant instruction and append to method. Loads an
* unwrapped primitive value from the constant pool.
*
* @param value constant value to be loaded
*/
public void appendLoadConstant(Object value) {
append(m_instructionBuilder.createLoadConstant(value));
if (value instanceof Integer || value instanceof Character ||
value instanceof Short || value instanceof Boolean ||
value instanceof Byte) {
m_stackState.push("int");
} else if (value instanceof Long) {
m_stackState.push("long");
} else if (value instanceof Float) {
m_stackState.push("float");
} else if (value instanceof Double) {
m_stackState.push("double");
} else {
throw new IllegalArgumentException("Unknown argument type");
}
}
/**
* Create getfield instruction and append to method. Uses the target field
* information to generate the instruction.
*
* @param item information for field to be gotton
*/
public void appendGetField(ClassItem item) {
verifyStack(item.getClassFile().getName());
append(m_instructionBuilder.createGetField(item));
m_stackState.pop();
m_stackState.push(item.getTypeName());
}
/**
* Create getstatic instruction and append to method. Uses the target field
* information to generate the instruction.
*
* @param item information for field to be set
*/
public void appendGetStatic(ClassItem item) {
append(m_instructionBuilder.createGetStatic(item));
m_stackState.push(item.getTypeName());
}
/**
* Create get instruction and append to method. This generates either a
* getstatic or a getfield instruction, as appropriate.
*
* @param item information for field to be gotten
*/
public void appendGet(ClassItem item) {
if (item.isStatic()) {
appendGetStatic(item);
} else {
appendGetField(item);
}
}
/**
* Create putfield instruction and append to method. Uses the target field
* information to generate the instruction.
*
* @param item information for field to be set
*/
public void appendPutField(ClassItem item) {
String tname = item.getTypeName();
verifyStack(tname, item.getClassFile().getName());
append(m_instructionBuilder.createPutField(item));
m_stackState.pop(2);
}
/**
* Create putstatic instruction and append to method. Uses the target field
* information to generate the instruction.
*
* @param item information for field to be set
*/
public void appendPutStatic(ClassItem item) {
verifyStack(item.getTypeName());
append(m_instructionBuilder.createPutStatic(item));
m_stackState.pop();
}
/**
* Create put instruction and append to method. This generates either a
* putstatic or a putfield instruction, as appropriate.
*
* @param item information for field to be gotten
*/
public void appendPut(ClassItem item) {
if (item.isStatic()) {
appendPutStatic(item);
} else {
appendPutField(item);
}
}
/**
* Create invoke instruction for static, member, or interface method and
* append to method. Uses the target method information to generate the
* correct instruction.
*
* @param item information for method to be called
*/
public void appendCall(ClassItem item) {
// process based on call type
String[] types = item.getArgumentTypes();
int count = types.length;
if (item.getClassFile().isInterface()) {
// process parameters and object reference for interface call
verifyCallStack(item.getClassFile().getName(), types);
append(m_instructionBuilder.createCallInterface(item));
m_stackState.pop(count+1);
} else if ((item.getAccessFlags() & Constants.ACC_STATIC) != 0) {
// process only parameters for static call
verifyCallStack(types);
append(m_instructionBuilder.createCallStatic(item));
if (count > 0) {
m_stackState.pop(count);
}
} else {
// process parameters and object reference for normal method call
verifyCallStack(item.getClassFile().getName(), types);
append(m_instructionBuilder.createCallVirtual(item));
m_stackState.pop(count+1);
}
// adjust stack state to reflect result of call
if (!"void".equals(item.getTypeName())) {
m_stackState.push(item.getTypeName());
}
}
/**
* Create invoke static method instruction from signature and append to
* method.
*
* @param method fully qualified class and method name
* @param signature method signature in standard form
*/
public void appendCallStatic(String method, String signature) {
// verify all call parameters on stack
String[] types = ClassItem.getParametersFromSignature(signature);
verifyCallStack(types);
// generate the actual method call
append(m_instructionBuilder.createCallStatic(method, signature));
// change stack state to reflect result of call
if (types.length > 0) {
m_stackState.pop(types.length);
}
String result = ClassItem.getTypeFromSignature(signature);
if (!"void".equals(result)) {
m_stackState.push(result);
}
}
/**
* Create invoke virtual method instruction from signature and append to
* method.
*
* @param method fully qualified class and method name
* @param signature method signature in standard form
*/
public void appendCallVirtual(String method, String signature) {
// verify all call parameters and object reference on stack
String[] types = ClassItem.getParametersFromSignature(signature);
int split = method.lastIndexOf('.');
if (split < 0) {
throw new IllegalArgumentException
("Internal error: Missing class name on method " + method);
}
verifyCallStack(method.substring(0, split), types);
// generate the actual method call
append(m_instructionBuilder.createCallVirtual(method, signature));
// change stack state to reflect result of call
m_stackState.pop(types.length+1);
String result = ClassItem.getTypeFromSignature(signature);
if (!"void".equals(result)) {
m_stackState.push(result);
}
}
/**
* Create invoke interface method instruction from signature and append to
* method.
*
* @param method fully qualified interface and method name
* @param signature method signature in standard form
*/
public void appendCallInterface(String method, String signature) {
// verify all call parameters and object reference on stack
String[] types = ClassItem.getParametersFromSignature(signature);
int split = method.lastIndexOf('.');
if (split < 0) {
throw new IllegalArgumentException
("Internal error: Missing class name on method " + method);
}
verifyCallStack(method.substring(0, split), types);
// generate the actual method call
append(m_instructionBuilder.createCallInterface(method, signature));
// change stack state to reflect result of call
m_stackState.pop(types.length+1);
String result = ClassItem.getTypeFromSignature(signature);
if (!"void".equals(result)) {
m_stackState.push(result);
}
}
/**
* Append instruction to create instance of class.
*
* @param name fully qualified class name
*/
public void appendCreateNew(String name) {
append(m_instructionBuilder.createNew(name));
m_stackState.push(name);
}
/**
* Create invoke initializer instruction from signature and append to
* method.
*
* @param name fully qualified class name
* @param signature method signature in standard form
*/
public void appendCallInit(String name, String signature) {
// verify all call parameters and object reference on stack
String[] types = ClassItem.getParametersFromSignature(signature);
verifyCallStack(name, types);
// generate the actual method call
append(m_instructionBuilder.createCallInit(name, signature));
// change stack state to reflect result of call
m_stackState.pop(types.length+1);
}
/**
* Append instruction to create instance of array.
*
* @param type fully qualified type name of array elements
*/
public void appendCreateArray(String type) {
if (ClassItem.isPrimitive(type)) {
String sig = Utility.getSignature(type);
append(new NEWARRAY(Utility.typeOfSignature(sig)));
} else if (type.endsWith("[]")) {
String cname = Utility.getSignature(type + "[]");
append(new MULTIANEWARRAY(m_instructionBuilder.
getConstantPoolGen().addClass(cname), (short)1));
} else {
append(new ANEWARRAY(m_instructionBuilder.
getConstantPoolGen().addClass(type)));
}
m_stackState.pop();
m_stackState.push(type + "[]");
}
/**
* Append check cast instruction (if needed).
*
* @param from fully qualified name of current type
* @param to fully qualified name of desired type
*/
public void appendCreateCast(String from, String to) {
// verify current top of stack
verifyStack(from);
// check if any change of type
if (!from.equals(to)) {
// generate instruction and change stack state to match
append(m_instructionBuilder.
createCast(ClassItem.typeFromName(from),
ClassItem.typeFromName(to)));
m_stackState.pop();
m_stackState.push(to);
}
}
/**
* Append check cast instruction from object (if needed).
*
* @param to fully qualified name of desired type
*/
public void appendCreateCast(String to) {
// verify current top of stack
verifyStackObject();
// check if any change of type
if (!m_stackState.peek().equals(to)) {
// generate instruction and change stack state to match
append(m_instructionBuilder.
createCast(Type.OBJECT, ClassItem.typeFromName(to)));
m_stackState.pop();
m_stackState.push(to);
}
}
/**
* Append instanceof check instruction.
*
* @param to fully qualified name of type to check
*/
public void appendInstanceOf(String to) {
// make sure the stack has an object reference
verifyStackObject();
// see if anything actually needs to be checked
if ("java.lang.Object".equals(to)) {
append(InstructionConstants.POP);
appendLoadConstant(1);
} else {
append(m_instructionBuilder.
createInstanceOf((ReferenceType)ClassItem.typeFromName(to)));
}
// change stack state to reflect results of added code
m_stackState.pop();
m_stackState.push("int");
}
/**
* Add local variable to method. The current code in the method must have
* the initial value for the variable on the stack. The scope of the
* variable is defined from the last instruction to the end of the
* method unless otherwise modified.
*
* @param name local variable name (may be null to use default)
* @param type variable type
*/
protected LocalVariableGen createLocal(String name, Type type) {
// verify top of stack
verifyStack(type.toString());
// create name if needed
if (name == null) {
name = "var" + m_generator.getLocalVariables().length;
}
// allocation local and store value
LocalVariableGen var = m_generator.addLocalVariable
(name, type, getLastInstruction(), null);
append(InstructionFactory.createStore(type, var.getIndex()));
// save type information for local variable slot
int slot = var.getIndex();
while (slot >= m_localTypes.size()) {
m_localTypes.add(null);
}
m_localTypes.set(slot, type.toString());
// change stack state to reflect result
m_stackState.pop();
return var;
}
/**
* Add local variable to method. The current code in the method must have
* the initial value for the variable on the stack. The scope of the
* variable is defined from the preceding instruction to the end of the
* method.
*
* @param name local variable name
* @param type variable type
* @return local variable slot number
*/
public int addLocal(String name, Type type) {
LocalVariableGen var = createLocal(name, type);
return var.getIndex();
}
/**
* Append instruction to load local variable.
*
* @param slot local variable slot to load
*/
public void appendLoadLocal(int slot) {
String type = (String)m_localTypes.get(slot);
if (type == null) {
throw new IllegalArgumentException
("Internal error: No variable defined at position " + slot);
}
append(InstructionFactory.
createLoad(ClassItem.typeFromName(type), slot));
m_stackState.push(type);
}
/**
* Append instruction to store local variable.
*
* @param slot local variable slot to store
*/
public void appendStoreLocal(int slot) {
String type = (String)m_localTypes.get(slot);
if (type == null) {
throw new IllegalArgumentException
("Internal error: No variable defined at position " + slot);
}
verifyStack(type);
append(InstructionFactory.
createStore(ClassItem.typeFromName(type), slot));
m_stackState.pop();
}
/**
* Append instruction to increment local integer variable.
*
* @param inc amount of incrment
* @param slot local variable slot to load
*/
public void appendIncrementLocal(int inc, int slot) {
String type = (String)m_localTypes.get(slot);
if (type == null) {
throw new IllegalArgumentException
("Internal error: No variable defined at position " + slot);
} else if (!"int".equals(type)) {
throw new IllegalArgumentException("Internal error: Variable at " +
slot + " is " + type + ", not int");
}
append(new IINC(slot, inc));
}
/**
* Append simple return.
*/
public void appendReturn() {
append(InstructionConstants.RETURN);
m_stackState = null;
}
/**
* Append typed return.
*
* @param type returned type (may be Type.VOID)
*/
public void appendReturn(Type type) {
// verify and return the object reference
if (type != Type.VOID) {
verifyStack(type.toString());
}
append(InstructionFactory.createReturn(type));
// set open stack state for potential continuation code
m_stackState = null;
}
/**
* Append typed return.
*
* @param type returned type (may be void)
*/
public void appendReturn(String type) {
// verify stack and generate return
if ("void".equals(type)) {
append(InstructionConstants.RETURN);
} else {
verifyStack(type);
if (ClassItem.isPrimitive(type)) {
if ("int".equals(type) || "char".equals(type) ||
"short".equals(type) || "boolean".equals(type)) {
append(InstructionConstants.IRETURN);
} else if ("long".equals(type)) {
append(InstructionConstants.LRETURN);
} else if ("float".equals(type)) {
append(InstructionConstants.FRETURN);
} else if ("double".equals(type)) {
append(InstructionConstants.DRETURN);
} else {
throw new IllegalArgumentException("Unknown argument type");
}
} else {
append(InstructionConstants.ARETURN);
}
}
// set open stack state for potential continuation code
m_stackState = null;
}
/**
* Append exception throw.
*/
public void appendThrow() {
append(InstructionConstants.ATHROW);
m_stackState = null;
}
/**
* Append appropriate array load to the instruction list.
*
* @param type array item type expected
*/
public void appendALOAD(String type) {
verifyStack("int");
m_stackState.pop();
verifyArray(type);
if ("byte".equals(type) || "boolean".equals(type)) {
append(InstructionConstants.BALOAD);
} else if ("char".equals(type)) {
append(InstructionConstants.CALOAD);
} else if ("double".equals(type)) {
append(InstructionConstants.DALOAD);
} else if ("float".equals(type)) {
append(InstructionConstants.FALOAD);
} else if ("int".equals(type)) {
append(InstructionConstants.IALOAD);
} else if ("long".equals(type)) {
append(InstructionConstants.LALOAD);
} else if ("short".equals(type)) {
append(InstructionConstants.SALOAD);
} else {
append(InstructionConstants.AALOAD);
}
m_stackState.pop();
m_stackState.push(type);
}
/**
* Append an AASTORE to the instruction list. Doesn't actually check the
* types, just the count of items present.
*/
public void appendAASTORE() {
verifyStackDepth(3);
String vtype = m_stackState.pop();
verifyStack("int");
m_stackState.pop();
String atype = verifyArray();
verifyCompatible(vtype, atype);
m_stackState.pop();
append(InstructionConstants.AASTORE);
}
/**
* Append the appropriate array store to the instruction list.
*
* @param type array item type expected
*/
public void appendASTORE(String type) {
verifyStackDepth(3);
String vtype = m_stackState.pop();
verifyStack("int");
m_stackState.pop();
String atype = verifyArray();
verifyCompatible(vtype, atype);
m_stackState.pop();
if ("byte".equals(type) || "boolean".equals(type)) {
append(InstructionConstants.BASTORE);
} else if ("char".equals(type)) {
append(InstructionConstants.CASTORE);
} else if ("double".equals(type)) {
append(InstructionConstants.DASTORE);
} else if ("float".equals(type)) {
append(InstructionConstants.FASTORE);
} else if ("int".equals(type)) {
append(InstructionConstants.IASTORE);
} else if ("long".equals(type)) {
append(InstructionConstants.LASTORE);
} else if ("short".equals(type)) {
append(InstructionConstants.SASTORE);
} else {
append(InstructionConstants.AASTORE);
}
}
/**
* Append an ACONST_NULL to the instruction list.
*/
public void appendACONST_NULL() {
append(InstructionConstants.ACONST_NULL);
m_stackState.push("");
}
/**
* Append an ARRAYLENGTH to the instruction list.
*/
public void appendARRAYLENGTH() {
verifyArray();
append(InstructionConstants.ARRAYLENGTH);
m_stackState.pop();
m_stackState.push("int");
}
/**
* Append an DCMPG to the instruction list.
*/
public void appendDCMPG() {
verifyStack("double", "double");
append(InstructionConstants.DCMPG);
m_stackState.pop(2);
m_stackState.push("int");
}
/**
* Append a DUP to the instruction list.
*/
public void appendDUP() {
verifyStackDepth(1);
String type = m_stackState.peek();
if ("long".equals(type) || "double".equals(type)) {
throw new IllegalStateException
("Internal error: DUP splits long value");
}
append(InstructionConstants.DUP);
m_stackState.push(m_stackState.peek());
}
/**
* Append a DUP2 to the instruction list.
*/
public void appendDUP2() {
verifyStackDepth(1);
append(InstructionConstants.DUP2);
m_stackState.push(m_stackState.peek());
}
/**
* Append a DUP_X1 to the instruction list.
*/
public void appendDUP_X1() {
verifyStackDepth(2);
String type = m_stackState.peek();
if ("long".equals(type) || "double".equals(type)) {
throw new IllegalStateException
("Internal error: DUP_X1 splits long value");
}
append(InstructionConstants.DUP_X1);
String hold0 = m_stackState.pop();
String hold1 = m_stackState.pop();
m_stackState.push(hold0);
m_stackState.push(hold1);
m_stackState.push(hold0);
}
/**
* Append an FCMPG to the instruction list.
*/
public void appendFCMPG() {
verifyStack("float", "float");
append(InstructionConstants.FCMPG);
m_stackState.pop(2);
m_stackState.push("int");
}
/**
* Append an IASTORE to the instruction list. Doesn't actually check the
* types, just the count of items present.
*/
public void appendIASTORE() {
verifyStackDepth(3);
append(InstructionConstants.IASTORE);
m_stackState.pop(3);
}
/**
* Append an ICONST_0 to the instruction list.
*/
public void appendICONST_0() {
append(InstructionConstants.ICONST_0);
m_stackState.push("int");
}
/**
* Append an ICONST_1 to the instruction list.
*/
public void appendICONST_1() {
append(InstructionConstants.ICONST_1);
m_stackState.push("int");
}
/**
* Append an ISUB to the instruction list.
*/
public void appendISUB() {
verifyStack("int", "int");
append(InstructionConstants.ISUB);
m_stackState.pop(1);
}
/**
* Append an IXOR to the instruction list.
*/
public void appendIXOR() {
verifyStack("int", "int");
append(InstructionConstants.IXOR);
m_stackState.pop(1);
}
/**
* Append an LCMP to the instruction list.
*/
public void appendLCMP() {
verifyStack("long", "long");
append(InstructionConstants.LCMP);
m_stackState.pop(2);
m_stackState.push("int");
}
/**
* Append a POP to the instruction list.
*/
public void appendPOP() {
verifyStackDepth(1);
String type = m_stackState.peek();
if ("long".equals(type) || "double".equals(type)) {
throw new IllegalStateException
("Internal error: POP splits long value");
}
append(InstructionConstants.POP);
m_stackState.pop();
}
/**
* Append a POP2 to the instruction list.
*/
public void appendPOP2() {
verifyStackDepth(1);
String type = m_stackState.peek();
if (!"long".equals(type) && !"double".equals(type)) {
throw new IllegalStateException
("Internal error: POP2 requires long value");
}
append(InstructionConstants.POP2);
m_stackState.pop();
}
/**
* Append a SWAP to the instruction list.
*/
public void appendSWAP() {
verifyStackDepth(2);
append(InstructionConstants.SWAP);
String hold0 = m_stackState.pop();
String hold1 = m_stackState.pop();
m_stackState.push(hold0);
m_stackState.push(hold1);
}
/**
* Append instructions to exchange a single-word value on the top of the
* stack with the double-word value below it on the stack.
*/
public void appendSWAP1For2() {
verifyStackDepth(2);
append(InstructionConstants.DUP_X2);
append(InstructionConstants.POP);
String hold0 = m_stackState.pop();
String hold1 = m_stackState.pop();
m_stackState.push(hold0);
m_stackState.push(hold1);
}
/**
* Append a compound instruction to the list as a branch target.
*
* @param inst compound instruction to be appended as branch target
* @return branch target information
*/
private BranchTarget appendTargetInstruction(CompoundInstruction inst) {
String[] types = m_stackState.toArray();
InstructionHandle hand = m_instructionList.append(inst);
return new BranchTarget(hand, types);
}
/**
* Append an instruction to the list as a branch target.
*
* @param inst instruction to be appended as branch target
* @return branch target information
*/
private BranchTarget appendTargetInstruction(Instruction inst) {
String[] types = m_stackState.toArray();
InstructionHandle hand = m_instructionList.append(inst);
return new BranchTarget(hand, types);
}
/**
* Append a NOP to the instruction list as a branch target.
*
* @return branch target information
*/
public BranchTarget appendTargetNOP() {
return appendTargetInstruction(InstructionConstants.NOP);
}
/**
* Append an ACONST_NULL to the instruction list as a branch target.
*
* @return branch target information
*/
public BranchTarget appendTargetACONST_NULL() {
BranchTarget target = appendTargetInstruction
(InstructionConstants.ACONST_NULL);
m_stackState.push("");
return target;
}
/**
* Append a load constant instruction as a branch target. Builds the most
* appropriate type of instruction for the value.
*
* @param value constant value to be loaded
* @return branch target information
*/
public BranchTarget appendTargetLoadConstant(int value) {
BranchTarget target = appendTargetInstruction(m_instructionBuilder.
createLoadConstant(value));
m_stackState.push("int");
return target;
}
/**
* Append a load constant instruction as a branch target. Loads a
* String reference from the constant pool.
*
* @param value constant value to be loaded
* @return branch target information
*/
public BranchTarget appendTargetLoadConstant(String value) {
BranchTarget target = appendTargetInstruction(m_instructionBuilder.
createLoadConstant(value));
m_stackState.push("java.lang.String");
return target;
}
/**
* Append instruction to create instance of class as a branch target.
*
* @param name fully qualified class name
* @return branch target information
*/
public BranchTarget appendTargetCreateNew(String name) {
BranchTarget target =
appendTargetInstruction(m_instructionBuilder.createNew(name));
m_stackState.push(name);
return target;
}
/**
* Internal append instruction to create instance of class. This is used by
* subclasses when they need access to the actual instruction handle.
*
* @param name fully qualified class name
*/
protected InstructionHandle internalAppendCreateNew(String name) {
InstructionHandle handle = m_instructionList.append
(m_instructionBuilder.createNew(name));
m_stackState.push(name);
return handle;
}
/**
* Check if top item on stack is a long value.
*
* @return true if long value, false if not
*/
public boolean isStackTopLong() {
verifyStackDepth(1);
String type = m_stackState.peek();
return "long".equals(type) || "double".equals(type);
}
/**
* Initialize stack state to match branch source. This can be used to set
* the expected stack state following an unconditional transfer of control
* instruction. The principle here is that the code to be generated must be
* reached by a branch, so the stack state must match that of the branch
* source.
*
* @param branch wrapper for branch to be for stack initialization
*/
public void initStackState(BranchWrapper branch) {
m_stackState = new StringStack(branch.getStackState());
}
/**
* Initialize stack state to partially match branch source. This can be used
* to set the expected stack state following an unconditional transfer of
* control instruction. The specified number of items are removed from the
* branch stack, with the assumption that code to add these items will be
* appended before the branch join point is reached.
*
* @param branch wrapper for branch to be for stack initialization
* @param pop number of items to be removed from branch source stack state
*/
public void initStackState(BranchWrapper branch, int pop) {
m_stackState = new StringStack(branch.getStackState());
if (pop > 0) {
m_stackState.pop(pop);
}
}
/**
* Initialize stack state to array of value types. This can be used to set
* the expected stack state following an unconditional transfer of control
* instruction.
*
* @param types array of type names on stack
*/
protected void initStackState(String[] types) {
m_stackState = new StringStack(types);
}
/**
* Set branch target as next instruction added to method. This effectively
* sets up a state trigger for the next append operation. The appended
* instruction is set as the target for the branch. This requires that
* instructions are only appended using the methods supplied in this class.
*
* @param branch wrapper for branch to be aimed at next instruction (may be
* null, in which case nothing is done)
*/
public void targetNext(BranchWrapper branch) {
if (branch != null) {
if (m_targetBranches == null) {
m_targetBranches = new BranchWrapper[] { branch };
if (m_stackState == null) {
m_stackState = new StringStack(branch.getStackState());
}
} else {
int length = m_targetBranches.length;
BranchWrapper[] wrappers = new BranchWrapper[length+1];
System.arraycopy(m_targetBranches, 0, wrappers, 0, length);
wrappers[length] = branch;
m_targetBranches = wrappers;
}
}
}
/**
* Set branch targets as next instruction added to method. This effectively
* sets up a state trigger for the next append operation. The appended
* instruction is set as the target for all the branches. This requires that
* instructions are only appended using the methods supplied in this class.
*
* @param branches wrappers for branches to be aimed at next instruction
* (may be null, in which case nothing is done)
*/
public void targetNext(BranchWrapper[] branches) {
if (branches != null && branches.length > 0) {
if (m_targetBranches == null) {
m_targetBranches = branches;
if (m_stackState == null) {
m_stackState = new StringStack(branches[0].getStackState());
}
} else {
int offset = m_targetBranches.length;
int length = offset + branches.length;
BranchWrapper[] wrappers = new BranchWrapper[length];
System.arraycopy(m_targetBranches, 0, wrappers, 0, offset);
System.arraycopy(branches, 0, wrappers, offset,
branches.length);
m_targetBranches = wrappers;
}
}
}
/**
* Process accumulated exceptions. Each subclass must implement this
* method to perform the appropriate handling of the checked exceptions
* that may be thrown in the constructed method.
*
* @throws JiBXException on error in exception handling
*/
protected abstract void handleExceptions() throws JiBXException;
/**
* Complete method construction. Finalizes the instruction list and
* generates the byte code for the constructed method, then computes the
* hash code based on the byte code. If requested, an appropriate suffix is
* tacked on the end of the supplied name in order to make sure that it will
* not be duplicated (even in a superclass or subclass).
*
* @param suffix add suffix to make method name unique
* @throws JiBXException on error in finishing method construction
*/
public void codeComplete(boolean suffix) throws JiBXException {
if (m_targetBranches != null) {
throw new IllegalStateException
("Method complete with pending branch target");
}
if (m_exceptions != null) {
handleExceptions();
}
if (suffix) {
m_generator.setName(getClassFile().
makeUniqueMethodName(m_generator.getName()));
}
m_generator.setMaxStack();
m_generator.setMaxLocals();
m_instructionList.setPositions(true);
m_method = m_generator.getMethod();
m_instructionList.dispose();
m_hashCode = computeMethodHash(m_method);
}
/**
* Get the method item.
*
* @return method item information
*/
public ClassItem getItem() {
if (m_item == null) {
throw new IllegalStateException("Method not added to class");
} else {
return m_item;
}
}
/**
* Get hash code. This is based only on the byte code in the method, and
* is only valid after the {@link #codeComplete} method is called.
*
* @return hash code based on code sequence
*/
public int hashCode() {
if (m_method == null) {
throw new IllegalStateException("Method still under construction");
} else {
return m_hashCode;
}
}
/**
* Add constructed method to class. Makes the method callable, generating
* the method information.
*
* @return added method information
* @throws JiBXException on error in finishing method construction
*/
public ClassItem addMethod() throws JiBXException {
if (m_method == null) {
throw new IllegalStateException("Method not finalized.");
} else {
m_item = getClassFile().addMethod(m_method);
return m_item;
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/classes/MungedClass.java 0000644 0001750 0001750 00000036456 10677535436 025670 0 ustar moeller moeller /*
Copyright (c) 2003-2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.classes;
import java.io.File;
import java.io.FileFilter;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import org.apache.bcel.Constants;
import org.jibx.binding.def.BindingDefinition;
import org.jibx.runtime.BindingDirectory;
import org.jibx.runtime.JiBXException;
/**
* Modifiable class handler. Each instance controls changes to a particular
* class modified by one or more binding definitions. As methods are generated
* they're checked for uniqueness. If an already-generated method is found with
* the same characteristics (including byte code) as the one being generated,
* the already-generated is used instead.
*
* @author Dennis M. Sosnoski
*/
public class MungedClass
{
//
// Constants and such related to code generation.
/** Empty class file array. */
private static final ClassFile[] EMPTY_CLASSFILE_ARRAY = {};
/** Name and signature for generated methods without standard prefix. */
private static final String[] EXTRA_METHODS_MATCHES =
{
"marshal", "(Lorg/jibx/runtime/IMarshallingContext;)V",
"unmarshal", "(Lorg/jibx/runtime/IUnmarshallingContext;)V"
};
//
// Static data.
/** Munged class information. */
private static ArrayList s_classes;
/** Set of class names in list (used to assure uniqueness). */
private static HashSet s_classNameSet;
/** Map from generated class to binding information. */
private static HashMap s_classMap;
/** Map of directories already checked for JiBX classes. */
private static HashMap s_directories;
/** Map from class name to binding information. */
private static HashMap s_nameMap;
/** Munged classes to be unique-added at end of binding. */
private static ArrayList s_pendingClasses;
//
// Actual instance data.
/** Munged class file information. */
private ClassFile m_classFile;
/** Map from method byte code and signature to method item. */
private HashMap m_methodMap;
/** Existing binding methods in class. */
private ExistingMethod[] m_existingMethods;
/** List of factory names for this class. */
private String m_factoryList;
/**
* Constructor. This sets up for modifying a class with added methods.
*
* @param cf owning class file information
*/
private MungedClass(ClassFile cf) {
// initialize basic class information
m_classFile = cf;
m_methodMap = new HashMap();
// get information for existing binding methods in this class
ExistingMethod[] exists = cf.getBindingMethods
(BindingDefinition.GENERATE_PREFIX, EXTRA_METHODS_MATCHES);
if (exists != null) {
for (int i = 0; i < exists.length; i++) {
m_methodMap.put(exists[i], exists[i]);
}
}
m_existingMethods = exists;
}
/**
* Get munged class file information.
*
* @return class file information for bound class
*/
/*package*/ ClassFile getClassFile() {
return m_classFile;
}
/**
* Delete pre-existing binding methods that are no longer needed.
*
* @throws JiBXException on configuration error
*/
private void purgeUnusedMethods() throws JiBXException {
if (m_existingMethods != null) {
for (int i = 0; i < m_existingMethods.length; i++) {
ExistingMethod method = m_existingMethods[i];
if (!method.isUsed()) {
method.delete();
}
}
}
}
/**
* Get unique method. If a method matching the byte code of the supplied
* method has already been defined the existing method is returned.
* Otherwise the method is added to the definitions. If necessary, a number
* suffix is appended to the method name to prevent conflicts with existing
* names.
*
* @param builder method to be defined
* @param suffix append name suffix to assure uniqueness flag
* @return defined method item
* @throws JiBXException on configuration error
*/
/*package*/ BindingMethod getUniqueMethod(MethodBuilder builder,
boolean suffix) throws JiBXException {
// try to find already added method with same characteristics
if (builder.getClassFile() != m_classFile) {
throw new IllegalStateException
("Internal error: wrong class for call");
}
builder.codeComplete(suffix);
BindingMethod method = (BindingMethod)m_methodMap.get(builder);
if (method == null) {
// System.out.println("No match found for method " +
// builder.getClassFile().getName()+ '.' + builder.getName() +
// "; adding method");
// create as new method
builder.addMethod();
m_methodMap.put(builder, builder);
return builder;
} else if (method instanceof ExistingMethod) {
((ExistingMethod)method).setUsed();
}
// System.out.println("Found " + method.getClassFile().getName()+
// '.' + method.getName() + " as match for " + builder.getName());
return method;
}
/**
* Get unique generated support class. Allows tracking of all generated
* classes for common handling with the bound classes. Each generated
* support class is associated with a particular bound class.
*
* @param cf generated class file
* @return unique class file information
*/
public static ClassFile getUniqueSupportClass(ClassFile cf) {
cf.codeComplete();
Object value = s_classMap.get(cf);
if (value == null) {
if (!s_classNameSet.contains(cf.getName())) {
s_classes.add(cf);
s_classNameSet.add(cf.getName());
}
s_classMap.put(cf, cf);
return cf;
} else {
ClassFile prior = (ClassFile)value;
prior.incrementUseCount();
return prior;
}
}
/**
* Check directory for JiBX generated files. Scans through all class files
* in the target directory and loads any that start with the JiBX
* identifier string.
*
* @param root class path root for directory
* @param pack package relative to root directory
* @throws JiBXException on configuration error
*/
/*package*/ static void checkDirectory(File root, String pack)
throws JiBXException {
try {
File directory = new File
(root, pack.replace('.', File.separatorChar));
String cpath = directory.getCanonicalPath();
if (s_directories.get(cpath) == null) {
File[] matches = new File(cpath).listFiles(new JiBXFilter());
for (int i = 0; i < matches.length; i++) {
File file = matches[i];
String name = file.getName();
int split = name.indexOf('.');
if (split >= 0) {
name = name.substring(0, split);
}
if (pack.length() > 0) {
name = pack + '.' + name;
}
ClassFile cf = ClassCache.getClassFile(name);
s_classes.add(cf);
s_classMap.put(cf, cf);
}
s_directories.put(cpath, cpath);
}
} catch (IOException ex) {
throw new JiBXException("Error loading class file", ex);
}
}
/**
* Add binding factory to class. The binding factories are accumulated as
* a delimited string during generation, then dumped to a static field in
* the class at the end.
*
* @param fact binding factory name
*/
/*package*/ void addFactory(String fact) {
String match = "|" + fact + "|";
if (m_factoryList == null) {
m_factoryList = match;
} else if (m_factoryList.indexOf(match) < 0) {
m_factoryList = m_factoryList + fact + "|";
}
}
/**
* Generate factory list. Adds or replaces the existing static array of
* factories in the class.
*
* @throws JiBXException on configuration error
*/
/*package*/ void setFactoryList() throws JiBXException {
if (m_factoryList != null) {
short access = Constants.ACC_PUBLIC | Constants.ACC_FINAL |
Constants.ACC_STATIC;
m_classFile.updateField("java.lang.String",
BindingDirectory.BINDINGLIST_NAME, access, m_factoryList);
}
}
/**
* Get modification tracking information for class.
*
* @param cf information for class to be modified (must be writable)
* @return binding information for class
* @throws JiBXException on configuration error
*/
/*package*/ static MungedClass getInstance(ClassFile cf)
throws JiBXException {
MungedClass inst = (MungedClass)s_nameMap.get(cf.getName());
if (inst == null) {
inst = new MungedClass(cf);
s_nameMap.put(cf.getName(), inst);
if (cf.isComplete()) {
if (s_classMap.get(cf) == null) {
if (!s_classNameSet.contains(cf.getName())) {
s_classes.add(inst);
s_classNameSet.add(cf.getName());
}
s_classMap.put(cf, cf);
} else {
throw new IllegalStateException
("Existing class conflicts with load");
}
String pack = cf.getPackage();
checkDirectory(cf.getRoot(), pack);
}
}
inst.m_classFile.incrementUseCount();
return inst;
}
/**
* Add unique support class at end of binding process. This allows a class
* to be constructed in steps during handling of one or more bindings, with
* the class finished and checked for uniqueness only after all bindings
* have been handled. The actual add of the class is done during the
* {@link #fixChanges(boolean)} handling.
*
* @param cf class file to be added as unique support class at end of
* binding
*/
public static void delayedAddUnique(ClassFile cf) {
s_pendingClasses.add(cf);
}
/**
* Add class file to set modified. This uses the class name as a identifier
* to prevent duplicate entries in the list, so that classes which are still
* under construction can be handled.
*
* @param cf
*/
public static void addModifiedClass(ClassFile cf) {
if (!s_classNameSet.contains(cf.getName())) {
s_classes.add(cf);
s_classNameSet.add(cf.getName());
}
}
/**
* Finalize changes to modified class files.
*
* @param write replace original class files with modified versions
* @return three-way array of class files, for written, unmodified, and
* deleted
* @throws JiBXException on write error
*/
public static ClassFile[][] fixChanges(boolean write) throws JiBXException {
try {
// process all pending class adds
for (int i = 0; i < s_pendingClasses.size(); i++) {
getUniqueSupportClass((ClassFile)s_pendingClasses.get(i));
}
// first delete all existing classes which are no longer needed
ArrayList writes = new ArrayList();
ArrayList keeps = new ArrayList();
ArrayList deletes = new ArrayList();
for (int i = 0; i < s_classes.size(); i++) {
Object obj = s_classes.get(i);
ClassFile cf;
if (obj instanceof MungedClass) {
MungedClass inst = (MungedClass)obj;
inst.purgeUnusedMethods();
inst.setFactoryList();
cf = inst.getClassFile();
} else {
cf = (ClassFile)obj;
}
if (cf.isModified()) {
writes.add(cf);
} else if (cf.getUseCount() > 0) {
keeps.add(cf);
} else {
cf.delete();
deletes.add(cf);
}
}
// now write all modified classes (separate step for name conflicts)
if (write) {
for (int i = 0; i < writes.size(); i++) {
((ClassFile)writes.get(i)).writeFile();
}
}
// return changes in separate lists
ClassFile[][] results = new ClassFile[3][];
results[0] = (ClassFile[])writes.toArray(EMPTY_CLASSFILE_ARRAY);
results[1] = (ClassFile[])keeps.toArray(EMPTY_CLASSFILE_ARRAY);
results[2] = (ClassFile[])deletes.toArray
(EMPTY_CLASSFILE_ARRAY);
return results;
} catch (IOException ex) {
throw new JiBXException("Error writing to file", ex);
}
}
/**
* Filter for class files generated by JiBX.
*/
private static class JiBXFilter implements FileFilter
{
public boolean accept(File file) {
String name = file.getName();
return name.startsWith(BindingDefinition.GENERATE_PREFIX) &&
name.endsWith(".class");
}
}
/**
* Discard cached information and reset in preparation for a new binding
* run.
*/
public static void reset() {
s_classes = new ArrayList();
s_classNameSet = new HashSet();
s_classMap = new HashMap();
s_directories = new HashMap();
s_nameMap = new HashMap();
s_pendingClasses = new ArrayList();
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/classes/UnmarshalBuilder.java 0000644 0001750 0001750 00000012742 10263161374 026677 0 ustar moeller moeller /*
Copyright (c) 2003-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.classes;
import org.apache.bcel.Constants;
import org.apache.bcel.generic.*;
import org.jibx.runtime.JiBXException;
/**
* Unmarshalling method builder. Tracks the creation of an unmarshalling method,
* including special handling of exceptions that may be generated by object
* accesses during the unmarshalling process.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class UnmarshalBuilder extends MarshalUnmarshalBuilder
{
//
// Constants for code generation.
private static final String UNMARSHALCONTEXT_CLASS =
"org.jibx.runtime.impl.UnmarshallingContext";
protected static final String UNMARSHAL_EXCEPTION_TEXT =
"Error while unmarshalling ";
protected static final String UNMARSHALLING_POSITION_METHOD =
"org.jibx.runtime.impl.UnmarshallingContext.buildPositionString";
protected static final String UNMARSHALLING_POSITION_SIGNATURE =
"()Ljava/lang/String;";
protected static final Type[] UNMARSHAL_METHOD_ARGS =
{
new ObjectType("org.jibx.runtime.impl.UnmarshallingContext")
};
protected static final Type[] SINGLE_STRING_ARGS =
{
Type.STRING
};
/**
* Constructor. This sets up for constructing a virtual unmarshalling method
* with public access and wrapped exception handling. If the method is being
* generated directly to the class being unmarshalled it's built as a
* virtual method; otherwise, it's done as a static method.
*
* @param name method name to be built
* @param cf unmarshal class file information
* @param mf method generation class file information
* @throws JiBXException on error in initializing method construction
*/
public UnmarshalBuilder(String name, ClassFile cf, ClassFile mf)
throws JiBXException {
super(name, cf.getType(),
(mf == cf) ? UNMARSHAL_METHOD_ARGS :
new Type[] { cf.getType(), UNMARSHAL_METHOD_ARGS[0]},
mf, (mf == cf) ? Constants.ACC_PUBLIC | Constants.ACC_FINAL :
Constants.ACC_PUBLIC | Constants.ACC_STATIC, 0, cf.getName(),
1, UNMARSHALCONTEXT_CLASS);
}
/**
* Add exception handler code. The implementation of this abstract base
* class method provides handling specific to an unmarshalling method.
*
* @return handle for first instruction in handler
* @throws JiBXException on error in creating exception handler
*/
public InstructionHandle genExceptionHandler() throws JiBXException {
// first part of instruction sequence is create new exception object,
// duplicate two down (below caught exception), swap (so order is new,
// new, caught)
initStackState(new String[] {"java.lang.Exception"});
InstructionHandle start =
internalAppendCreateNew(FRAMEWORK_EXCEPTION_CLASS);
appendDUP_X1();
appendSWAP();
// second part of sequence is build StringBuffer, duplicate, load lead
// String, call constructor with String argument, load unmarshalling
// context, call position String method, call StringBuffer append,
// call StringBuffer toString
appendCreateNew("java.lang.StringBuffer");
appendDUP();
appendLoadConstant(UNMARSHAL_EXCEPTION_TEXT);
appendCallInit("java.lang.StringBuffer", "(Ljava/lang/String;)V");
loadContext();
appendCallVirtual(UNMARSHALLING_POSITION_METHOD,
UNMARSHALLING_POSITION_SIGNATURE);
appendCallVirtual("java.lang.StringBuffer.append",
"(Ljava/lang/String;)Ljava/lang/StringBuffer;");
appendCallVirtual("java.lang.StringBuffer.toString",
"()Ljava/lang/String;");
// final part of sequence is swap to get arguments in correct order,
// invoke exception constructor, throw exception
appendSWAP();
appendCallInit(FRAMEWORK_EXCEPTION_CLASS,
EXCEPTION_CONSTRUCTOR_SIGNATURE2);
appendThrow();
return start;
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/def/ 0000755 0001750 0001750 00000000000 11023035634 021660 5 ustar moeller moeller libjibx-java-1.1.6a/build/src/org/jibx/binding/def/BaseMappingWrapper.java 0000644 0001750 0001750 00000006067 10524434556 026276 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import org.jibx.binding.classes.*;
import org.jibx.runtime.JiBXException;
/**
* Component decorator for abstract base mapping from extension mapping. This
* just handles necessary glue code generation.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class BaseMappingWrapper extends PassThroughComponent
{
/**
* Constructor.
*
* @param wrap wrapped binding component
*/
public BaseMappingWrapper(IComponent wrap) {
super(wrap);
}
//
// IComponent interface method definitions
public void genAttributeUnmarshal(ContextMethodBuilder mb)
throws JiBXException {
mb.loadObject();
super.genAttributeUnmarshal(mb);
}
public void genAttributeMarshal(ContextMethodBuilder mb)
throws JiBXException {
mb.loadObject();
super.genAttributeMarshal(mb);
}
public void genContentUnmarshal(ContextMethodBuilder mb)
throws JiBXException {
mb.loadObject();
super.genContentUnmarshal(mb);
mb.appendPOP();
}
public void genContentMarshal(ContextMethodBuilder mb)
throws JiBXException {
mb.loadObject();
super.genContentMarshal(mb);
}
public void genNewInstance(ContextMethodBuilder mb) throws JiBXException {
throw new IllegalStateException
("Internal error - no new instance for base class");
}
// DEBUG
public void print(int depth) {
BindingDefinition.indent(depth);
System.out.println("base mapping wrapper");
m_component.print(depth+1);
}
}
libjibx-java-1.1.6a/build/src/org/jibx/binding/def/BindingBuilder.java 0000644 0001750 0001750 00000253253 11013374746 025427 0 ustar moeller moeller /*
Copyright (c) 2003-2008, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.HashSet;
import org.apache.bcel.Constants;
import org.apache.bcel.classfile.Utility;
import org.jibx.binding.classes.BoundClass;
import org.jibx.binding.classes.BranchTarget;
import org.jibx.binding.classes.BranchWrapper;
import org.jibx.binding.classes.ClassCache;
import org.jibx.binding.classes.ClassFile;
import org.jibx.binding.classes.ClassItem;
import org.jibx.binding.classes.ExceptionMethodBuilder;
import org.jibx.binding.classes.MethodBuilder;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.QName;
import org.jibx.runtime.impl.UnmarshallingContext;
/**
* Binding definition builder. This processes the binding definition file to
* generate the code generation structure.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public abstract class BindingBuilder
{
/** Element namespace used for binding definition file. */
private static final String URI_ELEMENTS = null;
/** Attribute namespace used for binding definition file. */
private static final String URI_ATTRIBUTES = null;
/* Common style attribute. */
private static final String COMMON_STYLE = "value-style";
/* Common linkage attributes. */
private static final String COMMON_AUTOLINK = "auto-link";
private static final String COMMON_ACCESSLEVEL = "access-level";
private static final String COMMON_STRIPPREFIX = "strip-prefix";
private static final String COMMON_STRIPSUFFIX = "strip-suffix";
private static final String COMMON_NAMESTYLE = "name-style";
/* Common name attributes. */
private static final String COMMON_NAME = "name";
private static final String COMMON_NAMESPACE = "ns";
/* Common object attributes. */
private static final String COMMON_FACTORY = "factory";
private static final String COMMON_PRESET = "pre-set";
private static final String COMMON_POSTSET = "post-set";
private static final String COMMON_PREGET = "pre-get";
private static final String COMMON_MARSHALLER = "marshaller";
private static final String COMMON_UNMARSHALLER = "unmarshaller";
private static final String COMMON_CREATETYPE = "create-type";
/* Common property attributes. */
private static final String COMMON_FIELD = "field";
private static final String COMMON_TYPE = "type";
private static final String COMMON_USAGE = "usage";
private static final String COMMON_TESTMETHOD = "test-method";
private static final String COMMON_GETMETHOD = "get-method";
private static final String COMMON_SETMETHOD = "set-method";
/* Common string attributes. */
private static final String COMMON_DEFAULT = "default";
private static final String COMMON_SERIALIZER = "serializer";
private static final String COMMON_DESERIALIZER = "deserializer";
private static final String COMMON_ENUMVALUEMETHOD = "enum-value-method";
/* Common label attributes. */
private static final String COMMON_LABEL = "label";
private static final String COMMON_USING = "using";
/* Common ordered and choice attributes. */
private static final String COMMON_ORDERED = "ordered";
private static final String COMMON_CHOICE = "choice";
private static final String COMMON_FLEXIBLE = "flexible";
private static final String COMMON_DUPLICATES = "allow-repeats";
/* Common nillable attribute. */
private static final String COMMON_NILLABLE = "nillable";
/** Definitions for "binding" element use "BINDING" prefix. */
private static final String BINDING_ELEMENT = "binding";
private static final String BINDING_NAME = "name";
private static final String BINDING_DIRECTION = "direction";
private static final String BINDING_GLOBALID = "global-id";
private static final String BINDING_FORWARDS = "forwards";
private static final String BINDING_PACKAGE = "package";
private static final String BINDING_TRACKING = "track-source";
private static final String BINDING_FORCE = "force-classes";
// also COMMON_STYLE, and linkage group
/** Definitions for "namespace" element use "NAMESPACE" prefix. */
private static final String NAMESPACE_ELEMENT = "namespace";
private static final String NAMESPACE_URI = "uri";
private static final String NAMESPACE_PREFIX = "prefix";
private static final String NAMESPACE_DEFAULT = "default";
/** Definitions for "format" element use "FORMAT" prefix. */
private static final String FORMAT_ELEMENT = "format";
private static final String FORMAT_NAME = "label";
private static final String FORMAT_TYPE = "type";
// also string group
/** Definitions for "mapping" element use "MAPPING" prefix. */
private static final String MAPPING_ELEMENT = "mapping";
private static final String MAPPING_CLASS = "class";
private static final String MAPPING_ABSTRACT = "abstract";
private static final String MAPPING_EXTENDS = "extends";
private static final String MAPPING_TYPENAME = "type-name";
// also COMMON_STYLE, name, object, ordered, and linkage groups
/** Definitions for "value" element use "VALUE" prefix. */
private static final String VALUE_ELEMENT = "value";
private static final String VALUE_STYLE = "style";
private static final String VALUE_FORMAT = "format";
private static final String VALUE_CONSTANT = "constant";
private static final String VALUE_IDENT = "ident";
// also name, property, and string groups
/** Definitions for "structure" element use "STRUCTURE" prefix. */
private static final String STRUCTURE_ELEMENT = "structure";
private static final String STRUCTURE_MAPAS = "map-as";
// also COMMON_STYLE, name, object, ordered, property, and label groups
/** Definitions for "collection" element use "COLLECTION" prefix. */
private static final String COLLECTION_ELEMENT = "collection";
private static final String COLLECTION_LOADMETHOD = "load-method";
private static final String COLLECTION_SIZEMETHOD = "size-method";
private static final String COLLECTION_STOREMETHOD = "store-method";
private static final String COLLECTION_ADDMETHOD = "add-method";
private static final String COLLECTION_ITERMETHOD = "iter-method";
private static final String COLLECTION_ITEMTYPE = "item-type";
// also COMMON_STYLE, name, ordered, property, and label groups
/** Definitions for "include" element use "INCLUDE" prefix. */
private static final String INCLUDE_ELEMENT = "include";
private static final String INCLUDE_PATH = "path";
//
// Value style enumeration.
private static final String[] VALUE_STYLE_NAMES =
{
"attribute", "cdata", "element", "text"
};
private static final int[] VALUE_STYLE_NUMS =
{
ValueChild.ATTRIBUTE_STYLE,
ValueChild.CDATA_STYLE,
ValueChild.ELEMENT_STYLE,
ValueChild.TEXT_STYLE
};
private static final String[] CONTAINING_STYLE_NAMES =
{
"attribute", "element"
};
private static final int[] CONTAINING_STYLE_NUMS =
{
ValueChild.ATTRIBUTE_STYLE,
ValueChild.ELEMENT_STYLE
};
//
// Enumeration for auto-link types.
/*package*/ static final int LINK_NONE = 0;
/*package*/ static final int LINK_FIELDS = 1;
/*package*/ static final int LINK_METHODS = 2;
private static final String[] AUTO_LINK_NAMES =
{
"fields", "none", "methods"
};
private static final int[] AUTO_LINK_NUMS =
{
LINK_FIELDS, LINK_NONE, LINK_METHODS
};
//
// Enumeration for access level.
/*package*/ static final int ACC_PRIVATE = 0;
/*package*/ static final int ACC_PACKAGE = 1;
/*package*/ static final int ACC_PROTECTED = 2;
/*package*/ static final int ACC_PUBLIC = 3;
private static final String[] ACCESS_LEVEL_NAMES =
{
"package", "private", "protected", "public"
};
private static final int[] ACCESS_LEVEL_NUMS =
{
ACC_PACKAGE, ACC_PRIVATE, ACC_PROTECTED, ACC_PUBLIC
};
//
// Enumeration for name generation styles.
/*package*/ static final int NAME_HYPHENS = 0;
/*package*/ static final int NAME_MIXED = 1;
private static final String[] NAME_GENERATE_NAMES =
{
"hyphens", "mixed-case"
};
private static final int[] NAME_GENERATE_NUMS =
{
NAME_HYPHENS, NAME_MIXED
};
//
// Attributes that imply a component object
private static final String[] COMPONENT_OBJECT_NAMESPACES =
{
URI_ATTRIBUTES,
URI_ATTRIBUTES,
URI_ATTRIBUTES,
URI_ATTRIBUTES
};
private static final String[] COMPONENT_OBJECT_NAMES =
{
COMMON_FACTORY,
COMMON_PRESET,
COMMON_POSTSET,
COMMON_PREGET
};
//
// Enumeration for namespace usage.
private static final String[] NAMESPACEACCESS_NAMES =
{
"all", "attributes", "elements", "none"
};
private static final int[] NAMESPACEACCESS_NUMS =
{
NamespaceDefinition.ALLDEFAULT_USAGE,
NamespaceDefinition.ATTRIBUTES_USAGE,
NamespaceDefinition.ELEMENTS_USAGE,
NamespaceDefinition.NODEFAULT_USAGE
};
//
// Ident type enumeration.
private static final String[] IDENTTYPE_NAMES =
{
"auto", "def", "direct", "ref"
};
private static final int[] IDENTTYPE_NUMS =
{
ValueChild.AUTO_IDENT,
ValueChild.DEF_IDENT,
ValueChild.DIRECT_IDENT,
ValueChild.REF_IDENT
};
//
// Binding direction enumeration.
private static final int DIRECTION_INPUT = 0;
private static final int DIRECTION_OUTPUT = 1;
private static final int DIRECTION_BOTH = 2;
private static final String[] BINDINGDIR_NAMES =
{
"both", "input", "output"
};
private static final int[] BINDINGDIR_NUMS =
{
DIRECTION_BOTH,
DIRECTION_INPUT,
DIRECTION_OUTPUT
};
//
// Constants for property usage values
private static final String USAGE_OPTIONAL = "optional";
private static final String USAGE_REQUIRED = "required";
//
// Checking and code generation constants
private static final String UNMARSHALLER_INTERFACE =
"org.jibx.runtime.IUnmarshaller";
private static final String MARSHALLER_INTERFACE =
"org.jibx.runtime.IMarshaller";
private static final String UNMARSHALLER_INTERFACETYPE =
"Lorg/jibx/runtime/IUnmarshaller;";
private static final String MARSHALLER_INTERFACETYPE =
"Lorg/jibx/runtime/IMarshaller;";
private static final String CUSTOM_ENUM_SERIALIZER_NAME =
"_jibx_serialize";
private static final String CUSTOM_ENUM_DESERIALIZER_NAME =
"_jibx_deserialize";
/**
* Check if attributes supply a name definition.
*
* @param ctx unmarshalling context information
* @return true if attributes define a name,
* false if not
*/
private static boolean isNamePresent(UnmarshallingContext ctx) {
return ctx.attributeText(URI_ATTRIBUTES, COMMON_NAME, null) != null;
}
/**
* Check for property definition present. Just checks the attributes of
* the current element.
*
* @param ctx unmarshalling context information
*/
private static boolean isPropertyPresent(UnmarshallingContext ctx) {
return ctx.attributeText(URI_ATTRIBUTES, COMMON_FIELD, null) != null ||
ctx.attributeText(URI_ATTRIBUTES, COMMON_GETMETHOD, null) != null ||
ctx.attributeText(URI_ATTRIBUTES, COMMON_SETMETHOD, null) != null ||
ctx.attributeText(URI_ATTRIBUTES, COMMON_TESTMETHOD, null) != null;
}
/**
* Check if attributes define a direct object reference. Just checks the
* attributes of the current element.
*
* @param ctx unmarshalling context information
*/
private static boolean isDirectObject(UnmarshallingContext ctx) {
return ctx.attributeText(URI_ATTRIBUTES,
COMMON_MARSHALLER, null) != null ||
ctx.attributeText(URI_ATTRIBUTES,
COMMON_UNMARSHALLER, null) != null;
}
/**
* Check if attributes define a mapping reference.
*
* @param ctx unmarshalling context information
* @return true if attributes define a mapping reference,
* false if not
* @throws JiBXException if error in unmarshalling
*/
private static boolean isMappingRef(UnmarshallingContext ctx)
throws JiBXException {
return ctx.hasAttribute(URI_ATTRIBUTES, STRUCTURE_MAPAS);
}
/**
* Check for component object present. Just checks the attributes of the
* current element, so this is not definitive - there may still be child
* binding definitions even without attributes.
*
* @param ctx unmarshalling context information
* @throws JiBXException if error in unmarshalling
*/
private static boolean isObjectBinding(UnmarshallingContext ctx)
throws JiBXException {
return ctx.hasAnyAttribute(COMPONENT_OBJECT_NAMESPACES,
COMPONENT_OBJECT_NAMES);
}
/**
* Unmarshal name definition. This unmarshals directly from attributes of
* the current element.
*
* @param ctx unmarshalling context information
* @param attr flag for attribute name definition
* @throws JiBXException if error in unmarshalling
*/
private static NameDefinition unmarshalName(UnmarshallingContext ctx,
boolean attr) throws JiBXException {
String name = ctx.attributeText(URI_ATTRIBUTES, COMMON_NAME);
String ns = ctx.attributeText(URI_ATTRIBUTES, COMMON_NAMESPACE, null);
return new NameDefinition(name, ns, attr);
}
/**
* Unmarshal namespace definition.
*
* @param ctx unmarshalling context information
* @throws JiBXException if error in unmarshalling
*/
private static NamespaceDefinition unmarshalNamespace
(UnmarshallingContext ctx) throws JiBXException {
// set up the basic information
String uri = ctx.attributeText(URI_ATTRIBUTES, NAMESPACE_URI);
String prefix = ctx.attributeText(URI_ATTRIBUTES,
NAMESPACE_PREFIX, null);
if ("".equals(prefix)) {
prefix = null;
}
// check default usage attribute
int usage = ctx.attributeEnumeration(URI_ATTRIBUTES, NAMESPACE_DEFAULT,
NAMESPACEACCESS_NAMES, NAMESPACEACCESS_NUMS,
NamespaceDefinition.NODEFAULT_USAGE);
// finish parsing the element
ctx.parsePastEndTag(URI_ELEMENTS, NAMESPACE_ELEMENT);
return new NamespaceDefinition(uri, prefix, usage);
}
/**
* Add serializer and deserializer methods to enum class with special value
* method. This allows enums to be used even when the values present in XML
* are not valid Java names.
*
* @param type
* @param evmeth
* @throws JiBXException
*/
private static void buildEnumValueMethods(String type, String evmeth)
throws JiBXException {
// set up for adding serialize/deserialize methods to enum class
BoundClass bndclas = BoundClass.getInstance(type, null);
String typesig = bndclas.getClassFile().getSignature();
ClassFile cf = bndclas.getMungedFile();
String evfull = type + '.' + evmeth;
// build the serializer method (just delegates to value method)
String sersig = "(" + typesig + ")Ljava/lang/String;";
ExceptionMethodBuilder smeth = new ExceptionMethodBuilder
(CUSTOM_ENUM_SERIALIZER_NAME, sersig, cf,
Constants.ACC_PUBLIC | Constants.ACC_STATIC);
smeth.appendLoadLocal(0);
BranchWrapper nonnull = smeth.appendIFNONNULL(smeth);
smeth.appendACONST_NULL();
smeth.appendReturn("java.lang.String");
smeth.targetNext(nonnull);
smeth.appendLoadLocal(0);
smeth.appendCallVirtual(evfull, "()Ljava/lang/String;");
smeth.appendReturn("java.lang.String");
bndclas.getUniqueNamed(smeth);
// create the deserializer method
String dsersig = "(Ljava/lang/String;)" + typesig;
ExceptionMethodBuilder dmeth = new ExceptionMethodBuilder
(CUSTOM_ENUM_DESERIALIZER_NAME, dsersig, cf,
Constants.ACC_PUBLIC | Constants.ACC_STATIC);
dmeth.addException(MethodBuilder.FRAMEWORK_EXCEPTION_CLASS);
// start by handling the null string case
dmeth.appendLoadLocal(0);
nonnull = dmeth.appendIFNONNULL(dmeth);
dmeth.appendACONST_NULL();
dmeth.appendReturn(type);
dmeth.targetNext(nonnull);
// set up locals for array of values and decrementing index
dmeth.appendCallStatic(type + ".values", "()[" + typesig);
dmeth.appendDUP();
int arraylocal = dmeth.addLocal("values",
ClassItem.typeFromName(type + "[]"));
dmeth.appendARRAYLENGTH();
int arrayindex = dmeth.addLocal("index",
ClassItem.typeFromName("int"));
// start comparison loop with check for off bottom of array
BranchTarget start = dmeth.appendTargetNOP();
dmeth.appendIncrementLocal(-1, arrayindex);
dmeth.appendLoadLocal(arrayindex);
BranchWrapper loadnext = dmeth.appendIFGE(dmeth);
// throw an exception for value not found
dmeth.appendCreateNew("java.lang.StringBuffer");
dmeth.appendDUP();
dmeth.appendLoadConstant("No match found for value '");
dmeth.appendCallInit("java.lang.StringBuffer",
"(Ljava/lang/String;)V");
dmeth.appendLoadLocal(0);
dmeth.appendCallVirtual("java.lang.StringBuffer.append",
"(Ljava/lang/String;)Ljava/lang/StringBuffer;");
dmeth.appendLoadConstant("' in enum class " + type);
dmeth.appendCallVirtual("java.lang.StringBuffer.append",
"(Ljava/lang/String;)Ljava/lang/StringBuffer;");
dmeth.appendCallVirtual("java.lang.StringBuffer.toString",
"()Ljava/lang/String;");
dmeth.appendCreateNew(MethodBuilder.FRAMEWORK_EXCEPTION_CLASS);
dmeth.appendDUP_X1();
dmeth.appendSWAP();
dmeth.appendCallInit(MethodBuilder.FRAMEWORK_EXCEPTION_CLASS,
MethodBuilder.EXCEPTION_CONSTRUCTOR_SIGNATURE1);
dmeth.appendThrow();
// load and compare the value
dmeth.targetNext(loadnext);
dmeth.appendLoadLocal(0);
dmeth.appendLoadLocal(arraylocal);
dmeth.appendLoadLocal(arrayindex);
dmeth.appendALOAD(type);
dmeth.appendCallVirtual(evfull, "()Ljava/lang/String;");
dmeth.appendCallVirtual("java.lang.Object.equals",
"(Ljava/lang/Object;)Z");
BranchWrapper tonext = dmeth.appendIFEQ(dmeth);
tonext.setTarget(start, dmeth);
// return the matching instance
dmeth.appendLoadLocal(arraylocal);
dmeth.appendLoadLocal(arrayindex);
dmeth.appendALOAD(type);
dmeth.appendReturn(type);
// add completed method to class
bndclas.getUniqueNamed(dmeth);
}
/**
* Unmarshal string conversion. Unmarshals conversion information directly
* from the attributes of the current start tag.
*
* @param ctx unmarshalling context information
* @param base conversion used as base for this conversion
* @param type fully qualified class name of type handled by conversion
* @throws JiBXException if error in unmarshalling
*/
private static StringConversion unmarshalStringConversion
(UnmarshallingContext ctx, StringConversion base, String type)
throws JiBXException {
String dflt = ctx.attributeText(URI_ATTRIBUTES, COMMON_DEFAULT, null);
String ser = ctx.attributeText(URI_ATTRIBUTES, COMMON_SERIALIZER, null);
String dser = ctx.attributeText(URI_ATTRIBUTES,
COMMON_DESERIALIZER, null);
String evmeth = ctx.attributeText(URI_ATTRIBUTES,
COMMON_ENUMVALUEMETHOD, null);
if (evmeth != null) {
ser = type + '.' + CUSTOM_ENUM_SERIALIZER_NAME;
dser = type + '.' + CUSTOM_ENUM_DESERIALIZER_NAME;
buildEnumValueMethods(type, evmeth);
}
return base.derive(type, ser, dser, dflt);
}
/**
* Check for optional property. Just checks for the attribute and makes sure
* it has a valid value if present, returning either the default or the
* defined value.
*
* @param ctx unmarshalling context information
* @return true if attribute present with value "true",
* false otherwise
* @throws JiBXException if error in unmarshalling
*/
private static boolean isOptionalProperty(UnmarshallingContext ctx)
throws JiBXException {
boolean opt = false;
String value = ctx.attributeText(URI_ATTRIBUTES, COMMON_USAGE,
USAGE_REQUIRED);
if (USAGE_OPTIONAL.equals(value)) {
opt = true;
} else if (!USAGE_REQUIRED.equals(value)) {
ctx.throwStartTagException("Illegal value for \"" + COMMON_USAGE+
"\" attribute");
}
return opt;
}
/**
* Unmarshal property definition. This unmarshals directly from attributes
* of the current element.
*
* @param ctx unmarshalling context information
* @param parent containing binding definition structure
* @param cobj context object information
* @param opt force optional value flag
* @throws JiBXException if error in unmarshalling
*/
private static PropertyDefinition unmarshalProperty
(UnmarshallingContext ctx, IContainer parent, IContextObj cobj,
boolean opt) throws JiBXException {
// read basic attribute values for property definition
String type = ctx.attributeText(URI_ATTRIBUTES, COMMON_TYPE, null);
if (!(parent instanceof NestedCollection) && isOptionalProperty(ctx)) {
opt = true;
}
// read and validate method and/or field attribute values
PropertyDefinition pdef = null;
try {
String fname = ctx.attributeText(URI_ATTRIBUTES,
COMMON_FIELD, null);
String test = ctx.attributeText(URI_ATTRIBUTES,
COMMON_TESTMETHOD, null);
String get = ctx.attributeText(URI_ATTRIBUTES,
COMMON_GETMETHOD, null);
String set = ctx.attributeText(URI_ATTRIBUTES,
COMMON_SETMETHOD, null);
boolean isthis = fname == null && get == null && set == null;
pdef = new PropertyDefinition
(parent, cobj, type, isthis, opt, fname, test, get, set);
} catch (JiBXException ex) {
// rethrow error message with position information
ctx.throwStartTagException(ex.getMessage());
}
return pdef;
}
/**
* Unmarshal value definition. This handles the complete element supplying
* the value binding.
*
* @param ctx unmarshalling context information
* @param parent containing binding definition structure
* @param cobj context object information
* @param uord unordered collection member flag
* @param impl implicit value from collection flag
* @param itype base type for value
* @throws JiBXException if error in unmarshalling
*/
private static ValueChild unmarshalValue(UnmarshallingContext ctx,
IContainer parent, IContextObj cobj, boolean uord, boolean impl,
String itype) throws JiBXException {
// find the style for this value
int style = ctx.attributeEnumeration(URI_ATTRIBUTES, VALUE_STYLE,
VALUE_STYLE_NAMES, VALUE_STYLE_NUMS, parent.getStyleDefault());
// set up the basic structures
boolean isatt = style == ValueChild.ATTRIBUTE_STYLE;
NameDefinition name = null;
if (isatt || style == ValueChild.ELEMENT_STYLE) {
name = unmarshalName(ctx, isatt);
name.fixNamespace(parent.getDefinitionContext());
} else if (isNamePresent(ctx)) {
ctx.throwStartTagException
("Name not allowed for text or CDATA value");
}
String constant = ctx.attributeText(URI_ATTRIBUTES,
VALUE_CONSTANT, null);
// handle property information (unless auto ident or implicit value)
int ident = ctx.attributeEnumeration(URI_ATTRIBUTES, VALUE_IDENT,
IDENTTYPE_NAMES, IDENTTYPE_NUMS, ValueChild.DIRECT_IDENT);
PropertyDefinition prop = null;
if (ident == ValueChild.AUTO_IDENT) {
ctx.throwStartTagException
("Automatic id generation not yet supported");
} else if (impl) {
String type = ctx.attributeText(URI_ATTRIBUTES, COMMON_TYPE, itype);
prop = new PropertyDefinition(type, cobj,
!(parent instanceof NestedCollection) && isOptionalProperty(ctx));
} else {
prop = unmarshalProperty(ctx, parent, cobj,
ctx.hasAttribute(URI_ATTRIBUTES, COMMON_DEFAULT));
/* if (constant == null && prop.isThis()) {
ctx.throwStartTagException("No property for value");
} else if (prop.isOptional()) {
if (ident == ValueChild.DEF_IDENT) {
ctx.throwStartTagException("Object ID cannot be optional");
}
} else if (uord) {
ctx.throwStartTagException("All items in unordered " +
"structure must be optional");
} */
}
if (ident != ValueChild.DIRECT_IDENT && uord) {
ctx.throwStartTagException(VALUE_IDENT +
" not allowed in unordered structure");
}
// get serializer/deserializer attributes now to allow enum override
String ser = ctx.attributeText(URI_ATTRIBUTES, COMMON_SERIALIZER, null);
String dser = ctx.attributeText(URI_ATTRIBUTES,
COMMON_DESERIALIZER, null);
// check for enum with value method
String type = (prop == null || constant != null) ?
"java.lang.String" : prop.getTypeName();
String evmeth = ctx.attributeText(URI_ATTRIBUTES,
COMMON_ENUMVALUEMETHOD, null);
boolean basicenum = false;
ClassFile target = ClassCache.getClassFile(type);
if (evmeth != null) {
// handle enum using generated serialize and deserialize methods
ser = type + '.' + CUSTOM_ENUM_SERIALIZER_NAME;
dser = type + '.' + CUSTOM_ENUM_DESERIALIZER_NAME;
buildEnumValueMethods(type, evmeth);
} else {
// check for a Java 5 enumeration
ClassFile sclas = target;
while ((sclas = sclas.getSuperFile()) != null) {
if (sclas.getName().equals("java.lang.Enum")) {
basicenum = true;
break;
}
}
}
// find the basic converter to use
StringConversion convert = null;
String format = ctx.attributeText(URI_ATTRIBUTES, VALUE_FORMAT, null);
DefinitionContext defc = parent.getDefinitionContext();
if (format == null) {
// no format name, get specific convertor for type or best match
convert = defc.getSpecificConversion(type);
if (convert == null) {
// find best match converter for type
convert = defc.getConversion(target);
// generate specific converter based on general form
if (basicenum) {
String basedeser = type + '.' + "valueOf";
convert = convert.derive(type, null, basedeser, null);
} else if (convert.getTypeName().equals("java.lang.Object")) {
convert = new ObjectStringConversion(type,
(ObjectStringConversion)convert);
}
}
} else {
// format name supplied, look it up and check compatibility
QName qname = QName.deserialize(format, ctx);
convert = defc.getNamedConversion(qname);
if (convert == null) {
ctx.throwStartTagException
("Unknown format \"" + format + "\"");
}
String ctype = convert.getTypeName();
if (!ClassItem.isAssignable(type, ctype) &&
!ClassItem.isAssignable(ctype, type)) {
ctx.throwStartTagException
("Converter type not compatible with value type");
}
}
// check for any special conversion handling
String dflt = ctx.attributeText(URI_ATTRIBUTES, COMMON_DEFAULT, null);
if (dflt != null || ser != null || dser != null) {
convert = convert.derive(type, ser, dser, dflt);
}
// create the instance to be returned
boolean nillable = ctx.attributeBoolean(URI_ATTRIBUTES,
COMMON_NILLABLE, false);
if (nillable) {
parent.getBindingRoot().setSchemaInstanceUsed();
}
ValueChild value = new ValueChild(parent, cobj, name, prop, convert,
style, ident, constant, nillable);
// handle identifier property flag
if (ident == ValueChild.DEF_IDENT || ident == ValueChild.AUTO_IDENT) {
if (!cobj.setIdChild(value)) {
ctx.throwStartTagException
("Duplicate ID definition for containing mapping");
} else if (!"java.lang.String".equals(type)) {
ctx.throwStartTagException
("ID property must be a String");
}
}
// finish with skipping past end tag
ctx.parsePastEndTag(URI_ELEMENTS, VALUE_ELEMENT);
return value;
}
/**
* Unmarshal direct object component. Just constructs the component to
* be returned along with the supporting objects, and verifies that no
* disallowed properties are present.
*
* @param ctx unmarshalling context information
* @param type fully qualified class name of object type handled
* @param parent containing binding definition structure
* @param defc definition context to be used (if separate from parent,
* otherwise null)
* @param slot marshaller/unmarshaller slot number
* @param name element name information (null if no element
* name)
* @return constructed direct object component
* @throws JiBXException if error in unmarshalling
*/
private static DirectObject unmarshalDirectObj(UnmarshallingContext ctx,
String type, IContainer parent, DefinitionContext defc, int slot,
NameDefinition name) throws JiBXException {
// define and validate marshaller
ClassFile mcf = null;
if (parent.getBindingRoot().isOutput()) {
String clas = ctx.attributeText(URI_ATTRIBUTES, COMMON_MARSHALLER);
mcf = ClassCache.getClassFile(clas);
if (!mcf.isImplements(MARSHALLER_INTERFACETYPE)) {
ctx.throwStartTagException("Marshaller class " + clas +
" does not implement required interface " +
MARSHALLER_INTERFACE);
}
}
// define and validate unmarshaller
ClassFile ucf = null;
if (parent.getBindingRoot().isInput()) {
String clas = ctx.attributeText(URI_ATTRIBUTES,
COMMON_UNMARSHALLER);
ucf = ClassCache.getClassFile(clas);
if (!ucf.isImplements(UNMARSHALLER_INTERFACETYPE)) {
ctx.throwStartTagException("Unmarshaller class " + clas +
" does not implement required interface " +
UNMARSHALLER_INTERFACE);
}
}
// make sure none of the prohibited attributes are present
if (isObjectBinding(ctx)) {
ctx.throwStartTagException("Other object attributes not " +
"allowed when using marshaller or unmarshaller");
} else if (isMappingRef(ctx)) {
ctx.throwStartTagException("Mapping not allowed when " +
"using marshaller or unmarshaller");
} else if (ctx.hasAttribute(URI_ATTRIBUTES, COMMON_USING)) {
ctx.throwStartTagException(COMMON_USING +
" attribute not allowed when using marshaller or unmarshaller");
}
// return constructed instance
return new DirectObject(parent, defc,
ClassCache.getClassFile(type), false, mcf, ucf, slot, name);
}
/**
* Unmarshal mapping reference component. Just constructs the component to
* be returned along with the supporting objects, and verifies that no
* disallowed properties are present.
*
* @param ctx unmarshalling context information
* @param parent containing binding definition structure
* @param objc current object context
* @param prop property definition
* @param name reference name definition (only allowed with abstract
* mappings)
* @return constructed mapping reference component
* @throws JiBXException if error in unmarshalling
*/
private static IComponent unmarshalMappingRef(UnmarshallingContext ctx,
IContainer parent, IContextObj objc, PropertyDefinition prop,
NameDefinition name) throws JiBXException {
// make sure no forbidden attributes are present
if (isObjectBinding(ctx)) {
ctx.throwStartTagException("Other object attributes not " +
"allowed when using mapping reference");
} else if (ctx.hasAttribute(URI_ATTRIBUTES, COMMON_USING)) {
ctx.throwStartTagException(COMMON_USING +
" attribute not allowed when using mapping reference");
}
// build the actual component to be returned
String type = (prop == null) ? null : prop.getTypeName();
String text = ctx.attributeText(URI_ATTRIBUTES, STRUCTURE_MAPAS, type);
QName qname = QName.deserialize(text, ctx);
boolean nillable = ctx.attributeBoolean(URI_ATTRIBUTES,
COMMON_NILLABLE, false);
if (nillable) {
parent.getBindingRoot().setSchemaInstanceUsed();
}
return new MappingReference(parent, prop, type, text, qname.toString(),
objc, name, false, nillable);
}
/**
* Unmarshal structure reference component. Just constructs the component to
* be returned along with the supporting objects, and verifies that no
* disallowed properties are present.
*
* @param ctx unmarshalling context information
* @param contain containing binding component
* @param name element name information (null if no element
* name)
* @param prop property definition (null if no separate
* property)
* @param cobj context object
* @return constructed structure reference component
* @throws JiBXException if error in unmarshalling
*/
private static IComponent unmarshalStructureRef(UnmarshallingContext ctx,
IContainer contain, NameDefinition name, PropertyDefinition prop,
IContextObj cobj) throws JiBXException {
// make sure no forbidden attributes are present
if (isObjectBinding(ctx)) {
ctx.throwStartTagException("Other object attributes not " +
"allowed when using structure reference");
}
// build the actual component to be returned
String ident = ctx.attributeText(URI_ATTRIBUTES, COMMON_USING);
IComponent comp = new StructureReference(contain, ident, prop,
name != null, cobj);
if (name != null) {
boolean nillable = ctx.attributeBoolean(URI_ATTRIBUTES,
COMMON_NILLABLE, false);
if (nillable) {
contain.getBindingRoot().setSchemaInstanceUsed();
}
comp = new ElementWrapper(contain.getDefinitionContext(),
name, comp, nillable);
if (prop != null && prop.isOptional()) {
((ElementWrapper)comp).setOptionalNormal(true);
((ElementWrapper)comp).setStructureObject(true);
comp = new OptionalStructureWrapper(comp, prop, true);
prop.setOptional(false);
}
}
return comp;
}
/**
* Unmarshal child bindings for a nested structure definition.
*
* @param ctx unmarshalling context information
* @param nest nested structure definition
* @param objc context object definition
* @param impl property value implicit flag
* @param itype item type for child components
* @throws JiBXException if error in unmarshalling
*/
private static void unmarshalStructureChildren(UnmarshallingContext ctx,
NestedBase nest, IContextObj objc, boolean impl, String itype)
throws JiBXException {
boolean uord = !nest.isContentOrdered();
while (true) {
// unmarshal next child binding definition
IComponent comp;
if (ctx.isAt(URI_ELEMENTS, VALUE_ELEMENT)) {
ValueChild child =
unmarshalValue(ctx, nest, objc, uord, impl, itype);
comp = child;
} else if (ctx.isAt(URI_ELEMENTS, STRUCTURE_ELEMENT)) {
comp = unmarshalStructure(ctx, nest, objc, false, uord, impl);
} else if (ctx.isAt(URI_ELEMENTS, COLLECTION_ELEMENT)) {
comp = unmarshalStructure(ctx, nest, objc, true, uord, impl);
} else {
break;
}
// add component to structure
nest.addComponent(comp);
}
}
/**
* Unmarshal object binding component. Just constructs the component to
* be returned along with the supporting objects. This handles both the
* unmarshalling of attributes, and of nested binding components.
*
* @param ctx unmarshalling context information
* @param parent containing binding definition structure
* @param objc current object context
* @param type fully qualified name of object class
* @return constructed structure reference component
* @throws JiBXException if error in unmarshalling
*/
private static ObjectBinding unmarshalObjectBinding
(UnmarshallingContext ctx, IContextObj objc, IContainer parent,
String type) throws JiBXException {
// set method names from attributes of start tag
String fact = ctx.attributeText(URI_ATTRIBUTES, COMMON_FACTORY, null);
String pres = ctx.attributeText(URI_ATTRIBUTES, COMMON_PRESET, null);
String posts = ctx.attributeText(URI_ATTRIBUTES, COMMON_POSTSET, null);
String preg = ctx.attributeText(URI_ATTRIBUTES, COMMON_PREGET, null);
String ctype = ctx.attributeText(URI_ATTRIBUTES,
COMMON_CREATETYPE, null);
ObjectBinding bind = null;
try {
bind = new ObjectBinding(parent, objc, type, fact, pres,
posts, preg, ctype);
} catch (JiBXException ex) {
ctx.throwStartTagException(ex.getMessage(), ex);
}
return bind;
}
/**
* Unmarshal namespace definitions. Any namespace definitions present are
* unmarshalled and added to the supplied definition context.
*
* @param ctx unmarshalling context information
* @param defc definition context for defined namespaces
* @throws JiBXException if error in unmarshalling
*/
private static void unmarshalNamespaces(UnmarshallingContext ctx,
DefinitionContext defc) throws JiBXException {
while (ctx.isAt(URI_ELEMENTS, NAMESPACE_ELEMENT)) {
defc.addNamespace(unmarshalNamespace(ctx));
}
}
/**
* Unmarshal format definitions. Any format definitions present are
* unmarshalled and added to the supplied definition context.
*
* @param ctx unmarshalling context information
* @param defc definition context for defined formats
* @throws JiBXException if error in unmarshalling
*/
private static void unmarshalFormats(UnmarshallingContext ctx,
DefinitionContext defc) throws JiBXException {
// process all format definitions at level
while (ctx.isAt(URI_ELEMENTS, FORMAT_ELEMENT)) {
// find the current default format information for type
String type = ctx.attributeText(URI_ATTRIBUTES, FORMAT_TYPE);
String sig = Utility.getSignature(type);
StringConversion base = null;
if (sig.length() == 1) {
// must be a primitive, check type directly
base = defc.getSpecificConversion(type);
if (base == null) {
ctx.throwStartTagException("Unsupported \"" +
FORMAT_TYPE + "\" value");
}
} else {
// must be an object type, find best match
ClassFile cf = ClassCache.getClassFile(type);
base = defc.getConversion(cf);
}
// unmarshal with defaults provided by existing format
StringConversion format =
unmarshalStringConversion(ctx, base, type);
// handle based on presence or absence of name attribute
String text = ctx.attributeText(URI_ATTRIBUTES, FORMAT_NAME, null);
if (text == null) {
defc.setConversion(format);
} else {
QName qname = QName.deserialize(text, ctx);
defc.setNamedConversion(qname, format);
}
// scan past end of definition
ctx.parsePastEndTag(URI_ELEMENTS, FORMAT_ELEMENT);
}
}
/**
* Unmarshal mapping definitions. Any mapping definitions present are
* unmarshalled and added to the supplied definition context.
*
* @param ctx unmarshalling context information
* @param parent containing binding definition structure
* @param nss extra namespaces to be included in this mapping definition
* (may be null)
* @param uord container is unordered structure flag
* @throws JiBXException if error in unmarshalling
*/
private static void unmarshalMappings(UnmarshallingContext ctx,
IContainer parent, ArrayList nss, boolean uord) throws JiBXException {
while (ctx.isAt(URI_ELEMENTS, MAPPING_ELEMENT)) {
unmarshalMapping(ctx, parent, nss, uord);
}
}
/**
* Unmarshal subclass instance for structure definition. This handles all
* combinations of attributes on the start tag, generating the appropriate
* structure of nested components and other classes to represent the binding
* information within the current element. This must be called with the
* parse positioned at the start tag of the element to be unmarshalled.
*
* TODO: At least split this up, or organize a better way to build binding
*
* @param ctx unmarshalling context information
* @param contain containing binding definition structure
* @param cobj context object information
* @param coll collection structure flag
* @param uord container is unordered structure flag
* @param implic property value implicit flag
* @return root of component tree constructed from binding
* @throws JiBXException if error in unmarshalling
*/
public static IComponent unmarshalStructure(UnmarshallingContext ctx,
IContainer contain, IContextObj cobj, boolean coll, boolean uord,
boolean implic) throws JiBXException {
// get name definition if supplied (check later to see if valid)
NameDefinition name = null;
if (isNamePresent(ctx)) {
name = unmarshalName(ctx, false);
}
// check for optional flag on structure
boolean opt = isOptionalProperty(ctx);
boolean incoll = false;
if (contain instanceof NestedCollection) {
incoll = true;
opt = false;
}
// check for property definition supplied
IComponent comp;
boolean hasprop = isPropertyPresent(ctx);
boolean thisref = false;
if (!hasprop) {
thisref = incoll || ctx.hasAttribute(URI_ATTRIBUTES, COMMON_TYPE);
}
boolean mapping = isMappingRef(ctx);
if (hasprop || coll || implic || thisref) {
// set up the property definition to be used
PropertyDefinition prop = null;
boolean hasobj = hasprop;
if (implic) {
// make sure no override of implicit property from collection
if (hasprop) {
ctx.throwStartTagException("Property definition not " +
"allowed for collection items");
} else {
String type = ctx.attributeText(URI_ATTRIBUTES,
COMMON_TYPE, null);
if (type == null) {
if (!mapping) {
if (incoll) {
type = ((NestedCollection)contain).getItemType();
hasobj = true;
} else {
type = "java.lang.Object";
}
}
} else {
hasobj = true;
}
prop = new PropertyDefinition(type, cobj, opt);
}
} else if (hasprop || thisref) {
prop = unmarshalProperty(ctx, contain, cobj, opt);
} else {
prop = new PropertyDefinition(cobj, opt);
}
// check if using direct object marshalling and unmarshalling
if (isDirectObject(ctx)) {
// validate and configure direct marshalling and unmarshalling
comp = new DirectProperty(prop, unmarshalDirectObj(ctx,
prop.getTypeName(), contain, null, -1, name));
} else if (mapping) {
// validate and configure reference to mapping in context
comp = unmarshalMappingRef(ctx, contain, cobj, prop, name);
} else {
// check for object binding needed
IContextObj icobj = cobj;
ObjectBinding bind = null;
boolean typed = false;
if (implic) {
typed = !prop.getTypeName().equals("java.lang.Object");
} else {
typed = !prop.getTypeName().equals
(cobj.getBoundClass().getClassName());
}
if ((hasobj && !prop.isThis()) || (!hasobj && typed)) {
bind = unmarshalObjectBinding(ctx, cobj, contain,
prop.getTypeName());
icobj = bind;
}
// validate and configure reference to structure in context
if (ctx.hasAttribute(URI_ATTRIBUTES, COMMON_USING)) {
comp = unmarshalStructureRef(ctx, contain, name,
prop, icobj);
} else {
// validate and configure actual binding definition
DefinitionContext defc = contain.getDefinitionContext();
IComponent top = bind;
// check for optional label definition
String label = ctx.attributeText(URI_ATTRIBUTES,
COMMON_LABEL, null);
// set load and store handlers for collection
NestedCollection.CollectionLoad load = null;
NestedCollection.CollectionStore store = null;
String itype = null;
if (coll) {
// get any method names and type supplied by user
String stname = ctx.attributeText(URI_ATTRIBUTES,
COLLECTION_STOREMETHOD, null);
String aname = ctx.attributeText(URI_ATTRIBUTES,
COLLECTION_ADDMETHOD, null);
String lname = ctx.attributeText(URI_ATTRIBUTES,
COLLECTION_LOADMETHOD, null);
String szname = ctx.attributeText(URI_ATTRIBUTES,
COLLECTION_SIZEMETHOD, null);
String iname = ctx.attributeText(URI_ATTRIBUTES,
COLLECTION_ITERMETHOD, null);
itype = ctx.attributeText(URI_ATTRIBUTES,
COLLECTION_ITEMTYPE, "java.lang.Object");
// verify combinations of attributes supplied
if ((lname == null || szname == null) &&
!(lname == null && szname == null)) {
ctx.throwStartTagException(COLLECTION_LOADMETHOD +
" and " + COLLECTION_SIZEMETHOD +
" attributes must be used together");
}
if (iname != null && lname != null) {
ctx.throwStartTagException(COLLECTION_ITERMETHOD +
" and " + COLLECTION_LOADMETHOD +
" attributes cannot be used together");
}
if (aname != null && stname != null) {
ctx.throwStartTagException(COLLECTION_ADDMETHOD +
" and " + COLLECTION_STOREMETHOD +
" attributes cannot be used together");
}
// set defaults based on collection type
ClassFile cf = ClassCache.getClassFile
(prop.getTypeName());
if (cf.isSuperclass("java.util.Vector")||
cf.isSuperclass("java.util.ArrayList")) {
if (stname == null && aname == null) {
aname = "add";
}
if (iname == null && lname == null) {
lname = "get";
szname = "size";
}
} else if (cf.isImplements("Ljava/util/Collection;")) {
if (stname == null && aname == null) {
aname = "add";
}
if (iname == null && lname == null) {
iname = "iterator";
}
} else if (cf.isArray()) {
String ptype = prop.getTypeName();
itype = ptype.substring(0, ptype.length()-2);
}
// check binding direction(s)
BindingDefinition bdef = contain.getBindingRoot();
boolean isdoub =
"long".equals(itype) || "double".equals(itype);
if (bdef.isInput()) {
// define strategy for adding items to collection
if (aname != null) {
ClassItem meth = cf.getBestMethod(aname,
null, new String[] { itype });
if (meth == null) {
ctx.throwStartTagException
("Add method " + aname +
" not found in collection type " +
cf.getName());
}
boolean hasval =
!"void".equals(meth.getTypeName());
store = new NestedCollection.AddStore(meth,
isdoub, hasval);
} else if (stname != null) {
ClassItem meth = cf.getBestMethod(stname,
null, new String[] { "int", itype });
if (meth == null) {
ctx.throwStartTagException
("Indexed store method " + stname +
" not found in collection type " +
cf.getName());
}
boolean hasval =
!"void".equals(meth.getTypeName());
store = new NestedCollection.IndexedStore(meth,
isdoub, hasval);
} else if (cf.isArray()) {
store = new NestedCollection.ArrayStore(itype,
isdoub);
} else {
ctx.throwStartTagException
("Unknown collection " +
"type with no add or store method defined");
}
}
if (bdef.isOutput()) {
// define strategy for loading items from collection
if (lname != null) {
ClassItem smeth = cf.getMethod(szname, "()I");
if (smeth == null) {
ctx.throwStartTagException
("Size method " + szname +
" not found in collection type " +
cf.getName());
}
ClassItem lmeth = cf.getBestMethod(lname,
itype, new String[] { "int" });
if (lmeth == null) {
ctx.throwStartTagException
("Load method " + lname +
" not found in collection type " +
cf.getName());
}
load = new NestedCollection.
IndexedLoad(smeth, isdoub, lmeth);
} else if (iname != null) {
String mname = "hasNext";
String nname = "next";
ClassItem meth = cf.getMethod(iname,
"()Ljava/util/Iterator;");
if (meth == null) {
mname = "hasMoreElements";
nname = "nextElement";
meth = cf.getMethod(iname,
"()Ljava/util/Enumeration;");
if (meth == null) {
ctx.throwStartTagException
("Iterator method " + iname +
" not found in collection type " +
cf.getName());
}
}
load = new NestedCollection.
IteratorLoad(meth, isdoub,
"java.util.Iterator." + mname,
"java.util.Iterator." + nname);
} else if (cf.isArray()) {
load = new NestedCollection.ArrayLoad(itype,
isdoub);
} else {
ctx.throwStartTagException
("Unknown collection " +
"type with no load method defined");
}
}
}
// unmarshal basics of nested structure
NestedBase nest;
boolean ordered = ctx.attributeBoolean(URI_ATTRIBUTES,
COMMON_ORDERED, true);
boolean flex = ctx.attributeBoolean(URI_ATTRIBUTES,
COMMON_FLEXIBLE, false);
boolean nillable = ctx.attributeBoolean(URI_ATTRIBUTES,
COMMON_NILLABLE, false);
if (nillable) {
contain.getBindingRoot().setSchemaInstanceUsed();
}
if (coll) {
// create collection definition
nest = new NestedCollection(contain, icobj,
ordered, opt, flex, itype, load, store);
nest.unmarshal(ctx);
ctx.parsePastStartTag(URI_ELEMENTS,
COLLECTION_ELEMENT);
} else {
// create structure definition
boolean choice = ctx.attributeBoolean(URI_ATTRIBUTES,
COMMON_CHOICE, false);
boolean dupl = ctx.attributeBoolean(URI_ATTRIBUTES,
COMMON_DUPLICATES, false);
nest = new NestedStructure(contain, icobj,
ordered, choice, flex, false, hasobj, dupl);
nest.unmarshal(ctx);
ctx.parsePastStartTag(URI_ELEMENTS,
STRUCTURE_ELEMENT);
}
// unmarshal child bindings with optional label
String ctype = (itype == null) ? "java.lang.Object" : itype;
unmarshalFormats(ctx, nest.getDefinitionContext());
unmarshalMappings(ctx, contain, null, uord);
unmarshalStructureChildren(ctx, nest, icobj,
coll | (implic && !hasobj), ctype);
if (top == null) {
top = nest;
}
// special check for structure wrapping value
boolean impstruct = false;
boolean childs = nest.hasContent();
if (implic && !coll && childs) {
ArrayList contents = nest.getContents();
impstruct = true;
for (int i = 0; i < contents.size(); i++) {
if (!(contents.get(i) instanceof ValueChild)) {
impstruct = false;
break;
} else {
ValueChild vchild = (ValueChild)contents.get(i);
if (!vchild.isImplicit()) {
impstruct = false;
break;
}
}
}
}
if (impstruct) {
comp = nest;
nest.setObjectContext(cobj);
if (name != null) {
comp = new ElementWrapper(defc, name, comp, nillable);
if (bind != null && implic) {
if (!hasprop) {
((ElementWrapper)comp).setDirect(true);
ArrayList contents = nest.getContents();
impstruct = true;
for (int i = 0; i < contents.size(); i++) {
if (contents.get(i) instanceof ValueChild) {
ValueChild vchild = (ValueChild)contents.get(i);
vchild.switchProperty();
}
}
}
prop.setOptional(false);
}
}
} else {
// check for children defined
boolean addref = false;
if (!childs) {
if (coll) {
// add mapping as only child
if (ctype.equals("java.lang.Object")) {
nest.addComponent
(new DirectGeneric(nest, null));
} else {
nest.addComponent(new MappingReference(contain,
new PropertyDefinition(ctype, cobj, false),
ctype, null, null, icobj, null, true, false));
}
childs = true;
} else if (name != null) {
// must be abstract mappping reference, create child
addref = true;
}
}
// handle nested children
comp = top;
if (childs || addref) {
// define component property wrapping object binding
boolean optprop = hasprop && prop.isOptional();
if (bind != null) {
boolean skip = name != null && optprop;
comp = new ComponentProperty(prop, comp, skip);
bind.setWrappedComponent(nest);
}
// create reference to mapping as special case
// this allows structure with name but no children to
// use abstract mapping
if (addref) {
PropertyDefinition thisprop =
new PropertyDefinition(bind, false);
nest.addComponent(new MappingReference
(nest, thisprop, comp.getType(), null, null,
icobj, null, false, false));
}
if (name != null) {
comp = new ElementWrapper(defc, name, comp,
nillable);
if (bind != null && implic) {
if (!hasprop) {
((ElementWrapper)comp).setDirect(true);
}
prop.setOptional(false);
}
if (optprop) {
((ElementWrapper)comp).setOptionalNormal(true);
boolean isobj = bind != null;
((ElementWrapper)comp).
setStructureObject(isobj);
((ElementWrapper)comp).setDirect(isobj);
comp = new OptionalStructureWrapper(comp, prop,
isobj);
prop.setOptional(false);
} else if (opt && !implic) {
((ElementWrapper)comp).setOptionalNormal(true);
comp = new OptionalStructureWrapper(comp, prop,
false);
prop.setOptional(false);
}
}
} else {
// treat as mapping, with either type or generic
String type = prop.getTypeName();
if (prop.equals("java.lang.Object")) {
comp = new ComponentProperty(prop, new
DirectGeneric(contain, null), false);
} else {
comp = new MappingReference(contain, prop, type,
null, null, icobj, name, false, false);
}
}
}
// set object binding as definition for label
if (label != null) {
defc.addNamedStructure(label, top);
}
}
}
} else {
// structure with no separate object, verify no forbidden attributes
if (isObjectBinding(ctx)) {
ctx.throwStartTagException("Object attributes not " +
"allowed without property definition");
} else if (isDirectObject(ctx)) {
ctx.throwStartTagException("Marshaller and unmarshaller not " +
"allowed without property definition");
}
// check for reference to structure defined elsewhere
if (mapping) {
// handle "this" reference as anonymous property
PropertyDefinition prop = new PropertyDefinition(cobj, opt);
// handle reference to defined mapping
comp = unmarshalMappingRef(ctx, contain, cobj, prop, name);
implic = true;
} else if (ctx.hasAttribute(URI_ATTRIBUTES, COMMON_USING)) {
// make sure forbidden attribute not used
if (ctx.hasAttribute(URI_ATTRIBUTES, COMMON_ORDERED)) {
ctx.throwStartTagException(COMMON_ORDERED + " attribute " +
" not allowed with " + COMMON_USING + " attribute");
}
// validate and configure reference to structure in context
comp = unmarshalStructureRef(ctx, contain, name, null, cobj);
} else {
// unmarshal children as nested structure
boolean ordered = ctx.attributeBoolean(URI_ATTRIBUTES,
COMMON_ORDERED, true);
boolean choice = ctx.attributeBoolean(URI_ATTRIBUTES,
COMMON_CHOICE, false);
boolean flex = ctx.attributeBoolean(URI_ATTRIBUTES,
COMMON_FLEXIBLE, false);
boolean dupl = ctx.attributeBoolean(URI_ATTRIBUTES,
COMMON_DUPLICATES, false);
NestedStructure nest = new NestedStructure(contain, cobj,
ordered, choice, flex, false, hasprop, dupl);
nest.unmarshal(ctx);
// unmarshal child bindings with optional label
String label = ctx.attributeText(URI_ATTRIBUTES,
COMMON_LABEL, null);
ctx.parsePastStartTag(URI_ELEMENTS, STRUCTURE_ELEMENT);
unmarshalFormats(ctx, nest.getDefinitionContext());
unmarshalMappings(ctx, contain, null, uord);
unmarshalStructureChildren(ctx, nest, cobj, false,
"java.lang.Object");
// check for children defined
DefinitionContext defc = contain.getDefinitionContext();
if (nest.hasContent()) {
// build structure to access children or with elment wrapper
if (name == null) {
comp = nest;
} else {
comp = new ElementWrapper(defc, name, nest, false);
if (opt) {
((ElementWrapper)comp).setOptionalNormal(true);
((ElementWrapper)comp).setStructureObject(true);
}
}
if (label != null) {
defc.addNamedStructure(label, nest);
}
} else {
// make sure there's a name defined
if (name == null) {
ctx.throwException
("Property, name, or child component required");
}
// treat as throwaway portion of document
comp = new ElementWrapper(defc, name, null, false);
if (opt) {
((ElementWrapper)comp).setOptionalIgnored(true);
}
}
}
}
// finish by parsing past end tag
ctx.parsePastEndTag(URI_ELEMENTS,
coll ? COLLECTION_ELEMENT : STRUCTURE_ELEMENT);
return comp;
}
/**
* Unmarshal mapping definition. This handles all combinations of attributes
* on the start tag, generating the appropriate structure of nested
* components and other classes to represent the binding information within
* the current element. This must be called with the parse positioned at the
* start tag of the element to be unmarshalled.
*
* @param ctx unmarshalling context information
* @param parent containing binding definition structure
* @param nss extra namespaces to be included in this mapping definition
* (may be null)
* @param uord container is unordered structure flag
* @return mapping definition constructed from binding
* @throws JiBXException if error in unmarshalling
*/
public static IMapping unmarshalMapping(UnmarshallingContext ctx,
IContainer parent, ArrayList nss, boolean uord) throws JiBXException {
// first check for an abstract mapping
boolean abs = ctx.attributeBoolean(URI_ATTRIBUTES,
MAPPING_ABSTRACT, false);
String type = ctx.attributeText(URI_ATTRIBUTES, MAPPING_CLASS);
// get name definition if supplied
NameDefinition name = null;
if (isNamePresent(ctx)) {
name = unmarshalName(ctx, false);
}
// get type name information
String text = ctx.attributeText(URI_ATTRIBUTES, MAPPING_TYPENAME, null);
String tname = null;
if (text != null) {
tname = QName.deserialize(text, ctx).toString();
}
// check if using direct object marshalling and unmarshalling
IMapping mapping;
if (isDirectObject(ctx)) {
// check for definition context needed
DefinitionContext defc = null;
if (nss != null && nss.size() > 0) {
// add all outer namespaces to context
defc = new DefinitionContext(parent);
if (nss != null && nss.size() > 0) {
for (int j = 0; j < nss.size(); j++) {
defc.addNamespace((NamespaceDefinition)nss.get(j));
}
}
}
// validate and configure direct marshalling and unmarshalling
int slot = parent.getBindingRoot().getMappedClassIndex(type);
mapping = new MappingDirect(parent, type, tname,
unmarshalDirectObj(ctx, type, parent, defc, slot, name), abs);
} else {
// not direct mapping, check for missing required name
if (!abs && name == null) {
ctx.throwStartTagException("Non-abstract mapping must define " +
"an element name");
}
// check for optional definitions
String label = ctx.attributeText(URI_ATTRIBUTES,
COMMON_LABEL, null);
// create definition context for namespaces and formats
String base = ctx.attributeText(URI_ATTRIBUTES,
MAPPING_EXTENDS, null);
ObjectBinding bind = unmarshalObjectBinding(ctx, null,
parent, type);
boolean ordered = ctx.attributeBoolean(URI_ATTRIBUTES,
COMMON_ORDERED, true);
boolean choice = ctx.attributeBoolean(URI_ATTRIBUTES,
COMMON_CHOICE, false);
boolean flex = ctx.attributeBoolean(URI_ATTRIBUTES,
COMMON_FLEXIBLE, false);
boolean nillable = ctx.attributeBoolean(URI_ATTRIBUTES,
COMMON_NILLABLE, false);
if (nillable) {
parent.getBindingRoot().setSchemaInstanceUsed();
}
boolean dupl = ctx.attributeBoolean(URI_ATTRIBUTES,
COMMON_DUPLICATES, false);
NestedStructure nest = new NestedStructure(parent, bind,
ordered, choice, flex, true, true, dupl);
nest.unmarshal(ctx);
// add all outer namespaces to context
DefinitionContext defc = nest.getDefinitionContext();
if (nss != null && nss.size() > 0) {
for (int j = 0; j < nss.size(); j++) {
defc.addNamespace((NamespaceDefinition)nss.get(j));
}
}
// unmarshal all contained binding information
ctx.parsePastStartTag(URI_ELEMENTS, MAPPING_ELEMENT);
unmarshalNamespaces(ctx, nest.getDefinitionContext());
unmarshalFormats(ctx, nest.getDefinitionContext());
unmarshalMappings(ctx, nest, null, uord);
unmarshalStructureChildren(ctx, nest, bind, false,
"java.lang.Object");
// validate and configure actual binding definition
bind.setWrappedComponent(nest);
mapping = new MappingDefinition(parent, nest.getDefinitionContext(),
type, name, tname, abs, base, bind, nillable);
// set label if defined
if (label != null) {
defc.addNamedStructure(label, bind);
}
}
// finish by adding mapping and parsing past end tag
parent.getDefinitionContext().addMapping(mapping);
ctx.parsePastEndTag(URI_ELEMENTS, MAPPING_ELEMENT);
return mapping;
}
/**
* Unmarshal included binding. This handles the actual include element along
* with the actual included binding. The current implementation allows for
* nested includes, but requires that all the included bindings use
* compatible settings for the attributes of the root element, and only
* allows mapping elements as children of the included bindings (no
* namespace or format elements).
*
* @param ctx unmarshalling context information
* @param bdef binding defintion at root of includes
* @param root base URL for binding, or null if unknown
* @param nslist list of namespaces defined
* @param paths set of binding paths processed
* @throws JiBXException if error in unmarshalling
*/
public static void unmarshalInclude(UnmarshallingContext ctx,
BindingDefinition bdef, URL root, ArrayList nslist, HashSet paths)
throws JiBXException {
// make sure path hasn't already been processed
ctx.parseToStartTag(URI_ELEMENTS, INCLUDE_ELEMENT);
String path = ctx.attributeText(URI_ATTRIBUTES, INCLUDE_PATH);
URL url;
try {
if (root == null) {
url = new URL(path);
} else {
url = new URL(root, path);
}
} catch (MalformedURLException e) {
throw new JiBXException("Unable to handle include path " + path, e);
}
String fpath = url.toExternalForm();
if (paths.add(fpath)) {
try {
// access the included binding as input stream
UnmarshallingContext ictx = new UnmarshallingContext();
ictx.setDocument(url.openStream(), null);
// unmarshal namespaces (to apply to these mappings, only)
ictx.parseToStartTag(URI_ELEMENTS, BINDING_ELEMENT);
ictx.parsePastStartTag(URI_ELEMENTS, BINDING_ELEMENT);
ArrayList nss = new ArrayList(nslist);
while (ictx.isAt(URI_ELEMENTS, NAMESPACE_ELEMENT)) {
nss.add(unmarshalNamespace(ictx));
}
// process any format definitions (for global context)
unmarshalFormats(ictx, bdef.getDefinitionContext());
// check for nested includes
while (ictx.isAt(URI_ELEMENTS, INCLUDE_ELEMENT)) {
unmarshalInclude(ictx, bdef, url, nss, paths);
}
// process all mappings defined in included binding
unmarshalMappings(ictx, bdef, nss, false);
} catch (IOException e) {
throw new JiBXException
("Error accessing included binding with path " + path, e);
}
}
// finish by skipping past end of tag in main binding
ctx.parsePastEndTag(URI_ELEMENTS, INCLUDE_ELEMENT);
}
/**
* Unmarshal binding definition. This handles the entire binding definition
* document.
*
* @param ctx unmarshalling context information
* @param name default name for binding
* @param root base URL for binding, or null if unknown
* @throws JiBXException if error in unmarshalling
*/
public static BindingDefinition unmarshalBindingDefinition
(UnmarshallingContext ctx, String name, URL root)
throws JiBXException {
// start by reading optional binding name
ctx.parseToStartTag(URI_ELEMENTS, BINDING_ELEMENT);
name = ctx.attributeText(URI_ATTRIBUTES, BINDING_NAME, name);
// set the binding direction flags
int dir = ctx.attributeEnumeration(URI_ATTRIBUTES, BINDING_DIRECTION,
BINDINGDIR_NAMES, BINDINGDIR_NUMS, DIRECTION_BOTH);
boolean ibind = dir == DIRECTION_BOTH || dir == DIRECTION_INPUT;
boolean obind = dir == DIRECTION_BOTH || dir == DIRECTION_OUTPUT;
// read other attribute values
String tpack = ctx.attributeText(URI_ATTRIBUTES, BINDING_PACKAGE, null);
boolean glob = ctx.attributeBoolean(URI_ATTRIBUTES,
BINDING_GLOBALID, true);
boolean forward = ctx.attributeBoolean(URI_ATTRIBUTES,
BINDING_FORWARDS, true);
boolean track = ctx.attributeBoolean(URI_ATTRIBUTES,
BINDING_TRACKING, false);
boolean force = ctx.attributeBoolean(URI_ATTRIBUTES,
BINDING_FORCE, false);
// create actual binding instance
BindingDefinition bdef = new BindingDefinition(name, ibind, obind, tpack,
glob, forward, track, force);
bdef.unmarshal(ctx);
// unmarshal namespaces and formats defined under root
ctx.parsePastStartTag(URI_ELEMENTS, BINDING_ELEMENT);
ArrayList nss = new ArrayList();
while (ctx.isAt(URI_ELEMENTS, NAMESPACE_ELEMENT)) {
nss.add(unmarshalNamespace(ctx));
}
unmarshalFormats(ctx, bdef.getDefinitionContext());
// process any included binding definitions
HashSet paths = new HashSet();
if (root != null) {
paths.add(root.toExternalForm());
}
while (ctx.isAt(URI_ELEMENTS, INCLUDE_ELEMENT)) {
unmarshalInclude(ctx, bdef, root, nss, paths);
}
// finish with common handling for elements which can be nested
unmarshalMappings(ctx, bdef, nss, false);
ctx.parsePastEndTag(URI_ELEMENTS, BINDING_ELEMENT);
return bdef;
}
/**
* Base class for containers. This just handles unmarshalling and checking
* the values of attributes used by all containers. The container class
* should set the appropriate default values for all these attributes in its
* constructor, using -1 (for int values) and
* null (for String values) if the default is to
* simply use setting inherited from a containing component. The binding
* definition root object must always define actual values as the defaults,
* since otherwise the code will fall off the end of the chain of ancestors.
*/
/*package*/ static class ContainerBase {
/** Containing binding component. */
protected IContainer m_container;
/** Default style for value expression. */
protected int m_styleDefault;
/** Auto-link style for default mappings. */
protected int m_autoLink;
/** Access level for default mappings. */
protected int m_accessLevel;
/** Prefix text to be stripped from names. */
protected String m_stripPrefix;
/** Suffix text to be stripped from names. */
protected String m_stripSuffix;
/** Style used for generating element or attribute names. */
protected int m_nameStyle;
/**
* Constructor.
*
* @param parent containing binding definition context
*/
public ContainerBase(IContainer parent) {
m_container = parent;
}
/**
* Unmarshal common container attributes.
*
* @param ctx unmarshalling context information
* @throws JiBXException if error in unmarshalling
*/
public void unmarshal(UnmarshallingContext ctx) throws JiBXException {
m_styleDefault = ctx.attributeEnumeration(URI_ATTRIBUTES,
COMMON_STYLE, CONTAINING_STYLE_NAMES, CONTAINING_STYLE_NUMS,
m_styleDefault);
m_autoLink = ctx.attributeEnumeration(URI_ATTRIBUTES,
COMMON_AUTOLINK, AUTO_LINK_NAMES, AUTO_LINK_NUMS, m_autoLink);
m_accessLevel = ctx.attributeEnumeration(URI_ATTRIBUTES,
COMMON_ACCESSLEVEL, ACCESS_LEVEL_NAMES, ACCESS_LEVEL_NUMS,
m_accessLevel);
m_stripPrefix = ctx.attributeText(URI_ATTRIBUTES,
COMMON_STRIPPREFIX, m_stripPrefix);
m_stripSuffix = ctx.attributeText(URI_ATTRIBUTES,
COMMON_STRIPSUFFIX, m_stripSuffix);
m_nameStyle = ctx.attributeEnumeration(URI_ATTRIBUTES,
COMMON_NAMESTYLE, NAME_GENERATE_NAMES, NAME_GENERATE_NUMS,
m_nameStyle);
}
//
// IContainer interface method definitions (partial list)
public int getStyleDefault() {
if (m_styleDefault >= 0) {
return m_styleDefault;
} else {
return m_container.getStyleDefault();
}
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/def/BindingDefinition.java 0000644 0001750 0001750 00000141200 11005476404 026110 0 ustar moeller moeller /*
Copyright (c) 2003-2008, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;
import org.apache.bcel.Constants;
import org.apache.bcel.generic.ArrayType;
import org.apache.bcel.generic.Type;
import org.jibx.binding.classes.BoundClass;
import org.jibx.binding.classes.BranchWrapper;
import org.jibx.binding.classes.ClassCache;
import org.jibx.binding.classes.ClassFile;
import org.jibx.binding.classes.ClassItem;
import org.jibx.binding.classes.ExceptionMethodBuilder;
import org.jibx.binding.classes.MethodBuilder;
import org.jibx.binding.classes.MungedClass;
import org.jibx.binding.util.ArrayMap;
import org.jibx.binding.util.IntegerCache;
import org.jibx.runtime.IBindingFactory;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.QName;
/**
* Binding definition. This is the root of the object graph for a binding.
*
* @author Dennis M. Sosnoski
*/
public class BindingDefinition extends BindingBuilder.ContainerBase
implements IContainer
{
//
// Miscellaneous static data.
private static final String EXPAND_NAMESPACES_SIGNATURE = "(Ljava/lang/String;[Ljava/lang/String;)[Ljava/lang/String;";
private static final String EXPAND_NAMESPACES_METHOD = "org.jibx.runtime.impl.RuntimeSupport.expandNamespaces";
/** Current distribution file name. This is filled in by the Ant build
process to match the current distribution. */
public static final String CURRENT_VERSION_NAME = "@distrib@";
/** Prefix used in all code generation for methods and classes. */
public static final String GENERATE_PREFIX = "JiBX_";
/** Default prefix for automatic ID generation. */
/*package*/ static final String DEFAULT_AUTOPREFIX = "id_";
/** Minimum size to use map for index from type name. */
private static final int TYPEMAP_MINIMUM_SIZE = 5;
/** Table of defined bindings. */
private static ArrayList s_bindings;
/** Classes included in any binding. */
private static ArrayMap s_mappedClasses;
//
// Static instances of predefined conversions.
private static StringConversion s_byteConversion =
new PrimitiveStringConversion(Byte.TYPE, new Byte((byte)0), "B",
"serializeByte", "parseByte", "attributeByte", "parseElementByte");
private static StringConversion s_charConversion =
new PrimitiveStringConversion(Character.TYPE, new Character((char)0),
"C", "serializeChar", "parseChar", "attributeChar", "parseElementChar");
private static StringConversion s_doubleConversion =
new PrimitiveStringConversion(Double.TYPE, new Double(0.0d), "D",
"serializeDouble", "parseDouble", "attributeDouble",
"parseElementDouble");
private static StringConversion s_floatConversion =
new PrimitiveStringConversion(Float.TYPE, new Float(0.0f), "F",
"serializeFloat", "parseFloat", "attributeFloat", "parseElementFloat");
private static StringConversion s_intConversion =
new PrimitiveStringConversion(Integer.TYPE, new Integer(0), "I",
"serializeInt", "parseInt", "attributeInt", "parseElementInt");
private static StringConversion s_longConversion =
new PrimitiveStringConversion(Long.TYPE, new Long(0L), "J",
"serializeLong", "parseLong", "attributeLong", "parseElementLong");
private static StringConversion s_shortConversion =
new PrimitiveStringConversion(Short.TYPE, new Short((short)0), "S",
"serializeShort", "parseShort", "attributeShort", "parseElementShort");
private static StringConversion s_booleanConversion =
new PrimitiveStringConversion(Boolean.TYPE, Boolean.FALSE, "Z",
"serializeBoolean", "parseBoolean", "attributeBoolean",
"parseElementBoolean");
private static StringConversion s_dateConversion =
new ObjectStringConversion(null,
"org.jibx.runtime.Utility.serializeDateTime",
"org.jibx.runtime.Utility.deserializeDateTime", "java.util.Date");
//#!j2me{
private static StringConversion s_sqlDateConversion =
new ObjectStringConversion(null,
"org.jibx.runtime.Utility.serializeSqlDate",
"org.jibx.runtime.Utility.deserializeSqlDate", "java.sql.Date");
private static StringConversion s_sqlTimeConversion =
new ObjectStringConversion(null,
"org.jibx.runtime.Utility.serializeSqlTime",
"org.jibx.runtime.Utility.deserializeSqlTime", "java.sql.Time");
private static StringConversion s_timestampConversion =
new ObjectStringConversion(null,
"org.jibx.runtime.Utility.serializeTimestamp",
"org.jibx.runtime.Utility.deserializeTimestamp", "java.sql.Timestamp");
//#j2me}
public static StringConversion s_base64Conversion =
new ObjectStringConversion(null,
"org.jibx.runtime.Utility.serializeBase64",
"org.jibx.runtime.Utility.deserializeBase64", "byte[]");
public static StringConversion s_stringConversion =
new ObjectStringConversion(null, null, null, "java.lang.String");
public static StringConversion s_objectConversion =
new ObjectStringConversion(null, null, null, "java.lang.Object");
//
// Constants for code generation
private static final String FACTORY_SUFFIX = "Factory";
private static final String FACTORY_INTERFACE =
"org.jibx.runtime.IBindingFactory";
private static final String[] FACTORY_INTERFACES =
{
FACTORY_INTERFACE
};
private static final String FACTORY_INSTNAME = "m_inst";
private static final int FACTORY_INSTACCESS =
Constants.ACC_PRIVATE | Constants.ACC_STATIC;
private static final String MARSHALLER_ARRAYNAME = "m_marshallers";
private static final String UNMARSHALLER_ARRAYNAME = "m_unmarshallers";
private static final String STRING_ARRAYTYPE = "java.lang.String[]";
private static final String CLASSES_ARRAYNAME = "m_classes";
private static final String URIS_ARRAYNAME = "m_uris";
private static final String PREFIXES_ARRAYNAME = "m_prefixes";
private static final String GNAMES_ARRAYNAME = "m_globalNames";
private static final String GURIS_ARRAYNAME = "m_globalUris";
private static final String IDNAMES_ARRAYNAME = "m_idNames";
private static final String TYPEMAP_NAME = "m_typeMap";
private static final String CREATEMARSHAL_METHODNAME =
"createMarshallingContext";
private static final String MARSHALCONTEXT_INTERFACE =
"org.jibx.runtime.IMarshallingContext";
private static final String MARSHALCONTEXT_IMPLEMENTATION =
"org.jibx.runtime.impl.MarshallingContext";
private static final String MARSHALCONTEXTINIT_SIGNATURE =
"([Ljava/lang/String;[Ljava/lang/String;[Ljava/lang/String;" +
"Lorg/jibx/runtime/IBindingFactory;)V";
private static final String CREATEUNMARSHAL_METHODNAME =
"createUnmarshallingContext";
private static final String UNMARSHALCONTEXT_INTERFACE =
"org.jibx.runtime.IUnmarshallingContext";
private static final String UNMARSHALCONTEXT_IMPLEMENTATION =
"org.jibx.runtime.impl.UnmarshallingContext";
private static final String UNMARSHALCONTEXTINIT_SIGNATURE =
"(I[Ljava/lang/String;[Ljava/lang/String;[Ljava/lang/String;" +
"[Ljava/lang/String;Lorg/jibx/runtime/IBindingFactory;)V";
private static final String GETINST_METHODNAME = "getInstance";
private static final String UNSUPPORTED_EXCEPTION_CLASS =
"java.lang.UnsupportedOperationException";
private static final String GETVERSION_METHODNAME = "getCompilerVersion";
private static final String GETDISTRIB_METHODNAME =
"getCompilerDistribution";
private static final String GETDEFINEDNSS_METHODNAME = "getNamespaces";
private static final String GETDEFINEDPREFS_METHODNAME = "getPrefixes";
private static final String GETCLASSES_METHODNAME = "getMappedClasses";
private static final String GETELEMENTNSS_METHODNAME =
"getElementNamespaces";
private static final String GETELEMENTNAMES_METHODNAME = "getElementNames";
private static final String GETTYPEINDEX_METHODNAME = "getTypeIndex";
private static final String STRINGINT_MAPTYPE =
"org.jibx.runtime.impl.StringIntHashMap";
private static final String STRINGINTINIT_SIGNATURE = "(I)V";
private static final String STRINGINTADD_METHOD =
"org.jibx.runtime.impl.StringIntHashMap.add";
private static final String STRINGINTADD_SIGNATURE =
"(Ljava/lang/String;I)I";
private static final String STRINGINTGET_METHOD =
"org.jibx.runtime.impl.StringIntHashMap.get";
private static final String STRINGINTGET_SIGNATURE =
"(Ljava/lang/String;)I";
private static final int MAX_STRING_LENGTH = 0x7FFF;
private static final String SPLIT_NAMES_METHOD =
"org.jibx.runtime.impl.RuntimeSupport.splitNames";
private static final String SPLIT_CLASS_NAMES_SIGNATURE =
"(ILjava/lang/String;)[Ljava/lang/String;";
private static final String SPLIT_CLASS_NAMES_METHOD =
"org.jibx.runtime.impl.RuntimeSupport.splitClassNames";
//
// Actual instance data
/** Binding name. */
private final String m_name;
/** Index number of this binding. */
private final int m_index;
/** Input binding flag. */
private final boolean m_isInput;
/** Output binding flag. */
private final boolean m_isOutput;
/** Use global ID values flag. */
private final boolean m_isIdGlobal;
/** Support forward references to IDs flag. */
private final boolean m_isForwards;
/** Generate souce tracking interface flag. */
private final boolean m_isTrackSource;
/** Generate marshaller/unmarshaller classes for top-level non-base abstract
mappings flag. */
private final boolean m_isForceClasses;
/** Add default constructors where needed flag. */
private boolean m_isAddConstructors;
/** Package for generated context factory. */
private String m_targetPackage;
/** File root for generated context factory. */
private File m_targetRoot;
/** Classes using unique (per class) identifiers. This is null
and unused when using global ID values. */
private ArrayMap m_uniqueIds;
/** Namespaces URIs included in binding. */
private ArrayMap m_namespaceUris;
/** Original prefixes for namespaces. */
private ArrayList m_namespacePrefixes;
/** Outer definition context with default definitions. */
private DefinitionContext m_outerContext;
/** Inner definition context constructed for binding. */
private DefinitionContext m_activeContext;
/** Flag for done assigning indexes to mapped classes. */
private boolean m_isMappedDone;
/** Flag for schema instance namespace used in binding. */
private boolean m_isSchemaInstanceUsed;
/** Next index number for marshaller/unmarshaller slots used in-line. */
private int m_mumIndex;
/** Classes handled by in-line marshaller/unmarshaller references. */
private ArrayList m_extraClasses;
/** Marshaller classes used in-line. */
private ArrayList m_extraMarshallers;
/** Unmarshaller classes used in-line. */
private ArrayList m_extraUnmarshallers;
/**
* Constructor. Sets all defaults, including the default name provided, and
* initializes the definition context for the outermost level of the
* binding.
*
* @param name binding name
* @param ibind input binding flag
* @param obind output binding flag
* @param tpack target package
* @param glob global IDs flag
* @param forward support forward referenced IDs flag
* @param source add source tracking for unmarshalled objects flag
* @param force create marshaller/unmarshaller classes for top-level
* non-base mappings
* @throws JiBXException if error in transformation
*/
public BindingDefinition(String name, boolean ibind, boolean obind,
String tpack, boolean glob, boolean forward, boolean source,
boolean force) throws JiBXException {
// handle basic initialization
super(null);
m_name = name;
m_isInput = ibind;
m_isOutput = obind;
m_targetPackage = tpack;
m_isIdGlobal = glob;
m_isForwards = forward;
m_isTrackSource = source;
m_isForceClasses = force;
// set base class defaults
m_styleDefault = ValueChild.ELEMENT_STYLE;
m_autoLink = BindingBuilder.LINK_FIELDS;
m_accessLevel = BindingBuilder.ACC_PRIVATE;
m_nameStyle = BindingBuilder.NAME_HYPHENS;
// initialize the contexts
m_outerContext = m_activeContext = new DefinitionContext(this);
m_activeContext = new DefinitionContext(this);
m_namespaceUris = new ArrayMap();
m_namespaceUris.findOrAdd("");
m_namespacePrefixes = new ArrayList();
m_namespacePrefixes.add("");
m_outerContext.addNamespace(NamespaceDefinition.buildNamespace
("http://www.w3.org/XML/1998/namespace", "xml"));
getNamespaceUriIndex
("http://www.w3.org/2001/XMLSchema-instance", "xsi");
// build the default converters in outer context
m_outerContext.setDefaultConversion(new QName("byte.default"),
s_byteConversion);
m_outerContext.setDefaultConversion(new QName("char.default"),
s_charConversion);
StringConversion schar = s_charConversion.derive("char",
"org.jibx.runtime.Utility.serializeCharString",
"org.jibx.runtime.Utility.parseCharString", null);
m_outerContext.setNamedConversion(new QName("char.string"), schar);
m_outerContext.setDefaultConversion(new QName("double.default"),
s_doubleConversion);
m_outerContext.setDefaultConversion(new QName("float.default"),
s_floatConversion);
m_outerContext.setDefaultConversion(new QName("int.default"),
s_intConversion);
m_outerContext.setDefaultConversion(new QName("long.default"),
s_longConversion);
m_outerContext.setDefaultConversion(new QName("short.default"),
s_shortConversion);
m_outerContext.setDefaultConversion(new QName("boolean.default"),
s_booleanConversion);
m_outerContext.setDefaultConversion(new QName("Date.default"),
s_dateConversion);
//#!j2me{
m_outerContext.setDefaultConversion(new QName("SqlDate.default"),
s_sqlDateConversion);
m_outerContext.setDefaultConversion(new QName("SqlTime.default"),
s_sqlTimeConversion);
m_outerContext.setDefaultConversion(new QName("Timestamp.default"),
s_timestampConversion);
//#j2me}
m_outerContext.setDefaultConversion(new QName("byte-array.default"),
s_base64Conversion);
m_outerContext.setDefaultConversion(new QName("String.default"),
s_stringConversion);
m_outerContext.setDefaultConversion(new QName("Object.default"),
s_objectConversion);
// add this binding to list
m_index = s_bindings.size();
s_bindings.add(this);
}
/**
* Get class linked to binding element. Implementation of
* {@link org.jibx.binding.def.IContainer} interface, just returns
* null in this case.
*
* @return information for class linked by binding
*/
public BoundClass getBoundClass() {
return null;
}
/**
* Get default style for value expression. Implementation of
* {@link org.jibx.binding.def.IContainer} interface.
*
* @return default style type for values
*/
public int getStyleDefault() {
return m_styleDefault;
}
/**
* Set ID property. This parent binding component interface method should
* never be called for the binding definition, and will throw a runtime
* exception if it is called.
*
* @param child child defining the ID property
* @return false
*/
public boolean setIdChild(IComponent child) {
throw new IllegalStateException("Internal error - setIdChild for root");
}
/**
* Get default package used for code generation.
*
* @return default code generation package
*/
public String getDefaultPackage() {
return m_targetPackage;
}
/**
* Get root directory for default code generation package.
*
* @return root for default code generation
*/
public File getDefaultRoot() {
return m_targetRoot;
}
/**
* Set location for binding factory class generation.
*
* @param tpack target package for generated context factory
* @param root target root for generated context factory
*/
public void setFactoryLocation(String tpack, File root) {
m_targetPackage = tpack;
m_targetRoot = root;
}
/**
* Get index number of binding.
*
* @return index number for this binding definition
*/
public int getIndex() {
return m_index;
}
/**
* Check if binding is defined for unmarshalling.
*
* @return true if defined, false if not
*/
public boolean isInput() {
return m_isInput;
}
/**
* Check if binding is defined for marshalling.
*
* @return true if defined, false if not
*/
public boolean isOutput() {
return m_isOutput;
}
/**
* Check if global ids are used by binding.
*
* @return true if defined, false if not
*/
public boolean isIdGlobal() {
return m_isIdGlobal;
}
/**
* Check if forward ids are supported by unmarshalling binding.
*
* @return true if supported, false if not
*/
public boolean isForwards() {
return m_isForwards;
}
/**
* Check if source tracking is supported by unmarshalling binding.
*
* @return true if defined, false if not
*/
public boolean isTrackSource() {
return m_isTrackSource;
}
/**
* Check if default constructor generation is enabled.
*
* @return true if default constructor generation enabled,
* false if not
*/
public boolean isAddConstructors() {
return m_isAddConstructors;
}
/**
* Get prefix for method or class generation.
*
* @return prefix for names created by this binding
*/
public String getPrefix() {
return GENERATE_PREFIX + m_name;
}
/**
* Get index for mapped class from binding. If the class is not already
* included in any binding it is first added to the list of bound classes.
* All bindings use the same index numbers to allow easy lookup of the
* appropriate marshaller and unmarshaller within a particular binding, but
* this does mean that all bindings dealing with a common set of classes
* need to be compiled together. This uses the same sequence of values as
* the {@link #getMarshallerUnmarshallerIndex} method but differs in that
* the values returned by this method are unique per class. This method is
* intended for use with <mapping> definitions. It is an error to call
* this method after calling the {@link #getMarshallerUnmarshallerIndex}
* method.
*
* @param name fully qualified name of mapped class
* @return index number of class
*/
public int getMappedClassIndex(String name) {
if (m_isMappedDone) {
throw new IllegalStateException
("Internal error: Call out of sequence");
} else {
return s_mappedClasses.findOrAdd(name);
}
}
/**
* Get marshaller/unmarshaller slot index in binding. This uses the same
* sequence of values as the {@link #getMappedClassIndex} method but differs
* in that the same class may have more than one marshaller/unmarshaller
* slot defined. It's intended for user-defined marshallers/unmarshallers
* where use is specific to a particular context. After the slot has been
* assigned by this method, the {@link #setMarshallerUnmarshallerClasses}
* method must be used to set the actual class names.
*
* @param clas fully qualified name of class handled by
* marshaller/unmarshaller
* @return slot number for marshaller/unmarshaller
*/
public int getMarshallerUnmarshallerIndex(String clas) {
if (!m_isMappedDone) {
m_isMappedDone = true;
m_mumIndex = s_mappedClasses.size();
m_extraClasses = new ArrayList();
m_extraMarshallers = new ArrayList();
m_extraUnmarshallers = new ArrayList();
}
m_extraClasses.add(clas);
m_extraMarshallers.add(null);
m_extraUnmarshallers.add(null);
return m_mumIndex++;
}
/**
* Set marshaller and unmarshaller class names for slot.
*
* @param slot assigned marshaller/unmarshaller slot number
* @param mclas fully qualified name of marshaller class
* @param uclas fully qualified name of unmarshaller class
*/
public void setMarshallerUnmarshallerClasses(int slot, String mclas,
String uclas) {
int index = slot - s_mappedClasses.size();
m_extraMarshallers.set(index, mclas);
m_extraUnmarshallers.set(index, uclas);
}
/**
* Get index for ID'ed class from binding. If the class is not already
* included it is first added to the binding. If globally unique IDs are
* used this always returns 0.
*
* @param name fully qualified name of ID'ed class
* @return index number of class
*/
public int getIdClassIndex(String name) {
if (m_isIdGlobal) {
return 0;
} else {
if (m_uniqueIds == null) {
m_uniqueIds = new ArrayMap();
}
return m_uniqueIds.findOrAdd(name);
}
}
/**
* Get index for namespace URI in binding. If the URI is not already
* included it is first added to the binding. The empty namespace URI
* is always given index number 0.
*
* @param uri namespace URI to be included in binding
* @param prefix prefix used with namespace
* @return index number of namespace
*/
public int getNamespaceUriIndex(String uri, String prefix) {
int index = m_namespaceUris.findOrAdd(uri);
if (index > m_namespacePrefixes.size()) {
m_namespacePrefixes.add(prefix);
}
return index;
}
/**
* Set flag for schema instance namespace used in binding.
*/
public void setSchemaInstanceUsed() {
m_isSchemaInstanceUsed = true;
}
/**
* Build a class name blob from an array of class names. The returned string
* consists of compacted fully-qualified class names separated by '|'
* delimitor characters. If some number of package name levels are the same
* as the last name, these packages are replaced with simple '.' characters
* in the compacted name. null values are represented as empty
* names.
*
* @param names fully-qualified class names
* @return compacted name blob
*/
private static String buildClassNamesBlob(String[] names) {
StringBuffer buff = new StringBuffer();
String last = "";
for (int i = 0; i < names.length; i++) {
if (i > 0) {
buff.append('|');
}
String name = names[i];
if (name != null) {
int base = 0;
int scan = -1;
int limit = Math.min(last.lastIndexOf('.'), name.lastIndexOf('.'));
while (++scan <= limit) {
char chr = last.charAt(scan);
if (chr == name.charAt(scan)) {
if (chr == '.') {
buff.append('.');
base = scan + 1;
}
} else {
break;
}
}
buff.append(name.substring(base));
last = name;
}
}
return buff.toString();
}
/**
* Build a namespace index blob from an array of namespace URIs. The
* returned string consists of one character per namespace, giving the index
* of the namespace URI within the array of definitions, biased by +2 to
* avoid use of null characters (with +1 used for null values).
*
* @param uris table of namespaces defined in binding
* @param nss namespaces for index blob
* @return index blob
*/
private static String buildNamespaceIndexBlob(String[] uris, String[] nss) {
Map indexmap = new HashMap();
for (int i = 0; i < uris.length; i++) {
indexmap.put(uris[i], IntegerCache.getInteger(i+2));
}
StringBuffer buff = new StringBuffer(nss.length);
for (int i = 0; i < nss.length; i++) {
String uri = nss[i];
if (uri == null) {
buff.append((char)1);
} else {
buff.append((char)((Integer)indexmap.get(uri)).intValue());
}
}
return buff.toString();
}
/**
* Build a name blob from an array of names. The returned string consists of
* names separated by '|' delimitor characters. null values are
* represented as empty names.
*
* @param names names for blob
* @return name blob
*/
private static String buildNamesBlob(String[] names) {
StringBuffer buff = new StringBuffer();
for (int i = 0; i < names.length; i++) {
if (i > 0) {
buff.append('|');
}
if (names[i] != null) {
buff.append(names[i]);
}
}
return buff.toString();
}
/**
* Generate code to load a string value, which may be longer than the
* maximum string length. This either loads the string directly (if within
* the limit) or recreates it by concatenating two or more shorter strings.
*
* @param string
* @param mb
*/
private static void codegenString(String string, MethodBuilder mb) {
if (string.length() < MAX_STRING_LENGTH) {
mb.appendLoadConstant(string);
} else {
// build a StringBuffer, then loop loading each component constant
// string in turn and appending it; when all strings done, call
// StringBuffer.toString()
mb.appendCreateNew("java.lang.StringBuffer");
mb.appendDUP();
mb.appendLoadConstant(string.length());
mb.appendCallInit("java.lang.StringBuffer", "(I)V");
int base = 0;
while (base < string.length()) {
int end = Math.min(base + MAX_STRING_LENGTH, string.length());
mb.appendLoadConstant(string.substring(base, end));
mb.appendCallVirtual("java.lang.StringBuffer.append",
"(Ljava/lang/String;)Ljava/lang/StringBuffer;");
base = end;
}
mb.appendCallVirtual("java.lang.StringBuffer.toString",
"()Ljava/lang/String;");
}
}
/**
* Generate code. First sets linkages and executes code generation for
* each top-level mapping defined in this binding, which in turn propagates
* the code generation all the way down. Then generates the actual binding
* factory for this binding.
*
* TODO: handle unidirectional bindings properly
*
* @param verbose flag for verbose output
* @throws JiBXException if error in code generation
*/
public void generateCode(boolean verbose) throws JiBXException {
// check schema instance namespace usage
if (m_isSchemaInstanceUsed) {
NamespaceDefinition xsins = NamespaceDefinition.buildNamespace
("http://www.w3.org/2001/XMLSchema-instance", "xsi");
ArrayList mappings = m_activeContext.getMappings();
for (int i = 0; i < mappings.size(); i++) {
Object mapping = mappings.get(i);
if (mapping instanceof MappingDefinition) {
((MappingDefinition)mapping).addNamespace(xsins);
}
}
}
// handle basic linkage and child code generation
BoundClass.setModify(m_targetRoot, m_targetPackage);
m_activeContext.linkMappings();
m_activeContext.setLinkages();
m_activeContext.generateCode(verbose, m_isForceClasses);
// disabled because of potential recursion issues
/* if (verbose) {
System.out.println("After linking view of binding " + m_name + ':');
print();
} */
// build the binding factory class
String name;
if (m_targetPackage.length() == 0) {
name = getPrefix() + FACTORY_SUFFIX;
} else {
name = m_targetPackage + '.' + getPrefix() + FACTORY_SUFFIX;
}
ClassFile base = ClassCache.getClassFile("java.lang.Object");
ClassFile cf = new ClassFile(name, m_targetRoot, base,
Constants.ACC_PUBLIC, FACTORY_INTERFACES);
// add static field for instance and member fields for data
ClassItem inst = cf.addField(FACTORY_INTERFACE,
FACTORY_INSTNAME, FACTORY_INSTACCESS);
ClassItem marshs = cf.addPrivateField(STRING_ARRAYTYPE,
MARSHALLER_ARRAYNAME);
ClassItem umarshs = cf.addPrivateField(STRING_ARRAYTYPE,
UNMARSHALLER_ARRAYNAME);
ClassItem classes = cf.addPrivateField(STRING_ARRAYTYPE,
CLASSES_ARRAYNAME);
ClassItem uris = cf.addPrivateField(STRING_ARRAYTYPE, URIS_ARRAYNAME);
ClassItem prefs = cf.addPrivateField(STRING_ARRAYTYPE,
PREFIXES_ARRAYNAME);
ClassItem gnames = cf.addPrivateField(STRING_ARRAYTYPE,
GNAMES_ARRAYNAME);
ClassItem guris = cf.addPrivateField(STRING_ARRAYTYPE,
GURIS_ARRAYNAME);
ClassItem idnames = cf.addPrivateField(STRING_ARRAYTYPE,
IDNAMES_ARRAYNAME);
// add the private constructor method
MethodBuilder mb = new ExceptionMethodBuilder("",
Type.VOID, new Type[0], cf, Constants.ACC_PRIVATE);
// call the superclass constructor
mb.appendLoadLocal(0);
mb.appendCallInit("java.lang.Object", "()V");
// create and fill array of unmarshaller class names
int count = s_mappedClasses.size();
int mcnt = m_isMappedDone ? m_mumIndex : count;
if (m_isInput) {
String[] names = new String[mcnt];
for (int i = 0; i < count; i++) {
String cname = (String)s_mappedClasses.get(i);
IMapping map = m_activeContext.getMappingAtLevel(cname);
if (map != null && map.getUnmarshaller() != null) {
names[i] = map.getUnmarshaller().getName();
}
}
for (int i = count; i < mcnt; i++) {
names[i] = (String)m_extraUnmarshallers.get(i-count);
}
mb.appendLoadLocal(0);
mb.appendLoadConstant(mcnt);
codegenString(buildClassNamesBlob(names), mb);
mb.appendCallStatic(SPLIT_CLASS_NAMES_METHOD,
SPLIT_CLASS_NAMES_SIGNATURE);
mb.appendPutField(umarshs);
}
// create and fill array of marshaller class names
if (m_isOutput) {
String[] names = new String[mcnt];
for (int i = 0; i < count; i++) {
String cname = (String)s_mappedClasses.get(i);
IMapping map = m_activeContext.getMappingAtLevel(cname);
if (map != null && map.getMarshaller() != null) {
names[i] = map.getMarshaller().getName();
}
}
for (int i = count; i < mcnt; i++) {
names[i] = (String)m_extraMarshallers.get(i-count);
}
mb.appendLoadLocal(0);
mb.appendLoadConstant(mcnt);
codegenString(buildClassNamesBlob(names), mb);
mb.appendCallStatic(SPLIT_CLASS_NAMES_METHOD,
SPLIT_CLASS_NAMES_SIGNATURE);
mb.appendPutField(marshs);
}
// create and fill array of mapped class names
String[] names = new String[mcnt];
for (int i = 0; i < count; i++) {
names[i] = (String)s_mappedClasses.get(i);
}
for (int i = count; i < mcnt; i++) {
names[i] = (String)m_extraClasses.get(i-count);
}
mb.appendLoadLocal(0);
mb.appendLoadConstant(mcnt);
codegenString(buildClassNamesBlob(names), mb);
mb.appendCallStatic(SPLIT_CLASS_NAMES_METHOD,
SPLIT_CLASS_NAMES_SIGNATURE);
mb.appendPutField(classes);
// create and fill array of namespace URIs
String[] nsuris = new String[m_namespaceUris.size()];
mb.appendLoadLocal(0);
mb.appendLoadConstant(m_namespaceUris.size());
mb.appendCreateArray("java.lang.String");
for (int i = 0; i < m_namespaceUris.size(); i++) {
mb.appendDUP();
mb.appendLoadConstant(i);
String uri = (String)m_namespaceUris.get(i);
mb.appendLoadConstant(uri);
mb.appendAASTORE();
nsuris[i] = uri;
}
mb.appendPutField(uris);
// create and fill array of namespace prefixes
if (m_isOutput) {
mb.appendLoadLocal(0);
mb.appendLoadConstant(m_namespacePrefixes.size());
mb.appendCreateArray("java.lang.String");
for (int i = 0; i < m_namespacePrefixes.size(); i++) {
mb.appendDUP();
mb.appendLoadConstant(i);
mb.appendLoadConstant((String)m_namespacePrefixes.get(i));
mb.appendAASTORE();
}
mb.appendPutField(prefs);
}
// create and fill arrays of globally mapped element names and URIs
names = new String[count];
String[] namespaces = new String[count];
for (int i = 0; i < count; i++) {
String cname = (String)s_mappedClasses.get(i);
IMapping map = m_activeContext.getMappingAtLevel(cname);
if (map != null) {
NameDefinition ndef = map.getName();
if (ndef != null) {
names[i] = ndef.getName();
namespaces[i] = ndef.getNamespace();
}
}
}
mb.appendLoadLocal(0);
mb.appendLoadConstant(mcnt);
codegenString(buildNamesBlob(names), mb);
mb.appendCallStatic(SPLIT_NAMES_METHOD,
SPLIT_CLASS_NAMES_SIGNATURE);
mb.appendPutField(gnames);
mb.appendLoadLocal(0);
mb.appendLoadConstant(buildNamespaceIndexBlob(nsuris, namespaces));
mb.appendLoadLocal(0);
mb.appendGetField(uris);
mb.appendCallStatic(EXPAND_NAMESPACES_METHOD,
EXPAND_NAMESPACES_SIGNATURE);
mb.appendPutField(guris);
// create and fill array of class names with unique IDs (null if none)
mb.appendLoadLocal(0);
if (m_uniqueIds != null && m_uniqueIds.size() > 0) {
mb.appendLoadConstant(m_uniqueIds.size());
mb.appendCreateArray("java.lang.String");
for (int i = 0; i < m_uniqueIds.size(); i++) {
mb.appendDUP();
mb.appendLoadConstant(i);
mb.appendLoadConstant((String)m_uniqueIds.get(i));
mb.appendAASTORE();
}
} else {
mb.appendACONST_NULL();
}
mb.appendPutField(idnames);
// get class names for types (abstract non-base mappings)
ArrayList tnames = new ArrayList();
if (m_isForceClasses) {
for (int i = 0; i < count; i++) {
String cname = (String)s_mappedClasses.get(i);
IMapping map = m_activeContext.getMappingAtLevel(cname);
if (map != null && map.isAbstract() && !map.isBase()) {
String tname = map.getTypeName();
if (tname == null) {
tname = cname;
}
tnames.add(tname);
}
}
}
// check if map needed for types
ClassItem tmap = null;
if (tnames.size() >= TYPEMAP_MINIMUM_SIZE) {
// create field for map
tmap = cf.addPrivateField(STRINGINT_MAPTYPE, TYPEMAP_NAME);
// initialize with appropriate size
mb.appendLoadLocal(0);
mb.appendCreateNew(STRINGINT_MAPTYPE);
mb.appendDUP();
mb.appendLoadConstant(tnames.size());
mb.appendCallInit(STRINGINT_MAPTYPE, STRINGINTINIT_SIGNATURE);
// add all values to map
for (int i = 0; i < tnames.size(); i++) {
int index = s_mappedClasses.find(tnames.get(i));
if (index >= 0) {
mb.appendDUP();
mb.appendLoadConstant((String)tnames.get(i));
mb.appendLoadConstant(index);
mb.appendCallVirtual(STRINGINTADD_METHOD,
STRINGINTADD_SIGNATURE);
mb.appendPOP();
}
}
mb.appendPutField(tmap);
}
// finish with return from constructor
mb.appendReturn();
mb.codeComplete(false);
mb.addMethod();
// add the public marshalling context construction method
mb = new ExceptionMethodBuilder(CREATEMARSHAL_METHODNAME,
ClassItem.typeFromName(MARSHALCONTEXT_INTERFACE), new Type[0], cf,
Constants.ACC_PUBLIC);
if (m_isOutput) {
// construct and return marshaller instance
mb.appendCreateNew(MARSHALCONTEXT_IMPLEMENTATION);
mb.appendDUP();
mb.appendLoadLocal(0);
mb.appendGetField(classes);
mb.appendLoadLocal(0);
mb.appendGetField(marshs);
mb.appendLoadLocal(0);
mb.appendGetField(uris);
mb.appendLoadLocal(0);
mb.appendCallInit(MARSHALCONTEXT_IMPLEMENTATION,
MARSHALCONTEXTINIT_SIGNATURE);
mb.appendReturn(MARSHALCONTEXT_IMPLEMENTATION);
} else {
// throw exception for unsupported operation
mb.appendCreateNew(UNSUPPORTED_EXCEPTION_CLASS);
mb.appendDUP();
mb.appendLoadConstant
("Binding is input only - cannot create marshaller");
mb.appendCallInit(UNSUPPORTED_EXCEPTION_CLASS,
MethodBuilder.EXCEPTION_CONSTRUCTOR_SIGNATURE1);
mb.appendThrow();
}
mb.codeComplete(false);
mb.addMethod();
// add the public unmarshalling context construction method
mb = new ExceptionMethodBuilder(CREATEUNMARSHAL_METHODNAME,
ClassItem.typeFromName(UNMARSHALCONTEXT_INTERFACE), new Type[0], cf,
Constants.ACC_PUBLIC);
if (m_isInput) {
// construct and return unmarshaller instance
mb.appendCreateNew(UNMARSHALCONTEXT_IMPLEMENTATION);
mb.appendDUP();
mb.appendLoadConstant(mcnt);
mb.appendLoadLocal(0);
mb.appendGetField(umarshs);
mb.appendLoadLocal(0);
mb.appendGetField(guris);
mb.appendLoadLocal(0);
mb.appendGetField(gnames);
mb.appendLoadLocal(0);
mb.appendGetField(idnames);
mb.appendLoadLocal(0);
mb.appendCallInit(UNMARSHALCONTEXT_IMPLEMENTATION,
UNMARSHALCONTEXTINIT_SIGNATURE);
mb.appendReturn(UNMARSHALCONTEXT_IMPLEMENTATION);
} else {
// throw exception for unsupported operation
mb.appendCreateNew(UNSUPPORTED_EXCEPTION_CLASS);
mb.appendDUP();
mb.appendLoadConstant
("Binding is output only - cannot create unmarshaller");
mb.appendCallInit(UNSUPPORTED_EXCEPTION_CLASS,
MethodBuilder.EXCEPTION_CONSTRUCTOR_SIGNATURE1);
mb.appendThrow();
}
mb.codeComplete(false);
mb.addMethod();
// add the compiler version access method
mb = new ExceptionMethodBuilder(GETVERSION_METHODNAME,
Type.INT, new Type[0], cf, Constants.ACC_PUBLIC);
mb.appendLoadConstant(IBindingFactory.CURRENT_VERSION_NUMBER);
mb.appendReturn("int");
mb.codeComplete(false);
mb.addMethod();
// add the compiler distribution access method
mb = new ExceptionMethodBuilder(GETDISTRIB_METHODNAME,
Type.STRING, new Type[0], cf, Constants.ACC_PUBLIC);
mb.appendLoadConstant(CURRENT_VERSION_NAME);
mb.appendReturn(Type.STRING);
mb.codeComplete(false);
mb.addMethod();
// add the defined namespace URI array access method
Type satype = new ArrayType(Type.STRING, 1);
mb = new ExceptionMethodBuilder(GETDEFINEDNSS_METHODNAME,
satype, new Type[0], cf, Constants.ACC_PUBLIC);
mb.appendLoadLocal(0);
mb.appendGetField(uris);
mb.appendReturn(satype);
mb.codeComplete(false);
mb.addMethod();
// add the defined namespace prefixes array access method
mb = new ExceptionMethodBuilder(GETDEFINEDPREFS_METHODNAME,
satype, new Type[0], cf, Constants.ACC_PUBLIC);
mb.appendLoadLocal(0);
mb.appendGetField(prefs);
mb.appendReturn(satype);
mb.codeComplete(false);
mb.addMethod();
// add the class name array access method
mb = new ExceptionMethodBuilder(GETCLASSES_METHODNAME,
satype, new Type[0], cf, Constants.ACC_PUBLIC);
mb.appendLoadLocal(0);
mb.appendGetField(classes);
mb.appendReturn(satype);
mb.codeComplete(false);
mb.addMethod();
// add the element namespace URI array access method
mb = new ExceptionMethodBuilder(GETELEMENTNSS_METHODNAME,
satype, new Type[0], cf, Constants.ACC_PUBLIC);
mb.appendLoadLocal(0);
mb.appendGetField(guris);
mb.appendReturn(satype);
mb.codeComplete(false);
mb.addMethod();
// add the element name array access method
mb = new ExceptionMethodBuilder(GETELEMENTNAMES_METHODNAME,
satype, new Type[0], cf, Constants.ACC_PUBLIC);
mb.appendLoadLocal(0);
mb.appendGetField(gnames);
mb.appendReturn(satype);
mb.codeComplete(false);
mb.addMethod();
// add the type mapping index lookup method
mb = new ExceptionMethodBuilder(GETTYPEINDEX_METHODNAME,
Type.INT, new Type[] { Type.STRING }, cf, Constants.ACC_PUBLIC);
if (tnames.size() > 0) {
if (tmap == null) {
// generate in-line compares for mapping
for (int i = 0; i < tnames.size(); i++) {
int index = s_mappedClasses.find(tnames.get(i));
if (index >= 0) {
mb.appendLoadLocal(1);
mb.appendLoadConstant((String)tnames.get(i));
mb.appendCallVirtual("java.lang.String.equals",
"(Ljava/lang/Object;)Z");
BranchWrapper onfail = mb.appendIFEQ(this);
mb.appendLoadConstant(index);
mb.appendReturn(Type.INT);
mb.targetNext(onfail);
}
}
mb.appendLoadConstant(-1);
} else {
// use map constructed in initializer
mb.appendLoadLocal(0);
mb.appendGetField(tmap);
mb.appendLoadLocal(1);
mb.appendCallVirtual(STRINGINTGET_METHOD,
STRINGINTGET_SIGNATURE);
}
} else {
// no types to handle, just always return failure
mb.appendLoadConstant(-1);
}
mb.appendReturn(Type.INT);
mb.codeComplete(false);
mb.addMethod();
// finish with instance creation method
mb = new ExceptionMethodBuilder(GETINST_METHODNAME,
ClassItem.typeFromName(FACTORY_INTERFACE), new Type[0], cf,
(short)(Constants.ACC_PUBLIC | Constants.ACC_STATIC));
mb.appendGetStatic(inst);
BranchWrapper ifdone = mb.appendIFNONNULL(this);
mb.appendCreateNew(cf.getName());
mb.appendDUP();
mb.appendCallInit(cf.getName(), "()V");
mb.appendPutStatic(inst);
mb.targetNext(ifdone);
mb.appendGetStatic(inst);
mb.appendReturn(FACTORY_INTERFACE);
mb.codeComplete(false);
mb.addMethod();
// add factory class to generated registry
cf = MungedClass.getUniqueSupportClass(cf);
String link = name;
if (!name.equals(cf.getName())) {
link = cf.getName() + '=' + name;
}
// record the binding factory in each top-level mapped class
ArrayList maps = m_activeContext.getMappings();
for (int i = 0; i < maps.size(); i++) {
IMapping map = (IMapping)maps.get(i);
if (map instanceof MappingBase) {
BoundClass bound = ((MappingBase)map).getBoundClass();
if (bound.getClassFile().isModifiable()) {
bound.addFactory(link);
}
}
}
}
/**
* Get indexed binding.
*
* @param index number of binding to be returned
* @return binding at the specified index
*/
public static BindingDefinition getBinding(int index) {
return (BindingDefinition)s_bindings.get(index);
}
/**
* Discard cached information and reset in preparation for a new binding
* run.
*/
public static void reset() {
s_bindings = new ArrayList();
s_mappedClasses = new ArrayMap();
}
//
// IContainer interface method definitions
public boolean isContentOrdered() {
return true;
}
public boolean hasNamespaces() {
return false;
}
public BindingDefinition getBindingRoot() {
return this;
}
public DefinitionContext getDefinitionContext() {
return m_activeContext;
}
// DEBUG
private static byte[] s_blanks =
" ".getBytes();
public static void indent(int depth) {
if (depth < s_blanks.length) {
System.out.write(s_blanks, 0, depth);
} else {
System.out.print(s_blanks);
}
}
public void print() {
System.out.println("binding " + m_name + ":");
m_activeContext.print(1);
}
}
libjibx-java-1.1.6a/build/src/org/jibx/binding/def/ComponentProperty.java 0000644 0001750 0001750 00000031037 11013374744 026245 0 ustar moeller moeller /*
Copyright (c) 2003-2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import org.jibx.binding.classes.*;
import org.jibx.runtime.JiBXException;
/**
* Property reference with binding defined by component. This handles loading
* and storing the property value, calling the wrapped component methods for
* everything else.
*
* @author Dennis M. Sosnoski
*/
public class ComponentProperty extends PassThroughComponent
{
/** Property definition. */
private final PropertyDefinition m_property;
/** Skip marshalling code tests flag. */
private boolean m_skipMarshal;
/** Fake content to force unmarshal to create an object. */
private boolean m_forceUnmarshal;
/**
* Constructor.
*
* @param prop actual property definition
* @param impl component that defines marshalling and unmarshalling
* @param skip flag for marshalling code tests to be skipped
*/
public ComponentProperty(PropertyDefinition prop, IComponent impl,
boolean skip) {
super(impl);
m_property = prop;
m_skipMarshal = skip;
}
/**
* Set flag for skipping marshalling presence test code generation.
*
* @param skip true if skipping, false if not
*/
public void setSkipping(boolean skip) {
m_skipMarshal = skip;
}
/**
* Set flag to force unmarshalling to create an object.
*
* @param force true if skipping, false if not
*/
public void setForceUnmarshal(boolean force) {
m_forceUnmarshal = force;
}
/**
* Get the property information. This is a kludge used by the ElementWrapper
* code to store a null value directly to the property when
* unmarshalling a missing or xsi:nil element.
*
* @return property information
*/
public PropertyDefinition getProperty() {
return m_property;
}
//
// IComponent interface method definitions (overrides of defaults)
public boolean isOptional() {
return m_property.isOptional();
}
public boolean hasContent() {
return m_forceUnmarshal || super.hasContent();
}
public void genAttributeUnmarshal(ContextMethodBuilder mb)
throws JiBXException {
// start by generating code to load owning object so can finish by
// storing to property
if (!m_property.isImplicit() && !m_property.isThis()) {
mb.loadObject();
}
BranchWrapper ifpres = null;
BranchWrapper tosave = null;
if (m_property.isOptional()) {
// generate code to check presence for the case of an optional item,
// with branch if so; if not present, set a null value with branch
// to be targeted at property store.
m_component.genAttrPresentTest(mb);
ifpres = mb.appendIFNE(this);
mb.appendACONST_NULL();
tosave = mb.appendUnconditionalBranch(this);
}
// generate unmarshalling code for not optional, or optional and
// present; get existing instance or create a new one and handle
// attribute unmarshalling
mb.targetNext(ifpres);
if (m_property.isImplicit()) {
m_component.genNewInstance(mb);
} else if (!m_property.isThis()) {
// load current value, cast, copy, and test for non-null
mb.loadObject();
m_property.genLoad(mb);
mb.appendCreateCast(m_property.getGetValueType(),
m_component.getType());
mb.appendDUP();
BranchWrapper haveinst = mb.appendIFNONNULL(this);
// current value null, pop copy and create a new instance
mb.appendPOP();
m_component.genNewInstance(mb);
mb.targetNext(haveinst);
}
m_component.genAttributeUnmarshal(mb);
// convert the type if necessary, then store result to property
mb.appendCreateCast(m_component.getType(),
m_property.getSetValueType());
mb.targetNext(tosave);
if (!m_property.isImplicit() && !m_property.isThis()) {
m_property.genStore(mb);
}
}
public void genAttributeMarshal(ContextMethodBuilder mb)
throws JiBXException {
if (m_skipMarshal) {
// just generate pass-through marshal code generation
m_component.genAttributeMarshal(mb);
} else {
// start by generating code to load the actual object reference
if (!m_property.isImplicit()) {
mb.loadObject();
m_property.genLoad(mb);
}
BranchWrapper ifpres = null;
BranchWrapper toend = null;
if (m_property.isOptional()) {
// generate code to check nonnull for the case of an optional item,
// with branch if so; if not present, just pop the copy with branch
// to be targeted past end.
mb.appendDUP();
ifpres = mb.appendIFNONNULL(this);
mb.appendPOP();
toend = mb.appendUnconditionalBranch(this);
}
// generate code for actual marshalling if not optional, or optional and
// nonnull; then finish by setting target for optional with
// null value case
mb.targetNext(ifpres);
m_component.genAttributeMarshal(mb);
mb.targetNext(toend);
}
}
public void genContentUnmarshal(ContextMethodBuilder mb)
throws JiBXException {
// check for both attribute and content components
if (m_component.hasAttribute()) {
// start with code to load reference from attribute unmarshalling
if (!m_property.isImplicit()) {
mb.loadObject();
m_property.genLoad(mb);
} else {
mb.appendDUP();
}
BranchWrapper toend = null;
if (m_property.isOptional()) {
// generate code to check value defined for the case of an
// optional item, with branch if so; if not present, just pop
// the copy with branch to be targeted past end.
toend = mb.appendIFNULL(this);
if (!m_property.isImplicit()) {
mb.loadObject();
m_property.genLoad(mb);
} else {
mb.appendDUP();
}
}
// follow up in case where present with unmarshalling content
m_component.genContentUnmarshal(mb);
mb.appendPOP();
mb.targetNext(toend);
} else {
// start by generating code to load owning object so can finish by
// storing to property
if (!m_property.isImplicit() && !m_property.isThis()) {
mb.loadObject();
}
BranchWrapper ifpres = null;
BranchWrapper tosave = null;
if (m_property.isOptional() && !m_forceUnmarshal) {
// generate code to check presence for the case of an optional
// item, with branch if so; if not present, set a null value
// with branch to be targeted at property store.
m_component.genContentPresentTest(mb);
ifpres = mb.appendIFNE(this);
mb.appendACONST_NULL();
tosave = mb.appendUnconditionalBranch(this);
}
// generate unmarshalling code for not optional, or optional and
// present; get existing instance or create a new one and handle
// content unmarshalling
mb.targetNext(ifpres);
if (m_property.isImplicit()) {
m_component.genNewInstance(mb);
} else if (!m_property.isThis()) {
// load current value, cast, copy, and test for non-null
mb.loadObject();
m_property.genLoad(mb);
mb.appendCreateCast(m_property.getGetValueType(),
m_component.getType());
mb.appendDUP();
BranchWrapper haveinst = mb.appendIFNONNULL(this);
// current value null, pop copy and create a new instance
mb.appendPOP();
m_component.genNewInstance(mb);
mb.targetNext(haveinst);
}
if (!m_forceUnmarshal) {
m_component.genContentUnmarshal(mb);
}
// convert the type if necessary, then store result to property
mb.appendCreateCast(m_component.getType(),
m_property.getSetValueType());
mb.targetNext(tosave);
if (!m_property.isImplicit() && !m_property.isThis()) {
m_property.genStore(mb);
}
}
}
public void genContentMarshal(ContextMethodBuilder mb)
throws JiBXException {
if (m_forceUnmarshal) {
if (m_property.isImplicit()) {
// discard the object reference
mb.appendPOP();
}
} else {
if (m_skipMarshal) {
// just generate pass-through marshal code generation
m_component.genContentMarshal(mb);
} else {
// start by generating code to load the actual object reference
if (!m_property.isImplicit()) {
mb.loadObject();
m_property.genLoad(mb);
}
BranchWrapper ifpres = null;
BranchWrapper tonext = null;
if (m_property.isOptional()) {
// generate code to check nonull for the case of an optional item,
// with branch if so; if not present, just pop the copy with branch
// to be targeted past end.
mb.appendDUP();
ifpres = mb.appendIFNONNULL(this);
mb.appendPOP();
tonext = mb.appendUnconditionalBranch(this);
}
// generate code for actual marshalling if not optional, or optional and
// nonnull; then finish by setting target for optional with null value
// case
mb.targetNext(ifpres);
m_component.genContentMarshal(mb);
mb.targetNext(tonext);
}
}
}
// DEBUG
public void print(int depth) {
BindingDefinition.indent(depth);
System.out.print("component " + m_property.toString());
if (m_skipMarshal) {
System.out.print(" (pass-through marshal)");
}
System.out.println();
m_component.print(depth+1);
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/def/DefinitionContext.java 0000644 0001750 0001750 00000062627 10541614666 026211 0 ustar moeller moeller /*
Copyright (c) 2003-2006, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import java.util.ArrayList;
import java.util.HashMap;
import org.jibx.binding.classes.ClassFile;
import org.jibx.binding.classes.MethodBuilder;
import org.jibx.binding.util.ArrayMap;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.QName;
/**
* Nesting level for definitions in binding. This tracks namespace and mapping
* definitions that apply to all enclosed items.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class DefinitionContext
{
/** Containing binding definition component. */
private final IContainer m_container;
/** Containing definition context. */
private final DefinitionContext m_context;
/** Namespace used by default at this level for attributes. */
private NamespaceDefinition m_attributeDefault;
/** Namespace used by default at this level for elements. */
private NamespaceDefinition m_elementDefault;
/** Namespaces defined at level (lazy create). */
private ArrayList m_namespaces;
/** Mapping from prefix to namespace definition (lazy create). */
private HashMap m_prefixMap;
/** Mapping from URI to namespace definition (lazy create). */
private HashMap m_uriMap;
/** Mapping from fully qualified class name to mapping index (lazy
create). */
private ArrayMap m_classMap;
/** Class mappings defined at level (lazy create). */
private ArrayList m_mappings;
/** Map from signatures to String conversions. */
private HashMap m_convertMap;
/** Map from format qnames to String conversions. */
private HashMap m_formatMap;
/** Named binding components (only for root context of a binding). */
private HashMap m_namedStructureMap;
/**
* Constructor. Uses the containing context to establish the hierarchy for
* resolving namespaces and class mappings.
*
* @param contain containing binding definition component
*/
public DefinitionContext(IContainer contain) {
m_container = contain;
m_context = contain.getDefinitionContext();
// TODO: make these lazy
m_convertMap = new HashMap();
m_formatMap = new HashMap();
if (m_context == null) {
m_namedStructureMap = new HashMap();
}
}
/**
* Check for duplicate or conflicting namespace. This also intializes the
* namespace structures for this context the first time the method is
* called.
*
* @param def
* @return duplicate flag (either complete duplicate, or prior definition
* of same URI with prefix is present)
* @throws JiBXException on conflicting prefix
*/
private boolean checkDuplicateNamespace(NamespaceDefinition def)
throws JiBXException {
// create structures if not already done
if (m_namespaces == null) {
m_namespaces = new ArrayList();
m_prefixMap = new HashMap();
m_uriMap = new HashMap();
}
// check for conflict (or duplicate) on prefix
String uri = def.getUri();
String prefix = def.getPrefix();
NamespaceDefinition dup = (NamespaceDefinition)m_prefixMap.get(prefix);
DefinitionContext ctx = this;
while (dup == null && (ctx = ctx.m_context) != null) {
if (ctx.m_prefixMap != null) {
dup = (NamespaceDefinition)ctx.m_prefixMap.get(prefix);
}
}
if (dup == null) {
// check for duplicate definition of same URI, but with prefix
NamespaceDefinition prior = (NamespaceDefinition)m_uriMap.get(uri);
if (prior != null && prior.getPrefix() != null) {
return true;
} else {
return false;
}
} else {
// check for repeated definition of same namespace
if (uri.equals(dup.getUri())) {
return true;
} else {
throw new JiBXException("Namespace prefix conflict");
}
}
}
/**
* Add namespace to internal tables.
*
* @param def
*/
private void internalAddNamespace(NamespaceDefinition def) {
String uri = def.getUri();
String prefix = def.getPrefix();
def.setIndex(m_container.getBindingRoot().
getNamespaceUriIndex(uri, prefix));
m_namespaces.add(def);
m_prefixMap.put(prefix, def);
m_uriMap.put(uri, def);
}
/**
* Add namespace to set defined at this level. If the new namespace
* conflicts with an existing namespace at this level (in terms of default
* usage or prefix) this throws an exception.
*
* @param def namespace definition to be added (duplicates ignored)
* @throws JiBXException on namespace definition conflict
*/
public void addNamespace(NamespaceDefinition def) throws JiBXException {
if (!checkDuplicateNamespace(def)) {
// check for conflict as default for attributes
if (def.isAttributeDefault()) {
if (m_attributeDefault == null) {
m_attributeDefault = def;
} else {
throw new JiBXException
("Multiple default attribute namespaces at level");
}
}
// check for conflict as default for elements
if (def.isElementDefault()) {
if (m_elementDefault == null) {
m_elementDefault = def;
} else {
throw new JiBXException
("Multiple default element namespaces at level");
}
}
// no conflicts, add it
internalAddNamespace(def);
}
}
/**
* Add namespace declaration to set defined at this level. This method
* treats all namespaces as though they were declared with default="none".
* If the new namespace prefix conflicts with an existing namespace this
* throws an exception.
*
* @param def namespace definition to be added (duplicates ignored)
* @throws JiBXException on namespace definition conflict
*/
public void addImpliedNamespace(NamespaceDefinition def) throws JiBXException {
if (!checkDuplicateNamespace(def)) {
internalAddNamespace(def);
}
}
/**
* Add class mapping to set defined at this level. If the new mapping
* conflicts with an existing one at this level it throws an exception.
*
* @param def mapping definition to be added
* @throws JiBXException on mapping definition conflict
*/
public void addMapping(IMapping def) throws JiBXException {
// create structure if not already done
if (m_mappings == null) {
m_classMap = new ArrayMap();
m_mappings = new ArrayList();
}
// check for conflict on class name before adding to definitions
String name = def.getTypeName();
if (name == null) {
name = def.getReferenceType();
}
int index = m_classMap.findOrAdd(name);
if (index < m_mappings.size()) {
if (def.getTypeName() == null) {
throw new JiBXException
("Conflicting mappings for class " + name);
} else {
throw new JiBXException
("Conflicting mappings for type name " + name);
}
} else {
m_mappings.add(def);
}
}
/**
* Add named structure component to set defined at this level. If the name
* conflicts with an existing one at this level it throws an exception.
*
* @param name component name to be set
* @param comp named component
* @throws JiBXException on mapping definition conflict
*/
public void addNamedStructure(String name, IComponent comp)
throws JiBXException {
if (m_namedStructureMap == null) {
m_context.addNamedStructure(name, comp);
} else {
m_namedStructureMap.put(name, comp);
}
}
/**
* Get the default namespace for a contained name. Elements and attributes
* are treated separately, since namespace handling differs between the two.
*
* @param attr flag for attribute name
* @return default namespace URI, or null if none
*/
private NamespaceDefinition getDefaultNamespace(boolean attr) {
NamespaceDefinition ns;
if (attr) {
ns = m_attributeDefault;
} else {
ns = m_elementDefault;
}
if (ns == null && m_context != null) {
ns = m_context.getDefaultNamespace(attr);
}
return ns;
}
/**
* Get the default namespace URI for a contained name. Elements and
* attributes are treated separately, since namespace handling differs
* between the two.
*
* @param attr flag for attribute name
* @return default namespace URI, or null if none
*/
public String getDefaultURI(boolean attr) {
NamespaceDefinition ns = getDefaultNamespace(attr);
if (ns == null) {
return null;
} else {
return ns.getUri();
}
}
/**
* Get the default namespace index for a contained name. Elements and
* attributes are treated separately, since namespace handling differs
* between the two.
*
* @param attr flag for attribute name
* @return default namespace index
*/
public int getDefaultIndex(boolean attr) {
NamespaceDefinition ns = getDefaultNamespace(attr);
if (ns == null) {
return 0;
} else {
return ns.getIndex();
}
}
/**
* Get namespace index for a given URI. Finds the prefix for a URI in a
* name contained by this level, throwing an exception if the URI is not
* found or does not have a prefix.
*
* @param uri namespace URI to be found
* @param attr flag for attribute name
* @return namespace index for URI
* @throws JiBXException if URI not defined or not usable
*/
public int getNamespaceIndex(String uri, boolean attr)
throws JiBXException {
// check for namespace URI defined at this level
if (m_uriMap != null) {
Object value = m_uriMap.get(uri);
if (value != null) {
if (!attr || ((NamespaceDefinition)value).getPrefix() != null) {
return ((NamespaceDefinition)value).getIndex();
}
}
}
// if all else fails, try the higher level
if (m_context == null) {
throw new JiBXException("Namespace URI \"" + uri +
"\" not defined or not usable");
} else {
return m_context.getNamespaceIndex(uri, attr);
}
}
/**
* Get mapping definition for class if defined at this level.
*
* @param name fully qualified class name
* @return mapping definition for class, or null if not defined
*/
public IMapping getMappingAtLevel(String name) {
// check for class mapping defined at this level
if (m_classMap != null) {
// check for definition at this level
int index = m_classMap.find(name);
if (index >= 0) {
return (IMapping)m_mappings.get(index);
}
}
return null;
}
/**
* Get mapping definition for class. Finds the mapping for a fully
* qualified class name, throwing an exception if no mapping is defined.
* This can only be used during the linkage phase.
*
* @param name fully qualified class name
* @return mapping definition for class, or null if not defined
*/
public IMapping getClassMapping(String name) {
// check for class mapping defined at this level
IMapping def = getMappingAtLevel(name);
if (def == null && m_context != null) {
// try finding definition at higher level
def = m_context.getClassMapping(name);
}
return def;
}
/**
* Get nested structure by name. Finds the nested structure with the given
* name, throwing an exception if no component with that name is defined.
*
* @param name component name to be found
* @return component with given name
* @throws JiBXException if name not defined
*/
public IComponent getNamedStructure(String name) throws JiBXException {
// check for named component defined at this level
IComponent comp = null;
if (m_namedStructureMap != null) {
comp = (IComponent)m_namedStructureMap.get(name);
}
if (comp == null) {
if (m_context == null) {
throw new JiBXException("Referenced label \"" + name +
"\" not defined");
} else {
comp = m_context.getNamedStructure(name);
}
}
return comp;
}
/**
* Get mapping definitions at level.
*
* @return mapping definitions, null if none defined at level
*/
public ArrayList getMappings() {
return m_mappings;
}
/**
* Get specific conversion definition for type. Finds with an exact match
* on the class name, checking the containing definitions if a conversion
* is not found at this level.
*
* @param name fully qualified class name to be converted
* @return conversion definition for class, or null if not
* found
*/
public StringConversion getSpecificConversion(String name) {
StringConversion conv = (StringConversion)m_convertMap.get(name);
if (conv == null && m_context != null) {
conv = m_context.getSpecificConversion(name);
}
return conv;
}
/**
* Get conversion definition for class. Finds the conversion based on a
* fully qualified class name. If a specific conversion for the actual
* class is not found (either in this or a containing level) this returns
* the generic object conversion.
*
* @param clas information for target conversion class
* @return conversion definition for class
*/
public StringConversion getConversion(ClassFile clas) {
// use conversions for superclasses only
StringConversion conv = getSpecificConversion(clas.getName());
if (conv == null) {
return BindingDefinition.s_objectConversion;
} else {
return conv;
}
}
/**
* Get named conversion definition. Finds the conversion with the supplied
* name, checking the containing definitions if the conversion is not found
* at this level.
*
* @param name conversion name to be found
* @return conversion definition for class
*/
public StringConversion getNamedConversion(QName name) {
StringConversion conv = (StringConversion)m_formatMap.get(name);
if (conv == null && m_context != null) {
conv = m_context.getNamedConversion(name);
}
return conv;
}
/**
* Add named conversion. Checks for duplicate conversions defined within
* a level with the same name.
*
* @param name format name for this conversion
* @param conv conversion definition for class
* @throws JiBXException if duplicate conversion definition
*/
public void addConversion(QName name, StringConversion conv)
throws JiBXException {
if (m_formatMap.put(name, conv) != null) {
throw new JiBXException("Duplicate conversion defined with name " +
name);
}
}
/**
* Set specific conversion definition for type. Sets the conversion based
* on a type signature, checking for duplicate conversions defined within
* a level.
*
* @param conv conversion definition for class
* @throws JiBXException if duplicate conversion definition
*/
public void setConversion(StringConversion conv)
throws JiBXException {
if (m_convertMap.put(conv.getTypeName(), conv) != null) {
throw new JiBXException("Duplicate conversion defined for type " +
conv.getTypeName());
}
}
/**
* Sets a named conversion definition.
*
* @param name format name for this conversion
* @param conv conversion definition for class
* @throws JiBXException if duplicate conversion definition
*/
public void setNamedConversion(QName name, StringConversion conv)
throws JiBXException {
addConversion(name, conv);
}
/**
* Sets a conversion definition by both type and name. Both the type and
* name are checked for duplicate conversions defined within a level.
*
* @param name format name for this conversion
* @param conv conversion definition for class
* @throws JiBXException if duplicate conversion definition
*/
public void setDefaultConversion(QName name, StringConversion conv)
throws JiBXException {
addConversion(name, conv);
setConversion(conv);
}
/**
* Check if one or more namespaces are defined in this context.
*
* @return true if namespaces are defined, false
* if not
*/
public boolean hasNamespace() {
return m_namespaces != null && m_namespaces.size() > 0;
}
/**
* Get the namespaces defined in this context
*
* @return namespace definitions (may be null if none)
*/
public ArrayList getNamespaces() {
return m_namespaces;
}
/**
* Internal method to generate code to fill array with namespace indexes.
* The code generated to this point must have the array reference on the
* stack.
*
* @param nss namespaces to be handled
* @param mb method builder for generated code
*/
private void genFillNamespaceIndexes(ArrayList nss, MethodBuilder mb) {
if (nss != null) {
for (int i = 0; i < nss.size(); i++) {
mb.appendDUP();
mb.appendLoadConstant(i);
mb.appendLoadConstant
(((NamespaceDefinition)nss.get(i)).getIndex());
mb.appendIASTORE();
}
}
}
/**
* Internal method to generate code to fill array with namespace prefixes.
* The code generated to this point must have the array reference on the
* stack.
*
* @param nss namespaces to be handled
* @param mb method builder for generated code
*/
private void genFillNamespacePrefixes(ArrayList nss, MethodBuilder mb) {
if (nss != null) {
for (int i = 0; i < nss.size(); i++) {
mb.appendDUP();
mb.appendLoadConstant(i);
String prefix = ((NamespaceDefinition)nss.get(i)).getPrefix();
if (prefix == null) {
prefix = "";
}
mb.appendLoadConstant(prefix);
mb.appendAASTORE();
}
}
}
/**
* Generate code for loading namespace index and URI arrays. The code
* creates the arrays and leaves the references on the stack.
*
* @param mb method builder for generated code
*/
public void genLoadNamespaces(MethodBuilder mb) {
// first create the array of namespace indexes
int count = m_namespaces == null ? 0 : m_namespaces.size();
mb.appendLoadConstant(count);
mb.appendCreateArray("int");
genFillNamespaceIndexes(m_namespaces, mb);
// next create the array of prefixes
mb.appendLoadConstant(count);
mb.appendCreateArray("java.lang.String");
genFillNamespacePrefixes(m_namespaces, mb);
}
/**
* Generate code. Executes code generation for each top-level mapping
* defined in this binding, which in turn propagates the code generation
* all the way down.
*
* @param verbose flag for verbose output
* @param force create marshaller/unmarshaller even for abstract non-base
* mappings flag
* @throws JiBXException if error in transformation
*/
public void generateCode(boolean verbose, boolean force)
throws JiBXException {
if (m_mappings != null) {
for (int i = 0; i < m_mappings.size(); i++) {
IMapping mapping = (IMapping)m_mappings.get(i);
if (verbose) {
System.out.println("Generating code for mapping " +
mapping.getBoundType());
}
((IMapping)m_mappings.get(i)).generateCode(force);
}
}
}
/**
* Links extension mappings to their base mappings. This must be done before
* the more general linking step in order to determine which abstract
* mappings are standalone and which are extended by other mappings
*
* @throws JiBXException if error in linking
*/
public void linkMappings() throws JiBXException {
// check if any mappings are defined
if (m_mappings != null) {
for (int i = 0; i < m_mappings.size(); i++) {
Object obj = m_mappings.get(i);
if (obj instanceof MappingDefinition) {
((MappingDefinition)obj).linkMappings();
}
}
}
}
/**
* Set linkages between binding components. This is called after all the
* basic information has been set up. All linkage to higher level
* components should be done by this method, in order to prevent problems
* due to the order of definitions between components. For the definition
* context this calls the same method on all mappings defined in this
* context.
*
* @throws JiBXException if error in configuration
*/
public void setLinkages() throws JiBXException {
// check if any mappings are defined
if (m_mappings != null) {
for (int i = 0; i < m_mappings.size(); i++) {
Object obj = m_mappings.get(i);
if (obj instanceof MappingDefinition) {
((MappingDefinition)obj).setLinkages();
}
}
}
}
// DEBUG
public void print(int depth) {
BindingDefinition.indent(depth);
System.out.print("context");
if (m_namespaces != null) {
System.out.print(" (ns#=" + m_namespaces.size() + ')');
}
if (m_mappings != null) {
System.out.print(" (mp#=" + m_mappings.size() + ')');
}
if (m_namedStructureMap != null) {
System.out.print(" (nm#=" + m_namedStructureMap.size() + ')');
}
if (m_convertMap != null) {
System.out.print(" (cv#=" + m_convertMap.size() + ')');
}
if (m_formatMap != null) {
System.out.print(" (fm#=" + m_formatMap.size() + ')');
}
System.out.println();
if (m_namespaces != null) {
for (int i = 0; i < m_namespaces.size(); i++) {
NamespaceDefinition ndef =
(NamespaceDefinition)m_namespaces.get(i);
ndef.print(depth+1);
}
}
if (m_mappings != null) {
for (int i = 0; i < m_mappings.size(); i++) {
Object obj = m_mappings.get(i);
if (obj instanceof MappingDefinition) {
MappingDefinition mdef = (MappingDefinition)obj;
mdef.print(depth+1);
} else if (obj instanceof MappingDirect) {
MappingDirect mdir = (MappingDirect)obj;
mdir.print(depth+1);
} else {
BindingDefinition.indent(depth+1);
System.out.println("unexpected type " +
obj.getClass().getName());
}
}
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/def/DirectGeneric.java 0000644 0001750 0001750 00000021601 10435324110 025226 0 ustar moeller moeller /*
Copyright (c) 2003-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import org.jibx.binding.classes.*;
import org.jibx.runtime.JiBXException;
/**
* Linkage to generic object with defined marshaller and/or unmarshaller. This
* provides methods used to generate code for marshalling and unmarshalling
* objects of types unknown at binding time, so long as they have mappings
* defined.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class DirectGeneric implements IComponent
{
//
// Constants and such related to code generation.
private static final String ISEND_METHOD =
"org.jibx.runtime.impl.UnmarshallingContext.isEnd";
private static final String ISEND_SIGNATURE = "()Z";
private static final String UNMARSHALELEMENT_METHOD =
"org.jibx.runtime.impl.UnmarshallingContext.unmarshalElement";
private static final String UNMARSHALELEMENT_SIGNATURE =
"()Ljava/lang/Object;";
private static final String MARSHALLABLE_INTERFACE =
"org.jibx.runtime.IMarshallable";
private static final String MARSHALLABLE_METHOD =
"org.jibx.runtime.IMarshallable.marshal";
private static final String MARSHALLABLE_SIGNATURE =
"(Lorg/jibx/runtime/IMarshallingContext;)V";
//
// Actual instance data.
/** Type handled by this binding. */
private final String m_type;
/** Optional property definition. */
private final PropertyDefinition m_property;
/**
* Constructor without implicit property.
*
* @param parent containing binding definition structure
* @param type fully qualified class name of object type handled by this
* binding (null if unspecified)
*/
public DirectGeneric(IContainer parent, String type) {
m_type = (type == null) ? "java.lang.Object" : type;
m_property = null;
}
/**
* Constructor with defined property.
*
* @param parent containing binding definition structure
* @param type fully qualified class name of object type handled by this
* binding (null if unspecified)
* @param prop associated property information
*/
public DirectGeneric(IContainer parent, String type,
PropertyDefinition prop) {
m_type = (type == null) ? "java.lang.Object" : type;
m_property = prop;
}
/**
* Generate presence test code for this mapping. The generated code just
* checks that a start tag is next in the document, rather than an end tag.
*
* @param mb method builder
*/
public void genTestPresent(ContextMethodBuilder mb) {
// append code to call unmarshalling context method to check for end tag
// as next in document, then invert the result
mb.loadContext();
mb.appendCallVirtual(ISEND_METHOD, ISEND_SIGNATURE);
mb.appendLoadConstant(1);
mb.appendIXOR();
}
/**
* Generate unmarshalling code for this mapping. The generated code just
* calls the generic unmarshal element method, leaving the unmarshalled
* object on the stack (after casting it, if necessary, to the appropriate
* type).
* TODO: Instead call unmarshalling method with class passed directly, for
* better error reporting.
*
* @param mb method builder
*/
public void genUnmarshal(ContextMethodBuilder mb) throws JiBXException {
// check for optional property
BranchWrapper tosave = null;
if (m_property != null && m_property.isOptional()) {
// generate code to check presence for the case of an optional
// item, with branch if so; if not present, set a null value
// with branch to be targeted at property store.
genTestPresent(mb);
BranchWrapper ifpres = mb.appendIFNE(this);
mb.appendACONST_NULL();
tosave = mb.appendUnconditionalBranch(this);
mb.targetNext(ifpres);
}
// append code to call unmarshalling context method for generic element
mb.loadContext();
mb.appendCallVirtual(UNMARSHALELEMENT_METHOD,
UNMARSHALELEMENT_SIGNATURE);
mb.appendCreateCast(m_type);
mb.targetNext(tosave);
if (m_property != null && !m_property.isImplicit() &&
!m_property.isThis()) {
mb.loadObject();
mb.appendSWAP();
m_property.genStore(mb);
}
}
/**
* Generate marshalling code for this mapping. The generated code loads the
* object reference and casts it to the generic marshal interface, then
* calls the marshal method of that interface.
*
* @param mb method builder
*/
public void genMarshal(ContextMethodBuilder mb) throws JiBXException {
// append code to cast object and call generic marshal method
BranchWrapper toend = null;
if (m_property != null && !m_property.isImplicit()) {
mb.loadObject();
m_property.genLoad(mb);
if (m_property.isOptional()) {
// generate code to check nonnull for the case of an optional item,
// with branch if so; if not present, just pop the copy with branch
// to be targeted past end.
mb.appendDUP();
BranchWrapper ifpres = mb.appendIFNONNULL(this);
mb.appendPOP();
toend = mb.appendUnconditionalBranch(this);
mb.targetNext(ifpres);
}
}
mb.appendCreateCast(MARSHALLABLE_INTERFACE);
mb.loadContext();
mb.appendCallInterface(MARSHALLABLE_METHOD, MARSHALLABLE_SIGNATURE);
mb.targetNext(toend);
}
//
// IComponent interface method definitions
public boolean isOptional() {
return false;
}
public boolean hasAttribute() {
return false;
}
public void genAttrPresentTest(ContextMethodBuilder mb) {
throw new IllegalStateException
("Internal error - no attributes defined");
}
public void genAttributeUnmarshal(ContextMethodBuilder mb) {
throw new IllegalStateException
("Internal error - no attributes defined");
}
public void genAttributeMarshal(ContextMethodBuilder mb) {
throw new IllegalStateException
("Internal error - no attributes defined");
}
public boolean hasContent() {
return true;
}
public void genContentPresentTest(ContextMethodBuilder mb)
throws JiBXException {
genTestPresent(mb);
}
public void genContentUnmarshal(ContextMethodBuilder mb)
throws JiBXException {
genUnmarshal(mb);
}
public void genContentMarshal(ContextMethodBuilder mb)
throws JiBXException {
genMarshal(mb);
}
public void genNewInstance(ContextMethodBuilder mb) {
throw new IllegalStateException
("Internal error - no instance creation");
}
public String getType() {
return MARSHALLABLE_INTERFACE;
}
public boolean hasId() {
return false;
}
public void genLoadId(ContextMethodBuilder mb) {
throw new IllegalStateException("Internal error - no ID allowed");
}
public NameDefinition getWrapperName() {
return null;
}
public void setLinkages() {}
// DEBUG
public void print(int depth) {
BindingDefinition.indent(depth);
System.out.println("direct generic reference" );
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/def/DirectObject.java 0000644 0001750 0001750 00000054737 10435324110 025100 0 ustar moeller moeller /*
Copyright (c) 2003-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import org.apache.bcel.Constants;
import org.apache.bcel.generic.Type;
import org.jibx.binding.classes.*;
import org.jibx.runtime.JiBXException;
/**
* Linkage to object with supplied marshaller and unmarshaller. This provides
* methods used to generate code for calling the supplied classes.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class DirectObject implements IComponent
{
//
// Constants and such related to code generation.
private static final String GETUNMARSHALLER_METHOD =
"org.jibx.runtime.IUnmarshallingContext.getUnmarshaller";
private static final String GETUNMARSHALLER_SIGNATURE =
"(I)Lorg/jibx/runtime/IUnmarshaller;";
private static final String GETMARSHALLER_METHOD =
"org.jibx.runtime.IMarshallingContext.getMarshaller";
private static final String GETMARSHALLER_SIGNATURE =
"(ILjava/lang/String;)Lorg/jibx/runtime/IMarshaller;";
private static final String MARSHALLER_MARSHAL_METHOD =
"org.jibx.runtime.IMarshaller.marshal";
private static final String MARSHALLER_MARSHAL_SIGNATURE =
"(Ljava/lang/Object;Lorg/jibx/runtime/IMarshallingContext;)V";
private static final String UNMARSHALLER_TESTPRESENT_METHOD =
"org.jibx.runtime.IUnmarshaller.isPresent";
private static final String UNMARSHALLER_TESTPRESENT_SIGNATURE =
"(Lorg/jibx/runtime/IUnmarshallingContext;)Z";
private static final String UNMARSHALLER_UNMARSHAL_METHOD =
"org.jibx.runtime.IUnmarshaller.unmarshal";
private static final String UNMARSHALLER_UNMARSHAL_SIGNATURE =
"(Ljava/lang/Object;Lorg/jibx/runtime/IUnmarshallingContext;)" +
"Ljava/lang/Object;";
private static final String ABSTRACTMARSHALLER_INTERFACE =
"org.jibx.runtime.IAbstractMarshaller";
private static final String ABSTRACTMARSHAL_METHOD =
"org.jibx.runtime.IAbstractMarshaller.baseMarshal";
private static final String ABSTRACTMARSHAL_SIGNATURE =
MARSHALLER_MARSHAL_SIGNATURE;
private static final String ALIASABLE_INTERFACETYPE =
"Lorg/jibx/runtime/IAliasable;";
private static final String ANY_INIT_SIG = "()V";
private static final String ANY_INITCLASS_SIG = "(Ljava/lang/String;)V";
private static final String MARSHALUNMARSHAL_INIT_SIG =
"(Ljava/lang/String;ILjava/lang/String;)V";
private static final String MARSHALONLY_INIT_SIG = "(ILjava/lang/String;)V";
private static final String UNMARSHALONLY_INIT_SIG =
"(Ljava/lang/String;Ljava/lang/String;)V";
private static final String MARSHALUNMARSHAL_INITCLASS_SIG =
"(Ljava/lang/String;ILjava/lang/String;Ljava/lang/String;)V";
private static final String MARSHALONLY_INITCLASS_SIG =
"(ILjava/lang/String;Ljava/lang/String;)V";
private static final String UNMARSHALONLY_INITCLASS_SIG =
"(Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)V";
//
// Actual instance data.
/** Containing binding definition structure. */
private final IContainer m_parent;
/** Definition context for resolving names. */
private final DefinitionContext m_defContext;
/** Abstract mapping flag. If this is set the marshalling code will call the
special interface method used to verify the type of a passed object and
marshal it with the proper handling. */
private final boolean m_isAbstract;
/** Element name information (null if no bound element). */
private final NameDefinition m_name;
/** Flag for marshaller/unmarshaller slot defined. This is done during code
generation, rather than during linking, so that all mapped bindings can be
defined with lower index numbers than for marshallers/unmarshallers used
only in a specific context. */
private boolean m_isSlotSet;
/** Marshaller/unmarshaller slot number. */
private int m_mumSlot;
/** Class handled by this binding. */
private final ClassFile m_targetClass;
/** Marshaller base class. */
private final ClassFile m_marshallerBase;
/** Unmarshaller base class. */
private final ClassFile m_unmarshallerBase;
/** Marshaller class (lazy create on first use if name supplied). */
private ClassFile m_marshaller;
/** Unmarshaller class (lazy create on first use if name supplied). */
private ClassFile m_unmarshaller;
/**
* Constructor.
*
* @param parent containing binding definition structure
* @param target class handled by this binding
* @param abs abstract mapping flag
* @param mcf marshaller class information (null if input only
* binding)
* @param ucf unmarshaller class information (null if output
* only binding)
* @param slot marshaller/unmarshaller slot number (-1 if to be
* defined later)
* @param name element name information (null if no element
* name)
* @throws JiBXException if configuration error
*/
public DirectObject(IContainer parent, DefinitionContext defc,
ClassFile target, boolean abs, ClassFile mcf, ClassFile ucf, int slot,
NameDefinition name) throws JiBXException {
// initialize the basic information
m_parent = parent;
m_defContext = (defc == null) ? m_parent.getDefinitionContext() : defc;
m_isAbstract = abs;
m_targetClass = target;
m_marshallerBase = mcf;
m_unmarshallerBase = ucf;
m_name = name;
m_mumSlot = slot;
m_isSlotSet = slot >= 0;
// check for marshaller and/or unmarshaller configuration valid
if (name == null) {
// no name, make sure there's an appropriate constructor
if (mcf != null) {
if (mcf.getInitializerMethod(ANY_INIT_SIG) != null) {
m_marshaller = mcf;
} else if (mcf.getInitializerMethod
(ANY_INITCLASS_SIG) == null) {
throw new JiBXException("Marshaller class " +
mcf.getName() + " requires name to be set");
}
}
if (ucf != null) {
if (ucf.getInitializerMethod(ANY_INIT_SIG) != null) {
m_unmarshaller = ucf;
} else if (ucf.getInitializerMethod
(ANY_INITCLASS_SIG) == null) {
throw new JiBXException("Unmarshaller class " +
ucf.getName() + " requires name to be set");
}
}
}
if (name != null) {
// name supplied, make sure both support it
if (mcf != null && !mcf.isImplements(ALIASABLE_INTERFACETYPE)) {
throw new JiBXException("Marshaller class " +
mcf.getName() + " does not allow name to be set");
}
if (ucf != null && !ucf.isImplements(ALIASABLE_INTERFACETYPE)) {
throw new JiBXException("Unmarshaller class " +
ucf.getName() + " does not allow name to be set");
}
}
}
/**
* Get marshaller/unmarshaller index. This is the index into the tables of
* marshaller and unmarshaller instances maintained by the respective
* contexts. On the first time call this gets the index number from the
* binding definition, then the index number is reused on subsequent calls.
*
* @return slot number for binding
* @throws JiBXException on configuration error
*/
private int getSlot() throws JiBXException {
if (!m_isSlotSet) {
// first set slot in case called recursively
BindingDefinition bdef = m_parent.getBindingRoot();
m_mumSlot = bdef.getMarshallerUnmarshallerIndex
(m_targetClass.getName());
m_isSlotSet = true;
// now generate the classes (if needed) and set the names
String mclas = null;
String uclas = null;
if (bdef.isOutput()) {
if (m_marshaller == null) {
createSubclass(true);
}
mclas = m_marshaller.getName();
}
if (bdef.isInput()) {
if (m_unmarshaller == null) {
createSubclass(false);
}
uclas = m_unmarshaller.getName();
}
bdef.setMarshallerUnmarshallerClasses(m_mumSlot, mclas, uclas);
}
return m_mumSlot;
}
/**
* Load marshaller/unmarshaller index. This is assigned by the binding
* definition and used thereafter.
*
* @param mb method builder
*/
private void genLoadSlot(ContextMethodBuilder mb) throws JiBXException {
mb.appendLoadConstant(getSlot());
}
/**
* Create aliased subclass for marshaller or unmarshaller with element name
* defined by binding. If the same aliasable superclass is defined for use
* as both a marshaller and an unmarshaller a single subclass is generated
* to handle both uses.
*
* @param out true if alias needed for marshalling,
* false if for unmarshalling
* @throws JiBXException on configuration error
*/
private void createSubclass(boolean out) throws JiBXException {
// find initializer call to be used
ClassItem init = null;
boolean dual = false;
boolean classed = true;
boolean named = false;
ClassFile base = out ? m_marshallerBase : m_unmarshallerBase;
// check for name supplied
if (m_name == null) {
init = base.getInitializerMethod(ANY_INITCLASS_SIG);
classed = init != null;
}
if (init == null) {
named = true;
if (m_unmarshallerBase == m_marshallerBase) {
// single class, look first for signature with class name
init = base.getInitializerMethod
(MARSHALUNMARSHAL_INITCLASS_SIG);
if (init == null) {
classed = false;
init = base.getInitializerMethod(MARSHALUNMARSHAL_INIT_SIG);
}
dual = true;
} else {
// using only one function, first check one way with class name
String sig = out ?
MARSHALONLY_INITCLASS_SIG : UNMARSHALONLY_INITCLASS_SIG;
init = base.getInitializerMethod(sig);
if (init == null) {
// now check dual function with class name
sig = MARSHALUNMARSHAL_INITCLASS_SIG;
init = base.getInitializerMethod(sig);
dual = true;
if (init == null) {
// now try alternatives without class name included
classed = false;
sig = out ? MARSHALONLY_INIT_SIG :
UNMARSHALONLY_INIT_SIG;
init = base.getInitializerMethod(sig);
dual = false;
if (init == null) {
sig = MARSHALUNMARSHAL_INIT_SIG;
init = base.getInitializerMethod(sig);
dual = true;
}
}
}
}
}
// make sure the initializer is defined and public
if (init == null || ((init.getAccessFlags() &
Constants.ACC_PUBLIC) == 0)) {
throw new JiBXException("No usable constructor for " +
"marshaller or unmarshaller based on " + base.getName());
}
// get package and target name from bound class
String tname = base.getName();
int split = tname.lastIndexOf('.');
if (split >= 0) {
tname = tname.substring(split+1);
}
// create the helper class
BindingDefinition def = m_parent.getBindingRoot();
String pack = def.getDefaultPackage();
if (pack.length() > 0) {
pack += '.';
}
String name = pack + def.getPrefix() + tname + '_' + getSlot();
String[] intfs = def.isInput() ? (def.isOutput() ?
MappingDefinition.BOTH_INTERFACES :
MappingDefinition.UNMARSHALLER_INTERFACES) :
MappingDefinition.MARSHALLER_INTERFACES;
ClassFile cf = new ClassFile(name, def.getDefaultRoot(),
base, Constants.ACC_PUBLIC, intfs);
// add the public constructor method
ExceptionMethodBuilder mb = new ExceptionMethodBuilder("",
Type.VOID, new Type[0], cf, Constants.ACC_PUBLIC);
// call the superclass constructor
mb.appendLoadLocal(0);
if (m_name == null) {
if (named) {
if (dual) {
mb.appendACONST_NULL();
mb.appendICONST_0();
mb.appendACONST_NULL();
} else if (out) {
mb.appendICONST_0();
mb.appendACONST_NULL();
} else {
mb.appendACONST_NULL();
mb.appendACONST_NULL();
}
}
} else {
if (dual) {
m_name.genPushUri(mb);
m_name.genPushIndexPair(mb);
} else if (out) {
m_name.genPushIndexPair(mb);
} else {
m_name.genPushUriPair(mb);
}
}
if (classed) {
mb.appendLoadConstant(m_targetClass.getName());
}
mb.appendCallInit(base.getName(), init.getSignature());
// finish with return
mb.appendReturn();
mb.codeComplete(false);
// add method and class
mb.addMethod();
cf = MungedClass.getUniqueSupportClass(cf);
// save as appropriate type(s)
if (dual) {
m_marshaller = m_unmarshaller = cf;
} else if (out) {
m_marshaller = cf;
} else {
m_unmarshaller = cf;
}
}
/**
* Generate presence test code for this mapping. The generated code finds
* the unmarshaller and calls the test method, leaving the result on the
* stack.
*
* @param mb method builder
* @throws JiBXException if error in generating code
*/
public void genTestPresent(ContextMethodBuilder mb) throws JiBXException {
// start with call to unmarshalling context method to get the
// unmarshaller instance
mb.loadContext();
genLoadSlot(mb);
mb.appendCallInterface(GETUNMARSHALLER_METHOD,
GETUNMARSHALLER_SIGNATURE);
// call the actual unmarshaller test method with context as argument
mb.loadContext();
mb.appendCallInterface(UNMARSHALLER_TESTPRESENT_METHOD,
UNMARSHALLER_TESTPRESENT_SIGNATURE);
}
/**
* Generate unmarshalling code for this mapping. The generated code finds
* and calls the unmarshaller with the object to be unmarshaller (which
* needs to be loaded on the stack by the code prior to this call, but may
* be null). The unmarshalled object (or null in
* the case of a missing optional item) is left on the stack after this
* call. The calling method generally needs to cast this object reference to
* the appropriate type before using it.
*
* @param mb method builder
* @throws JiBXException if error in generating code
*/
public void genUnmarshal(ContextMethodBuilder mb) throws JiBXException {
// start with call to unmarshalling context method to get the
// unmarshaller instance
mb.loadContext();
genLoadSlot(mb);
mb.appendCallInterface(GETUNMARSHALLER_METHOD,
GETUNMARSHALLER_SIGNATURE);
// call the actual unmarshaller with object and context as arguments
mb.appendSWAP();
mb.loadContext();
mb.appendCallInterface(UNMARSHALLER_UNMARSHAL_METHOD,
UNMARSHALLER_UNMARSHAL_SIGNATURE);
}
/**
* Generate marshalling code for this mapping. The generated code finds
* and calls the marshaller, passing the object to be marshalled (which
* should have been loaded to the stack by the prior generated code)..
*
* @param mb method builder
* @throws JiBXException if error in configuration
*/
public void genMarshal(ContextMethodBuilder mb) throws JiBXException {
// start with call to marshalling context method to get the marshaller
// instance
mb.loadContext();
genLoadSlot(mb);
mb.appendLoadConstant(m_targetClass.getName());
mb.appendCallInterface(GETMARSHALLER_METHOD, GETMARSHALLER_SIGNATURE);
// check for an abstract mapping being used
if (m_isAbstract) {
// make sure returned marshaller implements required interface
mb.appendCreateCast(ABSTRACTMARSHALLER_INTERFACE);
// swap to reorder object and marshaller
mb.appendSWAP();
// call indirect marshaller for abstract base class with the object
// itself and context as arguments
mb.loadContext();
mb.appendCallInterface(ABSTRACTMARSHAL_METHOD,
ABSTRACTMARSHAL_SIGNATURE);
} else {
// swap to reorder object and marshaller
mb.appendSWAP();
// call the direct marshaller with the object itself and context as
// arguments
mb.loadContext();
mb.appendCallInterface(MARSHALLER_MARSHAL_METHOD,
MARSHALLER_MARSHAL_SIGNATURE);
}
}
/**
* Get target class for mapping.
*
* @return target class information
*/
public ClassFile getTargetClass() {
return m_targetClass;
}
/**
* Get marshaller class used for mapping. If a name has been supplied the
* actual marshaller class is created by extending the base class the first
* time this method is called.
*
* @return marshaller class information
* @throws JiBXException if error in transformation
*/
public ClassFile getMarshaller() throws JiBXException {
if (m_marshaller == null && m_marshallerBase != null) {
createSubclass(true);
}
return m_marshaller;
}
/**
* Get unmarshaller class used for mapping. If a name has been supplied the
* actual unmarshaller class is created by extending the base class the
* first time this method is called.
*
* @return unmarshaller class information
* @throws JiBXException if error in transformation
*/
public ClassFile getUnmarshaller() throws JiBXException {
if (m_unmarshaller == null && m_unmarshallerBase != null) {
createSubclass(false);
}
return m_unmarshaller;
}
//
// IComponent interface method definitions
public boolean isOptional() {
return false;
}
public boolean hasAttribute() {
return false;
}
public void genAttrPresentTest(ContextMethodBuilder mb) {
throw new IllegalStateException
("Internal error - no attributes defined");
}
public void genAttributeUnmarshal(ContextMethodBuilder mb) {
throw new IllegalStateException
("Internal error - no attributes defined");
}
public void genAttributeMarshal(ContextMethodBuilder mb) {
throw new IllegalStateException
("Internal error - no attributes defined");
}
public boolean hasContent() {
return true;
}
public void genContentPresentTest(ContextMethodBuilder mb)
throws JiBXException {
genTestPresent(mb);
}
public void genContentUnmarshal(ContextMethodBuilder mb)
throws JiBXException {
genUnmarshal(mb);
}
public void genContentMarshal(ContextMethodBuilder mb)
throws JiBXException {
genMarshal(mb);
}
public void genNewInstance(ContextMethodBuilder mb) {
throw new IllegalStateException
("Internal error - no instance creation");
}
public String getType() {
return m_targetClass.getFile().getName();
}
public boolean hasId() {
return false;
}
public void genLoadId(ContextMethodBuilder mb) {
throw new IllegalStateException("Internal error - no ID allowed");
}
public NameDefinition getWrapperName() {
return m_name;
}
public void setLinkages() throws JiBXException {
if (m_name != null) {
m_name.fixNamespace(m_defContext);
}
}
// DEBUG
public void print(int depth) {
BindingDefinition.indent(depth);
System.out.println("direct marshaller/unmarshaller reference" );
}
}
libjibx-java-1.1.6a/build/src/org/jibx/binding/def/DirectProperty.java 0000644 0001750 0001750 00000016607 10435324110 025510 0 ustar moeller moeller /*
Copyright (c) 2003-2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import org.jibx.binding.classes.*;
import org.jibx.runtime.JiBXException;
/**
* Property reference with marshaller and unmarshaller. This handles loading
* and storing the property value, calling the supplied marshaller and
* unmarshaller for all else.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class DirectProperty implements IComponent
{
/** Property definition. */
private final PropertyDefinition m_property;
/** Property value direct binding. */
private final DirectObject m_direct;
/**
* Constructor.
*
* @param prop property definition
* @param direct object direct binding information
*/
public DirectProperty(PropertyDefinition prop, DirectObject direct) {
m_property = prop;
m_direct = direct;
}
//
// IComponent interface method definitions
public boolean isOptional() {
return m_property.isOptional();
}
public boolean hasAttribute() {
return false;
}
public void genAttrPresentTest(ContextMethodBuilder mb)
throws JiBXException {
throw new IllegalStateException
("Internal error - no attributes allowed");
}
public void genAttributeUnmarshal(ContextMethodBuilder mb)
throws JiBXException {
throw new IllegalStateException
("Internal error - no attributes allowed");
}
public void genAttributeMarshal(ContextMethodBuilder mb)
throws JiBXException {
throw new IllegalStateException
("Internal error - no attributes allowed");
}
public boolean hasContent() {
return true;
}
public void genContentPresentTest(ContextMethodBuilder mb)
throws JiBXException {
m_direct.genContentPresentTest(mb);
}
public void genContentUnmarshal(ContextMethodBuilder mb)
throws JiBXException {
// check type of property binding
if (m_property.isImplicit()) {
// load null to force create of new object for item in collection
mb.appendACONST_NULL();
m_direct.genContentUnmarshal(mb);
} else if (m_property.isThis()) {
// load existing object to unmarshal for "this" reference
mb.loadObject();
m_direct.genContentUnmarshal(mb);
} else {
// start by generating code to load owning object so can finish by
// storing to property
mb.loadObject();
BranchWrapper ifpres = null;
BranchWrapper tosave = null;
if (m_property.isOptional()) {
// generate code to check presence for the case of an optional
// item, with branch if so; if not present, set a null value
// with branch to be targeted at property store.
m_direct.genContentPresentTest(mb);
ifpres = mb.appendIFNE(this);
mb.appendACONST_NULL();
tosave = mb.appendUnconditionalBranch(this);
}
// generate unmarshalling code for not optional, or optional and
// present; get existing instance or create a new one and handle
// attribute unmarshalling
mb.targetNext(ifpres);
mb.loadObject();
m_property.genLoad(mb);
m_direct.genContentUnmarshal(mb);
mb.appendCreateCast(m_property.getSetValueType());
mb.targetNext(tosave);
m_property.genStore(mb);
}
}
public void genContentMarshal(ContextMethodBuilder mb)
throws JiBXException {
// check type of property binding
if (m_property.isImplicit()) {
// marshal object already loaded on stack
m_direct.genContentMarshal(mb);
} else if (m_property.isThis()) {
// load object to marshal for "this" reference
mb.loadObject();
m_direct.genContentMarshal(mb);
} else {
// start by generating code to load the actual object reference
mb.loadObject();
m_property.genLoad(mb);
BranchWrapper missing = null;
if (m_property.isOptional()) {
// generate code to check null for the case of an optional item,
// with branch if so; if present, just reload object and fall
// through.
missing = mb.appendIFNULL(this);
mb.loadObject();
m_property.genLoad(mb);
}
// generate code for actual marshalling if not optional, or optional
// and nonnull; then finish by setting target for optional with
// null value case
m_direct.genContentMarshal(mb);
mb.targetNext(missing);
}
}
public void genNewInstance(ContextMethodBuilder mb) {
throw new IllegalStateException
("Internal error - no instance creation");
}
public String getType() {
return m_property.getTypeName();
}
public boolean hasId() {
return false;
}
public void genLoadId(ContextMethodBuilder mb) throws JiBXException {
throw new IllegalStateException("Internal error - no id defined");
}
public NameDefinition getWrapperName() {
return m_direct.getWrapperName();
}
public void setLinkages() throws JiBXException {
m_direct.setLinkages();
}
// DEBUG
public void print(int depth) {
BindingDefinition.indent(depth);
if (m_property == null) {
System.out.println("direct implicit property");
} else {
System.out.println("direct property using " +
m_property.toString());
}
m_direct.print(depth+1);
}
}
libjibx-java-1.1.6a/build/src/org/jibx/binding/def/ElementWrapper.java 0000644 0001750 0001750 00000052373 11013374744 025476 0 ustar moeller moeller /*
Copyright (c) 2003-2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import org.jibx.binding.classes.*;
import org.jibx.runtime.JiBXException;
/**
* Component decorator for element definition. This associates an element name
* with a component.
*
* @author Dennis M. Sosnoski
*/
public class ElementWrapper implements IComponent
{
//
// Constants and such related to code generation.
private static final String UNMARSHAL_PARSESTARTATTRIBUTES =
"org.jibx.runtime.impl.UnmarshallingContext.parseToStartTag";
private static final String UNMARSHAL_PARSESTARTNOATTRIBUTES =
"org.jibx.runtime.impl.UnmarshallingContext.parsePastStartTag";
private static final String UNMARSHAL_PARSEPASTSTART =
"org.jibx.runtime.impl.UnmarshallingContext.parsePastStartTag";
private static final String UNMARSHAL_PARSESTARTSIGNATURE =
"(Ljava/lang/String;Ljava/lang/String;)V";
private static final String UNMARSHAL_PARSEENDMETHOD =
"org.jibx.runtime.impl.UnmarshallingContext.parsePastCurrentEndTag";
private static final String UNMARSHAL_PARSEENDSIGNATURE =
"(Ljava/lang/String;Ljava/lang/String;)V";
private static final String UNMARSHAL_ISATMETHOD =
"org.jibx.runtime.IUnmarshallingContext.isAt";
private static final String UNMARSHAL_ISATSIGNATURE =
"(Ljava/lang/String;Ljava/lang/String;)Z";
private static final String UNMARSHAL_SKIPELEMENTMETHOD =
"org.jibx.runtime.impl.UnmarshallingContext.parsePastElement";
private static final String UNMARSHAL_SKIPELEMENTSIGNATURE =
"(Ljava/lang/String;Ljava/lang/String;)V";
private static final String MARSHAL_WRITESTARTNAMESPACES =
"org.jibx.runtime.impl.MarshallingContext.startTagNamespaces";
private static final String MARSHAL_STARTNAMESPACESSIGNATURE =
"(ILjava/lang/String;[I[Ljava/lang/String;)" +
"Lorg/jibx/runtime/impl/MarshallingContext;";
private static final String MARSHAL_WRITESTARTATTRIBUTES =
"org.jibx.runtime.impl.MarshallingContext.startTagAttributes";
private static final String MARSHAL_WRITESTARTNOATTRIBUTES =
"org.jibx.runtime.impl.MarshallingContext.startTag";
private static final String MARSHAL_WRITESTARTSIGNATURE =
"(ILjava/lang/String;)Lorg/jibx/runtime/impl/MarshallingContext;";
private static final String MARSHAL_CLOSESTARTCONTENT =
"org.jibx.runtime.impl.MarshallingContext.closeStartContent";
private static final String MARSHAL_CLOSESTARTEMPTY =
"org.jibx.runtime.impl.MarshallingContext.closeStartEmpty";
private static final String MARSHAL_CLOSESTARTSIGNATURE =
"()Lorg/jibx/runtime/impl/MarshallingContext;";
private static final String MARSHAL_WRITEENDMETHOD =
"org.jibx.runtime.impl.MarshallingContext.endTag";
private static final String MARSHAL_WRITEENDSIGNATURE =
"(ILjava/lang/String;)Lorg/jibx/runtime/impl/MarshallingContext;";
private static final String UNMARSHAL_PARSE_TO_START_NAME =
"org.jibx.runtime.impl.UnmarshallingContext.parseToStartTag";
private static final String UNMARSHAL_PARSE_TO_START_SIGNATURE =
"(Ljava/lang/String;Ljava/lang/String;)V";
protected static final String UNMARSHAL_ATTRIBUTE_BOOLEAN_NAME =
"org.jibx.runtime.impl.UnmarshallingContext.attributeBoolean";
protected static final String UNMARSHAL_ATTRIBUTE_BOOLEAN_SIGNATURE =
"(Ljava/lang/String;Ljava/lang/String;Z)Z";
private static final String UNMARSHAL_SKIP_NAME =
"org.jibx.runtime.impl.UnmarshallingContext.skipElement";
private static final String UNMARSHAL_SKIP_SIGNATURE = "()V";
protected static final String MARSHAL_STARTTAG_ATTRIBUTES =
"org.jibx.runtime.impl.MarshallingContext.startTagAttributes";
protected static final String MARSHAL_STARTTAG_SIGNATURE =
"(ILjava/lang/String;)Lorg/jibx/runtime/impl/MarshallingContext;";
protected static final String MARSHAL_CLOSESTART_EMPTY =
"org.jibx.runtime.impl.MarshallingContext.closeStartEmpty";
protected static final String MARSHAL_CLOSESTART_EMPTY_SIGNATURE =
"()Lorg/jibx/runtime/impl/MarshallingContext;";
protected static final String MARSHAL_ATTRIBUTE =
"org.jibx.runtime.impl.MarshallingContext.attribute";
protected static final String MARSHAL_SIGNATURE =
"(ILjava/lang/String;Ljava/lang/String;)" +
"Lorg/jibx/runtime/impl/MarshallingContext;";
private static final String MARSHALLING_CONTEXT =
"org.jibx.runtime.impl.MarshallingContext";
private static final String UNMARSHALLING_CONTEXT =
"org.jibx.runtime.impl.UnmarshallingContext";
//
// Actual instance data.
/** Property value binding component. */
private final IComponent m_component;
/** Binding definition context. */
private final DefinitionContext m_defContext;
/** Element name information. */
private final NameDefinition m_name;
/** Flag for nillable element. */
private final boolean m_isNillable;
/** Flag for value from collection (TODO: fix this in update). */
private boolean m_directAccess;
/** Flag for optional ignored element (TODO: fix this in update). */
private boolean m_optionalIgnored;
/** Flag for optional normal element (TODO: fix this in update). */
private boolean m_optionalNormal;
/** Flag for optional structure object (TODO: fix this in update). */
private boolean m_structureObject;
/**
* Constructor.
*
* @param defc definition context for this component
* @param name element name definition
* @param wrap wrapped binding component (may be null, in the
* case of a throwaway component)
* @param nillable flag for nillable element
*/
public ElementWrapper(DefinitionContext defc, NameDefinition name,
IComponent wrap, boolean nillable) {
m_defContext = defc;
m_name = name;
m_component = wrap;
m_isNillable = nillable;
}
/**
* Set the direct access flag. This controls a variation in the code
* generation to handle values loaded from a collection.
*
* @param direct true if direct access from collection,
* false if not
*/
public void setDirect(boolean direct) {
m_directAccess = direct;
}
/**
* Set flag for an optional ignored element.
*
* @param opt true if optional ignored element,
* false if not
*/
public void setOptionalIgnored(boolean opt) {
m_optionalIgnored = opt;
}
/**
* Set flag for an optional structure object.
*
* @param opt true if optional structure object,
* false if not
*/
public void setStructureObject(boolean opt) {
m_structureObject = opt;
}
/**
* Set flag for an optional normal element.
*
* @param opt true if optional normal element,
* false if not
*/
public void setOptionalNormal(boolean opt) {
m_optionalNormal = opt;
}
//
// IComponent interface method definitions
public boolean isOptional() {
return m_optionalNormal || m_optionalIgnored;
}
public boolean hasAttribute() {
return false;
}
public void genAttrPresentTest(ContextMethodBuilder mb) {
throw new IllegalStateException
("Internal error - no attributes from child element");
}
public void genAttributeUnmarshal(ContextMethodBuilder mb) {
throw new IllegalStateException
("Internal error - no attributes from child element");
}
public void genAttributeMarshal(ContextMethodBuilder mb) {
throw new IllegalStateException
("Internal error - no attributes from child element");
}
public boolean hasContent() {
return true;
}
public void genContentPresentTest(ContextMethodBuilder mb)
throws JiBXException {
// create call to unmarshalling context method with namespace and
// name, then return result directly
mb.loadContext();
m_name.genPushUriPair(mb);
mb.appendCallInterface(UNMARSHAL_ISATMETHOD, UNMARSHAL_ISATSIGNATURE);
}
public void genContentUnmarshal(ContextMethodBuilder mb)
throws JiBXException {
// check for optional empty wrapper present
BranchWrapper ifmiss = null;
if (isOptional()) {
genContentPresentTest(mb);
ifmiss = mb.appendIFEQ(this);
}
BranchWrapper ifnil = null;
if (m_isNillable) {
// make sure we're at the element
mb.loadContext(UNMARSHALLING_CONTEXT);
m_name.genPushUriPair(mb);
mb.appendCallVirtual(UNMARSHAL_PARSE_TO_START_NAME,
UNMARSHAL_PARSE_TO_START_SIGNATURE);
// check for xsi:nil="true"
mb.loadContext(UNMARSHALLING_CONTEXT);
mb.appendLoadConstant("http://www.w3.org/2001/XMLSchema-instance");
mb.appendLoadConstant("nil");
mb.appendICONST_0();
mb.appendCallVirtual(UNMARSHAL_ATTRIBUTE_BOOLEAN_NAME,
UNMARSHAL_ATTRIBUTE_BOOLEAN_SIGNATURE);
BranchWrapper notnil = mb.appendIFEQ(this);
// skip past the element before jumping to end
mb.loadContext(UNMARSHALLING_CONTEXT);
mb.appendCallVirtual(UNMARSHAL_SKIP_NAME,
UNMARSHAL_SKIP_SIGNATURE);
ifnil = mb.appendUnconditionalBranch(this);
mb.targetNext(notnil);
}
// set up flags for controlling code generation paths
boolean attr = m_component != null && m_component.hasAttribute();
boolean cont = m_component != null && m_component.hasContent();
// load the unmarshalling context followed by the namespace URI and
// element name.
mb.loadContext(UNMARSHALLING_CONTEXT);
m_name.genPushUriPair(mb);
// check type of unmarshalling behavior required
if (attr) {
// unmarshal start tag with attribute(s)
mb.appendCallVirtual(UNMARSHAL_PARSESTARTATTRIBUTES,
UNMARSHAL_PARSESTARTSIGNATURE);
m_component.genAttributeUnmarshal(mb);
// generate code to parse past the start tag with another call
// to unmarshalling context
mb.loadContext(UNMARSHALLING_CONTEXT);
m_name.genPushUriPair(mb);
mb.appendCallVirtual(UNMARSHAL_PARSEPASTSTART,
UNMARSHAL_PARSESTARTSIGNATURE);
} else if (cont) {
// unmarshal start tag without attributes
mb.appendCallVirtual(UNMARSHAL_PARSESTARTNOATTRIBUTES,
UNMARSHAL_PARSESTARTSIGNATURE);
} else {
// unmarshal element discarding all content
mb.appendCallVirtual(UNMARSHAL_SKIPELEMENTMETHOD,
UNMARSHAL_SKIPELEMENTSIGNATURE);
}
// unmarshal child content
if (cont) {
m_component.genContentUnmarshal(mb);
}
// next add code to push context, namespace and name, and call
// method to parse past end tag
if (attr || cont) {
mb.loadContext(UNMARSHALLING_CONTEXT);
m_name.genPushUriPair(mb);
mb.appendCallVirtual(UNMARSHAL_PARSEENDMETHOD,
UNMARSHAL_PARSEENDSIGNATURE);
}
// check if need code to handle missing or nil element
if (ifmiss != null || ifnil != null) {
// handle branch conditions, jumping around code to set null
BranchWrapper toend = mb.appendUnconditionalBranch(this);
mb.targetNext(ifmiss);
mb.targetNext(ifnil);
// generate code to store null to property
if (m_component instanceof ComponentProperty) {
PropertyDefinition prop =
((ComponentProperty)m_component).getProperty();
if (!prop.isImplicit()) {
mb.loadObject();
mb.appendACONST_NULL();
prop.genStore(mb);
} else {
mb.appendACONST_NULL();
}
} else {
mb.appendPOP();
mb.appendACONST_NULL();
}
mb.targetNext(toend);
}
}
public void genContentMarshal(ContextMethodBuilder mb)
throws JiBXException {
// nothing to be done if optional ignored element
if (!m_optionalIgnored) {
boolean noprop = m_directAccess ||
(!(m_component instanceof ComponentProperty) &&
!(m_component instanceof NestedStructure));
BranchWrapper ifmiss = null;
if (m_isNillable) {
// check for null object
BranchWrapper ifhit;
if (noprop) {
mb.appendDUP();
ifhit = mb.appendIFNONNULL(this);
mb.appendPOP();
} else {
PropertyDefinition prop =
((ComponentProperty)m_component).getProperty();
mb.loadObject();
prop.genLoad(mb);
ifhit = mb.appendIFNONNULL(this);
}
// generate empty element with xsi:nil="true"
mb.loadContext(MARSHALLING_CONTEXT);
m_name.genPushIndexPair(mb);
mb.appendCallVirtual(MARSHAL_STARTTAG_ATTRIBUTES,
MARSHAL_STARTTAG_SIGNATURE);
mb.appendLoadConstant(2);
mb.appendLoadConstant("nil");
mb.appendLoadConstant("true");
mb.appendCallVirtual(MARSHAL_ATTRIBUTE, MARSHAL_SIGNATURE);
mb.appendCallVirtual(MARSHAL_CLOSESTART_EMPTY,
MARSHAL_CLOSESTART_EMPTY_SIGNATURE);
mb.appendPOP();
ifmiss = mb.appendUnconditionalBranch(this);
mb.targetNext(ifhit);
}
// set up flags for controlling code generation paths
boolean attr = m_component != null && m_component.hasAttribute();
boolean cont = m_component != null && m_component.hasContent();
boolean needns = !m_structureObject && m_defContext.hasNamespace();
// duplicate object reference on stack if both attribute(s) and
// content
if (attr && cont && noprop) {
mb.appendDUP();
}
// load the context followed by namespace index and element name
mb.loadContext(MARSHALLING_CONTEXT);
m_name.genPushIndexPair(mb);
// check type of marshalling behavior required
if (attr || needns) {
// check for namespace definition required
if (needns) {
// marshal start tag with namespace(s)
m_defContext.genLoadNamespaces(mb);
mb.appendCallVirtual(MARSHAL_WRITESTARTNAMESPACES,
MARSHAL_STARTNAMESPACESSIGNATURE);
} else {
// marshal start tag with attribute(s)
mb.appendCallVirtual(MARSHAL_WRITESTARTATTRIBUTES,
MARSHAL_WRITESTARTSIGNATURE);
}
// handle attributes other than namespace declarations
if (attr) {
if (noprop) {
// discard marshalling context from stack before call
mb.appendPOP();
m_component.genAttributeMarshal(mb);
mb.loadContext(MARSHALLING_CONTEXT);
} else {
m_component.genAttributeMarshal(mb);
}
}
// generate code to close the start tag with another call
// to marshalling context
if (cont) {
mb.appendCallVirtual(MARSHAL_CLOSESTARTCONTENT,
MARSHAL_CLOSESTARTSIGNATURE);
} else {
mb.appendCallVirtual(MARSHAL_CLOSESTARTEMPTY,
MARSHAL_CLOSESTARTSIGNATURE);
}
} else if (cont) {
// marshal start tag without attributes
mb.appendCallVirtual(MARSHAL_WRITESTARTNOATTRIBUTES,
MARSHAL_WRITESTARTSIGNATURE);
} else {
// marshal empty tag
mb.appendCallVirtual(MARSHAL_WRITESTARTATTRIBUTES,
MARSHAL_WRITESTARTSIGNATURE);
mb.appendCallVirtual(MARSHAL_CLOSESTARTEMPTY,
MARSHAL_CLOSESTARTSIGNATURE);
}
// handle child content if present
if (cont) {
if (noprop) {
// discard marshalling context from stack before call
mb.appendPOP();
m_component.genContentMarshal(mb);
mb.loadContext(MARSHALLING_CONTEXT);
} else {
m_component.genContentMarshal(mb);
}
// write the element close tag
m_name.genPushIndexPair(mb);
mb.appendCallVirtual(MARSHAL_WRITEENDMETHOD,
MARSHAL_WRITEENDSIGNATURE);
}
mb.appendPOP();
mb.targetNext(ifmiss);
}
}
public void genNewInstance(ContextMethodBuilder mb) throws JiBXException {
if (m_component == null) {
throw new IllegalStateException
("Internal error - no wrapped component");
} else {
m_component.genNewInstance(mb);
}
}
public String getType() {
if (m_component == null) {
throw new IllegalStateException
("Internal error - no wrapped component");
} else {
return m_component.getType();
}
}
public boolean hasId() {
if (m_component == null) {
return false;
} else {
return m_component.hasId();
}
}
public void genLoadId(ContextMethodBuilder mb) throws JiBXException {
if (m_component == null) {
throw new IllegalStateException
("Internal error - no wrapped component");
} else {
m_component.genLoadId(mb);
}
}
public NameDefinition getWrapperName() {
return m_name;
}
public void setLinkages() throws JiBXException {
m_name.fixNamespace(m_defContext);
if (m_component != null) {
m_component.setLinkages();
}
}
// DEBUG
public void print(int depth) {
BindingDefinition.indent(depth);
System.out.println(toString());
if (m_component != null) {
m_component.print(depth+1);
}
}
public String toString() {
StringBuffer buff = new StringBuffer("element wrapper");
if (m_name != null) {
buff.append(' ');
buff.append(m_name.toString());
}
if (m_directAccess) {
buff.append(" direct");
}
if (m_optionalIgnored) {
buff.append(" optional ignored");
}
if (m_optionalNormal) {
buff.append(" optional");
}
if (m_structureObject) {
buff.append(" structure object");
}
return buff.toString();
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/def/IComponent.java 0000644 0001750 0001750 00000020213 10435324110 024570 0 ustar moeller moeller /*
Copyright (c) 2003-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import org.jibx.binding.classes.ContextMethodBuilder;
import org.jibx.runtime.JiBXException;
/**
* Child component (attribute or content) interface definition. This interface
* provides the basic hooks for generating code from the binding definition.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public interface IComponent
{
/**
* Check if component is an optional item.
*
* @return true if optional, false if required
*/
public boolean isOptional();
/**
* Check if component defines one or more attribute values of the
* containing element.
*
* @return true if one or more attribute values defined for
* containing element, false if not
*/
public boolean hasAttribute();
/**
* Generate code to test for attribute present. This generates code that
* tests if a child is present as determined by attributes of the containing
* start tag. It leaves the result of the test (zero if missing, nonzero if
* present) on the stack. This call is only valid if this component has one
* or more attributes for the containing element.
*
* @param mb method builder
* @throws JiBXException if configuration error
*/
public void genAttrPresentTest(ContextMethodBuilder mb)
throws JiBXException;
/**
* Generate attribute unmarshalling code. This is called within the code
* generation for the unmarshaller of the class associated with the
* containing element. It needs to generate the necessary code for handling
* the unmarshalling operation, leaving the unmarshalled object
* reference on the stack.
*
* @param mb method builder
* @throws JiBXException if error in configuration
*/
public void genAttributeUnmarshal(ContextMethodBuilder mb)
throws JiBXException;
/**
* Generate attribute marshalling code. This is called within the code
* generation for the marshaller of the class associated with the
* containing element. It needs to generate the necessary code for handling
* the marshalling operation, consuming the marshalled object
* reference from the stack.
*
* @param mb method builder
* @throws JiBXException if error in configuration
*/
public void genAttributeMarshal(ContextMethodBuilder mb)
throws JiBXException;
/**
* Check if component defines one or more elements or text values as
* children of the containing element. This method is only valid after the
* call to {@link #setLinkages()}.
*
* @return true if one or more content values defined
* for containing element, false if not
*/
public boolean hasContent();
/**
* Generate code to test for content present. This generates code that
* tests if a required element is present, leaving the result of the test
* (zero if missing, nonzero if present) on the stack. This call is only
* valid if this component has one or more content components for the
* containing element.
*
* @param mb method builder
* @throws JiBXException if configuration error
*/
public void genContentPresentTest(ContextMethodBuilder mb)
throws JiBXException;
/**
* Generate element or text unmarshalling code. This is called within the
* code generation for the unmarshaller of the class associated with the
* containing element. It needs to generate the necessary code for
* handling the unmarshalling operation, leaving the unmarshalled object
* reference on the stack.
*
* @param mb method builder
* @throws JiBXException if error in configuration
*/
public void genContentUnmarshal(ContextMethodBuilder mb)
throws JiBXException;
/**
* Generate element or text marshalling code. This is called within the
* code generation for the marshaller of the class associated with the
* containing element. It needs to generate the necessary code for
* handling the marshalling operation, consuming the marshalled object
* reference from the stack.
*
* @param mb method builder
* @throws JiBXException if error in configuration
*/
public void genContentMarshal(ContextMethodBuilder mb) throws JiBXException;
/**
* Generate code to create new instance of object. This is called within the
* code generation for the unmarshaller of the class associated with the
* containing element. It needs to generate the necessary code for creating
* an instance of the object to be unmarshalled, leaving the object
* reference on the stack.
*
* @param mb method builder
* @throws JiBXException if error in configuration
*/
public void genNewInstance(ContextMethodBuilder mb) throws JiBXException;
/**
* Get type expected by component.
*
* @return fully qualified class name of expected type
*/
public String getType();
/**
* Check if component defines an ID value for instances of context object.
*
* @return true if ID value defined for instances,
* false if not
*/
public boolean hasId();
/**
* Generate code to load ID value of instance to stack. The generated code
* should assume that the top of the stack is the reference for the
* containing object. It must consume this and leave the actual ID value
* on the stack (as a String).
*
* @param mb method builder
* @throws JiBXException if configuration error
*/
public void genLoadId(ContextMethodBuilder mb) throws JiBXException;
/**
* Get element wrapper name. If the component defines an element as the
* container for content, this returns the name information for that
* element.
*
* @return component element name, null if no wrapper element
*/
public NameDefinition getWrapperName();
/**
* Establish and validate linkages between binding components. This is
* called after the basic binding structures have been set up. All linkages
* between components must be resolved by this method, in order to prevent
* problems due to the order of definitions between components. This implies
* that each component must in turn call the same method for each child
* component. None of the other method calls defined by this interface are
* valid until after this call.
*
* @throws JiBXException if error in configuration
*/
public void setLinkages() throws JiBXException;
// DEBUG
public void print(int depth);
}
libjibx-java-1.1.6a/build/src/org/jibx/binding/def/IContainer.java 0000644 0001750 0001750 00000005030 10071714302 024552 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
/**
* Containing binding definitions structure interface. This interface is
* implemented by components corresponding to elements in the binding definition
* that can contain other elements. It supplies a context for resolving
* reference to mappings, formats, or labeled structures, and for inherited
* settings.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public interface IContainer
{
/**
* Check if content children are ordered.
*
* @return true if ordered, false if not
*/
public boolean isContentOrdered();
/**
* Get default style for value expression.
*
* @return default style type for values
*/
public int getStyleDefault();
/**
* Get definition context for binding element.
*
* @return binding definition context
*/
public DefinitionContext getDefinitionContext();
/**
* Get root of binding definition.
*
* @return binding definition root
*/
public BindingDefinition getBindingRoot();
}
libjibx-java-1.1.6a/build/src/org/jibx/binding/def/IContextObj.java 0000644 0001750 0001750 00000004450 10071714302 024714 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import org.jibx.binding.classes.*;
/**
* Containing object context interface. This interface is implemented by binding
* definition components that link to objects and can contain nested components.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public interface IContextObj
{
/**
* Get class linked to binding element.
*
* @return information for class linked by binding
*/
public BoundClass getBoundClass();
/**
* Set ID property. Tells the parent binding element that a particular
* child defines an ID property for the class linked to the parent.
*
* @param child child defining the ID property
* @return true if successful, false if ID
* already defined
*/
public boolean setIdChild(IComponent child);
} libjibx-java-1.1.6a/build/src/org/jibx/binding/def/IMapping.java 0000644 0001750 0001750 00000012722 10541604220 024230 0 ustar moeller moeller /*
Copyright (c) 2003-2006, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import java.util.ArrayList;
import org.jibx.binding.classes.ClassFile;
import org.jibx.runtime.JiBXException;
/**
* Interface for mapping definitions. This defines the additional access methods
* used with mappings (beyond those used with ordinary components).
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public interface IMapping extends IComponent
{
/**
* Get class name handled by mapping.
*
* @return name of class bound by mapping
*/
public String getBoundType();
/**
* Get class name of type to be assumed for references to this mapping.
*
* @return reference type class name name
*/
public String getReferenceType();
/**
* Get binding component implementing mapping. This call is only valid for
* mappings with child components, not for mappings defined using
* marshallers or unmarshallers.
*
* @return binding component implementing this mapping
*/
public IComponent getImplComponent();
/**
* Get marshaller class used for mapping.
*
* @return marshaller class information
* @throws JiBXException if error in configuration
*/
public ClassFile getMarshaller() throws JiBXException;
/**
* Get unmarshaller class used for mapping.
*
* @return unmarshaller class information
* @throws JiBXException if error in configuration
*/
public ClassFile getUnmarshaller() throws JiBXException;
/**
* Get mapped element name.
*
* @return mapped element name information (may be null if no
* element name defined for mapping)
*/
public NameDefinition getName();
/**
* Get type name.
*
* @return qualified type name, in text form (null if unnamed)
*/
public String getTypeName();
/**
* Get mapped class index number.
*
* @return mapped class index number in context
*/
public int getIndex();
/**
* Add namespace. This adds a namespace definition to those active for the
* mapping.
*
* @param ns namespace definition to be added
* @throws JiBXException if error in defining namespace
*/
public void addNamespace(NamespaceDefinition ns) throws JiBXException;
/**
* Check if mapping is abstract.
*
* @return true if an abstract mapping, false if
* not
*/
public boolean isAbstract();
/**
* Check if mapping has extensions.
*
* @return true if one or more mappings extend this mapping,
* false if not
*/
public boolean isBase();
/**
* Add extension to abstract mapping. This call is only valid for abstract
* mappings.
*
* @param mdef extension mapping definition
* @throws JiBXException if configuration error
*/
public void addExtension(MappingDefinition mdef) throws JiBXException;
/**
* Build reference to mapping. Constructs and returns the component for
* handling the mapping.
*
* @param parent containing binding definition structure
* @param objc current object context
* @param type mapped value type
* @param prop property definition (may be null)
* @return constructed mapping reference component
* @throws JiBXException if configuration error
*/
public IComponent buildRef(IContainer parent, IContextObj objc, String type,
PropertyDefinition prop) throws JiBXException;
/**
* Get namespaces defined for mapping.
*
* @return namespace definitions (may be null if none)
*/
public ArrayList getNamespaces();
/**
* Generate required code for mapping.
*
* @param force add marshaller/unmarshaller classes for abstract non-base
* mappings flag (not passed on to children)
* @throws JiBXException if error in transformation
*/
public void generateCode(boolean force) throws JiBXException;
} libjibx-java-1.1.6a/build/src/org/jibx/binding/def/LinkableBase.java 0000644 0001750 0001750 00000007117 10767272750 025065 0 ustar moeller moeller /*
Copyright (c) 2003-2008, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import org.jibx.runtime.JiBXException;
/**
* Base class for components that can be linked from multiple locations within
* the binding definition structure. The implemented basic behavior is a simple
* pass-through component, with the addition of recursion checking during the
* linking phase.
*
* @author Dennis M. Sosnoski
*/
public abstract class LinkableBase extends PassThroughComponent
{
/** Flag for linkage in progress. */
private boolean m_isLinking;
/** Flag for linkage complete. */
private boolean m_isLinked;
/**
* No argument constructor. This requires the component to be set later,
* using the {@link
* org.jibx.binding.def.PassThroughComponent#setWrappedComponent} method.
*/
protected LinkableBase() {}
/**
* Constructor.
*
* @param wrap wrapped binding component
*/
public LinkableBase(IComponent wrap) {
super(wrap);
}
/**
* Handler for recursion. If recursion is found during linking this method
* will be called. The base class implementation does nothing, but may be
* overridden by subclases to implement the appropriate behavior.
*/
protected void handleRecursion() {}
/**
* Check if linkage processing for this component is complete.
*
* @return true if complete, false if not
*/
protected boolean isLinked() {
return m_isLinked;
}
//
// IComponent interface method definitions
// subclasses should call the base class implementation if they override
// this method
public void setLinkages() throws JiBXException {
if (m_isLinking) {
handleRecursion();
} else {
if (!m_isLinked) {
m_isLinking = true;
m_component.setLinkages();
m_isLinking = false;
m_isLinked = true;
}
}
}
// DEBUG
public void print(int depth) {
BindingDefinition.indent(depth);
System.out.println("linkable wrapper");
m_component.print(depth+1);
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/def/MappingBase.java 0000644 0001750 0001750 00000022741 10434260242 024717 0 ustar moeller moeller /*
Copyright (c) 2003-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import org.apache.bcel.Constants;
import org.jibx.binding.classes.BoundClass;
import org.jibx.binding.classes.ClassFile;
import org.jibx.binding.classes.ContextMethodBuilder;
import org.jibx.binding.classes.ExceptionMethodBuilder;
import org.jibx.runtime.JiBXException;
/**
* Base class for mapping definitions. This is used for both normal and custom
* mappings. It handles adding the appropriate marshalling and/or unmarshalling
* interfaces and methods to the classes.
*/
public abstract class MappingBase extends LinkableBase implements IMapping
{
//
// Constants and such related to code generation.
// definitions for IMarshallable interface defined on mapped classes
protected static final String IMARSHALLABLE_INTERFACE =
"org.jibx.runtime.IMarshallable";
protected static final String MARSHALLABLE_METHODNAME = "marshal";
protected static final String MARSHALLABLE_SIGNATURE =
"(Lorg/jibx/runtime/IMarshallingContext;)V";
protected static final String GETINDEX_METHODNAME = "JiBX_getIndex";
protected static final String GETINDEX_SIGNATURE = "()I";
protected static final String CHECKEXTENDS_METHODNAME = "isExtension";
protected static final String CHECKEXTENDS_SIGNATURE = "(I)Z";
// definitions for IUnmarshallable interface defined on mapped classes
protected static final String IUNMARSHALLABLE_INTERFACE =
"org.jibx.runtime.IUnmarshallable";
protected static final String UNMARSHALLABLE_METHODNAME = "unmarshal";
protected static final String UNMARSHALLABLE_SIGNATURE =
"(Lorg/jibx/runtime/IUnmarshallingContext;)V";
// interface implemented by unmarshaller class
protected static final String UNMARSHALLER_INTERFACE =
"org.jibx.runtime.IUnmarshaller";
protected static final String UNMARSHALLERUNMARSHAL_METHOD =
"org.jibx.runtime.IUnmarshaller.unmarshal";
protected static final String UNMARSHALLERUNMARSHAL_SIGNATURE =
"(Ljava/lang/Object;Lorg/jibx/runtime/IUnmarshallingContext;)" +
"Ljava/lang/Object;";
// interface implemented by marshaller class
protected static final String MARSHALLER_INTERFACE =
"org.jibx.runtime.IMarshaller";
protected static final String ABSTRACTMARSHALLER_INTERFACE =
"org.jibx.runtime.IAbstractMarshaller";
protected static final String MARSHALLERMARSHAL_METHOD =
"org.jibx.runtime.IMarshaller.marshal";
protected static final String MARSHALLERMARSHAL_SIGNATURE =
"(Ljava/lang/Object;Lorg/jibx/runtime/IMarshallingContext;)V";
// definitions for context methods used to find marshaller and unmarshaller
protected static final String GETMARSHALLER_METHOD =
"org.jibx.runtime.IMarshallingContext.getMarshaller";
protected static final String GETMARSHALLER_SIGNATURE =
"(ILjava/lang/String;)Lorg/jibx/runtime/IMarshaller;";
protected static final String GETUNMARSHALLER_METHOD =
"org.jibx.runtime.IUnmarshallingContext.getUnmarshaller";
protected static final String GETUNMARSHALLER_SIGNATURE =
"(I)Lorg/jibx/runtime/IUnmarshaller;";
//
// Actual instance data.
/** Index number for this particular binding definition. */
private final int m_indexNumber;
/** Qualified type name, in text form. */
private final String m_typeName;
/**
* Constructor. This version requires the component to be set later,
* using the {@link
* org.jibx.binding.def.PassThroughComponent#setWrappedComponent} method.
*
* @param contain containing binding definition structure
* @param type class name handled by mapping
* @param tname qualified type name, in text form
*/
public MappingBase(IContainer contain, String type, String tname) {
String name = (tname == null) ? type : tname;
m_indexNumber = contain.getBindingRoot().getMappedClassIndex(name);
m_typeName = tname;
}
/**
* Constructor with wrapped component supplied.
*
* @param contain containing binding definition structure
* @param type class name handled by mapping
* @param tname qualified type name, in text form
* @param wrap wrapped binding component
*/
public MappingBase(IContainer contain, String type, String tname,
IComponent wrap) {
this(contain, type, tname);
setWrappedComponent(wrap);
}
/**
* Get the mapped class information. This must be implemented in each
* subclass to return the type of the bound class.
*
* @return information for mapped class
*/
public abstract BoundClass getBoundClass();
/**
* Generate marshallable interface methods for this mapping. This is not
* applicable to abstract mappings, since they cannot be marshalled as
* separate items.
*
* @throws JiBXException if error in generating code
*/
protected void addIMarshallableMethod() throws JiBXException {
// set up for constructing actual marshal method
BoundClass clas = getBoundClass();
ClassFile cf = clas.getMungedFile();
ContextMethodBuilder mb = new ContextMethodBuilder
(MARSHALLABLE_METHODNAME, MARSHALLABLE_SIGNATURE, cf,
Constants.ACC_PUBLIC, 0, clas.getClassFile().getName(),
1, MARSHALLER_INTERFACE);
// create call to marshalling context method with class index and
// actual class name
mb.loadContext();
mb.appendLoadConstant(getIndex());
mb.appendLoadConstant(cf.getName());
mb.appendCallInterface(GETMARSHALLER_METHOD, GETMARSHALLER_SIGNATURE);
// call the returned marshaller with this object and the marshalling
// context as parameters
mb.loadObject();
mb.loadContext();
mb.appendCallInterface(MARSHALLERMARSHAL_METHOD,
MARSHALLERMARSHAL_SIGNATURE);
mb.appendReturn();
// add method to class
clas.getUniqueNamed(mb);
// set up for constructing get index method
ExceptionMethodBuilder xb = new ExceptionMethodBuilder
(GETINDEX_METHODNAME, GETINDEX_SIGNATURE, cf, Constants.ACC_PUBLIC);
// generate code to return the constant index number
xb.appendLoadConstant(getIndex());
xb.appendReturn("int");
// add the method and interface to class
clas.getUniqueNamed(xb);
clas.getClassFile().addInterface(IMARSHALLABLE_INTERFACE);
}
/**
* Generate unmarshallable interface method for this mapping. This is not
* applicable to abstract mappings, since they cannot be unmarshalled as
* separate items.
*
* @throws JiBXException if error in generating code
*/
protected void addIUnmarshallableMethod() throws JiBXException {
// set up for constructing new method
BoundClass clas = getBoundClass();
ClassFile cf = clas.getMungedFile();
ContextMethodBuilder mb = new ContextMethodBuilder
(UNMARSHALLABLE_METHODNAME, UNMARSHALLABLE_SIGNATURE, cf,
Constants.ACC_PUBLIC, 0, clas.getClassFile().getName(),
1, UNMARSHALLER_INTERFACE);
// create call to unmarshalling context method with class index
mb.loadContext();
mb.appendLoadConstant(getIndex());
mb.appendCallInterface(GETUNMARSHALLER_METHOD,
GETUNMARSHALLER_SIGNATURE);
// call the returned unmarshaller with this object and the unmarshalling
// context as parameters
mb.loadObject();
mb.loadContext();
mb.appendCallInterface(UNMARSHALLERUNMARSHAL_METHOD,
UNMARSHALLERUNMARSHAL_SIGNATURE);
mb.appendReturn();
// add the method and interface to class
clas.getUniqueNamed(mb);
clas.getClassFile().addInterface(IUNMARSHALLABLE_INTERFACE);
}
//
// IMapping interface method definitions
/* (non-Javadoc)
* @see org.jibx.binding.def.IMapping#getIndex()
*/
public int getIndex() {
return m_indexNumber;
}
/* (non-Javadoc)
* @see org.jibx.binding.def.IMapping#getTypeName()
*/
public String getTypeName() {
return m_typeName;
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/def/MappingDefinition.java 0000644 0001750 0001750 00000105703 11010026614 026127 0 ustar moeller moeller /*
Copyright (c) 2003-2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import java.util.ArrayList;
import org.apache.bcel.Constants;
import org.apache.bcel.generic.*;
import org.jibx.binding.classes.*;
import org.jibx.runtime.JiBXException;
/**
* Normal mapping with defined binding. This is used for a mapping definition
* which includes detailed binding information (rather than marshaller and
* unmarshaller classes which handle the binding directly).
*
* @author Dennis M. Sosnoski
*/
public class MappingDefinition extends MappingBase
{
//
// Constants and such related to code generation.
// definitions used in generating the adapter class
private static final String ADAPTERCLASS_SUFFIX = "_access";
private static final String MARSHAL_METHODNAME = "marshal";
private static final String BASEMARSHAL_METHODNAME = "baseMarshal";
private static final String UNMARSHAL_METHODNAME = "unmarshal";
private static final String ISPRESENT_METHODNAME = "isPresent";
private static final String UNMARSHALCONTEXT_CLASS =
"org.jibx.runtime.impl.UnmarshallingContext";
private static final String MARSHALCONTEXT_CLASS =
"org.jibx.runtime.impl.MarshallingContext";
private static final String UNMARSHAL_ISATMETHOD =
"org.jibx.runtime.IUnmarshallingContext.isAt";
private static final String UNMARSHAL_ISATSIGNATURE =
"(Ljava/lang/String;Ljava/lang/String;)Z";
private static final String CHECKEXTENDS_METHOD =
"org.jibx.runtime.IMarshaller.isExtension";
private static final String GETINDEX_METHOD =
"org.jibx.runtime.IMarshallable.JiBX_getIndex";
private static final String UNMARSHALLERPRESENT_METHOD =
"org.jibx.runtime.IUnmarshaller.isPresent";
private static final String UNMARSHALLERPRESENT_SIGNATURE =
"(Lorg/jibx/runtime/IUnmarshallingContext;)Z";
private static final String UNMARSHALCONTEXT_INTERFACE =
"org.jibx.runtime.IUnmarshallingContext";
private static final String MARSHALCONTEXT_INTERFACE =
"org.jibx.runtime.IMarshallingContext";
private static final String CURRENTELEMENT_METHOD =
"org.jibx.runtime.impl.UnmarshallingContext.currentNameString";
private static final String CURRENTELEMENT_SIGNATURE =
"()Ljava/lang/String;";
private static final String PARSERNEXT_METHOD =
"org.jibx.runtime.impl.UnmarshallingContext.next";
private static final String PARSERNEXT_SIGNATURE = "()I";
private static final String CLOSESTART_METHOD =
"org.jibx.runtime.impl.MarshallingContext.closeStartContent";
private static final String CLOSESTART_SIGNATURE =
"()Lorg/jibx/runtime/impl/MarshallingContext;";
private static final String ADDUNMARSHALLER_METHOD =
"org.jibx.runtime.impl.UnmarshallingContext.addUnmarshalling";
private static final String ADDUNMARSHALLER_SIGNATURE =
"(ILjava/lang/String;Ljava/lang/String;Ljava/lang/String;)V";
private static final String REMOVEUNMARSHALLER_METHOD =
"org.jibx.runtime.impl.UnmarshallingContext.removeUnmarshalling";
private static final String REMOVEUNMARSHALLER_SIGNATURE = "(I)V";
private static final String ADDMARSHALLER_METHOD =
"org.jibx.runtime.impl.MarshallingContext.addMarshalling";
private static final String ADDMARSHALLER_SIGNATURE =
"(ILjava/lang/String;)V";
private static final String REMOVEMARSHALLER_METHOD =
"org.jibx.runtime.impl.MarshallingContext.removeMarshalling";
private static final String REMOVEMARSHALLER_SIGNATURE = "(I)V";
// argument list for the unmarshaller methods
private static final Type[] ISPRESENT_METHOD_ARGS =
{
ClassItem.typeFromName("org.jibx.runtime.IUnmarshallingContext")
};
private static final Type[] UNMARSHAL_METHOD_ARGS =
{
Type.OBJECT,
ClassItem.typeFromName("org.jibx.runtime.IUnmarshallingContext")
};
// argument list for the marshaller methods
private static final Type[] MARSHAL_METHOD_ARGS =
{
Type.OBJECT,
ClassItem.typeFromName("org.jibx.runtime.IMarshallingContext")
};
//
// Data shared with other classes within package
// interface list for adapter with unmarshaller only
/*package*/ static final String[] UNMARSHALLER_INTERFACES =
{
UNMARSHALLER_INTERFACE
};
// interface list for adapter with marshaller only
/*package*/ static final String[] MARSHALLER_INTERFACES =
{
MARSHALLER_INTERFACE
};
// interface list for adapter with both unmarshaller and marshaller
/*package*/ static final String[] BOTH_INTERFACES =
{
UNMARSHALLER_INTERFACE, MARSHALLER_INTERFACE
};
//
// Actual instance data.
/** Containing binding definition structure. */
private final IContainer m_container;
/** Definition context for mapping. */
private final DefinitionContext m_defContext;
/** Class linked to mapping. */
private final BoundClass m_class;
/** Mapped element name (may be null if element(s) defined
by marshaller and unmarshaller, or if abstract mapping). */
private final NameDefinition m_name;
/** Abstract mapping flag. */
private final boolean m_isAbstract;
/** Name of abstract base type. */
private final String m_baseType;
/** Type name for abstract mapping. */
private final String m_typeName;
/** Abstract binding this one is based on (null if not an
extension. */
private IMapping m_baseMapping;
/** Duplicate of component structure for use as "this" reference
* (null if not yet defined). */
private IComponent m_thisBinding;
/** Constructed marshaller class. */
private ClassFile m_marshaller;
/** Constructed unmarshaller class. */
private ClassFile m_unmarshaller;
/** Mapping which extend this one (null if none). */
private ArrayList m_extensions;
/** Reference type of mapping, as fully qualifed class name. */
private String m_referenceType;
/**
* Constructor. This initializes the new definition context.
*
* @param contain containing binding definition structure
* @param defc definition context for this mapping
* @param type bound class name
* @param name mapped element name information (null if defined
* by marshaller and unmarshaller)
* @param tname qualified type name for abstract mapping (null
* if none)
* @param abs abstract mapping flag
* @param base abstract mapping extended by this one
* @param bind binding definition component
* @param nillable flag for nillable element
* @throws JiBXException if class definition not found
*/
public MappingDefinition(IContainer contain, DefinitionContext defc,
String type, NameDefinition name, String tname, boolean abs,
String base, ObjectBinding bind, boolean nillable) throws JiBXException {
super(contain, type, tname);
IComponent tref = new ObjectBinding(bind);
if (name == null) {
setWrappedComponent(bind);
} else {
setWrappedComponent(new ElementWrapper(defc, name, bind, nillable));
tref = new ElementWrapper(defc, name, tref, nillable);
}
m_thisBinding = tref;
m_container = contain;
m_defContext = defc;
m_class = BoundClass.getInstance(type, null);
m_referenceType = type == null ? "java.lang.Object" : type;
m_name = name;
m_isAbstract = abs;
m_baseType = base;
m_typeName = tname;
}
/**
* Check if one or more namespaces are defined for element.
*
* @return true if namespaces are defined, false
* if not
*/
/*package*/ boolean hasNamespace() {
return m_defContext.hasNamespace();
}
/**
* Generate code for loading namespace index and URI arrays.
*
* @param mb method builder for generated code
*/
/*package*/ void genLoadNamespaces(MethodBuilder mb) {
m_defContext.genLoadNamespaces(mb);
}
/**
* Get the mapped class information. This implements the method used by the
* base class.
*
* @return information for mapped class
*/
public BoundClass getBoundClass() {
return m_class;
}
/**
* Links extension mappings to their base mappings. This must be done before
* the more general linking step in order to determine which abstract
* mappings are standalone and which are extended by other mappings
*
* @throws JiBXException if error in linking
*/
public void linkMappings() throws JiBXException {
if (m_baseType != null) {
m_baseMapping = m_defContext.getClassMapping(m_baseType);
if (m_baseMapping == null) {
throw new JiBXException("Mapping for base class " + m_baseType +
" not defined");
}
m_baseMapping.addExtension(this);
}
m_defContext.linkMappings();
}
//
// IMapping interface method definitions
public String getBoundType() {
return m_class.getClassName();
}
public String getReferenceType() {
return m_referenceType;
}
public IComponent getImplComponent() {
return m_component;
}
public ClassFile getMarshaller() {
return m_marshaller;
}
public ClassFile getUnmarshaller() {
return m_unmarshaller;
}
public NameDefinition getName() {
return m_name;
}
public void addNamespace(NamespaceDefinition ns) throws JiBXException {
m_defContext.addNamespace(ns);
}
public boolean isAbstract() {
return m_isAbstract;
}
public boolean isBase() {
return m_extensions != null && m_extensions.size() > 0;
}
public void addExtension(MappingDefinition mdef) throws JiBXException {
if (m_extensions == null) {
m_extensions = new ArrayList();
}
if (!m_extensions.contains(mdef)) {
m_extensions.add(mdef);
}
ClassFile cf = mdef.getBoundClass().getClassFile();
if (!cf.isSuperclass(m_referenceType) &&
!cf.isImplements(m_referenceType)) {
m_referenceType = "java.lang.Object";
}
}
public IComponent buildRef(IContainer parent, IContextObj objc, String type,
PropertyDefinition prop) throws JiBXException {
if (prop.isThis()) {
// directly incorporate base mapping definition
return new BaseMappingWrapper(m_thisBinding);
} else if (m_isAbstract && m_extensions == null) {
// create reference to use mapping definition directly
ComponentProperty comp =
new ComponentProperty(prop, m_component, false);
if (!hasAttribute() && !hasContent()) {
comp.setForceUnmarshal(true);
}
return comp;
} else {
// create link to mapping definition
DirectObject dobj = new DirectObject(m_container, null,
m_class.getClassFile(), m_isAbstract || m_extensions != null,
m_marshaller, m_unmarshaller, getIndex(), null);
return new DirectProperty(prop, dobj);
}
}
public ArrayList getNamespaces() {
return m_defContext.getNamespaces();
}
/**
* Add abstract marshaller interface to handler class. This adds the
* interface and generates the {@link
* org.jibx.runtime.IAbstractMarshaller#baseMarshal(Object,
* org.jibx.runtime.IMarshallingContext)} method responsible for passing
* handling on to the appropriate extension class.
*
* @param cf hanlder class
* @throws JiBXException
*/
private void generateAbstractMarshaller(ClassFile cf) throws JiBXException {
// build the implementation method
ContextMethodBuilder mb = new ContextMethodBuilder(BASEMARSHAL_METHODNAME,
Type.VOID, MARSHAL_METHOD_ARGS, cf,
Constants.ACC_PUBLIC|Constants.ACC_FINAL,
1, "java.lang.Object", 2, MARSHALCONTEXT_INTERFACE);
mb.addException(MethodBuilder.FRAMEWORK_EXCEPTION_CLASS);
// TODO: optionally check for null value on object
mb.loadContext();
mb.loadObject(IMARSHALLABLE_INTERFACE);
mb.appendCallInterface(GETINDEX_METHOD, GETINDEX_SIGNATURE);
mb.loadObject();
mb.appendCallVirtual("java.lang.Object.getClass",
"()Ljava/lang/Class;");
mb.appendCallVirtual("java.lang.Class.getName", "()Ljava/lang/String;");
mb.appendCallInterface(GETMARSHALLER_METHOD, GETMARSHALLER_SIGNATURE);
mb.appendDUP();
mb.appendLoadConstant(getIndex());
mb.appendCallInterface(CHECKEXTENDS_METHOD, CHECKEXTENDS_SIGNATURE);
BranchWrapper ifvalid = mb.appendIFNE(this);
// generate and throw exception describing the problem
mb.appendCreateNew("java.lang.StringBuffer");
mb.appendDUP();
mb.appendLoadConstant("Mapping for type ");
mb.appendCallInit("java.lang.StringBuffer", "(Ljava/lang/String;)V");
mb.appendDUP();
mb.loadObject();
mb.appendCallVirtual("java.lang.Object.getClass",
"()Ljava/lang/Class;");
mb.appendCallVirtual("java.lang.Class.getName", "()Ljava/lang/String;");
mb.appendCallVirtual("java.lang.StringBuffer.append",
"(Ljava/lang/String;)Ljava/lang/StringBuffer;");
mb.appendDUP();
mb.appendLoadConstant(" must extend abstract mapping for " +
"type " + m_class.getClassName());
mb.appendCallVirtual("java.lang.StringBuffer.append",
"(Ljava/lang/String;)Ljava/lang/StringBuffer;");
mb.appendCallVirtual("java.lang.StringBuffer.toString",
"()Ljava/lang/String;");
mb.appendCreateNew(MethodBuilder.FRAMEWORK_EXCEPTION_CLASS);
mb.appendDUP_X1();
mb.appendSWAP();
mb.appendCallInit(MethodBuilder.FRAMEWORK_EXCEPTION_CLASS,
MethodBuilder.EXCEPTION_CONSTRUCTOR_SIGNATURE1);
mb.appendThrow();
// for valid extension mapping, just call the marshaller
mb.targetNext(ifvalid);
mb.loadObject();
mb.loadContext();
mb.appendCallInterface(MARSHALLERMARSHAL_METHOD,
MARSHALLERMARSHAL_SIGNATURE);
mb.appendReturn();
mb.codeComplete(false);
mb.addMethod();
// add extended interface to constructed class
cf.addInterface(ABSTRACTMARSHALLER_INTERFACE);
}
/**
* Generate the {@link org.jibx.runtime.IMarshaller#isExtension(int)}
* method to check if this mapping is extending a particular abstract
* mapping.
*
* @param cf
* @param hasname
* @throws JiBXException
*/
private void generateIfExtendingCheck(ClassFile cf, boolean hasname)
throws JiBXException {
// build the method
ExceptionMethodBuilder xb = new ExceptionMethodBuilder
(CHECKEXTENDS_METHODNAME, CHECKEXTENDS_SIGNATURE, cf,
Constants.ACC_PUBLIC|Constants.ACC_FINAL);
xb.appendLoadLocal(1);
xb.appendLoadConstant(getIndex());
xb.appendISUB();
ArrayList ifeqs = new ArrayList();
ifeqs.add(xb.appendIFEQ(this));
IMapping base = m_baseMapping;
while (base != null) {
xb.appendLoadLocal(1);
xb.appendLoadConstant(base.getIndex());
xb.appendISUB();
ifeqs.add(xb.appendIFEQ(this));
if (base instanceof MappingDefinition) {
base = ((MappingDefinition)base).m_baseMapping;
} else {
break;
}
}
xb.appendICONST_0();
xb.appendReturn("int");
for (int i = 0; i < ifeqs.size(); i++) {
xb.targetNext((BranchWrapper)ifeqs.get(i));
}
xb.appendICONST_1();
xb.appendReturn("int");
xb.codeComplete(false);
xb.addMethod();
}
/**
* Generate the {@link org.jibx.runtime.IUnmarshaller#unmarshal(Object,
* org.jibx.runtime.IUnmarshallingContext)} method implementation.
*
* @param cf class to receive method
* @param hasattr attribute definition present flag
* @param hascont content definition present flag
* @param hasname element name defined by this mapping flag
* @throws JiBXException
*/
private void generateUnmarshalImplementation(ClassFile cf, boolean hasattr,
boolean hascont, boolean hasname) throws JiBXException {
// build the unmarshal method for item; this just generates code
// to unmarshal attributes and content, first creating an
// instance of the class if one was not passed in, then
// returning the unmarshalled instance as the value of the call
String type = m_class.getClassName();
ContextMethodBuilder mb = new ContextMethodBuilder(UNMARSHAL_METHODNAME,
Type.OBJECT, UNMARSHAL_METHOD_ARGS, cf,
Constants.ACC_PUBLIC|Constants.ACC_FINAL, 1, type,
2, UNMARSHALCONTEXT_INTERFACE);
mb.addException(MethodBuilder.FRAMEWORK_EXCEPTION_CLASS);
// first part of generated code just checks if an object has
// been supplied; if it has, this can just go direct to
// unmarshalling
mb.loadObject();
BranchWrapper ifnnull = mb.appendIFNONNULL(this);
// check for extension mapping handling required
if (m_extensions != null) {
// generate name comparison unless an abstract mapping
BranchWrapper ifthis = null;
if (hasname) {
// test if at defined element name
mb.addException(MethodBuilder.FRAMEWORK_EXCEPTION_CLASS);
mb.loadContext();
m_name.genPushUriPair(mb);
mb.appendCallInterface(UNMARSHAL_ISATMETHOD,
UNMARSHAL_ISATSIGNATURE);
ifthis = mb.appendIFNE(this);
}
// build code to check each extension mapping in turn,
// keeping an instance of the unmarshaller for the matching
// extension
BranchWrapper[] iffounds =
new BranchWrapper[m_extensions.size()];
for (int i = 0; i < iffounds.length; i++) {
IMapping map = (IMapping)m_extensions.get(i);
mb.loadContext();
mb.appendLoadConstant(map.getIndex());
mb.appendCallInterface(GETUNMARSHALLER_METHOD,
GETUNMARSHALLER_SIGNATURE);
mb.appendDUP();
mb.loadContext();
mb.appendCallInterface(UNMARSHALLERPRESENT_METHOD,
UNMARSHALLERPRESENT_SIGNATURE);
iffounds[i] = mb.appendIFNE(this);
mb.appendPOP();
}
// generate code to throw exception if no matching extension
// found
mb.appendCreateNew("java.lang.StringBuffer");
mb.appendDUP();
mb.appendLoadConstant("Element ");
mb.appendCallInit("java.lang.StringBuffer",
"(Ljava/lang/String;)V");
mb.appendDUP();
mb.loadContext(UNMARSHALCONTEXT_CLASS);
mb.appendCallVirtual(CURRENTELEMENT_METHOD,
CURRENTELEMENT_SIGNATURE);
mb.appendCallVirtual("java.lang.StringBuffer.append",
"(Ljava/lang/String;)Ljava/lang/StringBuffer;");
mb.appendDUP();
mb.appendLoadConstant(" has no mapping that extends " +
m_class.getClassName());
mb.appendCallVirtual("java.lang.StringBuffer.append",
"(Ljava/lang/String;)Ljava/lang/StringBuffer;");
mb.appendCallVirtual("java.lang.StringBuffer.toString",
"()Ljava/lang/String;");
mb.appendCreateNew(MethodBuilder.FRAMEWORK_EXCEPTION_CLASS);
mb.appendDUP_X1();
mb.appendSWAP();
mb.appendCallInit(MethodBuilder.FRAMEWORK_EXCEPTION_CLASS,
MethodBuilder.EXCEPTION_CONSTRUCTOR_SIGNATURE1);
mb.appendThrow();
if (iffounds.length > 0) {
// finish by calling unmarshaller for extension mapping
// found and returning the result with no further
// processing
mb.initStackState(iffounds[0]);
BranchTarget found = mb.appendTargetACONST_NULL();
for (int i = 0; i < iffounds.length; i++) {
iffounds[i].setTarget(found, mb);
}
mb.loadContext();
mb.appendCallInterface(UNMARSHALLERUNMARSHAL_METHOD,
UNMARSHALLERUNMARSHAL_SIGNATURE);
mb.appendReturn("java.lang.Object");
}
// fall into instance creation if this mapping reference
if (ifthis != null) {
mb.targetNext(ifthis);
}
} else if (m_isAbstract) {
// throw an exception when no instance supplied
mb.appendCreateNew(MethodBuilder.FRAMEWORK_EXCEPTION_CLASS);
mb.appendDUP();
mb.appendLoadConstant("Abstract mapping requires instance to " +
"be supplied for class " + m_class.getClassName());
mb.appendCallInit(MethodBuilder.FRAMEWORK_EXCEPTION_CLASS,
MethodBuilder.EXCEPTION_CONSTRUCTOR_SIGNATURE1);
mb.appendThrow();
}
if (hasname) {
// just create an instance of the (non-abstract) mapped class
genNewInstance(mb);
mb.storeObject();
}
// define unmarshallings for child mappings of this mapping
mb.targetNext(ifnnull);
ArrayList maps = m_defContext.getMappings();
if (maps != null && maps.size() > 0) {
for (int i = 0; i < maps.size(); i++) {
IMapping map = (IMapping)maps.get(i);
if (!map.isAbstract() || map.isBase()) {
mb.loadContext(UNMARSHALCONTEXT_CLASS);
mb.appendLoadConstant(map.getIndex());
NameDefinition mname = map.getName();
if (mname == null) {
mb.appendACONST_NULL();
mb.appendACONST_NULL();
} else {
map.getName().genPushUriPair(mb);
}
mb.appendLoadConstant(map.getUnmarshaller().getName());
mb.appendCallVirtual(ADDUNMARSHALLER_METHOD,
ADDUNMARSHALLER_SIGNATURE);
}
}
}
// load object and cast to type
mb.loadObject();
mb.appendCreateCast(type);
// handle the actual unmarshalling
if (hasattr) {
m_component.genAttributeUnmarshal(mb);
}
if (hasattr || !hasname) {
mb.loadContext(UNMARSHALCONTEXT_CLASS);
mb.appendCallVirtual(PARSERNEXT_METHOD,
PARSERNEXT_SIGNATURE);
mb.appendPOP();
}
if (hascont) {
m_component.genContentUnmarshal(mb);
}
// undefine unmarshallings for child mappings of this mapping
if (maps != null && maps.size() > 0) {
for (int i = 0; i < maps.size(); i++) {
IMapping map = (IMapping)maps.get(i);
if (!map.isAbstract() || map.isBase()) {
mb.loadContext(UNMARSHALCONTEXT_CLASS);
mb.appendLoadConstant(map.getIndex());
mb.appendCallVirtual(REMOVEUNMARSHALLER_METHOD,
REMOVEUNMARSHALLER_SIGNATURE);
}
}
}
// finish by returning unmarshalled object reference
mb.appendReturn("java.lang.Object");
mb.codeComplete(false);
mb.addMethod();
// add interface if mapped class is directly unmarshallable
if (hasname && m_class.getClassFile() == m_class.getMungedFile()) {
addIUnmarshallableMethod();
}
}
/**
* Generate the {@link
* org.jibx.runtime.IUnmarshaller#isPresent(org.jibx.runtime.IUnmarshallingContext)}
* method implementation.
*
* @param cf class to receive method
* @param hasname element name defined by this mapping flag
* @throws JiBXException
*/
private void generateIsPresent(ClassFile cf, boolean hasname)
throws JiBXException {
// create the method builder
ContextMethodBuilder mb = new ContextMethodBuilder
(ISPRESENT_METHODNAME, Type.BOOLEAN, ISPRESENT_METHOD_ARGS,
cf, Constants.ACC_PUBLIC|Constants.ACC_FINAL, -1, null,
1, UNMARSHALCONTEXT_INTERFACE);
// generate name comparison unless an abstract mapping
if (hasname) {
// test if at defined element name
mb.addException(MethodBuilder.FRAMEWORK_EXCEPTION_CLASS);
mb.loadContext();
m_name.genPushUriPair(mb);
mb.appendCallInterface(UNMARSHAL_ISATMETHOD,
UNMARSHAL_ISATSIGNATURE);
}
// check for extension mapping handling required
if (m_extensions != null) {
// return immediately if this mapping name check successful
BranchWrapper ifthis = null;
if (hasname) {
ifthis = mb.appendIFNE(this);
}
// build code to check each extension mapping in turn;
// return "true" if one matches, or "false" if none do
mb.addException(MethodBuilder.FRAMEWORK_EXCEPTION_CLASS);
BranchWrapper[] iffounds =
new BranchWrapper[m_extensions.size()];
for (int i = 0; i < iffounds.length; i++) {
IMapping map = (IMapping)m_extensions.get(i);
mb.loadContext();
mb.appendLoadConstant(map.getIndex());
mb.appendCallInterface(GETUNMARSHALLER_METHOD,
GETUNMARSHALLER_SIGNATURE);
mb.loadContext();
mb.appendCallInterface(UNMARSHALLERPRESENT_METHOD,
UNMARSHALLERPRESENT_SIGNATURE);
iffounds[i] = mb.appendIFNE(this);
}
mb.appendICONST_0();
mb.appendReturn("int");
mb.initStackState(iffounds[0]);
BranchTarget found = mb.appendTargetLoadConstant(1);
if (ifthis != null) {
ifthis.setTarget(found, mb);
}
for (int i = 0; i < iffounds.length; i++) {
iffounds[i].setTarget(found, mb);
}
} else if (!hasname) {
// mapping with no separate element name, just return "true"
mb.appendICONST_1();
}
mb.appendReturn("int");
mb.codeComplete(false);
mb.addMethod();
}
/**
* Generate the {@link org.jibx.runtime.IMarshaller#marshal(Object,
* org.jibx.runtime.IMarshallingContext)} method implementation.
*
* @param cf class to receive method
* @param hasattr attribute definition present flag
* @param hascont content definition present flag
* @throws JiBXException
*/
private void generateMarshalImplementation(ClassFile cf, boolean hasattr,
boolean hascont) throws JiBXException {
// build the marshal implementation method; this loads the
// passed object and casts it to the target type, then handles
// marshalling first attributes and followed by content for the
// item
ContextMethodBuilder mb = new ContextMethodBuilder
(MARSHAL_METHODNAME, Type.VOID, MARSHAL_METHOD_ARGS, cf,
Constants.ACC_PUBLIC|Constants.ACC_FINAL,
1, "java.lang.Object", 2, MARSHALCONTEXT_INTERFACE);
mb.addException(MethodBuilder.FRAMEWORK_EXCEPTION_CLASS);
// TODO: optionally check for null value on object
// define marshallings for child mappings of this mapping
ArrayList maps = m_defContext.getMappings();
if (maps != null && maps.size() > 0) {
for (int i = 0; i < maps.size(); i++) {
IMapping map = (IMapping)maps.get(i);
if (!map.isAbstract() || map.isBase()) {
mb.loadContext(MARSHALCONTEXT_CLASS);
mb.appendLoadConstant(map.getIndex());
mb.appendLoadConstant(map.getMarshaller().getName());
mb.appendCallVirtual(ADDMARSHALLER_METHOD,
ADDMARSHALLER_SIGNATURE);
}
}
}
// handle the actual marshalling
if (hasattr || hascont) {
mb.loadObject(m_class.getClassName());
if (hasattr) {
if (hascont) {
mb.appendDUP();
}
m_component.genAttributeMarshal(mb);
}
if (hasattr || m_isAbstract) {
mb.loadContext(MARSHALCONTEXT_CLASS);
mb.appendCallVirtual(CLOSESTART_METHOD,
CLOSESTART_SIGNATURE);
mb.appendPOP();
}
if (hascont) {
m_component.genContentMarshal(mb);
}
}
// undefine marshallings for child mappings of this mapping
if (maps != null && maps.size() > 0) {
for (int i = 0; i < maps.size(); i++) {
IMapping map = (IMapping)maps.get(i);
if (!map.isAbstract() || map.isBase()) {
mb.loadContext(MARSHALCONTEXT_CLASS);
mb.appendLoadConstant(map.getIndex());
mb.appendCallVirtual(REMOVEMARSHALLER_METHOD,
REMOVEMARSHALLER_SIGNATURE);
}
}
}
// finish with plain return
mb.appendReturn();
mb.codeComplete(false);
mb.addMethod();
}
public void generateCode(boolean force) throws JiBXException {
// first call code generation for child mappings
m_defContext.generateCode(false, false);
if (!force && m_isAbstract && m_extensions == null) {
return;
}
// create the helper class
BindingDefinition def = m_container.getBindingRoot();
String init = m_class.deriveClassName(def.getPrefix(),
ADAPTERCLASS_SUFFIX);
String name = init;
int loop = 0;
while (ClassCache.hasClassFile(name)) {
name = init + ++loop;
}
ClassFile base = ClassCache.getClassFile("java.lang.Object");
String[] intfs = def.isInput() ?
(def.isOutput() ? BOTH_INTERFACES : UNMARSHALLER_INTERFACES) :
MARSHALLER_INTERFACES;
ClassFile cf = new ClassFile(name, m_class.getMungedFile().getRoot(),
base, Constants.ACC_PUBLIC, intfs);
cf.addDefaultConstructor();
// add marshaller/unmarshaller implementation methods
boolean hasattr = m_component.hasAttribute();
boolean hascont = m_component.hasContent();
boolean hasname = !m_isAbstract && m_name != null;
if (def.isInput()) {
generateIsPresent(cf, hasname);
generateUnmarshalImplementation(cf, hasattr, hascont, hasname);
}
if (def.isOutput()) {
// generate the basic method
generateMarshalImplementation(cf, hasattr, hascont);
generateIfExtendingCheck(cf, hasname);
// add interface if mapped class is directly marshallable
if (hasname && m_class.getClassFile() == m_class.getMungedFile()) {
addIMarshallableMethod();
}
// check for mapping with extensions to add extra method and
// interface
if (m_extensions != null) {
generateAbstractMarshaller(cf);
}
}
// add as generated class
m_marshaller = m_unmarshaller = MungedClass.getUniqueSupportClass(cf);
}
public NameDefinition getWrapperName() {
return m_name;
}
public void setLinkages() throws JiBXException {
if (!isLinked()) {
super.setLinkages();
m_defContext.setLinkages();
if (m_name != null) {
m_name.fixNamespace(m_defContext);
}
}
}
// DEBUG
public void print(int depth) {
BindingDefinition.indent(depth);
System.out.print("mapping class " + m_class.getClassFile().getName());
if (m_name != null) {
System.out.print(" to element " + m_name.toString());
}
System.out.print(" (#" + getIndex() + ')');
if (m_baseMapping != null) {
System.out.print(" extends " + m_baseMapping.getBoundType());
}
if (m_isAbstract) {
if (m_extensions != null) {
System.out.print(" (abstract, " + m_extensions.size() +
" extensions)");
} else {
System.out.print(" (abstract)");
}
}
System.out.println();
m_defContext.print(depth+1);
m_component.print(depth+1);
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/def/MappingDirect.java 0000644 0001750 0001750 00000012056 10541604220 025252 0 ustar moeller moeller /*
Copyright (c) 2003-2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import java.util.ArrayList;
import org.jibx.binding.classes.BoundClass;
import org.jibx.binding.classes.ClassFile;
import org.jibx.runtime.JiBXException;
/**
* Direct mapping using supplied marshaller and unmarshaller.
*
* @author Dennis M. Sosnoski
*/
public class MappingDirect extends MappingBase
{
/** Direct mapping implementation. */
private final DirectObject m_mappingImpl;
/** Class file to use for added code. */
private final BoundClass m_boundClass;
/** Flag for abstract mapping. */
private final boolean m_isAbstract;
/** Flag for code added to class (if appropriate). */
private boolean m_isGenerated;
/**
* Constructor.
*
* @param contain containing binding definition structure
* @param type bound class name
* @param tname qualified type name (null if not specified)
* @param dir direct object information
* @param abs abstract mapping flag
* @throws JiBXException on mapping definition conflict
*/
public MappingDirect(IContainer contain, String type, String tname,
DirectObject dir, boolean abs) throws JiBXException {
super(contain, type, tname, dir);
m_mappingImpl = dir;
m_boundClass = BoundClass.getInstance(type, null);
m_isAbstract = abs;
}
/**
* Get the mapped class information. This implements the method used by the
* base class.
*
* @return information for mapped class
*/
public BoundClass getBoundClass() {
return m_boundClass;
}
//
// IMapping interface method definitions
public String getBoundType() {
return m_mappingImpl.getTargetClass().getName();
}
public String getReferenceType() {
return getBoundType();
}
public IComponent getImplComponent() {
return m_component;
}
public ClassFile getMarshaller() throws JiBXException {
return m_mappingImpl.getMarshaller();
}
public ClassFile getUnmarshaller() throws JiBXException {
return m_mappingImpl.getUnmarshaller();
}
public NameDefinition getName() {
return m_mappingImpl.getWrapperName();
}
public void addNamespace(NamespaceDefinition ns) {
throw new IllegalStateException
("Internal error: no namespace definition possible");
}
public boolean isAbstract() {
return m_isAbstract;
}
public boolean isBase() {
return false;
}
public void addExtension(MappingDefinition mdef) {
throw new IllegalStateException
("Internal error: no extension possible");
}
public IComponent buildRef(IContainer parent, IContextObj objc, String type,
PropertyDefinition prop) throws JiBXException {
return new DirectProperty(prop, m_mappingImpl);
}
public ArrayList getNamespaces() {
return null;
}
public void generateCode(boolean force) throws JiBXException {
if (!m_isGenerated) {
if (m_boundClass.isDirectAccess()) {
addIMarshallableMethod();
addIUnmarshallableMethod();
}
m_isGenerated = true;
}
}
public NameDefinition getWrapperName() {
return null;
}
public void setLinkages() throws JiBXException {
m_mappingImpl.setLinkages();
}
// DEBUG
public void print(int depth) {
BindingDefinition.indent(depth);
System.out.println("mapping direct " +
m_mappingImpl.getTargetClass().getName());
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/def/MappingReference.java 0000644 0001750 0001750 00000022357 11013374744 025755 0 ustar moeller moeller /*
Copyright (c) 2003-2008, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import java.util.ArrayList;
import org.jibx.binding.classes.ContextMethodBuilder;
import org.jibx.runtime.JiBXException;
/**
* Reference to a mapping definition. This is used as a placeholder when
* building the component structure of a binding definition. It's necessary
* because the referenced mapping may not have been parsed yet. During the
* linkage phase that follows parsing this looks up the appropriate mapping
* definition and sets up the corresponding component structure. Thereafter it
* operates as a simple pass-through wrapper for the top child component.
*
* @author Dennis M. Sosnoski
*/
public class MappingReference extends PassThroughComponent
{
/** Containing binding definition structure. */
private final IContainer m_container;
/** Property definition. */
private final PropertyDefinition m_property;
/** Flag for nillable element. */
private final boolean m_isNillable;
/** Fully qualified name of mapped type. */
private String m_type;
/** Ordinary name of type for abstract mapping. */
private String m_referenceText;
/** Qualified name of type for abstract mapping. */
private String m_referenceQName;
/** Context object. */
private final IContextObj m_contextObject;
/** Name from reference (only allowed with abstract mappings) */
private final NameDefinition m_name;
/** Synthetic reference added to empty collection flag */
private final boolean m_isSynthetic;
/** Generated wrapped component, used when checking for both attributes
and elements present. */
private IComponent m_wrappedReference;
/**
* Constructor from property and type.
*
* @param contain containing binding definition structure
* @param prop property definition
* @param type fully qualified name of mapped type
* @param reftext ordinary text name for abstract mapping reference
* (null if not specified)
* @param refqname qualified type name for abstract mapping reference
* (null if not specified)
* @param objc current object context
* @param name reference name definition (only allowed with abstract
* mappings)
* @param synth sythentic reference added to empty collection flag
* @param nillable flag for nillable element
*/
public MappingReference(IContainer contain, PropertyDefinition prop,
String type, String reftext, String refqname, IContextObj objc,
NameDefinition name, boolean synth, boolean nillable) {
super();
m_container = contain;
m_property = prop;
m_type = type;
m_referenceText = reftext;
m_referenceQName = refqname;
m_contextObject = objc;
m_name = name;
m_isSynthetic = synth;
m_isNillable = nillable;
}
//
// IComponent interface method definitions (overrides of defaults)
public boolean isOptional() {
return m_property.isOptional();
}
public String getType() {
return m_type;
}
public void setLinkages() throws JiBXException {
// find the mapping being used
DefinitionContext defc = m_container.getDefinitionContext();
IMapping mdef = null;
if (m_referenceText != null) {
mdef = defc.getClassMapping(m_referenceText);
if (mdef == null) {
mdef = defc.getClassMapping(m_referenceQName);
}
}
if (mdef == null) {
mdef = defc.getClassMapping(m_type);
}
IComponent wrap = null;
PropertyDefinition prop = m_property;
if (mdef == null) {
// generate generic mapping to unknown type
if (m_name != null) {
throw new JiBXException
("Name not allowed for generic mapping of type " + m_type);
}
wrap = new DirectGeneric(m_container, m_type, prop);
} else if (m_isSynthetic && mdef.isAbstract() && !mdef.isBase()) {
// collection reference to abstract non-base mapping as generic
wrap = new DirectGeneric(m_container, m_type, prop);
} else {
// check for reference from collection
if (prop.isImplicit()) {
prop.setOptional(false);
}
// add mapping namespaces to context (only if no element on mapping)
if (mdef.getName() == null) {
mdef.setLinkages();
ArrayList nss = mdef.getNamespaces();
if (nss != null) {
for (int i = 0; i < nss.size(); i++) {
defc.addImpliedNamespace((NamespaceDefinition)nss.get(i));
}
}
}
// generate wrapped component for all calls
String type = mdef.getBoundType();
if (prop.getTypeName() == null) {
prop = new PropertyDefinition(type, m_contextObject,
prop.isOptional());
}
wrap = mdef.buildRef(m_container, m_contextObject,
prop.getTypeName(), prop);
if (m_name != null) {
m_wrappedReference = wrap;
if (mdef.getName() == null) {
// create the replacement components
IComponent icomp = wrap;
wrap = new ElementWrapper(defc, m_name, icomp, m_isNillable);
if (prop.isImplicit()) {
((ElementWrapper)wrap).setDirect(true);
}
if (prop.isOptional()) {
// make element optional
if (icomp instanceof ComponentProperty) {
((ComponentProperty)icomp).setSkipping(true);
}
((ElementWrapper)wrap).setOptionalNormal(true);
((ElementWrapper)wrap).setStructureObject(true);
((ElementWrapper)wrap).setDirect(true);
wrap = new OptionalStructureWrapper(wrap, prop,
true);
}
} else {
throw new JiBXException
("Name not allowed for reference to mapping of type " +
type + ", which already defines a name");
}
}
// set type based on mapping
m_type = mdef.getReferenceType();
}
// link actual component into structure
setWrappedComponent(wrap);
super.setLinkages();
}
/**
* Patch the generated code to remove the unmarshalled object when it's a
* "this" reference with both elements and attributes.
*
* @param mb
* @throws JiBXException
*/
public void genContentUnmarshal(ContextMethodBuilder mb)
throws JiBXException {
super.genContentUnmarshal(mb);
// check for unmarshalling fix needed
if (m_wrappedReference != null && m_property.isThis() &&
m_wrappedReference.hasAttribute() &&
m_wrappedReference.hasContent()) {
mb.appendPOP();
}
}
// DEBUG
public void print(int depth) {
BindingDefinition.indent(depth);
System.out.print("mapping reference to " +
((m_referenceText == null) ? m_type : m_referenceText));
if (m_property != null) {
System.out.print(" using " + m_property.toString());
}
System.out.println();
if (m_component != null) {
m_component.print(depth+1);
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/def/NameDefinition.java 0000644 0001750 0001750 00000012046 10732007414 025420 0 ustar moeller moeller /*
Copyright (c) 2003-2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import org.jibx.binding.classes.MethodBuilder;
import org.jibx.runtime.JiBXException;
/**
* Named value definition from binding. This is a component of all items
* in the mapping corresponding to elements or attributes in the document.
*
* @author Dennis M. Sosnoski
*/
public class NameDefinition
{
/** Element or attribute name. */
private final String m_name;
/** Element or attribute namespace URI. */
private String m_namespace;
/** Flag for attribute name. */
private final boolean m_isAttribute;
/** Namespace index used for marshalling (derived from nesting). */
private int m_namespaceIndex;
/**
* Constructor.
*
* @param name
* @param ns
* @param attr flag for attribute name
*/
public NameDefinition(String name, String ns, boolean attr) {
m_name = name;
m_namespace = ns;
m_isAttribute = attr;
}
/**
* Get the local name.
*
* @return name
*/
public String getName() {
return m_name;
}
/**
* Get the namespace URI.
*
* @return namespace (null if no-namespace namespace)
*/
public String getNamespace() {
return m_namespace;
}
/**
* Check if namespace URI is null.
*
* @return true if URI null, false if not
*/
public boolean isNullUri() {
return m_namespace == null;
}
/**
* Generate code to push namespace URI.
*
* @param mb method builder
*/
public void genPushUri(MethodBuilder mb) {
if (m_namespace == null) {
mb.appendACONST_NULL();
} else {
mb.appendLoadConstant(m_namespace);
}
}
/**
* Generate code to push name.
*
* @param mb method builder
*/
public void genPushName(MethodBuilder mb) {
mb.appendLoadConstant(m_name);
}
/**
* Generate code to push namespace URI followed by name.
*
* @param mb method builder
*/
public void genPushUriPair(MethodBuilder mb) {
genPushUri(mb);
genPushName(mb);
}
/**
* Generate code to push namespace index followed by name.
*
* @param mb method builder
*/
public void genPushIndexPair(MethodBuilder mb) {
mb.appendLoadConstant(m_namespaceIndex);
genPushName(mb);
}
/**
* Finds the index for the namespace used with a name. If no explicit
* namespace has been set it uses the appropriate default. This is a
* separate operation from the unmarshalling in order to properly handle
* namespace definitions as children of the named binding component.
*
* @param defc definition context for namespaces
* @throws JiBXException if error in namespace handling
*/
public void fixNamespace(DefinitionContext defc) throws JiBXException {
if (m_namespace == null) {
m_namespace = defc.getDefaultURI(m_isAttribute);
m_namespaceIndex = defc.getDefaultIndex(m_isAttribute);
} else {
try {
m_namespaceIndex = defc.getNamespaceIndex
(m_namespace, m_isAttribute);
} catch (JiBXException ex) {
throw new JiBXException("Undefined or unusable namespace \"" +
m_namespace + '"');
}
}
}
// DEBUG
public String toString() {
if (m_namespace == null) {
return m_name;
} else {
return "{" + m_namespace + "}:" + m_name;
}
}
}
libjibx-java-1.1.6a/build/src/org/jibx/binding/def/NamespaceDefinition.java 0000644 0001750 0001750 00000012141 10071714320 026425 0 ustar moeller moeller /*
Copyright (c) 2003-2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import org.jibx.runtime.JiBXException;
/**
* Namespace definition from binding.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class NamespaceDefinition
{
//
// Enumeration for namespace usage.
/*package*/ static final int NODEFAULT_USAGE = 0;
/*package*/ static final int ELEMENTS_USAGE = 1;
/*package*/ static final int ATTRIBUTES_USAGE = 2;
/*package*/ static final int ALLDEFAULT_USAGE = 3;
//
// Actual instance data
/** Namespace URI. */
private String m_uri;
/** Namespace prefix (may be null, but not ""). */
private String m_prefix;
/** Index in namespace table for binding. */
private int m_index;
/** Use by default for nested elements. */
private boolean m_elementDefault;
/** Use by default for nested attributes. */
private boolean m_attributeDefault;
/**
* Constructor.
*
* @param uri namespace URI
* @param prefix namespace prefix (may be null for default
* namespace, but not "")
* @param usage code for default usage of namespace
* @throws JiBXException if configuration error
*/
public NamespaceDefinition(String uri, String prefix, int usage)
throws JiBXException {
m_uri = uri;
m_prefix = prefix;
m_elementDefault =
(usage == ALLDEFAULT_USAGE) || (usage == ELEMENTS_USAGE);
m_attributeDefault =
(usage == ALLDEFAULT_USAGE) || (usage == ATTRIBUTES_USAGE);
if (usage != ELEMENTS_USAGE && prefix == null) {
throw new JiBXException
("Prefix required for namespace unless element default");
}
if (m_attributeDefault && m_prefix == null) {
throw new JiBXException("Prefix required for attribute namespace");
}
}
/**
* Check if default namespace for attributes.
*
* @return true if default namespace for attributes,
* false if not
*/
public boolean isAttributeDefault() {
return m_attributeDefault;
}
/**
* Check if default namespace for elements.
*
* @return true if default namespace for elements,
* false if not
*/
public boolean isElementDefault() {
return m_elementDefault;
}
/**
* Get prefix for namespace.
*
* @return namespace prefix (may be null, but not "")
*/
public String getPrefix() {
return m_prefix;
}
/**
* Get namespace URI.
*
* @return namespace URI
*/
public String getUri() {
return m_uri;
}
/**
* Set namespace index.
*
* @param index namespace index
*/
public void setIndex(int index) {
m_index = index;
}
/**
* Get namespace index.
*
* @return namespace index
*/
public int getIndex() {
return m_index;
}
/**
* Instance builder with supplied values. Used for canned definitions.
*
* @param uri namespace URI
* @param prefix namespace prefix
* @throws JiBXException if configuration error
*/
public static NamespaceDefinition buildNamespace(String uri,
String prefix) throws JiBXException {
return new NamespaceDefinition(uri, prefix, NODEFAULT_USAGE);
}
// DEBUG
public void print(int depth) {
BindingDefinition.indent(depth);
System.out.print("namespace " + m_uri);
if (m_prefix != null) {
System.out.print(" (prefix " + m_prefix + ")");
}
System.out.println();
}
}
libjibx-java-1.1.6a/build/src/org/jibx/binding/def/NestedBase.java 0000644 0001750 0001750 00000017324 10435546730 024561 0 ustar moeller moeller /*
Copyright (c) 2003-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import java.util.ArrayList;
import org.jibx.binding.classes.*;
import org.jibx.runtime.JiBXException;
/**
* Base class for structure and collection binding definitions. This handles one
* or more child components, which may be ordered or unordered.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public abstract class NestedBase extends BindingBuilder.ContainerBase
implements IComponent, IContainer
{
/** Context object for this definition. */
private IContextObj m_contextObject;
/** Flag for context defined at level. */
private final boolean m_hasContext;
/** Flag for ordered child content (used by subclasses). */
protected final boolean m_isOrdered;
/** Flag for flexible element handling (used by subclasses). */
protected final boolean m_isFlexible;
/** Definition context for container (may be same as parent). */
private final DefinitionContext m_defContext;
/** Included attribute definitions (lazy create, only if needed). */
protected ArrayList m_attributes;
/** Nested content definitions (initially used for all child components). */
protected ArrayList m_contents;
/**
* Constructor.
*
* @param contain containing binding definition context
* @param objc current object context
* @param ord ordered content flag
* @param flex flexible element handling flag
* @param defc define context for structure flag
*/
public NestedBase(IContainer contain, IContextObj objc,
boolean ord, boolean flex, boolean defc) {
// set base class defaults
super(contain);
m_styleDefault = m_autoLink = m_accessLevel = m_nameStyle = -1;
// initialize members at this level
m_contextObject = objc;
m_contents = new ArrayList();
m_isOrdered = ord;
m_isFlexible = flex;
m_hasContext = defc;
if (defc) {
m_defContext = new DefinitionContext(contain);
} else {
m_defContext = contain.getDefinitionContext();
}
}
/**
* Set the object context.
*
* @param objc object context
*/
public void setObjectContext(IContextObj objc) {
m_contextObject = objc;
}
/**
* Get the attribute children of this mapping.
*
* @return list of attribute children (null if none; should not
* be modified)
*/
public ArrayList getAttributes() {
return m_attributes;
}
/**
* Get the content children of this mapping.
*
* @return list of content children (should not be modified)
*/
public ArrayList getContents() {
return m_contents;
}
/**
* Add child component to nested structure. All components are initially
* assumed to contain content. When {@link #setLinkages} is called the
* components are checked to determine whether they actually supply
* attribute(s), content, or both.
*
* @param comp child component to be added to structure
*/
public void addComponent(IComponent comp) {
m_contents.add(comp);
}
/**
* Check if flexible unmarshalling.
*
* @return flexible flag
*/
public boolean isFlexible() {
return m_isFlexible;
}
//
// IContainer interface method definitions
public boolean isContentOrdered() {
return m_isOrdered;
}
public boolean hasNamespaces() {
return m_hasContext && m_defContext.hasNamespace();
}
public BindingDefinition getBindingRoot() {
return m_container.getBindingRoot();
}
public DefinitionContext getDefinitionContext() {
return m_defContext;
}
//
// IComponent interface method definitions
public boolean isOptional() {
// optional if and only if all child components are optional
if (m_attributes != null) {
for (int i = 0; i < m_attributes.size(); i++) {
if (!((IComponent)m_attributes.get(i)).isOptional()) {
return false;
}
}
}
for (int i = 0; i < m_contents.size(); i++) {
if (!((IComponent)m_contents.get(i)).isOptional()) {
return false;
}
}
return true;
}
public boolean hasContent() {
return m_contents.size() > 0;
}
public void genContentPresentTest(ContextMethodBuilder mb)
throws JiBXException {
if (m_contents.size() > 0) {
// if single possiblity just test it directly
int count = m_contents.size();
if (count == 1) {
((IComponent)m_contents.get(0)).genContentPresentTest(mb);
} else {
// generate code for chained test with branches to found exit
BranchWrapper[] tofound = new BranchWrapper[count];
for (int i = 0; i < count; i++) {
IComponent comp = (IComponent)m_contents.get(i);
comp.genContentPresentTest(mb);
tofound[i] = mb.appendIFNE(this);
}
// fall off end of loop to push "false" on stack and jump to end
mb.appendICONST_0();
BranchWrapper toend = mb.appendUnconditionalBranch(this);
// generate found target to push "true" on stack and continue
for (int i = 0; i < count; i++) {
mb.targetNext(tofound[i]);
}
mb.appendICONST_1();
mb.targetNext(toend);
}
} else {
throw new IllegalStateException
("Internal error - no content present");
}
}
public void genNewInstance(ContextMethodBuilder mb) {
throw new IllegalStateException
("Internal error - no instance creation");
}
public String getType() {
return m_contextObject.getBoundClass().getClassName();
}
public NameDefinition getWrapperName() {
if (m_contents.size() == 1) {
return ((IComponent)m_contents.get(0)).getWrapperName();
} else {
return null;
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/def/NestedCollection.java 0000644 0001750 0001750 00000104421 10611637722 025773 0 ustar moeller moeller /*
Copyright (c) 2003-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import org.apache.bcel.generic.*;
import org.jibx.binding.classes.*;
import org.jibx.runtime.JiBXException;
/**
* Collection binding definition. This handles one or more child components,
* which may be ordered or unordered.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class NestedCollection extends NestedBase
{
//
// Method definitions used in code generation
private static final String GROWARRAY_METHOD =
"org.jibx.runtime.Utility.growArray";
private static final String GROWARRAY_SIGNATURE =
"(Ljava/lang/Object;)Ljava/lang/Object;";
private static final String RESIZEARRAY_METHOD =
"org.jibx.runtime.Utility.resizeArray";
private static final String RESIZEARRAY_SIGNATURE =
"(ILjava/lang/Object;)Ljava/lang/Object;";
private static final String CHECK_ISSTART_NAME =
"org.jibx.runtime.impl.UnmarshallingContext.isStart";
private static final String CHECK_ISSTART_SIGNATURE = "()Z";
private static final String SKIP_ELEMENT_NAME =
"org.jibx.runtime.impl.UnmarshallingContext.skipElement";
private static final String SKIP_ELEMENT_SIGNATURE = "()V";
//
// Actual instance data.
/** Fully qualified class name of values from collection. */
private final String m_itemType;
/** Strategy for generating code to load item from collection. */
private final CollectionLoad m_loadStrategy;
/** Strategy for generating code to store item to collection. */
private final CollectionStore m_storeStrategy;
/** Optional component flag. */
private final boolean m_isOptional;
/**
* Constructor.
*
* @param parent containing binding definition context
* @param objc current object context
* @param ord ordered content flag
* @param opt optional component flag
* @param flex flexible element handling flag
* @param type fully qualified class name of values from collection (may be
* null, if child content present)
* @param load collection load code generation strategy
* @param store collection store code generation strategy
*/
public NestedCollection(IContainer parent, IContextObj objc, boolean ord,
boolean opt, boolean flex, String type, CollectionLoad load,
CollectionStore store) {
super(parent, objc, ord, flex, false);
m_itemType = type;
m_loadStrategy = load;
m_storeStrategy = store;
m_isOptional = opt;
}
/**
* Get the collection item type.
*
* @return item type
*/
public String getItemType() {
return m_itemType;
}
//
// IComponent interface method definitions
public boolean hasAttribute() {
return false;
}
public void genAttrPresentTest(ContextMethodBuilder mb) {
throw new IllegalStateException
("Internal error - no attributes present");
}
public void genAttributeUnmarshal(ContextMethodBuilder mb) {
throw new IllegalStateException
("Internal error - no attributes present");
}
public void genAttributeMarshal(ContextMethodBuilder mb) {
throw new IllegalStateException
("Internal error - no attributes present");
}
public boolean hasContent() {
return m_contents.size() > 0;
}
public void genContentUnmarshal(ContextMethodBuilder mb)
throws JiBXException {
if (m_contents.size() > 0) {
// set up common handling and check for ordered or unordered content
m_storeStrategy.genStoreInit(mb);
BranchWrapper link = null;
int count = m_contents.size();
if (m_isOrdered) {
// just generate unmarshal code for each component in order
for (int i = 0; i < count; i++) {
// start with branch target for loop and link from last type
if (link != null) {
mb.initStackState(link);
}
BranchTarget start = mb.appendTargetNOP();
if (link != null) {
link.setTarget(start, mb);
}
// generate code to check if an element matching this
// component type is present
IComponent child = (IComponent)m_contents.get(i);
child.genContentPresentTest(mb);
link = mb.appendIFEQ(this);
// follow with code to unmarshal the component and store to
// collection, ending with loop back to start of this
// component
child.genContentUnmarshal(mb);
if (m_itemType != null && !ClassItem.isPrimitive(m_itemType)) {
mb.appendCreateCast(m_itemType);
}
m_storeStrategy.genStoreItem(mb);
mb.appendUnconditionalBranch(this).setTarget(start, mb);
}
} else {
// generate unmarshal loop code that checks for each component,
// branching to the next component until one is found and
// exiting the loop only when no component is matched
BranchTarget first = mb.appendTargetNOP();
for (int i = 0; i < count; i++) {
if (link != null) {
mb.targetNext(link);
}
IComponent child = (IComponent)m_contents.get(i);
child.genContentPresentTest(mb);
link = mb.appendIFEQ(this);
child.genContentUnmarshal(mb);
if (m_itemType != null && !ClassItem.isPrimitive(m_itemType)) {
mb.appendCreateCast(m_itemType);
}
m_storeStrategy.genStoreItem(mb);
mb.appendUnconditionalBranch(this).setTarget(first, mb);
}
// handle fall through condition depending on flexible flag
if (m_isFlexible) {
// exit loop if not positioned at element start
mb.targetNext(link);
mb.loadContext();
mb.appendCallVirtual(CHECK_ISSTART_NAME,
CHECK_ISSTART_SIGNATURE);
link = mb.appendIFEQ(this);
// ignore unknown element and loop back to start
mb.loadContext();
mb.appendCallVirtual(SKIP_ELEMENT_NAME,
SKIP_ELEMENT_SIGNATURE);
mb.appendUnconditionalBranch(this).setTarget(first, mb);
}
}
// patch final test failure branch to fall through loop
mb.targetNext(link);
m_storeStrategy.genStoreDone(mb);
} else {
throw new IllegalStateException
("Internal error - no content present");
}
}
public void genContentMarshal(ContextMethodBuilder mb)
throws JiBXException {
if (m_contents.size() > 0) {
// set up common handling of unknown item and collection empty
BranchWrapper[] ifempties;
BranchWrapper link = null;
m_loadStrategy.genLoadInit(mb);
// check for ordered or unordered content
int count = m_contents.size();
if (m_isOrdered) {
// generate marshal code for each component type in order, with
// an exception generated if the end of the possible component
// list is reached with anything left in the collection
ifempties = new BranchWrapper[count];
for (int i = 0; i < count; i++) {
// start generated code with loading next value from
// collection
if (link != null) {
mb.initStackState(link, 1);
}
BranchTarget start = mb.appendTargetNOP();
ifempties[i] = m_loadStrategy.genLoadItem(mb);
mb.targetNext(link);
// if multiple types are included in content, append code to
// check if item type matches this component
IComponent child = (IComponent)m_contents.get(i);
String type = child.getType();
if (count > 1) {
mb.appendDUP();
mb.appendInstanceOf(type);
link = mb.appendIFEQ(this);
}
if ((!"java.lang.Object".equals(type) &&
!ClassItem.isPrimitive(type))) {
mb.appendCreateCast(type);
}
// finish with code to marshal the component, looping back
// to start of block for more of same type
child.genContentMarshal(mb);
mb.appendUnconditionalBranch(this).setTarget(start, mb);
}
} else {
// generate marshal loop code that loads an item from the
// collection and then checks to see if it matches a component
// type, branching to the next component until a match is found
// (or generating an exception on no match)
BranchTarget start = mb.appendTargetNOP();
ifempties = new BranchWrapper[1];
ifempties[0] = m_loadStrategy.genLoadItem(mb);
for (int i = 0; i < count; i++) {
// start by setting target for branch from last component
mb.targetNext(link);
// if multiple types are included in content, append code to
// check if item type matches this component
IComponent child = (IComponent)m_contents.get(i);
String type = child.getType();
if (count > 1 || (!"java.lang.Object".equals(type) &&
!ClassItem.isPrimitive(type))) {
mb.appendDUP();
mb.appendInstanceOf(type);
link = mb.appendIFEQ(this);
mb.appendCreateCast(type);
}
// finish with code to marshal the component, branching back
// to start of loop
child.genContentMarshal(mb);
mb.appendUnconditionalBranch(this).setTarget(start, mb);
}
}
// patch final test failure branch to generate an exception
if (link != null) {
// instruction sequence for exception is create new exception
// object, build message in StringBuffer using type of item
// from stack, convert StringBuffer to String, invoke the
// exeception constructor with the String, and finally throw
// the exception
mb.targetNext(link);
mb.appendCreateNew("java.lang.StringBuffer");
mb.appendDUP();
mb.appendLoadConstant("Collection item of type ");
mb.appendCallInit("java.lang.StringBuffer",
"(Ljava/lang/String;)V");
mb.appendSWAP();
mb.appendDUP();
BranchWrapper ifnull = mb.appendIFNULL(this);
mb.appendCallVirtual("java.lang.Object.getClass",
"()Ljava/lang/Class;");
mb.appendCallVirtual("java.lang.Class.getName",
"()Ljava/lang/String;");
BranchWrapper toend = mb.appendUnconditionalBranch(this);
mb.targetNext(ifnull);
mb.appendPOP();
mb.appendLoadConstant("NULL");
mb.targetNext(toend);
mb.appendCallVirtual("java.lang.StringBuffer.append",
"(Ljava/lang/String;)Ljava/lang/StringBuffer;");
mb.appendLoadConstant(" has no binding defined");
mb.appendCallVirtual("java.lang.StringBuffer.append",
"(Ljava/lang/String;)Ljava/lang/StringBuffer;");
mb.appendCallVirtual("java.lang.StringBuffer.toString",
"()Ljava/lang/String;");
mb.appendCreateNew(MethodBuilder.FRAMEWORK_EXCEPTION_CLASS);
mb.appendDUP_X1();
mb.appendSWAP();
mb.appendCallInit(MethodBuilder.FRAMEWORK_EXCEPTION_CLASS,
MethodBuilder.EXCEPTION_CONSTRUCTOR_SIGNATURE1);
mb.appendThrow();
}
// finish by setting target for collection empty case(s)
m_loadStrategy.genLoadDone(mb);
mb.targetNext(ifempties);
} else {
throw new IllegalStateException
("Internal error - no content present");
}
}
public boolean hasId() {
return false;
}
public void genLoadId(ContextMethodBuilder mb) throws JiBXException {
throw new IllegalStateException("No ID child");
}
public NameDefinition getWrapperName() {
return null;
}
public boolean isOptional() {
return m_isOptional;
}
public void setLinkages() throws JiBXException {
for (int i = 0; i < m_contents.size(); i++) {
((IComponent)m_contents.get(i)).setLinkages();
}
}
// DEBUG
public void print(int depth) {
BindingDefinition.indent(depth);
System.out.print("collection " +
(m_isOrdered ? "ordered" : "unordered"));
if (m_itemType != null) {
System.out.print(" (" + m_itemType + ")");
}
if (isFlexible()) {
System.out.print(", flexible");
}
System.out.println();
for (int i = 0; i < m_contents.size(); i++) {
IComponent comp = (IComponent)m_contents.get(i);
comp.print(depth+1);
}
}
/**
* Base class for collection item load strategy. The implementation class
* must handle the appropriate form of code generation for the type of
* collection being used.
*/
/*package*/ static abstract class CollectionBase
{
/** Double word value flag. */
private final boolean m_isDoubleWord;
/**
* Constructor.
*
* @param doubword double word value flag
*/
protected CollectionBase(boolean doubword) {
m_isDoubleWord = doubword;
}
/**
* Append the appropriate instruction to swap the top of the stack
* (which must be a single-word value) with an item value (which may
* be one or two words, as configured for this collection).
*
* @param mb method
*/
protected void appendSWAP(MethodBuilder mb) {
if (m_isDoubleWord) {
mb.appendSWAP1For2();
} else {
mb.appendSWAP();
}
}
/**
* Append the appropriate instruction to pop the item value (which may
* be one or two words, as configured for this collection) from the top
* of the stack.
*
* @param mb method
*/
protected void appendPOP(MethodBuilder mb) {
if (m_isDoubleWord) {
mb.appendPOP2();
} else {
mb.appendPOP();
}
}
}
/**
* Base class for collection item load strategy. The implementation class
* must handle the appropriate form of code generation for the type of
* collection being used.
*/
/*package*/ static abstract class CollectionLoad extends CollectionBase
{
/**
* Constructor.
*
* @param add method used to add item to collection
* @param doubword double word value flag
* @param ret value returned by add flag
*/
protected CollectionLoad(boolean doubword) {
super(doubword);
}
/**
* Generate code to initialize collection for loading items. This
* generates the necessary code for handling the initialization. It
* must be called before attempting to call the {@link #genLoadItem}
* method. The base class implementation does nothing.
*
* @param mb method builder
* @throws JiBXException if error in configuration
*/
protected void genLoadInit(ContextMethodBuilder mb)
throws JiBXException {}
/**
* Generate code to load next item from collection. This generates the
* necessary code for handling the load operation, leaving the item on
* the stack. The {@link #genLoadInit} method must be called before
* calling this method, and the {@link #genLoadDone} method must be
* called after the last call to this method. This method must be
* overridden by each subclass.
*
* @param mb method builder
* @return branch wrapper for case of done with collection
* @throws JiBXException if error in configuration
*/
protected abstract BranchWrapper genLoadItem(ContextMethodBuilder mb)
throws JiBXException;
/**
* Generate code to clean up after loading items from collection. This
* generates the necessary code for handling the clean up. It must be
* called after the last call to {@link #genLoadItem}. The base class
* implementation does nothing.
*
* @param mb method builder
* @throws JiBXException if error in configuration
*/
protected void genLoadDone(ContextMethodBuilder mb)
throws JiBXException {}
}
/**
* Base class for collection item store strategy. The implementation class
* must handle the appropriate form of code generation for the type of
* collection being used.
*/
/*package*/ static abstract class CollectionStore extends CollectionBase
{
/**
* Constructor.
*
* @param doubword double word value flag
*/
protected CollectionStore(boolean doubword) {
super(doubword);
}
/**
* Generate code to initialize collection for storing items. This
* generates the necessary code for handling the initialization,
* including creating the collection object if appropriate. It must be
* called before attempting to call the {@link #genStoreItem} method.
* The base class implementation does nothing.
*
* @param mb method builder
* @throws JiBXException if error in configuration
*/
protected void genStoreInit(ContextMethodBuilder mb)
throws JiBXException {}
/**
* Generate code to store next item to collection. This generates the
* necessary code for handling the store operation, removing the item
* from the stack. The {@link #genStoreInit} method must be called
* before calling this method, and the {@link #genStoreDone} method must
* be called after the last call to this method. This method must be
* overridden by each subclass.
*
* @param mb method builder
* @throws JiBXException if error in configuration
*/
protected abstract void genStoreItem(ContextMethodBuilder mb)
throws JiBXException;
/**
* Generate code to clean up after storing items to collection. This
* generates the necessary code for handling the clean up. It must be
* called after the last call to {@link #genStoreItem}. The base class
* implementation does nothing.
*
* @param mb method builder
* @throws JiBXException if error in configuration
*/
protected void genStoreDone(ContextMethodBuilder mb)
throws JiBXException {}
}
/**
* Collection item load strategy for collection with items accessed by
* index number.
*/
/*package*/ static class IndexedLoad extends CollectionLoad
{
/** Method used to get count of items in collection. */
private final ClassItem m_sizeMethod;
/** Method used to get items by index from collection. */
private final ClassItem m_getMethod;
/**
* Constructor.
*
* @param size method used to get count of items in collection
* @param doubword double word value flag
* @param get method used to retrieve items by index from collection
*/
/*package*/ IndexedLoad(ClassItem size, boolean doubword,
ClassItem get) {
super(doubword);
m_sizeMethod = size;
m_getMethod = get;
}
protected void genLoadInit(ContextMethodBuilder mb)
throws JiBXException {
// create index local with appended code to set initial value
mb.appendLoadConstant(-1);
mb.defineSlot(m_getMethod, Type.INT);
// create size local with appended code to set initial value from
// collection method call
if (!m_sizeMethod.isStatic()) {
mb.loadObject();
}
mb.appendCall(m_sizeMethod);
mb.defineSlot(m_sizeMethod, Type.INT);
}
protected BranchWrapper genLoadItem(ContextMethodBuilder mb)
throws JiBXException {
// start by getting local variable slots for the index and size
int islot = mb.getSlot(m_getMethod);
int sslot = mb.getSlot(m_sizeMethod);
// append code to first increment index, then check for end of
// collection reached
mb.appendIncrementLocal(1, islot);
mb.appendLoadLocal(islot);
mb.appendLoadLocal(sslot);
mb.appendISUB();
BranchWrapper ifempty = mb.appendIFGE(this);
// finish by calling collection method to load item at current index
// position
if (!m_getMethod.isStatic()) {
mb.loadObject();
}
mb.appendLoadLocal(islot);
mb.appendCall(m_getMethod);
return ifempty;
}
protected void genLoadDone(ContextMethodBuilder mb)
throws JiBXException {
mb.freeSlot(m_getMethod);
mb.freeSlot(m_sizeMethod);
}
}
/**
* Collection item store strategy for collection with items set by
* index number.
*/
/*package*/ static class IndexedStore extends CollectionStore
{
/** Method used to set items by index in collection. */
private final ClassItem m_setMethod;
/** Flag for method returns result. */
private final boolean m_isReturned;
/**
* Constructor.
*
* @param set method used to store items by index in collection
* @param doubword double word value flag
* @param ret value returned by add flag
*/
/*package*/ IndexedStore(ClassItem set, boolean doubword, boolean ret) {
super(doubword);
m_setMethod = set;
m_isReturned = ret;
}
protected void genStoreInit(ContextMethodBuilder mb)
throws JiBXException {
// create index local with appended code to set initial value
mb.appendLoadConstant(-1);
mb.defineSlot(m_setMethod, Type.INT);
}
protected void genStoreItem(ContextMethodBuilder mb)
throws JiBXException {
// start by getting local variable slot for the index
int islot = mb.getSlot(m_setMethod);
// append code to first load object and swap with item, then
// increment index and swap copy with item, and finally call
// collection method to store item at new index position
if (!m_setMethod.isStatic()) {
mb.loadObject();
appendSWAP(mb);
}
mb.appendIncrementLocal(1, islot);
mb.appendLoadLocal(islot);
appendSWAP(mb);
mb.appendCall(m_setMethod);
if (m_isReturned) {
appendPOP(mb);
}
}
protected void genStoreDone(ContextMethodBuilder mb)
throws JiBXException {
mb.freeSlot(m_setMethod);
}
}
/**
* Collection item load strategy for collection with items accessed by
* iterator or enumeration.
*/
/*package*/ static class IteratorLoad extends CollectionLoad
{
/** Method used to get iterator for collection. */
private final ClassItem m_iterMethod;
/** Fully qualified method name to test if more in iteration. */
private final String m_moreName;
/** Fully qualified method name to get next item in iteration. */
private final String m_nextName;
/**
* Constructor.
*
* @param iter method to get iterator or enumerator from collection
* @param doubword double word value flag
* @param more fully qualified method name to test if more in iteration
* @param next fully qualified method name to get next item in iteration
*/
/*package*/ IteratorLoad(ClassItem iter, boolean doubword, String more,
String next) {
super(doubword);
m_iterMethod = iter;
m_moreName = more;
m_nextName = next;
}
protected void genLoadInit(ContextMethodBuilder mb)
throws JiBXException {
// create iterator local with appended code to set initial value
if (!m_iterMethod.isStatic()) {
mb.loadObject();
}
mb.appendCall(m_iterMethod);
mb.defineSlot(m_iterMethod, Type.getType("Ljava/util/Iterator;"));
}
protected BranchWrapper genLoadItem(ContextMethodBuilder mb)
throws JiBXException {
// start with code to load and test iterator
int islot = mb.getSlot(m_iterMethod);
mb.appendLoadLocal(islot);
mb.appendCallInterface(m_moreName, "()Z");
BranchWrapper ifempty = mb.appendIFEQ(this);
// append code to get next item from iterator
mb.appendLoadLocal(islot);
mb.appendCallInterface(m_nextName, "()Ljava/lang/Object;");
return ifempty;
}
protected void genLoadDone(ContextMethodBuilder mb)
throws JiBXException {
mb.freeSlot(m_iterMethod);
}
}
/**
* Collection item store strategy for collection with add method.
*/
/*package*/ static class AddStore extends CollectionStore
{
/** Method used to add item to collection. */
private final ClassItem m_addMethod;
/** Flag for method returns result. */
private final boolean m_isReturned;
/**
* Constructor.
*
* @param add method used to add item to collection
* @param doubword double word value flag
* @param ret value returned by add flag
*/
/*package*/ AddStore(ClassItem add, boolean doubword, boolean ret) {
super(doubword);
m_addMethod = add;
m_isReturned = ret;
}
protected void genStoreItem(ContextMethodBuilder mb)
throws JiBXException {
// append code to call collection method to add the item
if (!m_addMethod.isStatic()) {
mb.loadObject();
appendSWAP(mb);
}
mb.appendCall(m_addMethod);
if (m_isReturned) {
appendPOP(mb);
}
}
}
/**
* Collection item load strategy for array.
*/
/*package*/ static class ArrayLoad extends CollectionLoad
{
/** Array item type. */
private final String m_itemType;
/** Handle for referencing loop counter local variable. */
private Object m_slotHandle = new Object();
/**
* Constructor.
*
* @param itype array item type
* @param doubword double word value flag
*/
/*package*/ ArrayLoad(String itype, boolean doubword) {
super(doubword);
m_itemType = itype;
}
protected void genLoadInit(ContextMethodBuilder mb)
throws JiBXException {
// create index local with initial value -1
mb.appendLoadConstant(-1);
mb.defineSlot(m_slotHandle, Type.INT);
}
protected BranchWrapper genLoadItem(ContextMethodBuilder mb)
throws JiBXException {
// start by getting local variable slots for the index
int islot = mb.getSlot(m_slotHandle);
// append code to first increment index, then check for end of
// collection reached
mb.appendIncrementLocal(1, islot);
mb.appendLoadLocal(islot);
mb.loadObject();
mb.appendARRAYLENGTH();
mb.appendISUB();
BranchWrapper ifempty = mb.appendIFGE(this);
// finish by loading array item at current index position
mb.loadObject();
mb.appendLoadLocal(islot);
mb.appendALOAD(m_itemType);
return ifempty;
}
protected void genLoadDone(ContextMethodBuilder mb)
throws JiBXException {
mb.freeSlot(m_slotHandle);
}
}
/**
* Collection item store strategy for array.
*/
/*package*/ static class ArrayStore extends CollectionStore
{
/** Array item type. */
private final String m_itemType;
/**
* Constructor.
*
* @param itype array item type
* @param doubword double word value flag
*/
/*package*/ ArrayStore(String itype, boolean doubword) {
super(doubword);
m_itemType = itype;
}
protected void genStoreInit(ContextMethodBuilder mb)
throws JiBXException {
// create index local with initial value -1
mb.appendLoadConstant(-1);
mb.defineSlot(m_itemType, Type.INT);
}
protected void genStoreItem(ContextMethodBuilder mb)
throws JiBXException {
// start by getting local variable slot for the index
int islot = mb.getSlot(m_itemType);
// append code to first increment index and check array size
mb.appendIncrementLocal(1, islot);
mb.appendLoadLocal(islot);
mb.loadObject();
mb.appendARRAYLENGTH();
mb.appendISUB();
BranchWrapper ifnotfull = mb.appendIFLT(this);
// grow the array size to make room for more values
mb.loadObject();
mb.appendCallStatic(GROWARRAY_METHOD, GROWARRAY_SIGNATURE);
mb.storeObject();
// swap the array reference with the item, swap index with item, and
// finally store item at new index position
mb.targetNext(ifnotfull);
mb.loadObject();
appendSWAP(mb);
mb.appendLoadLocal(islot);
appendSWAP(mb);
if (!ClassItem.isPrimitive(m_itemType)) {
mb.appendCreateCast(m_itemType);
}
mb.appendASTORE(m_itemType);
}
protected void genStoreDone(ContextMethodBuilder mb)
throws JiBXException {
// resize the array to match actual item count
int islot = mb.getSlot(m_itemType);
mb.appendIncrementLocal(1, islot);
mb.appendLoadLocal(islot);
mb.loadObject();
mb.appendCallStatic(RESIZEARRAY_METHOD, RESIZEARRAY_SIGNATURE);
mb.storeObject();
mb.freeSlot(m_itemType);
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/def/NestedStructure.java 0000644 0001750 0001750 00000040377 10442760652 025712 0 ustar moeller moeller /*
Copyright (c) 2003-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import java.util.ArrayList;
import org.jibx.binding.classes.*;
import org.jibx.runtime.JiBXException;
/**
* Structure binding definition. This handles one or more child components,
* which may be ordered or unordered.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class NestedStructure extends NestedBase
{
//
// Method definitions used in code generation
private static final String CHECK_ISSTART_NAME =
"org.jibx.runtime.impl.UnmarshallingContext.isStart";
private static final String CHECK_ISSTART_SIGNATURE = "()Z";
private static final String SKIP_ELEMENT_NAME =
"org.jibx.runtime.impl.UnmarshallingContext.skipElement";
private static final String SKIP_ELEMENT_SIGNATURE = "()V";
private static final String THROW_EXCEPTION_NAME =
"org.jibx.runtime.impl.UnmarshallingContext.throwNameException";
private static final String THROW_EXCEPTION_SIGNATURE =
"(Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)V";
//
// Instance data
/** Child supplying ID for bound class. */
private IComponent m_idChild;
/** Flag for choice of child content (used by subclasses). */
protected final boolean m_isChoice;
/** Flag for duplicate values allowed when unmarshalling unordered group. */
private final boolean m_allowDuplicates;
/** Flag for structure has associated object. */
private boolean m_hasObject;
/** Flag for already linked (to avoid multiple passes). */
private boolean m_isLinked;
/**
* Constructor.
*
* @param parent containing binding definition context
* @param objc current object context
* @param ord ordered content flag
* @param choice choice content flag
* @param flex flexible element handling flag
* @param ctx define context for structure flag
* @param hasobj has associated object flag
* @param dupl allow duplicates in unordered group flag
*/
public NestedStructure(IContainer parent, IContextObj objc,
boolean ord, boolean choice, boolean flex, boolean ctx,
boolean hasobj, boolean dupl) {
super(parent, objc, ord, flex, ctx);
m_isChoice = choice;
m_hasObject = hasobj;
m_allowDuplicates = dupl;
}
/**
* Set the object context.
*
* @param objc object context
*/
public void setObjectContext(IContextObj objc) {
m_hasObject = false;
}
//
// IComponent interface method definitions
public boolean hasAttribute() {
return m_attributes != null && m_attributes.size() > 0;
}
public void genAttrPresentTest(ContextMethodBuilder mb)
throws JiBXException {
if (m_attributes != null && m_attributes.size() > 0) {
// if single possiblity just test it directly
int count = m_attributes.size();
if (count == 1) {
((IComponent)m_attributes.get(0)).genAttrPresentTest(mb);
} else {
// generate code for chained test with branches to found exit
BranchWrapper[] tofound = new BranchWrapper[count];
for (int i = 0; i < count; i++) {
IComponent comp = (IComponent)m_attributes.get(i);
comp.genAttrPresentTest(mb);
tofound[i] = mb.appendIFNE(this);
}
// fall off end of loop to push "false" on stack and jump to end
mb.appendICONST_0();
BranchWrapper toend = mb.appendUnconditionalBranch(this);
// generate found target to push "true" on stack and continue
for (int i = 0; i < count; i++) {
mb.targetNext(tofound[i]);
}
mb.appendICONST_1();
mb.targetNext(toend);
}
} else {
throw new IllegalStateException
("Internal error - no attributes present");
}
}
public void genAttributeUnmarshal(ContextMethodBuilder mb)
throws JiBXException {
if (m_attributes != null && m_attributes.size() > 0) {
for (int i = 0; i < m_attributes.size(); i++) {
IComponent attr = (IComponent)m_attributes.get(i);
attr.genAttributeUnmarshal(mb);
}
} else {
throw new IllegalStateException
("Internal error - no attributes present");
}
}
public void genAttributeMarshal(ContextMethodBuilder mb)
throws JiBXException {
if (m_attributes != null && m_attributes.size() > 0) {
for (int i = 0; i < m_attributes.size(); i++) {
IComponent attr = (IComponent)m_attributes.get(i);
attr.genAttributeMarshal(mb);
}
} else {
throw new IllegalStateException
("Internal error - no attributes present");
}
}
public boolean hasContent() {
return m_contents.size() > 0;
}
public void genContentUnmarshal(ContextMethodBuilder mb)
throws JiBXException {
if (m_contents.size() > 0) {
// check for ordered or unordered content
if (m_isOrdered) {
// just generate unmarshal code for each component in order
for (int i = 0; i < m_contents.size(); i++) {
IComponent child = (IComponent)m_contents.get(i);
child.genContentUnmarshal(mb);
}
} else {
// start by finding the number of required elements
int count = m_contents.size();
int nreq = 0;
for (int i = 0; i < count; i++) {
if (!((IComponent)m_contents.get(i)).isOptional()) {
nreq++;
}
}
// create array for tracking elements seen
boolean useflag = nreq > 0 || !m_allowDuplicates;
if (useflag) {
mb.appendLoadConstant(count);
mb.appendCreateArray("boolean");
mb.defineSlot(this, ClassItem.typeFromName("boolean[]"));
}
// generate unmarshal loop code that checks for each component,
// branching to the next component until one is found and
// exiting the loop only when no component is matched (or in
// the case of flexible unmarshalling, only exiting the loop
// when the enclosing end tag is seen). this uses the array(s)
// of booleans to track elements seen and detect duplicates.
BranchWrapper link = null;
// TODO: initialize default values
BranchTarget first = mb.appendTargetNOP();
BranchWrapper[] toends;
if (m_isChoice) {
toends = new BranchWrapper[count+1];
} else {
toends = new BranchWrapper[1];
}
for (int i = 0; i < count; i++) {
// start with basic test code
if (link != null) {
mb.targetNext(link);
}
IComponent child = (IComponent)m_contents.get(i);
child.genContentPresentTest(mb);
link = mb.appendIFEQ(this);
// check for duplicate (if enforced)
if (!m_allowDuplicates) {
genFlagTest(true, i, "Duplicate element ",
child.getWrapperName(), mb);
}
// set flag for element seen
if (useflag || !(child.isOptional() && m_allowDuplicates)) {
mb.appendLoadLocal(mb.getSlot(this));
mb.appendLoadConstant(i);
mb.appendLoadConstant(1);
mb.appendASTORE("boolean");
}
// generate actual unmarshalling code
child.genContentUnmarshal(mb);
BranchWrapper next = mb.appendUnconditionalBranch(this);
if (m_isChoice) {
toends[i+1] = next;
} else {
next.setTarget(first, mb);
}
}
// handle comparison fall through depending on flexible flag
if (m_isFlexible) {
if (link != null) {
// exit loop if not positioned at element start
mb.targetNext(link);
mb.loadContext();
mb.appendCallVirtual(CHECK_ISSTART_NAME,
CHECK_ISSTART_SIGNATURE);
toends[0] = mb.appendIFEQ(this);
// ignore unknown element and loop back to start
mb.loadContext();
mb.appendCallVirtual(SKIP_ELEMENT_NAME,
SKIP_ELEMENT_SIGNATURE);
mb.appendUnconditionalBranch(this).setTarget(first, mb);
}
} else {
// set final test failure branch to fall through loop
toends[0] = link;
}
// patch all branches that exit loop
mb.targetNext(toends);
// handle required element present tests
if (nreq > 0) {
for (int i = 0; i < count; i++) {
IComponent child = (IComponent)m_contents.get(i);
if (!child.isOptional()) {
genFlagTest(false, i, "Missing required element ",
child.getWrapperName(), mb);
}
}
}
mb.freeSlot(this);
}
} else {
throw new IllegalStateException
("Internal error - no content present");
}
}
/**
* Helper method to generate test code for value in boolean array. If the
* test fails, the generated code throws an exception with the appropriate
* error message.
*
* @param cond flag setting resulting in exception
* @param pos position of element in list of child components
* @param msg basic error message when test fails
* @param name
* @param mb
*/
private void genFlagTest(boolean cond, int pos, String msg,
NameDefinition name, ContextMethodBuilder mb) {
// generate code to load array item value
mb.appendLoadLocal(mb.getSlot(this));
mb.appendLoadConstant(pos);
mb.appendALOAD("boolean");
// append branch for case where test is passed
BranchWrapper ifgood;
if (cond) {
ifgood = mb.appendIFEQ(this);
} else {
ifgood = mb.appendIFNE(this);
}
// generate exception for test failed
mb.loadContext();
mb.appendLoadConstant(msg);
if (name == null) {
mb.appendACONST_NULL();
mb.appendLoadConstant("(unknown name, position " + pos +
" in binding structure)");
} else {
name.genPushUriPair(mb);
}
mb.appendCallVirtual(THROW_EXCEPTION_NAME, THROW_EXCEPTION_SIGNATURE);
// set target for success branch on test
mb.targetNext(ifgood);
}
public void genContentMarshal(ContextMethodBuilder mb)
throws JiBXException {
if (m_contents.size() > 0) {
for (int i = 0; i < m_contents.size(); i++) {
IComponent content = (IComponent)m_contents.get(i);
content.genContentMarshal(mb);
}
} else {
throw new IllegalStateException
("Internal error - no content present");
}
}
public String getType() {
if (m_hasObject) {
return super.getType();
} else if (m_attributes != null && m_attributes.size() > 0) {
return ((IComponent)m_attributes.get(0)).getType();
} else if (m_contents.size() > 0) {
return ((IComponent)m_contents.get(0)).getType();
} else {
throw new IllegalStateException("Internal error - " +
"no type defined for structure");
}
}
public boolean hasId() {
return m_idChild != null;
}
public void genLoadId(ContextMethodBuilder mb) throws JiBXException {
if (m_idChild == null) {
throw new IllegalStateException("No ID child defined");
} else {
m_idChild.genLoadId(mb);
}
}
public void setLinkages() throws JiBXException {
if (!m_isLinked) {
// set flag first in case of recursive reference
m_isLinked = true;
// process all child components to link and sort by type
int i = 0;
while (i < m_contents.size()) {
IComponent comp = (IComponent)m_contents.get(i);
comp.setLinkages();
if (comp.hasAttribute()) {
if (m_attributes == null) {
m_attributes = new ArrayList();
}
m_attributes.add(comp);
}
if (!comp.hasContent()) {
m_contents.remove(i);
} else {
i++;
}
}
}
}
// DEBUG
public void print(int depth) {
BindingDefinition.indent(depth);
System.out.print("structure " +
(m_isChoice ? "choice" : (m_isOrdered ? "ordered" : "unordered")));
if (m_allowDuplicates) {
System.out.print(", duplicates allowed");
}
if (isFlexible()) {
System.out.print(", flexible");
}
if (m_idChild != null) {
System.out.print(" (ID)");
}
System.out.println();
for (int i = 0; i < m_contents.size(); i++) {
IComponent comp = (IComponent)m_contents.get(i);
comp.print(depth+1);
}
if (m_attributes != null) {
for (int i = 0; i < m_attributes.size(); i++) {
IComponent comp = (IComponent)m_attributes.get(i);
comp.print(depth+1);
}
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/def/ObjectBinding.java 0000644 0001750 0001750 00000115354 10651465024 025243 0 ustar moeller moeller /*
Copyright (c) 2003-2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import org.apache.bcel.Constants;
import org.apache.bcel.generic.*;
import org.jibx.binding.classes.*;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.Utility;
/**
* Binding modifiers that apply to a class reference. This adds the methods used
* for handling binding operations to the object class, then generates calls to
* the added methods as this binding definition is used.
*
* @author Dennis M. Sosnoski
*/
public class ObjectBinding extends PassThroughComponent
implements IComponent, IContextObj
{
//
// Constants and such related to code generation.
// recognized marshal hook method (pre-get) signatures.
private static final String[] MARSHAL_HOOK_SIGNATURES =
{
"(Lorg/jibx/runtime/IMarshallingContext;)V",
"(Ljava/lang/Object;)V",
"()V"
};
// recognized factory hook method signatures.
private static final String[] FACTORY_HOOK_SIGNATURES =
{
"(Lorg/jibx/runtime/IUnmarshallingContext;)",
"(Ljava/lang/Object;)",
"()"
};
// recognized unmarshal hook method (pre-set, post-set) signatures.
private static final String[] UNMARSHAL_HOOK_SIGNATURES =
{
"(Lorg/jibx/runtime/IUnmarshallingContext;)V",
"(Ljava/lang/Object;)V",
"()V"
};
// definitions used in generating calls to user defined methods
private static final String UNMARSHAL_GETSTACKTOPMETHOD =
"org.jibx.runtime.impl.UnmarshallingContext.getStackTop";
private static final String MARSHAL_GETSTACKTOPMETHOD =
"org.jibx.runtime.impl.MarshallingContext.getStackTop";
private static final String GETSTACKTOP_SIGNATURE =
"()Ljava/lang/Object;";
private static final String MARSHALLING_CONTEXT =
"org.jibx.runtime.impl.MarshallingContext";
private static final String UNMARSHALLING_CONTEXT =
"org.jibx.runtime.impl.UnmarshallingContext";
private static final String UNMARSHAL_PARAMETER_SIGNATURE =
"(Lorg/jibx/runtime/impl/UnmarshallingContext;)";
private static final String UNMARSHAL_PUSHOBJECTMETHOD =
"org.jibx.runtime.impl.UnmarshallingContext.pushObject";
private static final String UNMARSHAL_PUSHTRACKEDOBJECTMETHOD =
"org.jibx.runtime.impl.UnmarshallingContext.pushTrackedObject";
private static final String MARSHAL_PUSHOBJECTMETHOD =
"org.jibx.runtime.impl.MarshallingContext.pushObject";
private static final String PUSHOBJECT_SIGNATURE =
"(Ljava/lang/Object;)V";
private static final String UNMARSHAL_POPOBJECTMETHOD =
"org.jibx.runtime.impl.UnmarshallingContext.popObject";
private static final String MARSHAL_POPOBJECTMETHOD =
"org.jibx.runtime.impl.MarshallingContext.popObject";
private static final String POPOBJECT_SIGNATURE = "()V";
// definitions for methods added to mapped class
private static final String NEWINSTANCE_SUFFIX = "_newinstance";
private static final String UNMARSHAL_ATTR_SUFFIX = "_unmarshalAttr";
private static final String MARSHAL_ATTR_SUFFIX = "_marshalAttr";
private static final String UNMARSHAL_SUFFIX = "_unmarshal";
private static final String MARSHAL_SUFFIX = "_marshal";
// definitions for source position tracking
private static final String SOURCE_TRACKING_INTERFACE =
"org.jibx.runtime.impl.ITrackSourceImpl";
private static final String SETSOURCE_METHODNAME = "jibx_setSource";
private static final Type[] SETSOURCE_ARGS =
{
Type.STRING, Type.INT, Type.INT
};
private static final String SOURCEDOCUMENT_FIELDNAME ="jibx_sourceDocument";
private static final String SOURCELINE_FIELDNAME = "jibx_sourceLine";
private static final String SOURCECOLUMN_FIELDNAME = "jibx_sourceColumn";
private static final String SOURCENAME_METHODNAME = "jibx_getDocumentName";
private static final String SOURCELINE_METHODNAME = "jibx_getLineNumber";
private static final String SOURCECOLUMN_METHODNAME =
"jibx_getColumnNumber";
private static final Type[] EMPTY_ARGS = {};
//
// Actual instance data.
/** Containing binding definition structure. */
private final IContainer m_container;
/** Class linked to mapping. */
private BoundClass m_class;
/** Object factory method. */
private final ClassItem m_factoryMethod;
/** Preset method for object. */
private final ClassItem m_preSetMethod;
/** Postset method for object. */
private final ClassItem m_postSetMethod;
/** Preget method for object. */
private final ClassItem m_preGetMethod;
/** Type to be used for creating new instances. */
private final ClassFile m_createClass;
/** Generated new instance method. */
private ClassItem m_newInstanceMethod;
/** Flag for recursion while generating attribute unmarshal. */
private boolean m_lockAttributeUnmarshal;
/** Flag for recursion while generating attribute marshal. */
private boolean m_lockAttributeMarshal;
/** Flag for recursion while generating attribute unmarshal. */
private boolean m_lockContentUnmarshal;
/** Flag for recursion while generating attribute marshal. */
private boolean m_lockContentMarshal;
/** Signature used for unmarshal methods. */
private String m_unmarshalSignature;
/** Name for unmarshal attribute method (null unless
generation started). */
private String m_unmarshalAttributeName;
/** Name for unmarshal content method (null unless
generation started). */
private String m_unmarshalContentName;
/** Flag for static unmarshal methods. */
private boolean m_isStaticUnmarshal;
/** Flag for static marshal methods. */
private boolean m_isStaticMarshal;
/** Signature used for marshal methods. */
private String m_marshalSignature;
/** Name for marshal attribute method (null unless
generation started). */
private String m_marshalAttributeName;
/** Name for marshal content method (null unless
generation istarted). */
private String m_marshalContentName;
/** Generated unmarshal attribute method. */
private ClassItem m_unmarshalAttributeMethod;
/** Generated unmarshal content method. */
private ClassItem m_unmarshalContentMethod;
/** Generated marshal attribute method. */
private ClassItem m_marshalAttributeMethod;
/** Generated marshal content method. */
private ClassItem m_marshalContentMethod;
/** Child supplying instance identifier value. */
private IComponent m_idChild;
/** Flag for "this" reference, meaning that there's no separate object
* instance created. */
private boolean m_isThisBinding;
/**
* Constructor. This initializes the definition context to be the same as
* the parent's. Subclasses may change this definition context if
* appropriate.
*
* @param contain containing binding definition component
* @param objc current object context
* @param type fully qualified class name for bound object
* @param fact user new instance factory method
* @param pres user preset method for unmarshalling
* @param posts user postset method for unmarshalling
* @param pget user preget method for marshalling
* @param ctype type to use for creating new instance (null if
* not specified)
* @throws JiBXException if method not found
*/
public ObjectBinding(IContainer contain, IContextObj objc, String type,
String fact, String pres, String posts, String pget, String ctype)
throws JiBXException {
// initialize the basics
m_container = contain;
BoundClass ctxc = (objc == null) ? null : objc.getBoundClass();
m_class = BoundClass.getInstance(type, ctxc);
ClassFile cf = m_class.getClassFile();
if (ctype == null) {
m_createClass = cf;
} else {
m_createClass = ClassCache.getClassFile(ctype);
}
// check instance creation for unmarshalling
if (fact == null) {
m_factoryMethod = null;
} else {
// look up supplied static factory method
int split = fact.lastIndexOf('.');
if (split >= 0) {
// verify the method is defined
String cname = fact.substring(0, split);
String mname = fact.substring(split+1);
ClassFile mcf = ClassCache.getClassFile(cname);
m_factoryMethod = mcf.getMethod(mname,
FACTORY_HOOK_SIGNATURES);
if (m_factoryMethod == null) {
throw new JiBXException("Factory method " + fact +
" not found");
} else {
// force access if necessary
m_factoryMethod.makeAccessible(cf);
}
} else {
m_factoryMethod = null;
}
if (m_factoryMethod == null) {
throw new JiBXException("Factory method " + fact +
" not found.");
}
}
// look up other method names as members of class
if (pres == null) {
m_preSetMethod = null;
} else {
m_preSetMethod = cf.getMethod(pres, UNMARSHAL_HOOK_SIGNATURES);
if (m_preSetMethod == null) {
throw new JiBXException("User method " + pres + " not found.");
}
}
if (posts == null) {
m_postSetMethod = null;
} else {
m_postSetMethod = cf.getMethod(posts, UNMARSHAL_HOOK_SIGNATURES);
if (m_postSetMethod == null) {
throw new JiBXException("User method " + posts + " not found.");
}
}
if (pget == null) {
m_preGetMethod = null;
} else {
m_preGetMethod = cf.getMethod(pget, MARSHAL_HOOK_SIGNATURES);
if (m_preGetMethod == null) {
throw new JiBXException("User method " + pget + " not found.");
}
}
}
/**
* Abstract binding copy constructor. This is used to create a variation of
* the object binding for a mapping which will be used for "this"
* references. The "this" reference handling differs only in the code
* generation, where it skips adding the source tracking interfaces and
* does not push an instance of the object on the marshalling or
* unmarshalling stack (since the object will already be there). This method
* is only to be used before code generation.
*
* @param base original object binding
*/
public ObjectBinding(ObjectBinding base) {
m_container = base.m_container;
m_class = base.m_class;
m_factoryMethod = null;
m_preSetMethod = base.m_preSetMethod;
m_postSetMethod = base.m_postSetMethod;
m_preGetMethod = base.m_preGetMethod;
m_createClass = base.m_createClass;
m_idChild = base.m_idChild;
m_component = base.m_component;
m_isThisBinding = true;
}
/**
* Copy constructor. This is used in handling abstract mappings, where the
* properties of the mapping definition object binding need to be copied for
* each use of that binding.
*
* @param contain binding definition component for constructed copy
* @param base instance to be copied
*/
public ObjectBinding(IContainer contain, ObjectBinding base) {
m_container = contain;
m_class = base.m_class;
m_factoryMethod = base.m_factoryMethod;
m_preSetMethod = base.m_preSetMethod;
m_postSetMethod = base.m_postSetMethod;
m_preGetMethod = base.m_preGetMethod;
m_newInstanceMethod = base.m_newInstanceMethod;
m_unmarshalSignature = base.m_unmarshalSignature;
m_unmarshalAttributeName = base.m_unmarshalAttributeName;
m_unmarshalContentName = base.m_unmarshalContentName;
m_isStaticUnmarshal = base.m_isStaticUnmarshal;
m_isStaticMarshal = base.m_isStaticMarshal;
m_marshalSignature = base.m_marshalSignature;
m_marshalAttributeName = base.m_marshalAttributeName;
m_marshalContentName = base.m_marshalAttributeName;
m_marshalContentName = base.m_marshalContentName;
m_unmarshalAttributeMethod = base.m_unmarshalAttributeMethod;
m_unmarshalContentMethod = base.m_unmarshalContentMethod;
m_marshalAttributeMethod = base.m_marshalAttributeMethod;
m_marshalContentMethod = base.m_marshalContentMethod;
m_createClass = base.m_createClass;
m_idChild = base.m_idChild;
m_component = base.m_component;
}
/**
* Generate code for calling a user supplied method. The object methods
* support three signature variations, with no parameters, with the
* marshalling or unmarshalling context, or with the owning object.
*
* @param in flag for unmarshalling method
* @param method information for method being called
* @param mb method builder for generated code
*/
private void genUserMethodCall(boolean in, ClassItem method,
ContextMethodBuilder mb) {
// load object reference for virtual call
if (!method.isStatic()) {
mb.loadObject();
}
// check if parameter required for call
if (method.getArgumentCount() > 0) {
// generate code to load context, then get containing object if
// needed for call
mb.loadContext();
String type = method.getArgumentType(0);
if ("java.lang.Object".equals(type)) {
String name = in ? UNMARSHAL_GETSTACKTOPMETHOD :
MARSHAL_GETSTACKTOPMETHOD;
mb.appendCallVirtual(name, GETSTACKTOP_SIGNATURE);
}
}
// generate appropriate form of call to user method
mb.appendCall(method);
mb.addMethodExceptions(method);
}
/**
* Generate code to create an instance of the object for this mapping. This
* convenience method generates the actual code for creating an instance of
* an object. The generated code leaves the created object reference on the
* stack.
*
* @param mb method builder
* @return true if able to create instance, false
* if not
* @throws JiBXException if error in generating code
*/
private boolean genNewInstanceCode(ContextMethodBuilder mb)
throws JiBXException {
// check for factory supplied to create instance
if (m_factoryMethod == null) {
if (m_createClass.isArray()) {
// construct array instance directly with basic size
mb.appendLoadConstant(Utility.MINIMUM_GROWN_ARRAY_SIZE);
String type = m_createClass.getName();
mb.appendCreateArray(type.substring(0, type.length()-2));
return true;
} else if (m_createClass.isInterface()) {
// cannot create instance, throw exception
mb.appendCreateNew(MethodBuilder.FRAMEWORK_EXCEPTION_CLASS);
mb.appendDUP();
mb.appendLoadConstant("Cannot create instance of interface " +
m_createClass.getName());
mb.appendCallInit(MethodBuilder.FRAMEWORK_EXCEPTION_CLASS,
MethodBuilder.EXCEPTION_CONSTRUCTOR_SIGNATURE1);
mb.appendThrow();
return false;
} else {
// make sure we have a no argument constructor
ClassItem cons = m_createClass.getInitializerMethod("()V");
if (cons == null) {
m_createClass.addDefaultConstructor();
} else {
cons.makeAccessible(m_class.getMungedFile());
}
// no factory, so create an instance, duplicate the
// reference, and then call the null constructor
mb.appendCreateNew(m_createClass.getName());
mb.appendDUP();
mb.appendCallInit(m_createClass.getName(),"()V");
return true;
}
} else {
// generate call to factory method
genUserMethodCall(true, m_factoryMethod, mb);
mb.appendCreateCast(m_factoryMethod.getTypeName(),
m_class.getClassName());
return true;
}
}
/**
* Generate call to new instance creation method for object. This
* convenience method just generates code to call the generated new
* instance method added to the class definition.
*
* @param mb method builder
* @throws JiBXException if error in configuration
*/
private void genNewInstanceCall(ContextMethodBuilder mb)
throws JiBXException {
// check if new instance method needs to be added to class
if (m_newInstanceMethod == null) {
// set up for constructing new method
String name = m_container.getBindingRoot().getPrefix() +
NEWINSTANCE_SUFFIX;
String sig = UNMARSHAL_PARAMETER_SIGNATURE +
m_class.getClassFile().getSignature();
ClassFile cf = m_class.getMungedFile();
ContextMethodBuilder meth = new ContextMethodBuilder(name, sig,
cf, Constants.ACC_PUBLIC|Constants.ACC_STATIC, -1,
m_class.getClassName(), 0, UNMARSHALLING_CONTEXT);
// generate the code to build a new instance
if (genNewInstanceCode(meth)) {
// finish method code with return of new instance
meth.appendReturn(m_class.getClassName());
}
m_newInstanceMethod = m_class.getUniqueMethod(meth).getItem();
}
// generate code to call created new instance method
mb.loadContext(UNMARSHALLING_CONTEXT);
mb.appendCall(m_newInstanceMethod);
}
/**
* Generate code to handle unmarshal source location tracking. This
* convenience method generates the member variables and method used to
* support setting the source location, the methods used to access the
* information, and also adds the appropriate interfaces to the class.
*
* @throws JiBXException if error in generating code
*/
private void genTrackSourceCode() throws JiBXException {
ClassFile cf = m_class.getMungedFile();
if (!m_isThisBinding && m_class.isDirectAccess() && !cf.isAbstract() &&
cf.addInterface(SOURCE_TRACKING_INTERFACE)) {
// add position tracking fields to class
ClassItem srcname = cf.addPrivateField("java.lang.String;",
SOURCEDOCUMENT_FIELDNAME);
ClassItem srcline = cf.addPrivateField("int", SOURCELINE_FIELDNAME);
ClassItem srccol = cf.addPrivateField("int",
SOURCECOLUMN_FIELDNAME);
// add method for setting the source information
MethodBuilder mb = new ExceptionMethodBuilder(SETSOURCE_METHODNAME,
Type.VOID, SETSOURCE_ARGS, cf, Constants.ACC_PUBLIC);
mb.appendLoadLocal(0);
mb.appendLoadLocal(1);
mb.appendPutField(srcname);
mb.appendLoadLocal(0);
mb.appendLoadLocal(2);
mb.appendPutField(srcline);
mb.appendLoadLocal(0);
mb.appendLoadLocal(3);
mb.appendPutField(srccol);
mb.appendReturn();
mb.codeComplete(false);
mb.addMethod();
// add methods for getting the source information
mb = new ExceptionMethodBuilder(SOURCENAME_METHODNAME,
Type.STRING, EMPTY_ARGS, cf, Constants.ACC_PUBLIC);
mb.appendLoadLocal(0);
mb.appendGetField(srcname);
mb.appendReturn(Type.STRING);
mb.codeComplete(false);
mb.addMethod();
mb = new ExceptionMethodBuilder(SOURCELINE_METHODNAME,
Type.INT, EMPTY_ARGS, cf, Constants.ACC_PUBLIC);
mb.appendLoadLocal(0);
mb.appendGetField(srcline);
mb.appendReturn("int");
mb.codeComplete(false);
mb.addMethod();
mb = new ExceptionMethodBuilder(SOURCECOLUMN_METHODNAME,
Type.INT, EMPTY_ARGS, cf, Constants.ACC_PUBLIC);
mb.appendLoadLocal(0);
mb.appendGetField(srccol);
mb.appendReturn("int");
mb.codeComplete(false);
mb.addMethod();
}
}
/**
* Construct fullly-qualified class and method name for method under
* construction.
*
* @param mb method to be named
* @return fully-qualified class and method name
*/
private String fullMethodName(ContextMethodBuilder mb) {
return mb.getClassFile().getName() + '.' + mb.getName();
}
/**
* Construct fully-qualified class and method name for constructed method.
*
* @param item method to be named
* @return fully-qualified class and method name
*/
private String fullMethodName(ClassItem item) {
return item.getClassFile().getName() + '.' + item.getName();
}
/**
* Generate call to a constructed unmarshal method.
*
* @param name
* @param mb
*/
private void genUnmarshalCall(String name, ContextMethodBuilder mb) {
if (m_isStaticUnmarshal) {
mb.appendCallStatic(name, m_unmarshalSignature);
} else {
mb.appendCallVirtual(name, m_unmarshalSignature);
}
}
/**
* Generate call to a constructed marshal method.
*
* @param name
* @param mb
*/
private void genMarshalCall(String name, ContextMethodBuilder mb) {
if (m_isStaticMarshal) {
mb.appendCallStatic(name, m_marshalSignature);
} else {
mb.appendCallVirtual(name, m_marshalSignature);
}
}
/**
* Generate call to attribute unmarshal method for object. This convenience
* method just generates code to call the generated unmarshal method added
* to the class definition. The code generated prior to this call must have
* loaded a reference to the object to be unmarshalled on the stack, and the
* generated code returns the (possibly different, in the case of arrays)
* object on the stack.
*
* @param mb method builder
* @throws JiBXException if error in configuration
*/
private void genUnmarshalAttributeCall(ContextMethodBuilder mb)
throws JiBXException {
// check if unmarshal method needs to be added to class
if (m_unmarshalAttributeMethod == null) {
if (m_unmarshalAttributeName == null) {
// set up for constructing new method
String name = m_container.getBindingRoot().getPrefix() +
UNMARSHAL_ATTR_SUFFIX;
UnmarshalBuilder meth = new UnmarshalBuilder(name,
m_class.getClassFile(), m_class.getMungedFile());
m_unmarshalAttributeName = fullMethodName(meth);
m_unmarshalSignature = meth.getSignature();
m_isStaticUnmarshal = meth.isStaticMethod();
// if preset method supplied add code to call it
if (m_preSetMethod != null) {
meth.loadObject();
genUserMethodCall(true, m_preSetMethod, meth);
}
// push object being unmarshalled to unmarshaller stack
if (!m_isThisBinding) {
meth.loadContext();
meth.loadObject();
meth.appendCallVirtual(UNMARSHAL_PUSHTRACKEDOBJECTMETHOD,
PUSHOBJECT_SIGNATURE);
}
// generate the actual unmarshalling code in method
meth.loadObject();
m_component.genAttributeUnmarshal(meth);
// pop object from unmarshal stack
if (!m_isThisBinding) {
meth.loadContext();
meth.appendCallVirtual(UNMARSHAL_POPOBJECTMETHOD,
POPOBJECT_SIGNATURE);
}
// if postset method supplied and no content add code to call it
if (m_postSetMethod != null && !hasContent()) {
genUserMethodCall(true, m_postSetMethod, meth);
}
// finish by returning object
meth.loadObject();
meth.appendReturn(m_class.getClassFile().getName());
// add method to class
if (m_lockAttributeUnmarshal) {
m_unmarshalAttributeMethod =
m_class.getUniqueNamed(meth).getItem();
} else {
m_unmarshalAttributeMethod =
m_class.getUniqueMethod(meth).getItem();
m_unmarshalAttributeName =
fullMethodName(m_unmarshalAttributeMethod);
}
} else {
m_lockAttributeUnmarshal = true;
}
}
// generate code to call created unmarshal method
mb.loadContext(UNMARSHALLING_CONTEXT);
genUnmarshalCall(m_unmarshalAttributeName, mb);
}
/**
* Generate call to attribute marshal method for object. This convenience
* method just generates code to call the generated marshal method added to
* the class definition. The code generated prior to this call must have
* loaded a reference to the object to be marshalled on the stack.
*
* @param mb method builder
* @throws JiBXException if error in configuration
*/
private void genMarshalAttributeCall(ContextMethodBuilder mb)
throws JiBXException {
// check if marshal method needs to be added to class
if (m_marshalAttributeMethod == null) {
if (m_marshalAttributeName == null) {
// set up for constructing new method
String name = m_container.getBindingRoot().getPrefix() +
MARSHAL_ATTR_SUFFIX;
MarshalBuilder meth = new MarshalBuilder(name,
m_class.getClassFile(), m_class.getMungedFile());
m_marshalAttributeName = fullMethodName(meth);
m_marshalSignature = meth.getSignature();
m_isStaticMarshal = meth.isStaticMethod();
// if preget method supplied add code to call it
if (m_preGetMethod != null) {
genUserMethodCall(false, m_preGetMethod, meth);
}
// push object being marshalled to marshaller stack
if (!m_isThisBinding) {
meth.loadContext();
meth.loadObject();
meth.appendCallVirtual(MARSHAL_PUSHOBJECTMETHOD,
PUSHOBJECT_SIGNATURE);
}
// generate actual marshalling code
meth.loadContext();
m_component.genAttributeMarshal(meth);
// pop object from stack
if (!m_isThisBinding) {
meth.loadContext();
meth.appendCallVirtual(MARSHAL_POPOBJECTMETHOD,
POPOBJECT_SIGNATURE);
}
// finish and add constructed method to class
meth.appendReturn();
if (m_lockAttributeMarshal) {
m_marshalAttributeMethod =
m_class.getUniqueNamed(meth).getItem();
} else {
m_marshalAttributeMethod =
m_class.getUniqueMethod(meth).getItem();
m_marshalAttributeName =
fullMethodName(m_marshalAttributeMethod);
}
} else {
m_lockAttributeMarshal = true;
}
}
// generate code to call created marshal method
// if (!m_directAccess) {
mb.loadContext(MARSHALLING_CONTEXT);
// }
genMarshalCall(m_marshalAttributeName, mb);
}
/**
* Generate call to content unmarshal method for object. This convenience
* method just generates code to call the generated unmarshal method added
* to the class definition. The code generated prior to this call must have
* loaded a reference to the object to be unmarshalled on the stack, and the
* generated code returns the (possibly different, in the case of arrays)
* object on the stack.
*
* @param mb method builder
* @throws JiBXException if error in configuration
*/
private void genUnmarshalContentCall(ContextMethodBuilder mb)
throws JiBXException {
// check if unmarshal method needs to be added to class
if (m_unmarshalContentMethod == null) {
if (m_unmarshalContentName == null) {
// set up for constructing new method
String name = m_container.getBindingRoot().getPrefix() +
UNMARSHAL_SUFFIX;
UnmarshalBuilder meth = new UnmarshalBuilder(name,
m_class.getClassFile(), m_class.getMungedFile());
m_unmarshalContentName = fullMethodName(meth);
m_unmarshalSignature = meth.getSignature();
m_isStaticUnmarshal = meth.isStaticMethod();
// if preset method supplied add code to call it
if (!hasAttribute() && m_preSetMethod != null) {
meth.loadObject();
genUserMethodCall(true, m_preSetMethod, meth);
}
// push object being unmarshalled to unmarshaller stack
if (!m_isThisBinding) {
meth.loadContext();
meth.loadObject();
String mname = hasAttribute() ? UNMARSHAL_PUSHOBJECTMETHOD :
UNMARSHAL_PUSHTRACKEDOBJECTMETHOD;
meth.appendCallVirtual(mname, PUSHOBJECT_SIGNATURE);
}
// generate the actual unmarshalling code in method
meth.loadObject();
m_component.genContentUnmarshal(meth);
// pop object from unmarshal stack
if (!m_isThisBinding) {
meth.loadContext();
meth.appendCallVirtual(UNMARSHAL_POPOBJECTMETHOD,
POPOBJECT_SIGNATURE);
}
// if postset method supplied and no attributes add code to call
if (m_postSetMethod != null) {
genUserMethodCall(true, m_postSetMethod, meth);
}
// finish by returning object
meth.loadObject();
meth.appendReturn(m_class.getClassFile().getName());
// add method to class
if (m_lockContentUnmarshal) {
m_unmarshalContentMethod =
m_class.getUniqueNamed(meth).getItem();
} else {
m_unmarshalContentMethod =
m_class.getUniqueMethod(meth).getItem();
m_unmarshalContentName =
fullMethodName(m_unmarshalContentMethod);
}
} else {
m_lockContentUnmarshal = true;
}
}
// generate code to call created unmarshal method
mb.loadContext(UNMARSHALLING_CONTEXT);
genUnmarshalCall(m_unmarshalContentName, mb);
}
/**
* Generate call to content marshal method for object. This convenience
* method just generates code to call the generated marshal method added to
* the class definition. The code generated prior to this call must have
* loaded a reference to the object to be marshalled on the stack.
*
* @param mb method builder
* @throws JiBXException if error in configuration
*/
private void genMarshalContentCall(ContextMethodBuilder mb)
throws JiBXException {
// check if marshal method needs to be added to class
if (m_marshalContentMethod == null) {
if (m_marshalContentName == null) {
// set up for constructing new method
String name =
m_container.getBindingRoot().getPrefix() + MARSHAL_SUFFIX;
MarshalBuilder meth = new MarshalBuilder(name,
m_class.getClassFile(), m_class.getMungedFile());
m_marshalContentName = fullMethodName(meth);
m_marshalSignature = meth.getSignature();
m_isStaticMarshal = meth.isStaticMethod();
// if preget method supplied and no attributes add code to call it
if (m_preGetMethod != null && !hasAttribute()) {
genUserMethodCall(false, m_preGetMethod, meth);
}
// push object being marshalled to marshaller stack
if (!m_isThisBinding) {
meth.loadContext();
meth.loadObject();
meth.appendCallVirtual(MARSHAL_PUSHOBJECTMETHOD,
PUSHOBJECT_SIGNATURE);
}
// generate actual marshalling code
meth.loadContext();
m_component.genContentMarshal(meth);
// pop object from stack
if (!m_isThisBinding) {
meth.loadContext();
meth.appendCallVirtual(MARSHAL_POPOBJECTMETHOD,
POPOBJECT_SIGNATURE);
}
// finish and add constructed method to class
meth.appendReturn();
if (m_lockContentMarshal) {
m_marshalContentMethod =
m_class.getUniqueNamed(meth).getItem();
} else {
m_marshalContentMethod =
m_class.getUniqueMethod(meth).getItem();
m_marshalContentName = fullMethodName(m_marshalContentMethod);
}
} else {
m_lockContentMarshal = true;
}
}
// generate code to call created marshal method
mb.loadContext(MARSHALLING_CONTEXT);
genMarshalCall(m_marshalContentName, mb);
}
//
// IContextObj interface method definitions
public BoundClass getBoundClass() {
return m_class;
}
public boolean setIdChild(IComponent child) {
if (m_idChild == null) {
m_idChild = child;
return true;
} else {
return false;
}
}
//
// IComponent interface method definitions
public boolean isOptional() {
return false;
}
public void genAttributeUnmarshal(ContextMethodBuilder mb)
throws JiBXException {
genUnmarshalAttributeCall(mb);
}
public void genAttributeMarshal(ContextMethodBuilder mb)
throws JiBXException {
genMarshalAttributeCall(mb);
}
public void genContentUnmarshal(ContextMethodBuilder mb)
throws JiBXException {
genUnmarshalContentCall(mb);
}
public void genContentMarshal(ContextMethodBuilder mb)
throws JiBXException {
genMarshalContentCall(mb);
}
public void genNewInstance(ContextMethodBuilder mb) throws JiBXException {
genNewInstanceCall(mb);
}
public String getType() {
return m_class.getClassName();
}
public boolean hasId() {
return m_idChild != null;
}
public void genLoadId(ContextMethodBuilder mb) throws JiBXException {
if (m_idChild == null) {
throw new IllegalStateException("Internal error: no id defined");
} else {
m_idChild.genLoadId(mb);
}
}
public void setLinkages() throws JiBXException {
super.setLinkages();
if (m_container.getBindingRoot().isTrackSource()) {
genTrackSourceCode();
}
}
// DEBUG
public void print(int depth) {
BindingDefinition.indent(depth);
System.out.print("object binding for " +
m_class.getClassFile().getName());
if (m_isThisBinding) {
System.out.print(" (\"this\" reference)");
}
if (m_createClass != null) {
System.out.print(" create class " + m_createClass.getName());
}
System.out.println();
m_component.print(depth+1);
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/def/ObjectStringConversion.java 0000644 0001750 0001750 00000037372 10602533642 027206 0 ustar moeller moeller /*
Copyright (c) 2003-2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import org.jibx.binding.classes.*;
import org.jibx.runtime.JiBXException;
/**
* Object string conversion handling. Defines serialization handling for
* converting objects to and from a String value. The default is
* to just use the object toString() method for serialization and
* a constructor from a String value for deserialization.
* java.lang.String itself is a special case, with no added code
* used by default for either serializing or deserializing.
* java.lang.Object is also a special case, with no added code
* used by default for deserializing (the String value is used
* directly). Other classes must either implement toString() and
* a constructor from String, or use custom serializers and/or
* deserializers.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class ObjectStringConversion extends StringConversion
{
//
// Constants for code generation.
private static final String TOSTRING_METHOD = "toString";
private static final String TOSTRING_SIGNATURE =
"()Ljava/lang/String;";
private static final String FROMSTRING_SIGNATURE =
"(Ljava/lang/String;)V";
//
// Actual instance data
/** Flag for conversion from String needed (type is anything
other than String or Object) */
private boolean m_needDeserialize;
/** Initializer used for creating instance from String
(only used if no conversion needed and no deserializer supplied;
may be null) */
private ClassItem m_initFromString;
/** Flag for conversion to String needed (type is anything
other than String) */
private boolean m_needSerialize;
/** toString() method for converting instance to
String (only used if conversion needed and no serializer
supplied; may be null) */
private ClassItem m_instToString;
/**
* Constructor. Initializes conversion handling based on the supplied
* inherited handling.
*
* @param type fully qualified name of class handled by conversion
* @param inherit conversion information inherited by this conversion
* @throws JiBXException if error in configuration
*/
/*package*/ ObjectStringConversion(String type,
ObjectStringConversion inherit)
throws JiBXException {
super(type, inherit);
if (type.equals(inherit.m_typeName)) {
m_needDeserialize = inherit.m_needDeserialize;
m_initFromString = inherit.m_initFromString;
m_needSerialize = inherit.m_needSerialize;
m_instToString = inherit.m_instToString;
} else {
initMethods();
}
}
/**
* Constructor. Initializes conversion handling based on argument values.
* This form is only used for constructing the default set of conversions.
* Because of this, it throws an unchecked exception on error.
*
* @param dflt default value object (wrapped value for primitive types,
* otherwise String)
* @param ser fully qualified name of serialization method
* @param deser fully qualified name of deserialization method
* @param type fully qualified name of class handled by conversion
*/
/*package*/ ObjectStringConversion(Object dflt, String ser, String deser,
String type) {
super(dflt, ser, deser, type);
try {
initMethods();
} catch (JiBXException ex) {
throw new IllegalArgumentException(ex.getMessage());
}
}
/**
* Initialize methods used for conversion of types without serializer or
* deserializer. Sets flags for types needed, with errors thrown at time
* of attempted use rather than at definition time. That offers the
* advantages of simpler handling (we don't need to know which directions
* are supported in a binding) and more flexibility (can support nested
* partial definitions cleanly).
*/
private void initMethods() throws JiBXException {
if (!"java.lang.String".equals(m_typeName)) {
m_needSerialize = true;
m_needDeserialize = !"java.lang.Object".equals(m_typeName);
ClassFile cf = ClassCache.getClassFile(m_typeName);
m_initFromString = cf.getInitializerMethod(FROMSTRING_SIGNATURE);
m_instToString = cf.getMethod(TOSTRING_METHOD, TOSTRING_SIGNATURE);
}
}
/**
* Generate code to convert String representation. The
* code generated by this method assumes that the String
* value has already been pushed on the stack. It consumes this and
* leaves the converted value on the stack.
*
* @param mb method builder
*/
public void genFromText(ContextMethodBuilder mb) throws JiBXException {
// first generate code to duplicate value and check for null, with
// duplicate replaced by explicit null if already null (confusing
// in the bytecode, but will be optimized out by any native code
// generation)
mb.appendDUP();
BranchWrapper ifnnull = mb.appendIFNONNULL(this);
mb.appendPOP();
mb.appendACONST_NULL();
BranchWrapper toend = mb.appendUnconditionalBranch(this);
mb.targetNext(ifnnull);
// check if a deserializer is used for this type
if (m_deserializer != null) {
// just generate call to the deserializer (adding any checked
// exceptions thrown by the deserializer to the list needing
// handling)
mb.addMethodExceptions(m_deserializer);
if (m_deserializer.getArgumentCount() > 1) {
mb.loadContext();
}
mb.appendCall(m_deserializer);
} else if (m_initFromString != null) {
// generate code to create an instance of object and pass text value
// to constructor
mb.appendCreateNew(m_typeName);
mb.appendDUP_X1();
mb.appendSWAP();
mb.appendCallInit(m_typeName, FROMSTRING_SIGNATURE);
} else if (m_needDeserialize) {
throw new JiBXException("No deserializer for " + m_typeName +
"; define deserializer or constructor from java.lang.String");
}
// finish by setting target for null case branch
mb.targetNext(toend);
}
/**
* Generate code to parse and convert optional attribute or element. The
* code generated by this method assumes that the unmarshalling context
* and name information for the attribute or element have already
* been pushed on the stack. It consumes these and leaves the converted
* value (or converted default value, if the item itself is missing) on
* the stack.
*
* @param attr item is an attribute (vs element) flag
* @param mb method builder
* @throws JiBXException if error in configuration
*/
public void genParseOptional(boolean attr, ContextMethodBuilder mb)
throws JiBXException {
// first part of generated instruction sequence is to push the default
// value, then call the appropriate unmarshalling context method to get
// the value as a String
mb.appendLoadConstant((String)m_default);
String name = attr ? UNMARSHAL_OPT_ATTRIBUTE : UNMARSHAL_OPT_ELEMENT;
mb.appendCallVirtual(name, UNMARSHAL_OPT_SIGNATURE);
// second part is to actually convert to an instance of the type
genFromText(mb);
}
/**
* Generate code to parse and convert required attribute or element. The
* code generated by this method assumes that the unmarshalling context and
* name information for the attribute or element have already been pushed
* on the stack. It consumes these and leaves the converted value on the
* stack.
*
* @param attr item is an attribute (vs element) flag
* @param mb method builder
* @throws JiBXException if error in configuration
*/
public void genParseRequired(boolean attr, ContextMethodBuilder mb)
throws JiBXException {
// first part of generated instruction sequence is a call to the
// appropriate unmarshalling context method to get the value as a
// String
String name = attr ? UNMARSHAL_REQ_ATTRIBUTE : UNMARSHAL_REQ_ELEMENT;
mb.appendCallVirtual(name, UNMARSHAL_REQ_SIGNATURE);
// second part is to actually convert to an instance of the type
genFromText(mb);
}
/**
* Shared code generation for converting instance of type to
* String. This override of the base class method checks for
* serialization using the toString method and implements that
* case directly, while calling the base class method for normal handling.
* The code generated by this method assumes that the reference to the
* instance to be converted is on the stack. It consumes the reference,
* replacing it with the corresponding String value.
*
* @param type fully qualified class name for value on stack
* @param mb marshal method builder
* @throws JiBXException if error in configuration
*/
public void genToText(String type, ContextMethodBuilder mb)
throws JiBXException {
if (m_serializer == null && m_needSerialize) {
// report error if no handling available
if (m_instToString == null) {
throw new JiBXException("No serializer for " + m_typeName +
"; define serializer or toString() method");
} else {
// generate code to call toString() method of instance (adding
// any checked exceptions thrown by the method to the list
// needing handling)
mb.addMethodExceptions(m_instToString);
mb.appendCall(m_instToString);
}
} else {
super.genToText(type, mb);
}
}
/**
* Generate code to check if an optional value is not equal to the default.
* The code generated by this method assumes that the actual value to be
* converted has already been pushed on the stack. It consumes this,
* leaving the converted text reference on the stack if it's not equal to
* the default value.
*
* @param type fully qualified class name for value on stack
* @param mb method builder
* @param extra count of extra values to be popped from stack if missing
* @return handle for branch taken when value is equal to the default
* (target must be set by caller)
* @throws JiBXException if error in configuration
*/
protected BranchWrapper genToOptionalText(String type,
ContextMethodBuilder mb, int extra) throws JiBXException {
// check if the default value is just null
if (m_default == null) {
// generate code to call the serializer and get String value on
// stack
genToText(type, mb);
return null;
} else {
// start with code to call the serializer and get the String value
// on stack
genToText(type, mb);
// add code to check if the serialized text is different from the
// default, by duplicating the returned reference, pushing the
// default, and calling the object comparison method. This is
// followed by a branch if the comparison says they're not equal
// (nonzero result, since it's a boolean value).
mb.appendDUP();
mb.appendLoadConstant((String)m_default);
mb.appendCallStatic(COMPARE_OBJECTS_METHOD,
COMPARE_OBJECTS_SIGNATURE);
BranchWrapper iffalse = mb.appendIFEQ(this);
// finish by discarding copy of object reference on stack when
// equal to the default
genPopValues(extra+1, mb);
BranchWrapper toend = mb.appendUnconditionalBranch(this);
mb.targetNext(iffalse);
return toend;
}
}
/**
* Check if the type handled by this conversion is of a primitive type.
*
* @return false to indicate object type
*/
public boolean isPrimitive() {
return false;
}
/**
* Convert text representation into default value object. For object types
* this just returns the text value.
*
* @param text value representation to be converted
* @return converted default value object
* @throws JiBXException on conversion error
*/
protected Object convertDefault(String text) throws JiBXException {
return text;
}
/**
* Derive from existing formatting information. This allows constructing
* a new instance from an existing format of the same or an ancestor
* type, with the properties of the existing format copied to the new
* instance except where overridden by the supplied values.
*
* @param type fully qualified name of class handled by conversion
* @param ser fully qualified name of serialization method
* (null if inherited)
* @param dser fully qualified name of deserialization method
* (null if inherited)
* @param dflt default value text (null if inherited)
* @return new instance initialized from existing one
* @throws JiBXException if error in configuration information
*/
public StringConversion derive(String type, String ser, String dser,
String dflt) throws JiBXException {
if (type == null) {
type = m_typeName;
}
StringConversion inst = new ObjectStringConversion(type, this);
if (ser != null) {
inst.setSerializer(ser);
}
if (dser != null) {
inst.setDeserializer(dser);
}
if (dflt != null) {
inst.m_default = inst.convertDefault(dflt);
}
return inst;
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/def/OptionalStructureWrapper.java 0000644 0001750 0001750 00000006605 10624253474 027613 0 ustar moeller moeller /*
Copyright (c) 2003-2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import org.jibx.binding.classes.*;
import org.jibx.runtime.JiBXException;
/**
* Component decorator for optional structure with associated property. This
* just handles necessary glue code generation for the marshalling operations,
* where the presence of the structure needs to be tested before actually
* handling tag generation.
*/
public class OptionalStructureWrapper extends PassThroughComponent
{
/** Property definition. */
private final PropertyDefinition m_property;
/** Load object for marshalling code generation flag. */
private final boolean m_loadMarshal;
/**
* Constructor.
*
* @param wrap wrapped binding component
* @param load flag for need to load object for marshalling code
*/
public OptionalStructureWrapper(IComponent wrap, PropertyDefinition prop,
boolean load) {
super(wrap);
m_property = prop;
m_loadMarshal = load;
}
//
// IComponent interface method definitions
public void genAttributeMarshal(ContextMethodBuilder mb)
throws JiBXException {
mb.loadObject();
BranchWrapper ifmiss = m_property.genTest(mb);
super.genAttributeMarshal(mb);
mb.targetNext(ifmiss);
}
public void genContentMarshal(ContextMethodBuilder mb)
throws JiBXException {
mb.loadObject();
BranchWrapper ifmiss = m_property.genTest(mb);
if (m_loadMarshal) {
mb.loadObject();
m_property.genLoad(mb);
}
super.genContentMarshal(mb);
mb.targetNext(ifmiss);
}
// DEBUG
public void print(int depth) {
BindingDefinition.indent(depth);
System.out.print("optional structure wrapper " + m_property.toString());
if (m_loadMarshal) {
System.out.print(" (load marshal)");
}
System.out.println();
m_component.print(depth+1);
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/def/PassThroughComponent.java 0000644 0001750 0001750 00000010505 10435324110 026652 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import org.jibx.binding.classes.ContextMethodBuilder;
import org.jibx.runtime.JiBXException;
/**
* Default component decorator. This just passes through all method calls to
* the wrapped component.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class PassThroughComponent implements IComponent
{
/** Property value binding component. */
protected IComponent m_component;
/**
* No argument constructor. This requires the component to be set later,
* using the {@link #setWrappedComponent} method.
*/
protected PassThroughComponent() {}
/**
* Constructor.
*
* @param comp wrapped component
*/
protected PassThroughComponent(IComponent comp) {
m_component = comp;
}
/**
* Set the wrapped component.
*
* @param comp wrapped component
*/
protected void setWrappedComponent(IComponent comp) {
m_component = comp;
}
//
// IComponent interface method definitions
public boolean isOptional() {
return m_component.isOptional();
}
public boolean hasAttribute() {
return m_component.hasAttribute();
}
public void genAttrPresentTest(ContextMethodBuilder mb)
throws JiBXException {
m_component.genAttrPresentTest(mb);
}
public void genAttributeUnmarshal(ContextMethodBuilder mb)
throws JiBXException {
m_component.genAttributeUnmarshal(mb);
}
public void genAttributeMarshal(ContextMethodBuilder mb)
throws JiBXException {
m_component.genAttributeMarshal(mb);
}
public boolean hasContent() {
return m_component.hasContent();
}
public void genContentPresentTest(ContextMethodBuilder mb)
throws JiBXException {
m_component.genContentPresentTest(mb);
}
public void genContentUnmarshal(ContextMethodBuilder mb)
throws JiBXException {
m_component.genContentUnmarshal(mb);
}
public void genContentMarshal(ContextMethodBuilder mb)
throws JiBXException {
m_component.genContentMarshal(mb);
}
public void genNewInstance(ContextMethodBuilder mb) throws JiBXException {
m_component.genNewInstance(mb);
}
public String getType() {
return m_component.getType();
}
public boolean hasId() {
return m_component.hasId();
}
public void genLoadId(ContextMethodBuilder mb) throws JiBXException {
m_component.genLoadId(mb);
}
public NameDefinition getWrapperName() {
return m_component.getWrapperName();
}
public void setLinkages() throws JiBXException {
m_component.setLinkages();
}
// DEBUG
public void print(int depth) {
throw new IllegalStateException
("Method must be overridden by subclass" +
getClass().getName());
}
}
libjibx-java-1.1.6a/build/src/org/jibx/binding/def/PrimitiveStringConversion.java 0000644 0001750 0001750 00000046643 10270435556 027757 0 ustar moeller moeller /*
Copyright (c) 2003-2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import org.jibx.binding.classes.*;
import org.jibx.runtime.JiBXException;
/**
* Primitive string conversion handling. Class for handling serialization
* converting a primitive type to and from String values.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class PrimitiveStringConversion extends StringConversion
{
//
// Static class references
private static ClassFile s_unmarshalClass;
{
try {
s_unmarshalClass = ClassCache.getClassFile
("org.jibx.runtime.impl.UnmarshallingContext");
} catch (JiBXException ex) { /* no handling required */ }
}
//
// enum for comparison types of primitive values
private static final int INT_TYPE = 0;
private static final int LONG_TYPE = 1;
private static final int FLOAT_TYPE = 2;
private static final int DOUBLE_TYPE = 3;
//
// Constants for code generation.
/** Class providing basic conversion methods. */
private static final String UTILITY_CLASS_NAME =
"org.jibx.runtime.Utility";
/** Unmarshal method signature leading portion. */
private static final String UNMARSHAL_SIG_LEAD =
"(Ljava/lang/String;Ljava/lang/String;";
/** Constant argument type array for finding conversion methods. */
private static final Class[] SINGLE_STRING_ARGS =
new Class[] { String.class };
//
// Actual instance data
/** Marshalling requires conversion to text flag. */
private boolean m_isMarshalText;
/** Unmarshalling requires conversion to text flag. */
private boolean m_isUnmarshalText;
/** Unmarshalling context method for optional attribute. */
private ClassItem m_unmarshalOptAttribute;
/** Unmarshalling context method for optional element. */
private ClassItem m_unmarshalOptElement;
/** Unmarshalling context method for required attribute. */
private ClassItem m_unmarshalReqAttribute;
/** Unmarshalling context method for required element. */
private ClassItem m_unmarshalReqElement;
/** Comparison and marshal type of value (INT_TYPE, LONG_TYPE, FLOAT_TYPE,
or DOUBLE_TYPE) */
private int m_valueType;
/** Name of value type on stack. */
private String m_stackType;
/**
* Constructor. Initializes conversion handling based on the supplied
* inherited handling.
*
* @param type name of primitive type handled by conversion
* @param inherit conversion information inherited by this conversion
*/
protected PrimitiveStringConversion(String type,
PrimitiveStringConversion inherit) {
super(type, inherit);
m_isMarshalText = inherit.m_isMarshalText;
m_isUnmarshalText = inherit.m_isUnmarshalText;
m_unmarshalOptAttribute = inherit.m_unmarshalOptAttribute;
m_unmarshalOptElement = inherit.m_unmarshalOptElement;
m_unmarshalReqAttribute = inherit.m_unmarshalReqAttribute;
m_unmarshalReqElement = inherit.m_unmarshalReqElement;
m_valueType = inherit.m_valueType;
m_stackType = inherit.m_stackType;
}
/**
* Constructor. Initializes conversion handling based on argument values.
* This form is only used for constructing the default set of conversions.
*
* @param cls class of primitive type handled by conversion
* @param dflt default value object (wrapped value, or String
* or null with special deserializer)
* @param ts name of utility class static method for converting value to
* String
* @param fs name of utility class static method for converting
* String to value
* @param uattr unmarshalling context method name for attribute value
* @param uelem unmarshalling context method name for element value
*/
public PrimitiveStringConversion(Class cls, Object dflt, String code,
String ts, String fs, String uattr, String uelem) {
super(dflt, UTILITY_CLASS_NAME+'.'+ts, UTILITY_CLASS_NAME+'.'+fs,
cls.getName());
m_isMarshalText = m_isUnmarshalText = false;
String sig = UNMARSHAL_SIG_LEAD + code + ')' + code;
m_unmarshalOptAttribute = s_unmarshalClass.getMethod(uattr, sig);
m_unmarshalOptElement = s_unmarshalClass.getMethod(uelem, sig);
sig = UNMARSHAL_SIG_LEAD + ')' + code;
m_unmarshalReqAttribute = s_unmarshalClass.getMethod(uattr, sig);
m_unmarshalReqElement = s_unmarshalClass.getMethod(uelem, sig);
if (cls == Long.TYPE) {
m_valueType = LONG_TYPE;
m_stackType = "long";
} else if (cls == Float.TYPE) {
m_valueType = FLOAT_TYPE;
m_stackType = "float";
} else if (cls == Double.TYPE) {
m_valueType = DOUBLE_TYPE;
m_stackType = "double";
} else {
m_valueType = INT_TYPE;
m_stackType = "int";
}
}
/**
* Generate code to convert String representation. The
* code generated by this method assumes that the String
* value has already been pushed on the stack. It consumes this and
* leaves the converted value on the stack.
*
* @param mb method builder
*/
public void genFromText(ContextMethodBuilder mb) {
// check if a deserializer is used for this type
if (m_deserializer != null) {
// just generate call to the deserializer (adding any checked
// exceptions thrown by the deserializer to the list needing
// handling)
mb.addMethodExceptions(m_deserializer);
if (m_deserializer.getArgumentCount() > 1) {
mb.loadContext();
}
mb.appendCall(m_deserializer);
}
}
/**
* Push default value on stack. Just adds the appropriate instruction to
* the list for the method.
*
* @param mb method builder
*/
protected void pushDefault(ContextMethodBuilder mb) {
mb.appendLoadConstant(m_default);
}
/**
* Generate code to parse and convert optional attribute or element. The
* code generated by this method assumes that the unmarshalling context
* and name information for the attribute or element have already
* been pushed on the stack. It consumes these and leaves the converted
* value (or default value, if the item itself is missing) on the stack.
*
* @param attr item is an attribute (vs element) flag
* @param mb method builder
* @throws JiBXException if error in configuration
*/
public void genParseOptional(boolean attr, ContextMethodBuilder mb)
throws JiBXException {
// choose between custom deserializer or standard built-in method
if (m_isUnmarshalText) {
// first part of generated instruction sequence is to push the
// default value text, then call the appropriate unmarshalling
// context method to get the value as a String
String dflt;
if (m_default instanceof String || m_default == null) {
dflt = (String)m_default;
} else {
dflt = m_default.toString();
}
mb.appendLoadConstant(dflt);
String name = attr ? UNMARSHAL_OPT_ATTRIBUTE :
UNMARSHAL_OPT_ELEMENT;
mb.appendCallVirtual(name, UNMARSHAL_OPT_SIGNATURE);
// second part is to generate call to deserializer
genFromText(mb);
} else {
// generated instruction sequence just pushes the unwrapped default
// value, then calls the appropriate unmarshalling context method
// to get the value as a primitive
pushDefault(mb);
mb.appendCall(attr ?
m_unmarshalOptAttribute : m_unmarshalOptElement);
}
}
/**
* Generate code to parse and convert required attribute or element. The
* code generated by this method assumes that the unmarshalling context and
* name information for the attribute or element have already been pushed
* on the stack. It consumes these and leaves the converted value on the
* stack.
*
* @param attr item is an attribute (vs element) flag
* @param mb method builder
* @throws JiBXException if error in configuration
*/
public void genParseRequired(boolean attr, ContextMethodBuilder mb)
throws JiBXException {
// choose between custom deserializer or standard built-in method
if (m_isUnmarshalText) {
// first part of generated instruction sequence is a call to
// the appropriate unmarshalling context method to get the value
// as a String
String name = attr ? UNMARSHAL_REQ_ATTRIBUTE :
UNMARSHAL_REQ_ELEMENT;
mb.appendCallVirtual(name, UNMARSHAL_REQ_SIGNATURE);
// second part is to generate call to deserializer
genFromText(mb);
} else {
// generated instruction sequence just calls the appropriate
// unmarshalling context method to get the value as a primitive
mb.appendCall(attr ?
m_unmarshalReqAttribute : m_unmarshalReqElement);
}
}
/**
* Generate code to check if an optional value is not equal to the default.
* The code generated by this method assumes that the actual value to be
* converted has already been pushed on the stack. It consumes this,
* leaving the converted text reference on the stack if it's not equal to
* the default value.
*
* @param type fully qualified class name for value on stack
* @param mb method builder
* @param extra count of extra values to be popped from stack if missing
* @return handle for branch taken when value is equal to the default
* (target must be set by caller)
* @throws JiBXException if error in configuration
*/
protected BranchWrapper genToOptionalText(String type,
ContextMethodBuilder mb, int extra) throws JiBXException {
// set instructions based on value size
if (m_valueType == LONG_TYPE || m_valueType == DOUBLE_TYPE) {
mb.appendDUP2();
} else {
mb.appendDUP();
}
extra++;
// first add code to check if the value is different from the default,
// by duplicating the value, pushing the default, and executing the
// appropriate branch comparison
// TODO: this should not be done inline, but necessary for now
Object value = m_default;
if (m_isUnmarshalText) {
try {
String mname = m_deserializer.getName();
String cname = m_deserializer.getClassFile().getName();
Class clas = ClassFile.loadClass(cname);
if (clas == null) {
throw new JiBXException("Deserializer class " + cname +
" not found for converting default value");
} else {
// try first to find a declared method, then a public one
Method meth;
try {
meth = clas.getDeclaredMethod(mname,
SINGLE_STRING_ARGS);
meth.setAccessible(true);
} catch (NoSuchMethodException ex) {
meth = clas.getMethod(mname, SINGLE_STRING_ARGS);
}
String text;
if (value instanceof String || value == null) {
text = (String)value;
} else {
text = value.toString();
}
value = meth.invoke(null, new Object[] { text });
}
} catch (IllegalAccessException ex) {
throw new JiBXException("Conversion method not accessible", ex);
} catch (InvocationTargetException ex) {
throw new JiBXException("Internal error", ex);
} catch (NoSuchMethodException ex) {
throw new JiBXException("Internal error", ex);
}
}
mb.appendLoadConstant(value);
BranchWrapper ifne = null;
switch (m_valueType) {
case LONG_TYPE:
mb.appendLCMP();
break;
case FLOAT_TYPE:
mb.appendFCMPG();
break;
case DOUBLE_TYPE:
mb.appendDCMPG();
break;
default:
ifne = mb.appendIF_ICMPNE(this);
break;
}
if (ifne == null) {
ifne = mb.appendIFNE(this);
}
// generate code for branch not taken case, popping the value from
// stack along with extra parameters, and branching past using code
genPopValues(extra, mb);
BranchWrapper toend = mb.appendUnconditionalBranch(this);
mb.targetNext(ifne);
genToText(m_stackType, mb);
return toend;
}
/**
* Convert text representation into default value object. This override of
* the base class method uses reflection to call the actual deserialization
* method, returning the wrapped result value. If a custom deserializer is
* defined this just returns the String value directly.
*
* @param text value representation to be converted
* @return converted default value object
* @throws JiBXException on conversion error
*/
protected Object convertDefault(String text) throws JiBXException {
if (!m_isUnmarshalText) {
try {
String mname = m_deserializer.getName();
String cname = m_deserializer.getClassFile().getName();
Class clas = ClassFile.loadClass(cname);
if (clas == null) {
throw new JiBXException("Deserializer class " + cname +
" not found for converting default value");
} else {
// try first to find a declared method, then a public one
Method meth;
try {
meth = clas.getDeclaredMethod(mname,
SINGLE_STRING_ARGS);
meth.setAccessible(true);
} catch (NoSuchMethodException ex) {
meth = clas.getMethod(mname, SINGLE_STRING_ARGS);
}
return meth.invoke(null, new Object[] { text });
}
} catch (IllegalAccessException ex) {
throw new JiBXException("Conversion method not accessible", ex);
} catch (InvocationTargetException ex) {
throw new JiBXException("Internal error", ex);
} catch (NoSuchMethodException ex) {
throw new JiBXException("Internal error", ex);
}
} else {
return text;
}
}
/**
* Check if the type handled by this conversion is of a primitive type.
*
* @return true to indicate primitive type
*/
public boolean isPrimitive() {
return true;
}
/**
* Set serializer for conversion. This override of the base class method
* sets a flag to indicate that values must be converted to text before
* they are written to a document after executing the base class processing.
*
* @param ser fully qualified class and method name of serializer
* @throws JiBXException if serializer not found or not usable
*/
protected void setSerializer(String ser) throws JiBXException {
super.setSerializer(ser);
m_isMarshalText = true;
}
/**
* Set deserializer for conversion. This override of the base class method
* sets a flag to indicate that values must be read from a document as text
* and converted as a separate step after executing the base class
* processing.
*
* @param deser fully qualified class and method name of deserializer
* @throws JiBXException if deserializer not found or not usable
*/
protected void setDeserializer(String deser) throws JiBXException {
super.setDeserializer(deser);
m_isUnmarshalText = true;
}
/**
* Derive from existing formatting information. This allows constructing
* a new instance from an existing format of the same or an ancestor
* type, with the properties of the existing format copied to the new
* instance except where overridden by the supplied values.
*
* @param type fully qualified name of class handled by conversion
* @param ser fully qualified name of serialization method
* (null if inherited)
* @param dser fully qualified name of deserialization method
* (null if inherited)
* @param dflt default value text (null if inherited)
* @return new instance initialized from existing one
* @throws JiBXException if error in configuration information
*/
public StringConversion derive(String type, String ser, String dser,
String dflt) throws JiBXException {
if (type == null) {
type = m_typeName;
}
StringConversion inst = new PrimitiveStringConversion(type, this);
if (ser != null) {
inst.setSerializer(ser);
}
if (dser != null) {
inst.setDeserializer(dser);
}
if (dflt != null) {
inst.m_default = inst.convertDefault(dflt);
}
return inst;
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/def/PropertyDefinition.java 0000644 0001750 0001750 00000055515 11006326500 026367 0 ustar moeller moeller /*
Copyright (c) 2003-2008, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import java.util.ArrayList;
import org.jibx.binding.classes.BranchWrapper;
import org.jibx.binding.classes.ClassFile;
import org.jibx.binding.classes.ClassItem;
import org.jibx.binding.classes.ContextMethodBuilder;
import org.jibx.binding.classes.MethodBuilder;
import org.jibx.binding.model.ClassUtils;
import org.jibx.binding.util.IntegerCache;
import org.jibx.runtime.JiBXException;
/**
* Property definition from binding. This organizes shared information for
* bindings linked to fields or get/set methods of an object, and provides
* methods for related code generation.
*
* @author Dennis M. Sosnoski
*/
public class PropertyDefinition
{
//
// Constants and such related to code generation.
// recognized test-method signatures.
private static final String[] TEST_METHOD_SIGNATURES =
{
"(Lorg/jibx/runtime/IMarshallingContext;)Z",
"()Z"
};
// recognized get-method signatures.
private static final String[] GET_METHOD_SIGNATURES =
{
"(Lorg/jibx/runtime/IMarshallingContext;)",
"()"
};
//
// Actual instance data
/** Reference to "this" property of object flag. */
private boolean m_isThis;
/** Reference to implicit value from collection. */
private boolean m_isImplicit;
/** Optional item flag. */
private boolean m_isOptional;
/** Containing object context. */
private final IContextObj m_objContext;
/** Fully qualified name of actual type of value. */
private final String m_typeName;
/** Fully qualified name of declared type of value loaded. */
private final String m_getValueType;
/** Fully qualified name of declared type of value stored. */
private final String m_setValueType;
/** Information for field (if given, may be null). */
private final ClassItem m_fieldItem;
/** Information for test method (if given, may be null). */
private final ClassItem m_testMethod;
/** Information for get method (if given, may be null). */
private final ClassItem m_getMethod;
/** Information for set method (if given, may be null). */
private final ClassItem m_setMethod;
/**
* Constructor.
*
* @param parent containing binding definition structure
* @param obj containing object context
* @param type fully qualified name of type
* @param isthis "this" object reference flag
* @param opt optional property flag
* @param fname containing object field name for property (may be
* null)
* @param test containing object method to test for property present (may be
* null)
* @param get containing object method to get property value (may be
* null)
* @param set containing object method to set property value (may be
* null)
* @throws JiBXException if configuration error
*/
public PropertyDefinition(IContainer parent, IContextObj obj, String type,
boolean isthis, boolean opt, String fname, String test, String get,
String set) throws JiBXException {
m_objContext = obj;
m_isThis = isthis;
m_isOptional = opt;
ClassFile cf = m_objContext.getBoundClass().getClassFile();
m_isImplicit = false;
String dtype = null;
String gtype = null;
String stype = null;
if (isthis) {
if (type == null) {
dtype = gtype = stype = cf.getName();
} else {
dtype = gtype = stype = type;
}
}
if (fname == null) {
m_fieldItem = null;
} else {
m_fieldItem = cf.getField(fname);
dtype = gtype = stype = m_fieldItem.getTypeName();
}
if (test == null) {
m_testMethod = null;
} else {
if (opt) {
m_testMethod = cf.getMethod(test, TEST_METHOD_SIGNATURES);
if (m_testMethod == null) {
throw new JiBXException("test-method " + test +
" not found in class " + cf.getName());
}
} else {
throw new JiBXException
("Test method only allowed for optional properties");
}
}
if (get == null) {
m_getMethod = null;
} else {
m_getMethod = cf.getMethod(get, GET_METHOD_SIGNATURES);
if (m_getMethod == null) {
throw new JiBXException("get-method " + get +
" not found in class " + cf.getName());
} else {
gtype = m_getMethod.getTypeName();
if (dtype == null) {
dtype = gtype;
}
}
}
if (set == null) {
m_setMethod = null;
} else {
// need to handle overloads, so generate possible signatures
ArrayList sigs = new ArrayList();
if (m_getMethod != null) {
String psig = ClassUtils.getSignature(gtype);
sigs.add("(" + psig +
"Lorg/jibx/runtime/IUnmarshallingContext;" + ")V");
sigs.add("(" + psig + ")V");
}
if (type != null) {
String psig = ClassUtils.getSignature(type);
sigs.add("(" + psig +
"Lorg/jibx/runtime/IUnmarshallingContext;" + ")V");
sigs.add("(" + psig + ")V");
}
if (m_fieldItem != null) {
String psig = m_fieldItem.getSignature();
sigs.add("(" + psig +
"Lorg/jibx/runtime/IUnmarshallingContext;" + ")V");
sigs.add("(" + psig + ")V");
}
sigs.add
("(Ljava/lang/Object;Lorg/jibx/runtime/IUnmarshallingContext;)V");
sigs.add("(Ljava/lang/Object;)V");
// set method needs verification of argument and return type
ClassItem setmeth = cf.getMethod(set,
(String[])sigs.toArray(new String[0]));
if (setmeth == null) {
// nothing known about signature, try anything by name
setmeth = cf.getMethod(set, "");
if (setmeth != null) {
if (!setmeth.getTypeName().equals("void") ||
setmeth.getArgumentCount() > 2) {
setmeth = null;
} else if (setmeth.getArgumentCount() == 2) {
String xtype = setmeth.getArgumentType(1);
if (!"org.jibx.runtime.IUnmarshallingContext".equals(xtype)) {
setmeth = null;
}
}
}
}
// check if method found
m_setMethod = setmeth;
if (m_setMethod == null) {
throw new JiBXException("set-method " + set +
" not found in class " + cf.getName());
} else {
stype = m_setMethod.getArgumentType(0);
if (dtype == null) {
dtype = stype;
}
}
}
if (gtype == null) {
gtype = "java.lang.Object";
}
m_getValueType = gtype;
m_setValueType = stype;
// check that enough information is supplied
BindingDefinition root = parent.getBindingRoot();
if (!isthis && m_fieldItem == null) {
if (root.isInput() && m_setMethod == null) {
throw new JiBXException
("Missing way to set value for input binding");
}
if (root.isOutput() && m_getMethod == null) {
throw new JiBXException
("Missing way to get value for output binding");
}
}
// check that type information is consistent
if (type == null) {
m_typeName = dtype;
} else {
m_typeName = type;
boolean valid = true;
if (isthis) {
valid = ClassItem.isAssignable(dtype, type);
} else {
if (root.isInput()) {
valid = ClassItem.isAssignable(type, m_setValueType) ||
ClassItem.isAssignable(m_setValueType, type);
}
if (valid && root.isOutput()) {
valid = ClassItem.isAssignable(type, m_getValueType) ||
ClassItem.isAssignable(m_getValueType, type);
}
}
if (!valid) {
throw new JiBXException
("Incompatible types for property definition");
}
}
}
/**
* Constructor for "this" object reference.
*
* @param obj containing object context
* @param opt optional property flag
*/
public PropertyDefinition(IContextObj obj, boolean opt) {
m_objContext = obj;
m_isThis = true;
m_isImplicit = false;
m_isOptional = opt;
ClassFile cf = m_objContext.getBoundClass().getClassFile();
m_fieldItem = m_testMethod = m_getMethod = m_setMethod = null;
m_typeName = m_getValueType = m_setValueType = cf.getName();
}
/**
* Constructor for implicit object reference.
*
* @param type object type supplied
* @param obj containing object context
* @param opt optional property flag
*/
public PropertyDefinition(String type, IContextObj obj, boolean opt) {
m_objContext = obj;
m_isImplicit = true;
m_isThis = false;
m_isOptional = opt;
m_fieldItem = m_testMethod = m_getMethod = m_setMethod = null;
m_typeName = m_getValueType = m_setValueType = type;
}
/**
* Check if property is "this" reference for object.
*
* @return true if reference to "this", false if
* not
*/
public boolean isThis() {
return m_isThis;
}
/**
* Check if property is implicit value from collection.
*
* @return true if implicit, false if not
*/
public boolean isImplicit() {
return m_isImplicit;
}
/**
* Switch property from "this" to "implicit".
*/
public void switchProperty() {
m_isThis = false;
m_isImplicit = true;
}
/**
* Check if property is optional.
*
* @return true if optional, false if required
*/
public boolean isOptional() {
return m_isOptional;
}
/**
* Set flag for an optional property.
*
* @param opt true if optional property, false if
* not
*/
public void setOptional(boolean opt) {
m_isOptional = opt;
}
/**
* Get property name. If a field is defined this is the same as the field;
* otherwise it is either the get method name (with leading "get" stripped,
* if present) or the set method (with leading "set" stripped, if present),
* whichever is found.
*
* @return name for this property
*/
public String getName() {
if (m_isThis) {
return "this";
} else if (m_fieldItem != null) {
return m_fieldItem.getName();
} else if (m_getMethod != null) {
String name = m_getMethod.getName();
if (name.startsWith("get") && name.length() > 3) {
name = name.substring(3);
}
return name;
} else if (m_setMethod != null) {
String name = m_setMethod.getName();
if (name.startsWith("set") && name.length() > 3) {
name = name.substring(3);
}
return name;
} else {
return "item";
}
}
/**
* Get declared type fully qualified name.
*
* @return fully qualified class name of declared type
*/
public String getTypeName() {
return m_typeName;
}
/**
* Get value type as fully qualified name for loaded property value.
*
* @return fully qualified class name of value type
*/
public String getGetValueType() {
return m_getValueType;
}
/**
* Get value type as fully qualified name for stored property value.
*
* @return fully qualified class name of value type
*/
public String getSetValueType() {
return m_setValueType;
}
/**
* Check if property has presence test. Code needs to be generated to check
* for the presence of the property if it is optional and either a test
* method is defined or the value is an object reference.
*
* @return true if presence test needed, false if
* not
*/
public boolean hasTest() {
return isOptional() && !isImplicit() &&
(m_testMethod != null || !ClassItem.isPrimitive(m_typeName));
}
/**
* Append instruction to duplicate the value on the stack. This will use the
* appropriate instruction for the size of the value.
*
* @param mb
*/
private void duplicateValue(MethodBuilder mb) {
if ("long".equals(m_typeName) || "double".equals(m_typeName)) {
mb.appendDUP2();
} else {
mb.appendDUP();
}
}
/**
* Append instruction to pop the value from the stack. This will use the
* appropriate instruction for the size of the value.
*
* @param mb
*/
private void discardValue(MethodBuilder mb) {
if ("long".equals(m_typeName) || "double".equals(m_typeName)) {
mb.appendPOP2();
} else {
mb.appendPOP();
}
}
/**
* Generate code to test if property is present. The generated code
* assumes that the top of the stack is the reference for the containing
* object, and consumes this value for the test. The target for the
* returned branch instruction must be set by the caller.
*
* @param mb method builder
* @return wrapper for branch instruction taken when property is missing
*/
public BranchWrapper genTest(ContextMethodBuilder mb) {
// first check for supplied test method
if (m_testMethod != null) {
// generate call to test method to check for property present
mb.addMethodExceptions(m_testMethod);
if (m_testMethod.isStatic()) {
discardValue(mb);
}
if (m_testMethod.getArgumentCount() > 0) {
mb.loadContext();
}
mb.appendCall(m_testMethod);
return mb.appendIFEQ(this);
} else if (!m_isThis && !m_isImplicit &&
!ClassItem.isPrimitive(m_typeName)) {
// generated instruction either loads a field value or calls a "get"
// method, as appropriate
if (m_getMethod == null) {
if (m_fieldItem.isStatic()) {
discardValue(mb);
}
mb.appendGet(m_fieldItem);
} else {
if (m_getMethod.isStatic()) {
discardValue(mb);
}
if (m_getMethod.getArgumentCount() > 0) {
mb.loadContext();
}
mb.addMethodExceptions(m_getMethod);
mb.appendCall(m_getMethod);
}
return mb.appendIFNULL(this);
} else {
return null;
}
}
/**
* Generate code to load property value to stack. The generated code
* assumes that the top of the stack is the reference for the containing
* object. It consumes this and leaves the actual value on the stack. If
* the property value is not directly accessible from the context of the
* method being generated this automatically constructs an access method
* and uses that method.
*
* @param mb method builder
* @throws JiBXException if configuration error
*/
public void genLoad(ContextMethodBuilder mb) throws JiBXException {
// nothing to be done if called on "this" or implicit reference
if (!m_isThis && !m_isImplicit) {
// first check direct access to property from method class
ClassFile from = mb.getClassFile();
ClassItem access = m_getMethod;
if (access == null) {
access = m_fieldItem;
}
if (access != null && !from.isAccessible(access)) {
access = m_objContext.getBoundClass().
getLoadMethod(access, mb.getClassFile());
}
// generated instruction either loads a field value or calls a "get"
// method, as appropriate
if (access == null) {
Integer index = (Integer)mb.getKeyValue(m_setMethod);
discardValue(mb);
if (index == null) {
mb.appendACONST_NULL();
} else {
mb.appendLoadLocal(index.intValue());
}
} else {
if (access.isStatic()) {
discardValue(mb);
}
if (access.isMethod()) {
if (access.getArgumentCount() > 0) {
mb.loadContext();
}
mb.addMethodExceptions(access);
mb.appendCall(access);
} else {
mb.appendGet(access);
}
}
// cast value if necessary to assure correct type
mb.appendCreateCast(m_getValueType, m_typeName);
}
}
/**
* Generate code to store property value from stack. The generated code
* assumes that the reference to the containing object and the value to be
* stored have already been pushed on the stack. It consumes these, leaving
* nothing. If the property value is not directly accessible from the
* context of the method being generated this automatically constructs an
* access method and uses that method.
*
* @param mb method builder
* @throws JiBXException if configuration error
*/
public void genStore(MethodBuilder mb) throws JiBXException {
// check for cast needed to convert to actual type
if (!ClassItem.isPrimitive(m_setValueType)) {
mb.appendCreateCast(m_setValueType);
}
// nothing to be done if called on "this" or implicit reference
if (!m_isThis && !m_isImplicit) {
// first check direct access to property from method class
ClassFile from = mb.getClassFile();
ClassItem access = m_setMethod;
if (access == null) {
access = m_fieldItem;
}
if (!from.isAccessible(access)) {
access = m_objContext.getBoundClass().
getStoreMethod(access, mb.getClassFile());
}
// save to local if no way of getting value
if (m_getMethod == null && m_fieldItem == null) {
duplicateValue(mb);
Integer index = (Integer)mb.getKeyValue(m_setMethod);
if (index == null) {
int slot = mb.addLocal(null,
ClassItem.typeFromName(m_typeName));
index = IntegerCache.getInteger(slot);
mb.setKeyValue(m_setMethod, index);
} else {
mb.appendStoreLocal(index.intValue());
}
}
// generated instruction either stores a field value or calls a
// "set" method, as appropriate
if (access.isMethod()) {
if (access.getArgumentCount() > 1) {
// this test is ugly, needed because of backfill method
// calls from ValueChild
if (mb instanceof ContextMethodBuilder) {
((ContextMethodBuilder)mb).loadContext();
} else {
mb.appendACONST_NULL();
}
}
mb.addMethodExceptions(access);
mb.appendCall(access);
} else {
mb.appendPut(access);
}
if (access.isStatic()) {
discardValue(mb);
}
}
}
// DEBUG
public String toString() {
StringBuffer text = new StringBuffer();
if (m_isOptional) {
text.append("optional ");
}
text.append("property ");
if (m_isThis) {
text.append("\"this\" ");
} else if (m_isImplicit) {
text.append("from collection ");
} else if (m_fieldItem != null) {
text.append(m_fieldItem.getName() + " ");
} else {
if (m_getMethod != null) {
text.append("from " + m_getMethod.getName() + " ");
}
if (m_setMethod != null) {
text.append("to " + m_setMethod.getName() + " ");
}
}
if (m_typeName != null) {
text.append( "("+ m_typeName + ")");
}
return text.toString();
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/def/StringConversion.java 0000644 0001750 0001750 00000042723 10434260242 026047 0 ustar moeller moeller /*
Copyright (c) 2003-2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import org.apache.bcel.classfile.Utility;
import org.jibx.binding.classes.*;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.QName;
/**
* String conversion handling. Defines serialization handling for converting
* to and from a String value. This uses an inheritance approach,
* where each serialization definition is initialized based on the handling
* set for the containing definition of the same (or parent class) type.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public abstract class StringConversion
{
//
// Constants for code generation.
protected static final String UNMARSHAL_OPT_ATTRIBUTE =
"org.jibx.runtime.impl.UnmarshallingContext.attributeText";
protected static final String UNMARSHAL_OPT_ELEMENT =
"org.jibx.runtime.impl.UnmarshallingContext.parseElementText";
protected static final String UNMARSHAL_OPT_SIGNATURE =
"(Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)" +
"Ljava/lang/String;";
protected static final String UNMARSHAL_REQ_ATTRIBUTE =
"org.jibx.runtime.impl.UnmarshallingContext.attributeText";
protected static final String UNMARSHAL_REQ_ELEMENT =
"org.jibx.runtime.impl.UnmarshallingContext.parseElementText";
protected static final String UNMARSHAL_REQ_SIGNATURE =
"(Ljava/lang/String;Ljava/lang/String;)Ljava/lang/String;";
protected static final String MARSHAL_ATTRIBUTE =
"org.jibx.runtime.impl.MarshallingContext.attribute";
protected static final String MARSHAL_ELEMENT =
"org.jibx.runtime.impl.MarshallingContext.element";
protected static final String MARSHAL_SIGNATURE =
"(ILjava/lang/String;Ljava/lang/String;)" +
"Lorg/jibx/runtime/impl/MarshallingContext;";
protected static final String COMPARE_OBJECTS_METHOD =
"org.jibx.runtime.Utility.isEqual";
protected static final String COMPARE_OBJECTS_SIGNATURE =
"(Ljava/lang/Object;Ljava/lang/Object;)Z";
protected static final String[] DESERIALIZER_SIGNATURES =
{
"(Ljava/lang/String;)",
"(Ljava/lang/String;Lorg/jibx/runtime/IUnmarshallingContext;)"
};
// values used for name in marshalling; must be 1 or 2
public static final int MARSHAL_NAME_VALUES = 2;
//
// Actual instance data
/** Default value used for this type (wrapper for primitives, otherwise
String or null). */
protected Object m_default;
/** Serializer method information. */
protected ClassItem m_serializer;
/** Deserializer method information. */
protected ClassItem m_deserializer;
/** Fully qualified name of class handled by conversion. */
protected String m_typeName;
/** Signature of class handled by conversion. */
protected String m_typeSignature;
/**
* Constructor. This internal form only initializes the type information.
*
* @param type fully qualified name of class handled by conversion
*/
private StringConversion(String type) {
m_typeName = type;
m_typeSignature = Utility.getSignature(type);
}
/**
* Constructor. Initializes conversion handling based on the supplied
* inherited handling.
*
* @param type fully qualified name of class handled by conversion
* @param inherit conversion information inherited by this conversion
*/
protected StringConversion(String type, StringConversion inherit) {
this(type);
m_default = inherit.m_default;
m_serializer = inherit.m_serializer;
m_deserializer = inherit.m_deserializer;
}
/**
* Constructor. Initializes conversion handling based on argument values.
* This form is only used for constructing the default set of conversions.
* Because of this, it throws an unchecked exception on error.
*
* @param dflt default value object (wrapped value for primitive types,
* otherwise String)
* @param ser fully qualified name of serialization method
* @param deser fully qualified name of deserialization method
* @param type fully qualified name of class handled by conversion
*/
/*package*/ StringConversion(Object dflt, String ser, String deser,
String type) {
this(type);
m_default = dflt;
try {
if (ser != null) {
setSerializer(ser);
}
if (deser != null) {
setDeserializer(deser);
}
} catch (JiBXException ex) {
throw new IllegalArgumentException(ex.getMessage());
}
}
/**
* Get name of type handled by this conversion.
*
* @return fully qualified class name of type handled by conversion
*/
public String getTypeName() {
return m_typeName;
}
/**
* Generate code to convert String representation. The
* code generated by this method assumes that the String
* value has already been pushed on the stack. It consumes this and
* leaves the converted value on the stack.
*
* @param mb method builder
* @throws JiBXException if error in configuration
*/
public abstract void genFromText(ContextMethodBuilder mb)
throws JiBXException;
/**
* Generate code to parse and convert optional attribute or element. This
* abstract base class method must be implemented by every subclass. The
* code generated by this method assumes that the unmarshalling context
* and name information for the attribute or element have already
* been pushed on the stack. It consumes these and leaves the converted
* value (or converted default value, if the item itself is missing) on
* the stack.
*
* @param attr item is an attribute (vs element) flag
* @param mb method builder
* @throws JiBXException if error in configuration
*/
public abstract void genParseOptional(boolean attr, ContextMethodBuilder mb)
throws JiBXException;
/**
* Generate code to parse and convert required attribute or element. This
* abstract base class method must be implemented by every subclass. The
* code generated by this method assumes that the unmarshalling context and
* name information for the attribute or element have already been pushed
* on the stack. It consumes these and leaves the converted value on the
* stack.
*
* @param attr item is an attribute (vs element) flag
* @param mb method builder
* @throws JiBXException if error in configuration
*/
public abstract void genParseRequired(boolean attr, ContextMethodBuilder mb)
throws JiBXException;
/**
* Generate code to write String value to generated document.
* The code generated by this method assumes that the marshalling context,
* the name information, and the actual value to be converted have already
* been pushed on the stack. It consumes these, leaving the marshalling
* context on the stack.
*
* @param attr item is an attribute (vs element) flag
* @param mb method builder
*/
public void genWriteText(boolean attr, ContextMethodBuilder mb) {
// append code to call the appropriate generic marshalling context
// String method
String name = attr ? MARSHAL_ATTRIBUTE : MARSHAL_ELEMENT;
mb.appendCallVirtual(name, MARSHAL_SIGNATURE);
}
/**
* Generate code to pop values from stack.
*
* @param count number of values to be popped
* @param mb method builder
*/
public void genPopValues(int count, ContextMethodBuilder mb) {
while (--count >= 0) {
if (mb.isStackTopLong()) {
mb.appendPOP2();
} else {
mb.appendPOP();
}
}
}
/**
* Generate code to check if an optional value is not equal to the default.
* This abstract base class method must be implemented by every subclass.
* The code generated by this method assumes that the actual value to be
* converted has already been pushed on the stack. It consumes this,
* leaving the converted text reference on the stack if it's not equal to
* the default value.
*
* @param type fully qualified class name for value on stack
* @param mb method builder
* @param extra count of extra words to be popped from stack if missing
* @return handle for branch taken when value is equal to the default
* (target must be set by caller)
* @throws JiBXException if error in configuration
*/
protected abstract BranchWrapper genToOptionalText(String type,
ContextMethodBuilder mb, int extra) throws JiBXException;
/**
* Generate code to convert value to a String. The code
* generated by this method assumes that the actual value to be converted
* has already been pushed on the stack. It consumes this, leaving the
* converted text reference on the stack.
*
* @param type fully qualified class name for value on stack
* @param mb method builder
* @throws JiBXException if error in configuration
*/
public void genToText(String type, ContextMethodBuilder mb)
throws JiBXException {
// check if a serializer is used for this type
if (m_serializer != null) {
// just generate call to the serializer (adding any checked
// exceptions thrown by the serializer to the list needing
// handling)
if (!isPrimitive()) {
mb.appendCreateCast(type, m_serializer.getArgumentType(0));
}
mb.addMethodExceptions(m_serializer);
if (m_serializer.getArgumentCount() > 1) {
mb.loadContext();
}
mb.appendCall(m_serializer);
} else {
// make sure this is a string
mb.appendCreateCast(type, "java.lang.String");
}
}
/**
* Generate code to convert and write optional value to generated document.
* The generated code first tests if the value is the same as the supplied
* default, and if so skips writing. The code assumes that the marshalling
* context, the name information, and the actual value to be converted have
* already been pushed on the stack. It consumes these, leaving only the
* marshalling context on the stack.
*
* @param attr item is an attribute (vs element) flag
* @param type fully qualified class name for value on stack
* @param mb method builder
* @throws JiBXException if error in configuration
*/
public void genWriteOptional(boolean attr, String type,
ContextMethodBuilder mb) throws JiBXException {
// start with code to convert value to String, if it's not equal to the
// default value
BranchWrapper toend = genToOptionalText(type, mb, MARSHAL_NAME_VALUES);
// next use standard write code, followed by targeting branch
genWriteText(attr, mb);
if (toend != null) {
mb.targetNext(toend);
}
}
/**
* Generate code to convert and write required value to generated document.
* The code generated by this method assumes that the marshalling context,
* the name information, and the actual value to be converted have already
* been pushed on the stack. It consumes these, leaving the returned
* marshalling context on the stack.
*
* @param attr item is an attribute (vs element) flag
* @param type fully qualified class name for value on stack
* @param mb method builder
* @throws JiBXException if error in configuration
*/
public void genWriteRequired(boolean attr, String type,
ContextMethodBuilder mb) throws JiBXException {
// generate code to convert to text, followed by code to marshal text
genToText(type, mb);
genWriteText(attr, mb);
}
/**
* Check if the type handled by this conversion is of a primitive type.
*
* @return true if a primitive type, false if an
* object type
*/
public abstract boolean isPrimitive();
/**
* Set serializer for conversion. This finds the named static method and
* sets it as the serializer to be used for this conversion. The serializer
* method is expected to take a single argument of either the handled
* type or a superclass or interface of the handled type, and to return a
* String result.
*
* @param ser fully qualified class and method name of serializer
* @throws JiBXException if serializer not found or not usable
*/
protected void setSerializer(String ser) throws JiBXException {
// build all possible signature variations
String[] tsigs = ClassItem.getSignatureVariants(m_typeName);
String[] msigs = new String[tsigs.length*2];
for (int i = 0; i < tsigs.length; i++) {
msigs[i*2] = "(" + tsigs[i] + ")Ljava/lang/String;";
msigs[i*2+1] = "(" + tsigs[i] +
"Lorg/jibx/runtime/IMarshallingContext;)Ljava/lang/String;";
}
// find a matching static method
ClassItem method = ClassItem.findStaticMethod(ser, msigs);
// report error if method not found
if (method == null) {
throw new JiBXException("Serializer " + ser + " not found");
} else {
m_serializer = method;
}
}
/**
* Set deserializer for conversion. This finds the named static method and
* sets it as the deserializer to be used for this conversion. The
* deserializer method is expected to take a single argument of type
* String, and to return a value of the handled type or a
* subtype of that type.
*
* @param deser fully qualified class and method name of deserializer
* @throws JiBXException if deserializer not found or not usable
*/
protected void setDeserializer(String deser) throws JiBXException {
// find a matching static method
ClassItem method =
ClassItem.findStaticMethod(deser, DESERIALIZER_SIGNATURES);
// report error if method not found or incompatible
if (method == null) {
throw new JiBXException("Deserializer " + deser + " not found");
} else if (ClassItem.isAssignable(method.getTypeName(), m_typeName)) {
m_deserializer = method;
} else {
throw new JiBXException("Deserializer " + deser +
" returns wrong type");
}
}
/**
* Convert text representation into default value object. Each subclass
* must implement this with the appropriate conversion handling.
*
* @param text value representation to be converted
* @return converted default value object
* @throws JiBXException on conversion error
*/
protected abstract Object convertDefault(String text) throws JiBXException;
/**
* Derive from existing formatting information. This abstract base class
* method must be implemented by every subclass. It allows constructing
* a new instance from an existing format of the same or an ancestor
* type, with the properties of the existing format copied to the new
* instance except where overridden by the supplied values.
*
* @param type fully qualified name of class handled by conversion
* @param ser fully qualified name of serialization method
* (null if inherited)
* @param dser fully qualified name of deserialization method
* (null if inherited)
* @param dflt default value text (null if inherited)
* @return new instance initialized from existing one
* @throws JiBXException if error in configuration information
*/
public abstract StringConversion derive(String type, String ser,
String dser, String dflt) throws JiBXException;
} libjibx-java-1.1.6a/build/src/org/jibx/binding/def/StructureReference.java 0000644 0001750 0001750 00000013124 10221060302 026330 0 ustar moeller moeller /*
Copyright (c) 2003-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import org.jibx.binding.classes.ClassCache;
import org.jibx.binding.classes.ClassFile;
import org.jibx.binding.classes.ContextMethodBuilder;
import org.jibx.runtime.JiBXException;
/**
* Reference to a structure definition. This is used as a placeholder when
* building the component structure of a binding definition. It's necessary
* because the referenced structure may not have been parsed yet. During the
* linkage phase that follows parsing this looks up the appropriate structure
* definition and sets up the corresponding component structure. Thereafter it
* operates as a simple pass-through wrapper for the top child component.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class StructureReference extends PassThroughComponent
{
/** Containing binding component. */
private final IContainer m_container;
/** Containing binding definition structure. */
private final IContextObj m_contextObject;
/** Property definition (may be null). */
private final PropertyDefinition m_property;
/** Identifier for referenced structure definition. */
private final String m_label;
/** Flag for marshalling code generation to be skipped by component. */
private boolean m_skipMarshal;
/** Object load needed for marshalling flag (used with object binding). */
private boolean m_needLoad;
/**
* Constructor.
*
* @param contain containing binding component
* @param label reference structure identifier
* @param prop property definition (may be null)
* @param hasname element name used with reference flag
* @param cobj context object
*/
public StructureReference(IContainer contain, String label,
PropertyDefinition prop, boolean hasname, IContextObj cobj) {
super();
m_container = contain;
m_contextObject = cobj;
m_property = prop;
m_skipMarshal = hasname && prop != null && prop.isOptional();
m_label = label;
}
//
// IComponent interface method definitions (overrides of defaults)
public void genAttributeMarshal(ContextMethodBuilder mb)
throws JiBXException {
if (m_needLoad) {
mb.loadObject();
}
m_component.genAttributeMarshal(mb);
}
public void genContentMarshal(ContextMethodBuilder mb)
throws JiBXException {
if (m_needLoad) {
mb.loadObject();
}
m_component.genContentMarshal(mb);
}
public void setLinkages() throws JiBXException {
// find the structure being used
DefinitionContext defc = m_container.getDefinitionContext();
IComponent impl = defc.getNamedStructure(m_label);
// verify compatible use of structure
String type = (m_property == null) ?
m_contextObject.getBoundClass().getClassName() :
m_property.getTypeName();
ClassFile cf = ClassCache.getClassFile(type);
String itype = impl.getType();
if (!cf.isSuperclass(itype)) {
throw new JiBXException("Reference to structure " + m_label +
" has object of type " + type + " rather than required " +
itype);
}
// generate component matching mapping type
IComponent wrap;
if (impl instanceof DirectObject) {
wrap = new DirectProperty(m_property, (DirectObject)impl);
} else if (m_property == null || m_property.isImplicit()) {
wrap = impl;
m_needLoad = impl instanceof ObjectBinding;
} else {
wrap = new ComponentProperty(m_property, impl, m_skipMarshal);
}
// set the wrapped component used for all other calls
setWrappedComponent(wrap);
m_component.setLinkages();
}
// DEBUG
public void print(int depth) {
BindingDefinition.indent(depth);
System.out.print("structure reference to " + m_label);
if (m_property != null) {
System.out.println(" using " + m_property.toString());
}
System.out.println();
}
}
libjibx-java-1.1.6a/build/src/org/jibx/binding/def/ValueChild.java 0000644 0001750 0001750 00000104572 11005476514 024562 0 ustar moeller moeller /*
Copyright (c) 2003-2008, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.def;
import org.apache.bcel.Constants;
import org.apache.bcel.generic.*;
import org.jibx.binding.classes.*;
import org.jibx.runtime.JiBXException;
/**
* Attribute or simple content value definition from binding. This organizes
* information for anything that can be converted to and from a simple
* String. Content values include both elements with only character
* data content and text, as character data content or CDATA sections.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class ValueChild implements IComponent
{
//
// Ident type enumeration.
/*package*/ static final int DIRECT_IDENT = 0;
/*package*/ static final int AUTO_IDENT = 1;
/*package*/ static final int DEF_IDENT = 2;
/*package*/ static final int REF_IDENT = 3;
//
// Value style enumeration.
/*package*/ static final int ATTRIBUTE_STYLE = 0;
/*package*/ static final int ELEMENT_STYLE = 1;
/*package*/ static final int TEXT_STYLE = 2;
/*package*/ static final int CDATA_STYLE = 3;
//
// Constants for unmarshalling.
/** Prefix used for backfill classes. */
private static final String BACKFILL_SUFFIX = "_backfill_";
private static final String[] BACKFILL_INTERFACES =
{
"org.jibx.runtime.impl.BackFillReference"
};
private static final String BACKFILL_METHODNAME = "backfill";
private static final Type[] BACKFILL_METHODARGS =
{
Type.OBJECT
};
private static final String BOUNDREF_NAME = "m_obj";
private static final String CHECK_ELEMENT_NAME =
"org.jibx.runtime.impl.UnmarshallingContext.isAt";
private static final String CHECK_ATTRIBUTE_NAME =
"org.jibx.runtime.impl.UnmarshallingContext.hasAttribute";
private static final String CHECK_SIGNATURE =
"(Ljava/lang/String;Ljava/lang/String;)Z";
private static final String UNMARSHAL_DEFREF_ATTR_NAME =
"org.jibx.runtime.impl.UnmarshallingContext.attributeExistingIDREF";
private static final String UNMARSHAL_DEFREF_ELEM_NAME =
"org.jibx.runtime.impl.UnmarshallingContext.parseElementExistingIDREF";
private static final String UNMARSHAL_FWDREF_ATTR_NAME =
"org.jibx.runtime.impl.UnmarshallingContext.attributeForwardIDREF";
private static final String UNMARSHAL_FWDREF_ELEM_NAME =
"org.jibx.runtime.impl.UnmarshallingContext.parseElementForwardIDREF";
private static final String UNMARSHAL_DEFREF_SIGNATURE =
"(Ljava/lang/String;Ljava/lang/String;I)Ljava/lang/Object;";
private static final String REGISTER_BACKFILL_NAME =
"org.jibx.runtime.impl.UnmarshallingContext.registerBackFill";
private static final String REGISTER_BACKFILL_SIGNATURE =
"(ILorg/jibx/runtime/impl/BackFillReference;)V";
private static final String DEFINE_ID_NAME =
"org.jibx.runtime.impl.UnmarshallingContext.defineID";
private static final String DEFINE_ID_SIGNATURE =
"(Ljava/lang/String;ILjava/lang/Object;)V";
private static final String UNMARSHAL_TEXT_NAME =
"org.jibx.runtime.impl.UnmarshallingContext.parseContentText";
private static final String UNMARSHAL_TEXT_SIGNATURE =
"()Ljava/lang/String;";
private static final String UNMARSHAL_ELEMENT_TEXT_NAME =
"org.jibx.runtime.impl.UnmarshallingContext.parseElementText";
private static final String UNMARSHAL_ELEMENT_TEXT_SIGNATURE =
"(Ljava/lang/String;Ljava/lang/String;)Ljava/lang/String;";
private static final String UNMARSHAL_PARSE_IF_START_NAME =
"org.jibx.runtime.impl.UnmarshallingContext.parseIfStartTag";
private static final String UNMARSHAL_PARSE_IF_START_SIGNATURE =
"(Ljava/lang/String;Ljava/lang/String;)Z";
private static final String UNMARSHAL_PARSE_TO_START_NAME =
"org.jibx.runtime.impl.UnmarshallingContext.parseToStartTag";
private static final String UNMARSHAL_PARSE_TO_START_SIGNATURE =
"(Ljava/lang/String;Ljava/lang/String;)V";
private static final String UNMARSHAL_PARSE_PAST_END_NAME =
"org.jibx.runtime.impl.UnmarshallingContext.parsePastEndTag";
private static final String UNMARSHAL_PARSE_PAST_END_SIGNATURE =
"(Ljava/lang/String;Ljava/lang/String;)V";
private static final String MARSHAL_TEXT_NAME =
"org.jibx.runtime.impl.MarshallingContext.writeContent";
private static final String MARSHAL_CDATA_NAME =
"org.jibx.runtime.impl.MarshallingContext.writeCData";
private static final String MARSHAL_TEXT_SIGNATURE =
"(Ljava/lang/String;)Lorg/jibx/runtime/impl/MarshallingContext;";
private static final String UNMARSHALLING_THROWEXCEPTION_METHOD =
"org.jibx.runtime.impl.UnmarshallingContext.throwException";
private static final String UNMARSHALLING_THROWEXCEPTION_SIGNATURE =
"(Ljava/lang/String;)V";
protected static final String MARSHAL_ATTRIBUTE =
"org.jibx.runtime.impl.MarshallingContext.attribute";
protected static final String MARSHAL_ELEMENT =
"org.jibx.runtime.impl.MarshallingContext.element";
protected static final String MARSHAL_SIGNATURE =
"(ILjava/lang/String;Ljava/lang/String;)" +
"Lorg/jibx/runtime/impl/MarshallingContext;";
protected static final String MARSHAL_STARTTAG_ATTRIBUTES =
"org.jibx.runtime.impl.MarshallingContext.startTagAttributes";
protected static final String MARSHAL_STARTTAG_SIGNATURE =
"(ILjava/lang/String;)Lorg/jibx/runtime/impl/MarshallingContext;";
protected static final String MARSHAL_CLOSESTART_EMPTY =
"org.jibx.runtime.impl.MarshallingContext.closeStartEmpty";
protected static final String MARSHAL_CLOSESTART_EMPTY_SIGNATURE =
"()Lorg/jibx/runtime/impl/MarshallingContext;";
protected static final String UNMARSHAL_ATTRIBUTE_BOOLEAN_NAME =
"org.jibx.runtime.impl.UnmarshallingContext.attributeBoolean";
protected static final String UNMARSHAL_ATTRIBUTE_BOOLEAN_SIGNATURE =
"(Ljava/lang/String;Ljava/lang/String;Z)Z";
//
// Actual instance data
/** Containing binding definition structure. */
private final IContainer m_container;
/** Containing object context. */
private final IContextObj m_objContext;
/** Value style code. */
private final int m_valueStyle;
/** Constant value. */
private final String m_constantValue;
/** Ident type code. */
private final int m_identType;
/** Attribute or element name information. */
private final NameDefinition m_name;
/** Fully qualified name of type. */
private final String m_type;
/** Nillable element flag. */
private final boolean m_isNillable;
/** Linked property information. */
private final PropertyDefinition m_property;
/** Conversion handling for value. */
private final StringConversion m_conversion;
/** Mapping definition for object class supplying identifier. */
private IMapping m_idRefMap;
/**
* Constructor. Saves the context information for later use.
*
* @param contain containing binding definition structure
* @param objc containing object context
* @param name element or attribute name information (may be
* null)
* @param prop property reference information
* @param conv string conversion handler
* @param style value style code
* @param ident identifier type code
* @param constant value for constant
* @param nillable nillable element flag
*/
public ValueChild(IContainer contain, IContextObj objc, NameDefinition name,
PropertyDefinition prop, StringConversion conv, int style, int ident,
String constant, boolean nillable) {
m_container = contain;
m_objContext = objc;
m_name = name;
m_property = prop;
m_type = prop.getTypeName();
m_conversion = conv;
m_valueStyle = style;
m_identType = ident;
m_constantValue = constant;
m_isNillable = nillable;
}
/**
* Create backfill handler class if it does not already exist. This either
* looks up the existing backfill handler class or creates a new one
* specifically for this value.
*
* @return backfill handler class for value
* @throws JiBXException if error in configuration
*/
private ClassFile createBackfillClass() throws JiBXException {
// create the new class
BoundClass bc = m_objContext.getBoundClass();
BindingDefinition def = m_container.getBindingRoot();
String name = bc.getClassFile().deriveClassName(def.getPrefix(),
BACKFILL_SUFFIX + m_property.getName());
ClassFile base = ClassCache.getClassFile("java.lang.Object");
ClassFile cf = new ClassFile(name, bc.getClassFile().getRoot(),
base, Constants.ACC_PUBLIC, BACKFILL_INTERFACES);
// add member variable for bound class reference
String type = bc.getClassFile().getName();
ClassItem ref = cf.addPrivateField(type, BOUNDREF_NAME);
// add the constructor taking bound class reference
Type[] args = new Type[] { ClassItem.typeFromName(type) };
MethodBuilder mb = new ExceptionMethodBuilder("",
Type.VOID, args, cf, (short)0);
// call the superclass constructor
mb.appendLoadLocal(0);
mb.appendCallInit("java.lang.Object", "()V");
// store bound class reference to member variable
mb.appendLoadLocal(0);
mb.appendLoadLocal(1);
mb.appendPutField(ref);
mb.appendReturn();
mb.codeComplete(false);
mb.addMethod();
// add actual backfill interface implementation method
mb = new ExceptionMethodBuilder(BACKFILL_METHODNAME, Type.VOID,
BACKFILL_METHODARGS, cf, Constants.ACC_PUBLIC);
mb.appendLoadLocal(0);
mb.appendGetField(ref);
mb.appendLoadLocal(1);
mb.appendCreateCast(m_property.getSetValueType());
m_property.genStore(mb);
mb.appendReturn();
mb.codeComplete(false);
mb.addMethod();
// return unique instance of class
return MungedClass.getUniqueSupportClass(cf);
}
/**
* Generate unmarshalling code for object identifier reference. The code
* generated by this method assumes the unmarshalling context and name have
* already been loaded to the stack, and these are consumed by the code.
*
* @param mb method builder
* @throws JiBXException if error in configuration
*/
private void genParseIdRef(ContextMethodBuilder mb) throws JiBXException {
// first part of generated instruction sequence is to check if optional
// value is present
BranchWrapper ifmiss = null;
if (m_property.isOptional()) {
// use existing context reference and name information to check for
// attribute or element present
String name = m_valueStyle == ValueChild.ATTRIBUTE_STYLE ?
CHECK_ATTRIBUTE_NAME : CHECK_ELEMENT_NAME;
mb.appendCallVirtual(name, CHECK_SIGNATURE);
BranchWrapper ifpres = mb.appendIFNE(this);
// push a null value to be stored as result for missing case
mb.appendACONST_NULL();
ifmiss = mb.appendUnconditionalBranch(this);
// reload context reference and name information for use by actual
// unmarshalling call
mb.targetNext(ifpres);
mb.loadContext();
m_name.genPushUriPair(mb);
}
// find index of target class ID map
int index = m_container.getBindingRoot().
getIdClassIndex(m_property.getTypeName());
// check if forward references allowed
if (m_container.getBindingRoot().isForwards()) {
// generate call to unmarshal with forward allowed
mb.appendLoadConstant(index);
String name = m_valueStyle == ValueChild.ATTRIBUTE_STYLE ?
UNMARSHAL_FWDREF_ATTR_NAME : UNMARSHAL_FWDREF_ELEM_NAME;
mb.appendCallVirtual(name, UNMARSHAL_DEFREF_SIGNATURE);
// check for null result returned
mb.appendDUP();
BranchWrapper ifdef = mb.appendIFNONNULL(this);
// build and register backfill handler; start by loading the
// unmarshalling context, then load the index number of the target
// class and create an instance of the backfill handler
ClassFile backclas = createBackfillClass();
mb.loadContext();
mb.appendLoadConstant(index);
mb.appendCreateNew(backclas.getName());
// duplicate the backfill handler reference, then load a reference
// to the owning object and call the initializer before calling
// the unmarshalling context to register the handler
mb.appendDUP();
mb.loadObject();
mb.appendCallInit(backclas.getName(), "(" +
m_objContext.getBoundClass().getClassFile().getSignature() +
")V");
mb.appendCallVirtual(REGISTER_BACKFILL_NAME,
REGISTER_BACKFILL_SIGNATURE);
// set branch target for case where already defined
mb.targetNext(ifdef);
} else {
// generate call to unmarshal with predefined ID required
mb.appendLoadConstant(index);
String name = m_valueStyle == ValueChild.ATTRIBUTE_STYLE ?
UNMARSHAL_DEFREF_ATTR_NAME : UNMARSHAL_DEFREF_ELEM_NAME;
mb.appendCallVirtual(name, UNMARSHAL_DEFREF_SIGNATURE);
}
// handle object type conversion if needed
mb.appendCreateCast(m_property.getSetValueType());
// store returned reference to property
if (ifmiss != null) {
mb.targetNext(ifmiss);
}
m_property.genStore(mb);
}
/**
* Generate test if present code. This generates code that tests if the
* child is present, leaving the result of the test (zero if missing,
* nonzero if present) on the stack.
*
* @param mb unmarshal method builder
* @throws JiBXException if configuration error
*/
public void genIfPresentTest(UnmarshalBuilder mb) throws JiBXException {
// make sure this is an appropriate call
if (m_name == null) {
throw new JiBXException("Method call on invalid value");
}
// load the unmarshalling context and name information, then call the
// appropriate method to test for item present
mb.loadContext();
m_name.genPushUriPair(mb);
String name = (m_valueStyle == ValueChild.ATTRIBUTE_STYLE) ?
CHECK_ATTRIBUTE_NAME : CHECK_ELEMENT_NAME;
mb.appendCallVirtual(name, CHECK_SIGNATURE);
}
/**
* Generate unmarshalling code. This internal method generates the
* necessary code for handling the unmarshalling operation. The code
* generated by this method restores the stack to the original state
* when done.
*
* @param mb method builder
* @throws JiBXException if error in configuration
*/
private void genUnmarshal(ContextMethodBuilder mb) throws JiBXException {
// first part of generated instruction sequence is to preload object
// reference for later use, then load the unmarshalling context and
// the name information
if (m_constantValue == null && !m_property.isImplicit()) {
mb.loadObject();
}
// prepare for parsing the element name
mb.loadContext();
if (m_name != null) {
m_name.genPushUriPair(mb);
}
// check if this is an identifier for object
boolean isatt = (m_valueStyle == ValueChild.ATTRIBUTE_STYLE);
if (m_identType == DEF_IDENT || m_identType == AUTO_IDENT) {
// always unmarshal identifier value as text, then duplicate for use
// if storing
BindingDefinition.s_stringConversion.genParseRequired(isatt, mb);
if (m_identType != AUTO_IDENT) {
mb.appendDUP();
}
// load the context and swap to reorder, load the index for the
// class, and finally the ID'ed object, then call ID definition
// method
mb.loadContext();
mb.appendSWAP();
int index = m_container.getBindingRoot().
getIdClassIndex(m_property.getTypeName());
mb.appendLoadConstant(index);
mb.loadObject();
mb.appendCallVirtual(DEFINE_ID_NAME, DEFINE_ID_SIGNATURE);
// convert from text and store result using object reference loaded
// earlier
if (m_identType != AUTO_IDENT) {
m_conversion.genFromText(mb);
m_property.genStore(mb);
}
} else if (m_identType == REF_IDENT) {
// generate code for unmarshalling object ID
genParseIdRef(mb);
} else if (m_constantValue == null) {
// unmarshal and convert value
if (m_isNillable) {
// first check for element present at all
BranchWrapper ifmiss = null;
if (m_property.isOptional()) {
mb.appendCallVirtual(CHECK_ELEMENT_NAME, CHECK_SIGNATURE);
ifmiss = mb.appendIFEQ(this);
} else {
mb.appendCallVirtual(UNMARSHAL_PARSE_TO_START_NAME,
UNMARSHAL_PARSE_TO_START_SIGNATURE);
}
// check for xsi:nil="true"
mb.loadContext();
mb.appendLoadConstant("http://www.w3.org/2001/XMLSchema-instance");
mb.appendLoadConstant("nil");
mb.appendICONST_0();
mb.appendCallVirtual(UNMARSHAL_ATTRIBUTE_BOOLEAN_NAME,
UNMARSHAL_ATTRIBUTE_BOOLEAN_SIGNATURE);
BranchWrapper notnil = mb.appendIFEQ(this);
// code to handle nil case just parses past end
mb.loadContext();
m_name.genPushUriPair(mb);
mb.appendCallVirtual(UNMARSHAL_PARSE_PAST_END_NAME,
UNMARSHAL_PARSE_PAST_END_SIGNATURE);
// merge path with element not present, which just loads null
mb.targetNext(ifmiss);
mb.appendACONST_NULL();
m_conversion.genFromText(mb);
BranchWrapper ifnil = mb.appendUnconditionalBranch(this);
// read element text and process for not-nil case
mb.targetNext(notnil);
mb.loadContext();
m_name.genPushUriPair(mb);
mb.appendCallVirtual(UNMARSHAL_ELEMENT_TEXT_NAME,
UNMARSHAL_ELEMENT_TEXT_SIGNATURE);
m_conversion.genFromText(mb);
mb.targetNext(ifnil);
} else if (m_valueStyle == ValueChild.TEXT_STYLE ||
m_valueStyle == ValueChild.CDATA_STYLE) {
// unmarshal text value directly and let handler convert
mb.appendCallVirtual(UNMARSHAL_TEXT_NAME,
UNMARSHAL_TEXT_SIGNATURE);
m_conversion.genFromText(mb);
} else if (m_property.isOptional() &&
(isatt || m_container.isContentOrdered())) {
// parse value with possible default in ordered container
m_conversion.genParseOptional(isatt, mb);
} else {
// parse required value, or value in unordered container
m_conversion.genParseRequired(isatt, mb);
}
// handle object type conversion if needed
if (!m_conversion.isPrimitive() && m_property != null) {
String stype = m_conversion.getTypeName();
String dtype = m_property.getSetValueType();
mb.appendCreateCast(stype, dtype);
}
// store result using object reference loaded earlier
m_property.genStore(mb);
} else {
// unmarshal and compare value
BranchWrapper ifmiss = null;
if (m_valueStyle == ValueChild.TEXT_STYLE ||
m_valueStyle == ValueChild.CDATA_STYLE) {
// unmarshal text value directly and let handler convert
mb.appendCallVirtual(UNMARSHAL_TEXT_NAME,
UNMARSHAL_TEXT_SIGNATURE);
} else if (m_property.isOptional() &&
(isatt || m_container.isContentOrdered())) {
// parse optional attribute or element value
m_conversion.genParseOptional(isatt, mb);
mb.appendDUP();
ifmiss = mb.appendIFNULL(this);
} else {
// parse required attribute or element value
m_conversion.genParseRequired(isatt, mb);
}
// compare unmarshalled value with required constant
mb.appendDUP();
mb.appendLoadConstant(m_constantValue);
mb.appendCallVirtual("java.lang.String.equals",
"(Ljava/lang/Object;)Z");
BranchWrapper ifmatch = mb.appendIFNE(this);
// throw exception on comparison error
mb.appendCreateNew("java.lang.StringBuffer");
mb.appendDUP();
mb.appendLoadConstant("Expected constant value \"" +
m_constantValue + "\", found \"");
mb.appendCallInit("java.lang.StringBuffer",
"(Ljava/lang/String;)V");
mb.appendSWAP();
mb.appendCallVirtual("java.lang.StringBuffer.append",
"(Ljava/lang/String;)Ljava/lang/StringBuffer;");
mb.appendLoadConstant("\"");
mb.appendCallVirtual("java.lang.StringBuffer.append",
"(Ljava/lang/String;)Ljava/lang/StringBuffer;");
mb.appendCallVirtual("java.lang.StringBuffer.toString",
"()Ljava/lang/String;");
mb.loadContext();
mb.appendSWAP();
mb.appendCallVirtual(UNMARSHALLING_THROWEXCEPTION_METHOD,
UNMARSHALLING_THROWEXCEPTION_SIGNATURE);
mb.appendACONST_NULL();
// finish by setting target for branch
mb.targetNext(ifmatch);
mb.targetNext(ifmiss);
mb.appendPOP();
}
}
/**
* Generate marshalling code. This internal method generates the
* necessary code for handling the marshalling operation. The code
* generated by this method restores the stack to the original state
* when done.
*
* @param mb method builder
* @throws JiBXException if error in configuration
*/
private void genMarshal(ContextMethodBuilder mb) throws JiBXException {
if (m_constantValue == null) {
// first part of generated instruction sequence is to generate a
// check for an optional property present, then load the context
// and the name information (if present) for later use, then
// finally load the actual property value
BranchWrapper ifmiss = null;
String type = m_property.getTypeName();
if (m_property.hasTest()) {
mb.loadObject();
ifmiss = m_property.genTest(mb);
} else if (m_isNillable && !ClassItem.isPrimitive(type)) {
// check for null object
BranchWrapper ifhit;
if (m_property.isImplicit()) {
mb.appendDUP();
ifhit = mb.appendIFNONNULL(this);
mb.appendPOP();
} else {
mb.loadObject();
m_property.genLoad(mb);
ifhit = mb.appendIFNONNULL(this);
}
// generate empty element with xsi:nil="true"
mb.loadContext();
m_name.genPushIndexPair(mb);
mb.appendCallVirtual(MARSHAL_STARTTAG_ATTRIBUTES,
MARSHAL_STARTTAG_SIGNATURE);
mb.appendLoadConstant(2);
mb.appendLoadConstant("nil");
mb.appendLoadConstant("true");
mb.appendCallVirtual(MARSHAL_ATTRIBUTE, MARSHAL_SIGNATURE);
mb.appendCallVirtual(MARSHAL_CLOSESTART_EMPTY,
MARSHAL_CLOSESTART_EMPTY_SIGNATURE);
mb.appendPOP();
ifmiss = mb.appendUnconditionalBranch(this);
mb.targetNext(ifhit);
}
if (m_name != null) {
// handle implicit property by first saving value to local, then
// reloading after the name information is on the stack
Type tobj = ClassItem.typeFromName(type);
if (m_property.isImplicit()) {
mb.defineSlot(this, tobj);
}
m_name.genPushIndexPair(mb);
if (m_property.isImplicit()) {
mb.appendLoadLocal(mb.getSlot(this));
mb.freeSlot(this);
}
}
if (!m_property.isImplicit()) {
mb.loadObject();
m_property.genLoad(mb);
}
// check for object identity definition (accessed through property)
StringConversion convert = m_conversion;
if (m_identType == REF_IDENT) {
m_idRefMap.getImplComponent().genLoadId(mb);
convert = BindingDefinition.s_stringConversion;
type = "java.lang.String";
}
// convert to expected type if object
if (!ClassItem.isPrimitive(type)) {
mb.appendCreateCast(type);
}
// convert and marshal value
boolean isatt = m_valueStyle == ValueChild.ATTRIBUTE_STYLE;
if (m_valueStyle == ValueChild.TEXT_STYLE ||
m_valueStyle == ValueChild.CDATA_STYLE) {
convert.genToText(type, mb);
String name = (m_valueStyle == ValueChild.TEXT_STYLE) ?
MARSHAL_TEXT_NAME : MARSHAL_CDATA_NAME;
mb.appendCallVirtual(name, MARSHAL_TEXT_SIGNATURE);
} else if (m_property.isOptional()) {
convert.genWriteOptional(isatt, type, mb);
} else {
convert.genWriteRequired(isatt, type, mb);
}
// finish by setting target for missing optional property test
mb.targetNext(ifmiss);
} else {
// just write constant value directly
if (m_name != null) {
m_name.genPushIndexPair(mb);
}
mb.appendLoadConstant(m_constantValue);
switch (m_valueStyle) {
case ATTRIBUTE_STYLE:
mb.appendCallVirtual(MARSHAL_ATTRIBUTE, MARSHAL_SIGNATURE);
break;
case ELEMENT_STYLE:
mb.appendCallVirtual(MARSHAL_ELEMENT, MARSHAL_SIGNATURE);
break;
case TEXT_STYLE:
mb.appendCallVirtual(MARSHAL_TEXT_NAME,
MARSHAL_TEXT_SIGNATURE);
break;
case CDATA_STYLE:
mb.appendCallVirtual(MARSHAL_CDATA_NAME,
MARSHAL_TEXT_SIGNATURE);
break;
}
}
}
/**
* Get property name. If the child has an associated property this returns
* the name of that property.
*
* @return name for child property
*/
public String getPropertyName() {
if (m_property == null) {
return null;
} else {
return m_property.getName();
}
}
/**
* Check if implicit.
*
* @return true if implicit, false if not
*/
public boolean isImplicit() {
return m_property.isThis();
}
/**
* Switch property from "this" to "implicit".
*/
public void switchProperty() {
m_property.switchProperty();
}
//
// IComponent interface method definitions
public boolean isOptional() {
return m_property.isOptional();
}
public boolean hasAttribute() {
return m_valueStyle == ATTRIBUTE_STYLE;
}
public void genAttrPresentTest(ContextMethodBuilder mb)
throws JiBXException {
// make sure this is an appropriate call
if (m_valueStyle != ATTRIBUTE_STYLE || m_name == null) {
throw new JiBXException("Method call on invalid structure");
}
// generate load of the unmarshalling context and the name information,
// then just call the attribute check method
mb.loadContext();
m_name.genPushUriPair(mb);
mb.appendCallVirtual(CHECK_ATTRIBUTE_NAME, CHECK_SIGNATURE);
}
public void genAttributeUnmarshal(ContextMethodBuilder mb)
throws JiBXException {
if (m_valueStyle == ATTRIBUTE_STYLE) {
genUnmarshal(mb);
}
}
public void genAttributeMarshal(ContextMethodBuilder mb)
throws JiBXException {
if (m_valueStyle == ATTRIBUTE_STYLE) {
genMarshal(mb);
}
}
public boolean hasContent() {
return m_valueStyle != ATTRIBUTE_STYLE;
}
public void genContentPresentTest(ContextMethodBuilder mb)
throws JiBXException {
// make sure this is an appropriate call
if (m_valueStyle != ELEMENT_STYLE) {
throw new JiBXException("Method call on invalid structure");
}
// generate load of the unmarshalling context and the name information,
// then just call the attribute check method
mb.loadContext();
m_name.genPushUriPair(mb);
mb.appendCallVirtual(CHECK_ELEMENT_NAME, CHECK_SIGNATURE);
}
public void genContentUnmarshal(ContextMethodBuilder mb)
throws JiBXException {
if (m_valueStyle != ATTRIBUTE_STYLE) {
genUnmarshal(mb);
}
}
public void genContentMarshal(ContextMethodBuilder mb)
throws JiBXException {
if (m_valueStyle != ATTRIBUTE_STYLE) {
genMarshal(mb);
}
}
public void genNewInstance(ContextMethodBuilder mb) {
throw new IllegalStateException
("Internal error - no instance creation");
}
public String getType() {
return m_type;
}
public boolean hasId() {
return m_identType == DEF_IDENT;
}
public void genLoadId(ContextMethodBuilder mub) throws JiBXException {
m_property.genLoad(mub);
}
public NameDefinition getWrapperName() {
return (m_valueStyle == ELEMENT_STYLE) ? m_name : null;
}
public void setLinkages() throws JiBXException {
if (m_identType == REF_IDENT) {
String type;
if (m_property == null) {
type = m_objContext.getBoundClass().getClassFile().getName();
} else {
type = m_property.getTypeName();
}
m_idRefMap = m_container.getDefinitionContext().
getClassMapping(type);
if (m_idRefMap == null) {
throw new JiBXException("No mapping defined for " +
type + " used as IDREF target");
} else if (!m_idRefMap.getImplComponent().hasId()) {
throw new JiBXException("No ID value defined for " +
type + " used as IDREF target");
}
}
}
// DEBUG
public void print(int depth) {
BindingDefinition.indent(depth);
if (m_valueStyle == ELEMENT_STYLE) {
if (m_isNillable) {
System.out.print("nillable ");
}
System.out.print("element");
} else if (m_valueStyle == ATTRIBUTE_STYLE) {
System.out.print("attribute");
} else if (m_valueStyle == TEXT_STYLE) {
System.out.print("text");
} else if (m_valueStyle == CDATA_STYLE) {
System.out.print("cdata");
}
if (m_name != null) {
System.out.print(" " + m_name.toString());
}
if (m_property != null) {
System.out.print(" from " + m_property.toString());
}
System.out.println();
}
}
libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/ 0000755 0001750 0001750 00000000000 11023035622 023105 5 ustar moeller moeller libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/BindingGenerator.java 0000644 0001750 0001750 00000140217 10767273656 027227 0 ustar moeller moeller /*
* Copyright (c) 2007-2008, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.jibx.binding.model.BindingDirectory;
import org.jibx.binding.model.BindingHolder;
import org.jibx.binding.model.CollectionElement;
import org.jibx.binding.model.ElementBase;
import org.jibx.binding.model.IClass;
import org.jibx.binding.model.MappingElement;
import org.jibx.binding.model.NestingElementBase;
import org.jibx.binding.model.StructureElement;
import org.jibx.binding.model.StructureElementBase;
import org.jibx.binding.model.ValueElement;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.QName;
import org.jibx.runtime.Utility;
import org.jibx.schema.codegen.ReferenceCountMap;
import org.jibx.util.Types;
/**
* Binding generator implementation.
*
* @author Dennis M. Sosnoski
*/
public class BindingGenerator
{
/** Binding generation customizations. */
private final GlobalCustom m_global;
/** Set of class names to be included. */
private final Set m_includeSet;
/** Set of class names to be ignored. */
private final Set m_ignoreSet;
/** Set of class names to be handled directly. */
private final Set m_directSet;
/** Set of class names subclassed by other classes in binding. */
private final Set m_superSet;
/** Map from fully-qualified class name to mapping details. */
private final Map m_mappingDetailsMap;
/** Map from namespace URI to {@link UniqueNameSet} for type names. */
private final Map m_typeNamesMap;
/** Map from namespace URI to {@link UniqueNameSet} for element names. */
private final Map m_elementNamesMap;
/** Target package for binding code generation. */
private String m_targetPackage;
/** Directory for bindings being built. */
private BindingDirectory m_directory;
/**
* Create a generator based on a particular set of customizations.
*
* @param glob
*/
public BindingGenerator(GlobalCustom glob) {
m_global = glob;
m_includeSet = new HashSet();
m_ignoreSet = new HashSet();
m_directSet = new HashSet();
m_superSet = new HashSet();
m_mappingDetailsMap = new HashMap();
m_typeNamesMap = new HashMap();
m_elementNamesMap = new HashMap();
m_directory = new BindingDirectory(glob.isForceClasses(), glob.isTrackSource(), glob.isAddConstructors(),
glob.isInput(), glob.isOutput());
}
/**
* Check if a class represents a simple value. TODO: implement ClassCustom hooks for this purpose
*
* @param type fully qualified class name
* @return true if simple value, false if not
*/
public boolean isValueClass(String type) {
ClassCustom clas = m_global.forceClassCustomization(type);
IClass sinfo = clas.getClassInformation().getSuperClass();
if (sinfo != null && "java.lang.Enum".equals(sinfo.getName())) {
return true;
} else {
return false;
}
}
/**
* Check if a class needs to be included in the binding. This checks all members of the class and if necessary
* superclasses, returning true if any member is ultimately found with a simple value.
*
* @param type fully qualified class name
* @return true if class to be included in binding, false if it should be skipped
*/
public boolean checkInclude(String type) {
if (m_includeSet.contains(type)) {
return true;
} else if (m_ignoreSet.contains(type)) {
return false;
} else {
// check if any members are to be included
boolean include = false;
ClassCustom clas = m_global.forceClassCustomization(type);
for (Iterator iter = clas.getMembers().iterator(); iter.hasNext();) {
MemberCustom memb = (MemberCustom)iter.next();
String mtype = memb.isCollection() ? memb.getItemType() : memb.getWorkingType();
if (Types.isSimpleValue(mtype) || isValueClass(mtype) || !m_global.isKnownMapping(mtype)
|| checkInclude(mtype)) {
include = true;
break;
}
}
if (!include) {
// force superclass handling if appropriate
if (clas.getMembers().size() > 0 && clas.isUseSuper()) {
String stype = clas.getClassInformation().getSuperClass().getName();
if (!"java.lang.Object".equals(stype) && checkInclude(stype)) {
include = true;
}
}
}
if (include) {
m_includeSet.add(type);
} else {
m_ignoreSet.add(type);
}
return include;
}
}
/**
* Expand all references from a class. This checks the types of all members of the class, counting references and
* calling itself recursively for any types which are not primitives and not java.* or javax.* classes. It also
* expands the superclass, if specified by the class customizations.
*
* @param type fully qualified class name
* @param refmap reference count map
*/
public void expandReferences(String type, ReferenceCountMap refmap) {
if (checkInclude(type)) {
// expand all references from members
ClassCustom clas = m_global.forceClassCustomization(type);
for (Iterator iter = clas.getMembers().iterator(); iter.hasNext();) {
MemberCustom memb = (MemberCustom)iter.next();
String mtype = memb.isCollection() ? memb.getItemType() : memb.getWorkingType();
if (!Types.isSimpleValue(mtype) && !isValueClass(mtype) && !m_global.isKnownMapping(mtype)) {
if ((mtype.startsWith("java.")) || (mtype.startsWith("javax."))) {
throw new IllegalStateException("No way to handle type '" + mtype + '\'');
} else if (checkInclude(mtype)) {
if (refmap.incrementCount(mtype) <= 1) {
expandReferences(mtype, refmap);
}
m_directSet.add(mtype);
}
}
}
// force superclass handling if appropriate
if (clas.getMembers().size() > 0 && clas.isUseSuper()) {
String stype = clas.getClassInformation().getSuperClass().getName();
if (!"java.lang.Object".equals(stype) && !Types.isSimpleValue(stype) && !isValueClass(stype)
&& !m_global.isKnownMapping(stype) && checkInclude(stype)) {
if (refmap.incrementCount(stype) <= 1) {
expandReferences(stype, refmap);
}
m_superSet.add(stype);
}
}
}
}
/**
* Set creation information for structure binding component. This includes the declared type, as well as the create
* type and factory method.
*
* @param memb
* @param struct
*/
private void setTypes(MemberCustom memb, StructureElementBase struct) {
String type = memb.getActualType();
if (type != null && !type.equals(memb.getStatedType())) {
struct.setDeclaredType(type);
}
struct.setCreateType(memb.getCreateType());
struct.setFactoryName(memb.getFactoryMethod());
}
/**
* Define the details of a collection binding. Collection bindings may be empty (in the case where the item type is
* directly mapped), have a <value> child element, or have either a mapping reference or direct definition
* <structure> child element. This determines the appropriate form based on the item type.
*
* @param itype item type
* @param iname item name
* @param coll
* @param hold
*/
public void defineCollection(String itype, String iname, CollectionElement coll, BindingHolder hold) {
// check item type handling
BindingMappingDetail detail = (BindingMappingDetail)m_mappingDetailsMap.get(itype);
ClassCustom icust = m_global.getClassCustomization(itype);
if (detail != null) {
if (detail.isUseAbstract() && !detail.isExtended()) {
// add reference to appropriate binding
QName qname = detail.getTypeQName();
hold.addReference(m_directory.findBinding(qname.getUri()));
// add with map-as for abstract mapping
if (iname == null) {
iname = icust.getElementName();
}
StructureElement struct = new StructureElement();
if (qname == null) {
struct.setMapAsName(itype);
} else {
// set the type reference
struct.setMapAsQName(qname);
// check dependency on other binding
m_directory.addDependency(qname.getUri(), hold);
}
struct.setName(iname);
struct.setCreateType(icust.getCreateType());
struct.setFactoryName(icust.getFactoryMethod());
coll.addChild(struct);
} else {
// just set item-type for concrete mapping
coll.setItemTypeName(itype);
}
} else if (m_global.isKnownMapping(itype)) {
// just set item-type for known mapping
coll.setItemTypeName(itype);
} else if (Types.isSimpleValue(itype) || isValueClass(itype)) {
// add for simple type, or enum type with optional value method
ValueElement value = new ValueElement();
value.setName(iname);
value.setDeclaredType(itype);
coll.addChild(value);
if (icust != null) {
value.setDefaultText(icust.getEnumValueMethod());
}
} else {
// embed structure definition within the collection
StructureElement struct = new StructureElement();
struct.setDeclaredType(itype);
if (iname == null) {
iname = icust.getElementName();
}
struct.setName(iname);
fillStructure(icust, null, null, struct, hold);
coll.addChild(struct);
}
}
/**
* Add binding details for the actual members of a class, excluding any members which have been handled separately.
*
* @param cust class customization information
* @param exmethmap map from property method names to be excluded to the corresponding property customizations
* @param inmethmap map from property method names included in binding to the corresponding property customizations
* (populated by this method, null if not needed)
* @param parent containing binding component
* @param hold binding holder
*/
private void addMemberBindings(ClassCustom cust, Map exmethmap, Map inmethmap, NestingElementBase parent,
BindingHolder hold) {
// generate binding component for each member of class
for (Iterator iter = cust.getMembers().iterator(); iter.hasNext();) {
// skip this member if excluded property
MemberCustom memb = (MemberCustom)iter.next();
String gmeth = memb.getGetName();
String smeth = memb.getSetName();
if (memb.isProperty() && !memb.isPrivate()) {
MemberCustom match = (MemberCustom)(gmeth != null ? exmethmap.get(gmeth) : exmethmap.get(smeth));
if (match == null) {
// add methods for included property to map implemented for this binding
if (inmethmap != null) {
if (gmeth != null) {
inmethmap.put(gmeth, memb);
}
if (smeth != null) {
inmethmap.put(smeth, memb);
}
}
} else {
continue;
}
}
// check for repeated item
if (memb.isCollection()) {
// create collection element for field or property
CollectionElement coll = new CollectionElement();
if (memb.getFieldName() == null) {
coll.setGetName(gmeth);
coll.setSetName(memb.getSetName());
} else {
coll.setFieldName(memb.getFieldName());
}
setTypes(memb, coll);
// set the element name, if defined
String name = memb.getXmlName();
if (cust.isWrapCollections() && name != null) {
coll.setName(name);
}
// check for optional value
if (!memb.isRequired()) {
coll.setUsageName("optional");
}
// check for type defined
String itype = memb.getItemType();
if (itype != null) {
// set name to be used for items in collection
String iname = memb.getItemName();
if (iname == null) {
// use name based on item type
String simple = itype;
int split = simple.lastIndexOf('.');
if (split >= 0) {
simple = simple.substring(0, split);
}
iname = cust.convertName(simple);
}
// define the collection details
defineCollection(itype, iname, coll, hold);
// check for special case of two unwrapped collections with same item-type and no children
ArrayList siblings = parent.children();
if (siblings.size() > 0 && coll.children().size() == 0 && coll.getName() == null) {
ElementBase sibling = (ElementBase)siblings.get(siblings.size()-1);
if (sibling.type() == ElementBase.COLLECTION_ELEMENT) {
CollectionElement lastcoll = (CollectionElement)sibling;
if (lastcoll.children().size() == 0 && lastcoll.getName() == null &&
Utility.safeEquals(lastcoll.getItemTypeName(), coll.getItemTypeName())) {
throw new IllegalStateException("Need to use wrapper element for collection member '" +
memb.getBaseName() + "' of class " + cust.getName());
}
}
}
}
parent.addChild(coll);
} else {
// check whether value or structure
String wtype = memb.getWorkingType();
if (Types.isSimpleValue(wtype) || isValueClass(wtype)) {
// add for simple type or enum
ValueElement value = new ValueElement();
if (memb.getFieldName() == null) {
value.setGetName(gmeth);
value.setSetName(memb.getSetName());
} else {
value.setFieldName(memb.getFieldName());
}
value.setName(memb.getXmlName());
// pass on optional value method for enum
ClassCustom icust = m_global.getClassCustomization(wtype);
if (icust != null) {
value.setEnumValueName(icust.getEnumValueMethod());
}
// check for optional value
if (!memb.isRequired()) {
value.setUsageName("optional");
}
// configure added property values
int style = memb.getStyle();
if (style == NestingBase.ATTRIBUTE_VALUE_STYLE) {
value.setStyleName("attribute");
} else if (style == NestingBase.ELEMENT_VALUE_STYLE) {
value.setStyleName("element");
} else {
value.setStyleName("text");
}
if (memb.getActualType() != null) {
value.setDeclaredType(memb.getActualType());
}
parent.addChild(value);
} else {
// create with name and access information
StructureElement struct = new StructureElement();
if (memb.getFieldName() == null) {
struct.setGetName(gmeth);
struct.setSetName(memb.getSetName());
} else {
struct.setFieldName(memb.getFieldName());
}
setTypes(memb, struct);
// check for optional value
if (!memb.isRequired()) {
struct.setUsageName("optional");
}
// set details based on class handling
ClassCustom mcust = m_global.getClassCustomization(memb.getWorkingType());
fillStructure(mcust, memb, null, struct, hold);
parent.addChild(struct);
}
}
}
}
/**
* Add binding details for the full representation of a class. This includes superclasses, if configured, and makes
* use of any appropriate <mapping> definitions as part of the binding.
*
* @param cust class customization information
* @param memb member customization information (null if implicit reference, rather than member)
* @param inmethmap map from property method names included in binding to the corresponding property customizations
* (populated by this method, null if not needed)
* @param struct structure element referencing the class
* @param hold binding holder
*/
private void fillStructure(ClassCustom cust, MemberCustom memb, Map inmethmap, StructureElement struct, BindingHolder hold) {
// check for an actual definition
String type = cust.getName();
BindingMappingDetail detail = (BindingMappingDetail)m_mappingDetailsMap.get(type);
if (detail != null) {
// use existing definition for type
if (detail.isUseAbstract() && !detail.isExtended()) {
QName qname = detail.getTypeQName();
m_directory.addDependency(qname.getUri(), hold);
struct.setMapAsQName(qname);
if (memb != null) {
struct.setName(memb.getXmlName());
}
} else {
struct.setMapAsName(cust.getName());
}
if (inmethmap != null) {
inmethmap.putAll(detail.getAccessMethodMap());
}
} else if (!m_global.isKnownMapping(type)) {
// add member reference information
if (memb != null) {
// check for type settings needed
if (memb.getActualType() != null) {
struct.setDeclaredType(memb.getActualType());
}
if (memb.getCreateType() != null) {
struct.setCreateType(memb.getCreateType());
}
if (memb.getFactoryMethod() != null) {
struct.setFactoryName(memb.getFactoryMethod());
}
// add a name if an optional value
if (!memb.isRequired()) {
struct.setName(memb.getXmlName());
}
}
// check if need to use superclass in binding
IClass clas = cust.getClassInformation();
IClass sclas = clas.getSuperClass();
String stype = sclas.getName();
Map exmethmap = Collections.EMPTY_MAP;
if (checkInclude(stype)) {
// check if any added content from this class
ClassCustom scust = m_global.getClassCustomization(stype);
exmethmap = new HashMap();
if (cust.getMembers().size() > 0) {
// add child element for superclass, followed by content from this class
StructureElement sstruct = new StructureElement();
sstruct.setDeclaredType(stype);
fillStructure(scust, null, exmethmap, sstruct, hold);
struct.addChild(sstruct);
} else {
// just replace class reference with superclass reference in existing
struct.setDeclaredType(stype);
fillStructure(scust, null, exmethmap, struct, hold);
}
} else {
// check for interface with abstract mapping to reference
String[] intfs = sclas.getInterfaces();
for (int i = 0; i < intfs.length; i++) {
String intf = intfs[i];
BindingMappingDetail idetail = (BindingMappingDetail)m_mappingDetailsMap.get(intf);
if (idetail != null && idetail.isUseAbstract() && idetail.getTypeQName() == null) {
// reference abstract mapped interface
struct = new StructureElement();
struct.setMapAsName(intf);
exmethmap = idetail.getAccessMethodMap();
break;
}
}
}
// fill in content details from this class
if (inmethmap != null) {
inmethmap.putAll(exmethmap);
}
if (cust.getMembers().size() > 0) {
addMemberBindings(cust, exmethmap, inmethmap, struct, hold);
}
}
}
/**
* Add the <mapping> definition for a class to a binding. This creates either an abstract mapping with a type
* name, or a concrete mapping with an element name, as determined by the passed-in mapping information. If the
* class is a concrete mapping that extends or implements another class with an anonymous abstract mapping, the
* created <mapping> will extend that base mapping. TODO: type substitution requires extending the binding
* definition
*
* @param type fully qualified class name
* @param detail mapping details
*/
private void addMapping(String type, BindingMappingDetail detail) {
// create the basic mapping structure(s)
ClassCustom cust = m_global.forceClassCustomization(type);
MappingElement mainmapping = null;
QName qname = null;
MappingElement mapcon = null;
IClass clas = cust.getClassInformation();
if (detail.isUseConcrete()) {
// create concrete mapping
mapcon = createMapping(type, cust);
qname = detail.getElementQName();
mapcon.setName(qname.getName());
detail.setConcreteMapping(mapcon);
// make "concrete" mapping abstract if no class creation possible
if (clas.isAbstract() || clas.isInterface()) {
mapcon.setAbstract(true);
}
// fill details directly to this mapping unless abstract also created
mainmapping = mapcon;
}
MappingElement mapabs = null;
if (detail.isUseAbstract()) {
// create abstract mapping
mapabs = createMapping(type, cust);
mapabs.setAbstract(true);
qname = detail.getTypeQName();
mapabs.setTypeQName(qname);
detail.setAbstractMapping(mapabs);
// use abstract mapping for details (concrete will reference this one)
mainmapping = mapabs;
}
if (mainmapping != null) {
// check for superclass mapping to be extended (do this first for
// compatibility with schema type extension)
BindingHolder hold = m_directory.findBinding(qname.getUri());
StructureElement struct = null;
String ptype = detail.getExtendsType();
Map exmembmap = Collections.EMPTY_MAP;
Map inmembmap = new HashMap();
if (ptype == null) {
// not extending a base mapping, check if need to include superclass
IClass parent = clas.getSuperClass();
if (cust.isUseSuper() && parent != null) {
ptype = parent.getName();
if (checkInclude(ptype)) {
struct = new StructureElement();
struct.setDeclaredType(ptype);
ClassCustom scust = m_global.getClassCustomization(ptype);
exmembmap = new HashMap();
fillStructure(scust, null, exmembmap, struct, hold);
}
}
} else {
// create reference to parent mapping
struct = new StructureElement();
BindingMappingDetail pdetail = (BindingMappingDetail)m_mappingDetailsMap.get(ptype);
if (!pdetail.isGenerated()) {
addMapping(ptype, pdetail);
}
exmembmap = pdetail.getAccessMethodMap();
if (pdetail.isUseAbstract()) {
// reference abstract mapped superclass
QName tname = pdetail.getTypeQName();
if (tname == null) {
throw new IllegalStateException("Internal error: unimplemented case of superclass " + ptype
+ " to be extended by subclass " + type + ", without an abstract ");
} else {
m_directory.addDependency(tname.getUri(), hold);
struct.setMapAsQName(tname);
}
} else {
// reference concrete mapped superclass
struct.setMapAsName(ptype);
}
// set extension for child concrete mapping
if (mapcon != null) {
mapcon.setExtendsName(ptype);
}
}
// add extension reference structure to mapping
if (struct != null) {
mainmapping.addChild(struct);
}
// add all details of class member handling to binding
inmembmap.putAll(exmembmap);
addMemberBindings(cust, exmembmap, inmembmap, mainmapping, hold);
hold.addMapping(mainmapping);
if (mapabs != null && mapcon != null) {
// define content as structure reference to abstract mapping
struct = new StructureElement();
QName tname = detail.getTypeQName();
struct.setMapAsQName(tname);
mapcon.addChild(struct);
hold.addMapping(mapcon);
}
// set the member property map for mapping
detail.setAccessMethodMap(inmembmap);
detail.setGenerated(true);
} else {
throw new IllegalStateException("Internal error: mapping detail for " + type
+ " with neither abstract nor concrete mapping");
}
}
/**
* Create and initialize a <mapping> element.
*
* @param type
* @param cust
* @return mapping
*/
private MappingElement createMapping(String type, ClassCustom cust) {
MappingElement mapabs;
mapabs = new MappingElement();
mapabs.setClassName(type);
mapabs.setCreateType(cust.getCreateType());
mapabs.setFactoryName(cust.getFactoryMethod());
return mapabs;
}
/**
* Add the details for mapping a class.
* TODO: should add checks for unique particle attribution rule - need to check for duplicate element names without
* a required element in between, and if found alter the names after the first; note that duplicates may be from the
* base type, or from a group; also need to make sure attribute names are unique
*
* @param abstr force abstract mapping flag
* @param ename element name for concrete mapping (null if unspecified)
* @param type fully-qualified class name
* @return mapping details
*/
private BindingMappingDetail addMappingDetails(Boolean abstr, QName ename, String type) {
// check for existing detail
BindingMappingDetail detail = (BindingMappingDetail)m_mappingDetailsMap.get(type);
if (detail == null) {
// provide warning when interface used with field access
ClassCustom cust = m_global.getClassCustomization(type);
IClass sclas = cust.getClassInformation();
if (sclas.isInterface() && !cust.isPropertyAccess()) {
System.out.println("Warning: generating mapping for interface " + type +
" without checking properties - consider setting property-access='true'");
}
// check if a superclass is base for extension
String stype = null;
Boolean isabs = null;
while ((sclas = sclas.getSuperClass()) != null) {
if (m_directSet.contains(sclas.getName())) {
stype = sclas.getName();
isabs = Boolean.valueOf(sclas.isAbstract());
break;
}
}
// TODO: really should check for multiple superclasses/interfaces to
// be handled (and generate a warning, since they can't be handled)
if (stype == null) {
// check if an interface is base for extension
sclas = cust.getClassInformation();
loop: while (sclas != null) {
String[] intfs = sclas.getInterfaces();
for (int i = 0; i < intfs.length; i++) {
String itype = intfs[i];
while (true) {
if (m_directSet.contains(itype)) {
stype = itype;
isabs = Boolean.TRUE;
break loop;
} else {
ClassCustom icust = m_global.getClassCustomization(itype);
if (icust == null) {
break;
} else {
// check for interface (should only ever be one) of interface
String[] sintfs = icust.getClassInformation().getInterfaces();
if (sintfs.length > 0) {
itype = sintfs[0];
} else {
break;
}
}
}
}
}
sclas = sclas.getSuperClass();
}
}
if (stype != null) {
BindingMappingDetail sdetail = addMappingDetails(isabs, null, stype);
sdetail.setExtended(true);
}
// fix names if necessary to avoid conflicts
QName tname = fixTypeName(cust.getTypeQName());
if (isQNameUsed(ename, m_elementNamesMap)) {
throw new IllegalStateException("Internal error - attempting to create mapping with element name " +
ename + " already used");
} else if (ename == null) {
ename = cust.getElementQName();
}
ename = fixElementName(ename);
// create mapping details as specified
boolean abs = (abstr == null) ? cust.isMapAbstract() : abstr.booleanValue();
detail = new BindingMappingDetail(type, tname, ename, stype);
if (abs || !cust.isConcrete()) {
detail.setUseAbstract(true);
} else {
detail.setUseConcrete(true);
}
m_mappingDetailsMap.put(type, detail);
// force concrete mapping if extension or base for extension
if (abs && (sclas != null || m_superSet.contains(type))) {
detail.setUseConcrete(true);
}
// check if package usable as target for binding code
if (m_targetPackage == null && cust.getClassInformation().isModifiable()) {
m_targetPackage = ((PackageCustom)cust.getParent()).getName();
}
} else if (abstr != null) {
// mapping detail already generated, just make sure of variety
if (abstr.booleanValue()) {
detail.setUseAbstract(true);
} else {
detail.setUseConcrete(true);
}
}
return detail;
}
/**
* Check if a qualified name is already defined within a category of names.
*
* @param qname requested qualified name (null allowed, always returns false)
* @param map namespace URI to {@link UniqueNameSet} map for category
* @return true if used, false if not
*/
private boolean isQNameUsed(QName qname, Map map) {
if (qname != null) {
UniqueNameSet nameset = (UniqueNameSet)map.get(qname.getUri());
if (nameset != null) {
return nameset.contains(qname.getName());
}
}
return false;
}
/**
* Fix local name to be unique within the appropriate namespace for a category of names.
*
* @param qname requested qualified name (null allowed, always returns null)
* @param map namespace URI to {@link UniqueNameSet} map for category
* @return unique version of qualified name
*/
private QName fixQName(QName qname, Map map) {
if (qname != null) {
String uri = qname.getUri();
UniqueNameSet nameset = (UniqueNameSet)map.get(uri);
if (nameset == null) {
nameset = new UniqueNameSet();
map.put(uri, nameset);
}
String base = qname.getName();
String name = nameset.add(base);
if (name.equals(base)) {
return qname;
} else {
return new QName(uri, name);
}
} else {
return null;
}
}
/**
* Fix element local name to be unique within the appropriate namespace.
*
* @param qname requested qualified name (null allowed, always returns null)
* @return unique version of qualified name
*/
private QName fixElementName(QName qname) {
return fixQName(qname, m_elementNamesMap);
}
/**
* Fix type local name to be unique within the appropriate namespace.
*
* @param qname requested qualified name (null allowed, always returns null)
* @return unique version of qualified name
*/
private QName fixTypeName(QName qname) {
return fixQName(qname, m_typeNamesMap);
}
/**
* Find closure of references from a supplied list of classes. References counted, and direct references are
* accumulated for handling. The supplied list may include generic classes with type parameters.
*
* @param classes
* @param refmap
*/
private void findReferences(List classes, ReferenceCountMap refmap) {
for (int i = 0; i < classes.size(); i++) {
String type = (String)classes.get(i);
int split = type.indexOf('<');
if (split > 0) {
type = type.substring(split + 1, type.length() - 1);
}
expandReferences(type, refmap);
}
}
/**
* Flag classes referenced more than once to be handled with <mapping> definitions.
*
* @param refmap
*/
private void flagMultipleReferences(ReferenceCountMap refmap) {
for (Iterator iter = refmap.iterator(); iter.hasNext();) {
String type = (String)iter.next();
if (refmap.getCount(type) > 1) {
m_directSet.add(type);
}
}
}
/**
* Add mapping details for classes referenced more than once.
*
* @param refmap
*/
private void addReferencedMappings(ReferenceCountMap refmap) {
for (Iterator iter = refmap.iterator(); iter.hasNext();) {
String type = (String)iter.next();
if (refmap.getCount(type) > 1 && !m_mappingDetailsMap.containsKey(type)) {
addMappingDetails(null, null, type);
}
}
}
/**
* Generate the mapping definitions for classes referenced more than once.
*
* @param refmap
*/
private void generateReferencedMappings(ReferenceCountMap refmap) {
for (Iterator iter = refmap.iterator(); iter.hasNext();) {
String type = (String)iter.next();
if (refmap.getCount(type) > 1) {
BindingMappingDetail detail = (BindingMappingDetail)m_mappingDetailsMap.get(type);
if (!detail.isGenerated()) {
addMapping(type, detail);
}
}
}
}
/**
* Generate mappings for a list of classes. The mapping details must have been configured before this method is
* called.
*
* @param classes
*/
private void generateMappings(List classes) {
for (int i = 0; i < classes.size(); i++) {
String type = (String)classes.get(i);
BindingMappingDetail detail = (BindingMappingDetail)m_mappingDetailsMap.get(type);
if (!detail.isGenerated()) {
addMapping(type, detail);
}
}
}
/**
* Fix the base classes that are to be used as extension types. This step is needed to generate the substitution
* group structures for classes which are both referenced directly and extended by other classes. The method must be
* called after all mapping details have been constucted but before the actual binding generation.
*/
private void fixBaseClasses() {
for (Iterator iter = m_directSet.iterator(); iter.hasNext();) {
String type = (String)iter.next();
BindingMappingDetail detail = (BindingMappingDetail)m_mappingDetailsMap.get(type);
if (detail != null && detail.isExtended()) {
detail.setUseConcrete(true);
}
}
}
/**
* Generate binding(s) for a list of classes. This creates a <mapping> definition for each class in the list, and
* either embeds <structure> definitions or creates separate <mapping>s for other classes referenced by these
* classes. If all the classes use the same namespace only the binding for that namespace will be created;
* otherwise, a separate binding will be created for each namespace.
*
* @param abstr force abstract mapping flag (determined by class customizations if null)
* @param classes class list
*/
public void generate(Boolean abstr, List classes) {
// start by expanding and counting references from supplied classes
ReferenceCountMap refmap = new ReferenceCountMap();
m_directSet.addAll(classes);
findReferences(classes, refmap);
flagMultipleReferences(refmap);
// set the classes to be handled with definitions
for (int i = 0; i < classes.size(); i++) {
addMappingDetails(abstr, null, (String)classes.get(i));
}
addReferencedMappings(refmap);
fixBaseClasses();
// generate the binding(s)
generateMappings(classes);
generateReferencedMappings(refmap);
}
/**
* Generate binding(s) for lists of classes. This creates a <mapping> definition for each class in the lists, and
* either embeds <structure> definitions or creates separate <mapping>s for other classes referenced by these
* classes. If all the classes use the same namespace only the binding for that namespace will be created;
* otherwise, a separate binding will be created for each namespace.
*
* @param qnames list of names for concrete mappings
* @param concrs list of classes to be given concrete mappings
* @param abstrs list of classes to be given abstract mappings
*/
public void generateSpecified(ArrayList qnames, List concrs, List abstrs) {
// start by expanding and counting references from supplied classes
ReferenceCountMap refmap = new ReferenceCountMap();
m_directSet.addAll(concrs);
m_directSet.addAll(abstrs);
findReferences(concrs, refmap);
findReferences(abstrs, refmap);
flagMultipleReferences(refmap);
// set classes to be handled with mapping definitions
for (int i = 0; i < concrs.size(); i++) {
BindingMappingDetail detail = addMappingDetails(Boolean.FALSE, (QName)qnames.get(i), (String)concrs.get(i));
if (detail.getElementQName() == null) {
detail.setElementQName(fixElementName((QName)qnames.get(i)));
}
}
for (int i = 0; i < abstrs.size(); i++) {
addMappingDetails(Boolean.TRUE, null, (String)abstrs.get(i));
}
addReferencedMappings(refmap);
fixBaseClasses();
// generate the binding(s)
generateMappings(concrs);
generateMappings(abstrs);
generateReferencedMappings(refmap);
}
/**
* Get the mapping details for a class. This method should only be used after the
* {@link #generate(Boolean, List)} method has been called.
*
* @param type fully-qualified class name
* @return mapping details, or null if none
*/
public BindingMappingDetail getMappingDetail(String type) {
return (BindingMappingDetail)m_mappingDetailsMap.get(type);
}
/**
* Find the binding to be used for a particular namespace. If this is the first time a particular namespace was
* requested, a new binding will be created for that namespace and returned. This method just delegates to the
* {@link org.jibx.binding.model.BindingDirectory} implementation.
*
* @param uri namespace URI (null if no namespace)
* @return binding holder
*/
public BindingHolder findBinding(String uri) {
return m_directory.findBinding(uri);
}
/**
* Get the binding definition for a namespace. This method should only be used after the
* {@link #generate(Boolean, List)} method has been called. It delegates to the
* {@link org.jibx.binding.model.BindingDirectory} implementation.
*
* @param uri
* @return binding holder, or null if none
*/
public BindingHolder getBinding(String uri) {
return m_directory.getBinding(uri);
}
/**
* Get the list of binding namespace URIs.
*
* @return namespaces
*/
public ArrayList getNamespaces() {
return m_directory.getNamespaces();
}
/**
* Complete the generated bindings and write them as files.
*
* @param name
* @param adduris
* @param dir
* @return root binding holder
* @throws JiBXException on error in generated bindings
* @throws IOException on error writing bindings
*/
public BindingHolder finish(String name, String[] adduris, File dir) throws JiBXException, IOException {
m_directory.finish();
BindingHolder root = m_directory.configureFiles(name, adduris, m_targetPackage);
m_directory.writeBindings(dir);
return root;
}
/**
* Run the binding generation using command line parameters.
*
* @param args
* @throws JiBXException
* @throws IOException
*/
public static void main(String[] args) throws JiBXException, IOException {
BindingGeneratorCommandLine parms = new BindingGeneratorCommandLine();
if (args.length > 0 && parms.processArgs(args)) {
// generate bindings for all namespaces
BindingGenerator gen = new BindingGenerator(parms.getGlobal());
gen.generate(parms.getAbstract(), parms.getExtraArgs());
gen.finish(parms.getBindingName(), new String[0], parms.getGeneratePath());
} else {
if (args.length > 0) {
System.err.println("Terminating due to command line errors");
} else {
parms.printUsage();
}
System.exit(1);
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/BindingGeneratorCommandLine.java 0000644 0001750 0001750 00000013521 10736011270 031305 0 ustar moeller moeller /*
* Copyright (c) 2007, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import java.io.FileInputStream;
import java.io.IOException;
import java.util.Map;
import org.jibx.binding.model.IClassLocator;
import org.jibx.runtime.BindingDirectory;
import org.jibx.runtime.IBindingFactory;
import org.jibx.runtime.IUnmarshallable;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
import org.jibx.schema.validation.ValidationContext;
/**
* Command line processing specifically for the {@link BindingGenerator} class.
*
* @author Dennis M. Sosnoski
*/
public class BindingGeneratorCommandLine extends ClassCustomizationBase
{
/** Ordered array of extra usage lines. */
protected static final String[] EXTRA_USAGE_LINES =
new String[] { " -a force abstract mappings for specified classes",
" -b generated root binding name (default is 'binding.xml')",
" -m force concrete mappings for specified classes" };
/**
* TRUE if abstract mappings forced, FALSE if concrete mappings forced,
* null if left to class settings.
*/
private Boolean m_abstract;
/** Customizations model root. */
private GlobalCustom m_global;
/** Name used for root binding. */
private String m_bindingName = "binding.xml";
/**
* Get force abstract mapping setting.
*
* @return TRUE if abstract mappings forced, FALSE if concrete mappings forced,
* null if left to class settings
*/
public Boolean getAbstract() {
return m_abstract;
}
/**
* Get customizations model root.
*
* @return customizations
*/
public GlobalCustom getGlobal() {
return m_global;
}
/**
* Get binding name.
*
* @return name
*/
public String getBindingName() {
return m_bindingName;
}
/*
* (non-Javadoc)
*
* @see org.jibx.binding.generator.CustomizationCommandLineBase#checkParameter(org.jibx.binding.generator.CustomizationCommandLineBase.ArgList)
*/
protected boolean checkParameter(ArgList alist) {
boolean match = true;
String arg = alist.current();
if ("-a".equalsIgnoreCase(arg)) {
m_abstract = Boolean.TRUE;
} else if ("-b".equalsIgnoreCase(arg)) {
m_bindingName = alist.next();
} else if ("-m".equalsIgnoreCase(arg)) {
m_abstract = Boolean.FALSE;
} else {
match = false;
}
return match;
}
/*
* (non-Javadoc)
*
* @see org.jibx.binding.generator.ClassCustomizationBase#loadCustomizations(String,IClassLocator.ValidationContext)
*/
protected void loadCustomizations(String path, IClassLocator loc, ValidationContext vctx) throws JiBXException, IOException {
// load or create customization information
m_global = new GlobalCustom(loc);
if (path != null) {
IBindingFactory fact = BindingDirectory.getFactory(GlobalCustom.class);
IUnmarshallingContext ictx = fact.createUnmarshallingContext();
FileInputStream is = new FileInputStream(path);
ictx.setDocument(is, null);
ictx.setUserContext(vctx);
((IUnmarshallable)m_global).unmarshal(ictx);
}
}
/*
* (non-Javadoc)
*
* @see org.jibx.binding.generator.CustomizationCommandLineBase#applyOverrides(Map)
*/
protected Map applyOverrides(Map overmap) {
Map unknowns = applyKeyValueMap(overmap, m_global);
m_global.initClasses();
m_global.fillClasses();
return unknowns;
}
/*
* (non-Javadoc)
*
* @see org.jibx.binding.generator.CustomizationCommandLineBase#printUsage()
*/
public void printUsage() {
System.out.println("\nUsage: java org.jibx.binding.generator.BindingGenerator "
+ "[options] class1 class2 ...\nwhere options are:");
String[] usages = mergeUsageLines(BASE_USAGE_LINES, EXTRA_USAGE_LINES);
for (int i = 0; i < usages.length; i++) {
System.out.println(usages[i]);
}
System.out.println("The class# files are different classes to be included in "
+ "the binding (references from\nthese classes will also be " + "included).\n");
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/BindingMappingDetail.java 0000644 0001750 0001750 00000021662 10651175632 030004 0 ustar moeller moeller /*
* Copyright (c) 2007, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import java.util.Map;
import org.jibx.binding.model.MappingElement;
import org.jibx.runtime.QName;
/**
* Holder for the details of how a class is going to be mapped. This information is needed in order to determine how to
* reference the mapped class when it's used within another mapping definition.
*
* @author Dennis M. Sosnoski
*/
public class BindingMappingDetail
{
/** Fully-qualified class name of mapped class. */
private final String m_type;
/** Generate abstract mapping flag. */
private boolean m_useAbstract;
/** Generate concrete mapping flag. */
private boolean m_useConcrete;
/** Flag for class extended by other mapped class(es). */
private boolean m_isExtended;
/** Abstract mapping type name (null if none). */
private final QName m_typeQName;
/** Concrete mapping element name (null if none). */
private QName m_elementQName;
/** Concrete mapping type extended by this one. */
private String m_extendsType;
/** Map from access method name to property customization information for properties covered by this mapping
(including inherited ones). */
private Map m_propertyMethodMap;
/** Flag for mapping(s) has been generated. */
private boolean m_isGenerated;
/** Abstract mapping definition (null if none). */
private MappingElement m_abstractMapping;
/** Concrete mapping definition (null if none). */
private MappingElement m_concreteMapping;
/**
* Constructor.
*
* @param type fully-qualified mapped class name
* @param aname abstract mapping type name
* @param cname concrete mapping element name
* @param stype superclass for extension (null if not an extension mapping)
*/
protected BindingMappingDetail(String type, QName aname, QName cname, String stype) {
m_type = type;
m_typeQName = aname;
m_elementQName = cname;
m_extendsType = stype;
}
/**
* Get fully-qualified name of mapped class.
*
* @return class name
*/
public String getType() {
return m_type;
}
/**
* Get the abstract <mapping> for the target class.
*
* @return abstract , null if none
*/
public MappingElement getAbstractMapping() {
return m_abstractMapping;
}
/**
* Set the abstract <mapping> for the target class.
*
* @param abs abstract , null if none
*/
public void setAbstractMapping(MappingElement abs) {
m_abstractMapping = abs;
}
/**
* Get the concrete <mapping> for the target class.
*
* @return concrete , null if none
*/
public MappingElement getConcreteMapping() {
return m_concreteMapping;
}
/**
* Set the concrete <mapping> for the target class.
*
* @param con concrete , null if none
*/
public void setConcreteMapping(MappingElement con) {
m_concreteMapping = con;
}
/**
* Check for target class extended by other mapped class(es).
*
* @return true if extended, false if not
*/
public boolean isExtended() {
return m_isExtended;
}
/**
* Set target class extended by other mapped class(es). Setting this true forces a concrete
* <mapping> to be used.
*
* @param ext
*/
public void setExtended(boolean ext) {
m_isExtended = ext;
if (ext) {
setUseConcrete(true);
}
}
/**
* Check if this <mapping> has been generated.
*
* @return true if generated, false if not
*/
public boolean isGenerated() {
return m_isGenerated;
}
/**
* Set flag for <mapping> generated.
*
* @param gen
*/
public void setGenerated(boolean gen) {
m_isGenerated = gen;
}
/**
* Check if an abstract <mapping> used for this class.
*
* @return true if abstract mapping used, false if not
*/
public boolean isUseAbstract() {
return m_useAbstract;
}
/**
* Set flag for abstract <mapping> used for this class.
*
* @param abs true if abstract mapping used, false if not
*/
public void setUseAbstract(boolean abs) {
m_useAbstract = abs;
}
/**
* Check if a concrete <mapping> used for this class.
*
* @return true if concrete mapping used, false if not
*/
public boolean isUseConcrete() {
return m_useConcrete;
}
/**
* Set flag for concrete <mapping> used for this class.
*
* @param con true if concrete mapping used, false if not
*/
public void setUseConcrete(boolean con) {
m_useConcrete = con;
if (!con && m_isExtended) {
throw new IllegalStateException("Internal error - concrete must be used for extensions");
}
}
/**
* Get the element name used for a concrete mapping. Note that this method will always return a
* non-null result if a concrete mapping is being used, but may also return a non-null
* result even if there is no concrete mapping - so check first using the {@link #isUseConcrete()} method.
*
* @return element name, or null if not defined
*/
public QName getElementQName() {
return m_elementQName;
}
/**
* Set the element name used for a concrete mapping.
*
* @param qname element name, or null if not defined
*/
public void setElementQName(QName qname) {
m_elementQName = qname;
}
/**
* Get the fully-qualified class name of the type extended by this <mapping>.
*
* @return class name, or null if none
*/
public String getExtendsType() {
return m_extendsType;
}
/**
* Get the type name used for an abstract mapping. Note that this method will always return a non-null
* result if an abstract mapping is being used, but may also return a non-null result even if there is
* no abstract mapping - so check first using the {@link #isUseConcrete()} method.
*
* @return type name, or null if not defined
*/
public QName getTypeQName() {
return m_typeQName;
}
/**
* Get map from access method name to property customization information for properties covered by this
* <mapping>. This map includes both properties defined directly, and those inherited from any base mapping.
*
* @return map (non-null after <mapping> constructed)
*/
public Map getAccessMethodMap() {
return m_propertyMethodMap;
}
/**
* Set map from access method name to property customization information for properties covered by this
* <mapping>. This must be done at the time the <mapping> is constructed.
*
* @param map (non-null, use empty map if not applicable)
*/
public void setAccessMethodMap(Map map) {
m_propertyMethodMap = map;
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/ClassCustom.java 0000644 0001750 0001750 00000067446 10752422164 026242 0 ustar moeller moeller /*
* Copyright (c) 2007-2008, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import java.lang.reflect.Modifier;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.jibx.binding.model.IClass;
import org.jibx.binding.model.IClassItem;
import org.jibx.binding.model.IClassLocator;
import org.jibx.binding.util.StringArray;
import org.jibx.custom.CustomUtils;
import org.jibx.runtime.EnumSet;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.QName;
import org.jibx.util.InsertionOrderedMap;
/**
* Class customization information. This supports direct class customizations. (such as the corresponding element name,
* when building a concrete mapping) and also acts as a container for individual fields and/or properties.
*
* @author Dennis M. Sosnoski
*/
public class ClassCustom extends NestingBase implements IApply
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new String[] { "create-type", "element-name", "enum-value-method", "excludes", "factory",
"form", "includes", "name", "optionals", "requireds", "type-name", "use-super" },
NestingBase.s_allowedAttributes);
/** Element name in XML customization file. */
public static final String ELEMENT_NAME = "class";
// value set information
public static final int DEFAULT_REPRESENTATION = 0;
public static final int CONCRETE_MAPPING_REPRESENTATION = 1;
public static final int ABSTRACT_MAPPING_REPRESENTATION = 2;
public static final EnumSet s_representationEnum =
new EnumSet(DEFAULT_REPRESENTATION, new String[] { "default", "concrete-mapping", "abstract-mapping" });
// values specific to class level
private String m_name;
private String m_elementName;
private String m_typeName;
private String m_createType;
private String m_factoryMethod;
private String m_enumValueMethod;
private int m_form;
private String[] m_includes;
private String[] m_excludes;
private boolean m_useSuper;
private String[] m_requireds;
private String[] m_optionals;
// list of contained items
private final ArrayList m_children;
// values filled in by apply() method
private boolean m_isApplied;
private QName m_typeQName;
private QName m_elementQName;
private IClass m_classInformation;
private InsertionOrderedMap m_memberMap;
/**
* Constructor.
*
* @param parent
* @param name class simple name (without package)
*/
/* package */ClassCustom(NestingBase parent, String name) {
super(parent);
m_name = name;
m_children = new ArrayList();
m_useSuper = true;
}
/**
* Make sure all attributes are defined.
*
* @param uctx unmarshalling context
*/
private void preSet(IUnmarshallingContext uctx) {
validateAttributes(uctx, s_allowedAttributes);
}
/**
* Get fully-qualified class name.
*
* @return class name
*/
public String getName() {
PackageCustom parent = (PackageCustom)getParent();
String pack = parent.getName();
if (pack.length() > 0) {
return pack + '.' + m_name;
} else {
return m_name;
}
}
/**
* Get simple class name.
*
* @return class name
*/
public String getSimpleName() {
return m_name;
}
/**
* Get the element name to be used for this class in a concrete mapping.
*
* @return element name
*/
public String getElementName() {
return m_elementName;
}
/**
* Get the qualified element name to be used for this class in a concrete mapping.
*
* @return element name
*/
public QName getElementQName() {
return m_elementQName;
}
/**
* Get the type name to be used for this class in an abstract mapping.
*
* @return type name
*/
public String getTypeName() {
return m_typeName;
}
/**
* Get the type name to be used when creating an instance of this class.
*
* @return type name
*/
public String getCreateType() {
return m_createType;
}
/**
* Set the type name to be used when creating an instance of this class.
*
* @param type
*/
public void setCreateType(String type) {
m_createType = type;
}
/**
* Get the method used to retrieve the text value for an enum class.
*
* @return method name
*/
public String getEnumValueMethod() {
return m_enumValueMethod;
}
/**
* Get the factory method to be used when creating an instance of this class.
*
* @return method name
*/
public String getFactoryMethod() {
return m_factoryMethod;
}
/**
* Get the qualified type name to be used for this class in an abstract mapping.
*
* @return type qname
*/
public QName getTypeQName() {
return m_typeQName;
}
/**
* Get the representation code.
*
* @return value from {@link #s_representationEnum} enumeration
*/
public int getForm() {
return m_form;
}
/**
* Get list of names to be excluded from class representation.
*
* @return excludes (null if none)
*/
public String[] getExcludes() {
return m_excludes;
}
/**
* Get list of names to be included in class representation.
*
* @return includes (null if none)
*/
public String[] getIncludes() {
return m_includes;
}
/**
* Check for superclass to be included in binding.
*
* @return true if superclass included, false if not
*/
public boolean isUseSuper() {
return m_useSuper;
}
/**
* Check if this is a directly instantiable class (not an interface, and not abstract)
*
* @return true if instantiable, false if not
*/
public boolean isConcrete() {
return !(m_classInformation.isAbstract() || m_classInformation.isInterface());
}
/**
* Get list of children.
*
* @return list
*/
public List getChildren() {
return m_children;
}
/**
* Add child.
*
* @param child
*/
protected void addChild(CustomBase child) {
if (child.getParent() == this) {
m_children.add(child);
} else {
throw new IllegalStateException("Internal error: child not linked");
}
}
/**
* Form set text method. This is intended for use during unmarshalling. TODO: add validation
*
* @param text
* @param ictx
*/
private void setFormText(String text, IUnmarshallingContext ictx) {
m_form = s_representationEnum.getValue(text);
}
/**
* Form get text method. This is intended for use during marshalling.
*
* @return text
*/
private String getFormText() {
return s_representationEnum.getName(m_form);
}
/**
* Build map from member names to read access methods. This assumes that each no-argument method which returns a
* value and has a name beginning with "get" or "is" is a property read access method. It maps the corresponding
* property name to the method, and returns the map.
*
* @param methods
* @param inclset set of member names to be included (null if not specified)
* @param exclset set of member names to be excluded (null if not specified, ignored if inclset is
* non-null)
* @return map
*/
private Map mapPropertyReadMethods(IClassItem[] methods, Set inclset, Set exclset) {
// check all methods for property read access matches
InsertionOrderedMap getmap = new InsertionOrderedMap();
for (int i = 0; i < methods.length; i++) {
IClassItem item = methods[i];
String name = item.getName();
if (item.getArgumentCount() == 0
&& ((name.startsWith("get") && !item.getTypeName().equals("void")) || (name.startsWith("is") && item
.getTypeName().equals("boolean")))) {
// have what appears to be a getter, check if it should be used
String memb = MemberCustom.memberNameFromGetMethod(name);
boolean use = true;
if (inclset != null) {
use = inclset.contains(memb.toLowerCase());
} else if (exclset != null) {
use = !exclset.contains(memb.toLowerCase());
}
if (use) {
getmap.put(memb, item);
}
}
}
return getmap;
}
/**
* Build map from member names to write access methods. This assumes that each single-argument method which returns
* void and has a name beginning with "set" is a property write access method. It maps the corresponding property
* name to the method, and returns the map.
*
* @param methods
* @param inclset set of member names to be included (null if not specified)
* @param exclset set of member names to be excluded (null if not specified, ignored if inclset is
* non-null)
* @return map
*/
private Map mapPropertyWriteMethods(IClassItem[] methods, Set inclset, Set exclset) {
// check all methods for property write access matches
InsertionOrderedMap setmap = new InsertionOrderedMap();
for (int i = 0; i < methods.length; i++) {
IClassItem item = methods[i];
String name = item.getName();
if (item.getArgumentCount() == 1 && name.startsWith("set") && item.getTypeName().equals("void")) {
// have what appears to be a setter, check if it should be used
String memb = MemberCustom.memberNameFromSetMethod(name);
boolean use = true;
if (inclset != null) {
use = inclset.contains(memb.toLowerCase());
} else if (exclset != null) {
use = !exclset.contains(memb.toLowerCase());
}
if (use) {
setmap.put(memb, item);
}
}
}
return setmap;
}
/**
* Build map from member names to fields. This includes all non-static and non-transient fields of the class.
*
* @param fields
* @param prefs prefixes to be stripped in deriving names
* @param suffs suffixes to be stripped in deriving names
* @param inclset set of member names to be included (null if not specified)
* @param exclset set of member names to be excluded (null if not specified, ignored if inclset is
* non-null)
* @return map
*/
private Map mapFields(IClassItem[] fields, String[] prefs, String[] suffs, Set inclset, Set exclset) {
// check all fields for use as members
InsertionOrderedMap fieldmap = new InsertionOrderedMap();
for (int i = 0; i < fields.length; i++) {
IClassItem item = fields[i];
String name = item.getName();
String memb = MemberCustom.memberNameFromField(name, prefs, suffs);
boolean use = true;
if (inclset != null) {
use = inclset.contains(memb.toLowerCase());
} else if (exclset != null) {
use = !exclset.contains(memb.toLowerCase());
}
if (use) {
fieldmap.put(memb, item);
}
}
return fieldmap;
}
/**
* Find the most specific type for a property based on the access methods.
*
* @param gmeth read access method (null if not defined)
* @param smeth write access method (null if not defined)
* @param icl
* @return most specific type name
*/
private String findPropertyType(IClassItem gmeth, IClassItem smeth, IClassLocator icl) {
String type;
if (gmeth == null) {
if (smeth == null) {
throw new IllegalArgumentException("Internal error: no access methods known");
} else {
type = smeth.getArgumentType(0);
}
} else if (smeth == null) {
type = gmeth.getTypeName();
} else {
String gtype = gmeth.getTypeName();
String stype = smeth.getArgumentType(0);
IClass gclas = icl.getClassInfo(gtype);
if (gclas.isSuperclass(stype) || gclas.isImplements(stype)) {
type = gtype;
} else {
type = stype;
}
}
return type;
}
/**
* Utility method to strip any leading non-alphanumeric characters from an array of name strings.
*
* @param names (null if none)
* @return array of stripped names (null if none)
*/
private static String[] stripNames(String[] names) {
if (names == null) {
return null;
} else {
String[] strips = null;
for (int i = 0; i < names.length; i++) {
String name = names[i];
int index = 0;
while (index < name.length()) {
char chr = name.charAt(index);
if (Character.isLetter(chr) || Character.isDigit(chr)) {
break;
} else {
index++;
}
}
if (index > 0) {
if (strips == null) {
strips = new String[names.length];
System.arraycopy(names, 0, strips, 0, names.length);
}
strips[i] = name.substring(index);
}
}
return (strips == null) ? names : strips;
}
}
/**
* Classify an array of names as elements or attributes, based on leading flag characters ('@' for an attribute,
* '<' for an element).
*
* @param names (null if none)
* @param elems set of element names
* @param attrs set of attribute names
*/
private static void classifyNames(String[] names, Set elems, Set attrs) {
if (names != null) {
for (int i = 0; i < names.length; i++) {
String name = names[i];
if (name.length() > 0) {
char chr = name.charAt(0);
Set addset = null;
Set altset = null;
if (chr == '@') {
addset = attrs;
altset = elems;
} else if (chr == '/') {
addset = elems;
altset = attrs;
}
if (addset != null) {
name = name.substring(1).toLowerCase();
addset.add(name);
if (altset.contains(name)) {
throw new IllegalArgumentException("Name " + name + " used as both element and attribute");
}
}
}
}
}
}
/**
* Apply customizations to class to fill out members.
*
* @param icl class locator
*/
public void apply(IClassLocator icl) {
// check for repeated call (happens due to package-level apply()
if (m_isApplied) {
return;
}
m_isApplied = true;
// initialize class information
m_classInformation = icl.getClassInfo(getName());
if (m_classInformation == null) {
throw new IllegalStateException("Internal error: unable to find class " + m_name);
}
// inherit namespace directly from package level, if not specified
String ns = getSpecifiedNamespace();
if (ns == null) {
ns = getParent().getNamespace();
}
setNamespace(ns);
// set the name(s) to be used if mapped
String cname = convertName(getSimpleName());
if (m_elementName == null) {
m_elementName = cname;
}
m_elementQName = new QName(getNamespace(), m_elementName);
if (m_typeName == null) {
m_typeName = cname;
}
m_typeQName = new QName(getNamespace(), m_typeName);
// initialize maps with existing member customizations
HashMap namemap = new HashMap();
for (Iterator iter = getChildren().iterator(); iter.hasNext();) {
MemberCustom memb = (MemberCustom)iter.next();
String name = memb.getBaseName();
if (name != null) {
namemap.put(name, memb);
}
}
// generate sets of names to be included or ignored, and optional/requires, elements/attributes
Set exclset = null;
Set inclset = null;
Set elemset = Collections.EMPTY_SET;
Set attrset = Collections.EMPTY_SET;
Set optset = Collections.EMPTY_SET;
Set reqset = Collections.EMPTY_SET;
if (m_includes != null || m_optionals != null || m_requireds != null) {
String[] optionals = stripNames(m_optionals);
String[] requireds = stripNames(m_requireds);
inclset = CustomUtils.noCaseNameSet(stripNames(m_includes));
if (optionals != null) {
optset = CustomUtils.noCaseNameSet(optionals);
}
if (requireds != null) {
reqset = CustomUtils.noCaseNameSet(requireds);
}
elemset = new HashSet();
attrset = new HashSet();
classifyNames(m_requireds, elemset, attrset);
classifyNames(m_optionals, elemset, attrset);
classifyNames(m_includes, elemset, attrset);
} else if (m_excludes != null) {
exclset = CustomUtils.noCaseNameSet(stripNames(m_excludes));
}
// first find members from property access methods
Map getmap = null;
Map setmap = null;
IClassItem[] methods = m_classInformation.getMethods();
GlobalCustom global = getGlobal();
if (global.isOutput()) {
// find properties using read access methods
getmap = mapPropertyReadMethods(methods, inclset, exclset);
if (global.isInput()) {
// find properties using write access methods
setmap = mapPropertyWriteMethods(methods, inclset, exclset);
// discard any read-only properties
for (Iterator iter = getmap.keySet().iterator(); iter.hasNext();) {
if (!setmap.containsKey(iter.next())) {
iter.remove();
}
}
}
}
if (global.isInput()) {
// find properties using write access methods
setmap = mapPropertyWriteMethods(methods, inclset, exclset);
}
// find members from fields
Map fieldmap =
mapFields(m_classInformation.getFields(), getStripPrefixes(), getStripSuffixes(), inclset, exclset);
// get list of names selected for use by options
ArrayList names;
if (isPropertyAccess()) {
if (global.isOutput()) {
names = new ArrayList(getmap.keySet());
} else {
names = new ArrayList(setmap.keySet());
}
} else {
names = new ArrayList();
for (Iterator iter = fieldmap.keySet().iterator(); iter.hasNext();) {
String name = (String)iter.next();
IClassItem field = (IClassItem)fieldmap.get(name);
int access = field.getAccessFlags();
if (!Modifier.isStatic(access) && !Modifier.isTransient(access)) {
names.add(name);
}
}
}
// process all members found in class
m_memberMap = new InsertionOrderedMap();
boolean auto = !getName().startsWith("java.") && !getName().startsWith("javax.");
for (int i = 0; i < names.size(); i++) {
// get basic member information
String name = (String)names.get(i);
String lcname = name.toLowerCase();
MemberCustom cust = null;
IClassItem gmeth = (IClassItem)(getmap == null ? null : getmap.get(name));
IClassItem smeth = (IClassItem)(setmap == null ? null : setmap.get(name));
IClassItem field = (IClassItem)(fieldmap == null ? null : fieldmap.get(name));
// find the optional/required setting
Boolean isreq = null;
if (optset.contains(lcname)) {
isreq = Boolean.FALSE;
}
if (reqset.contains(lcname)) {
isreq = Boolean.TRUE;
}
// find the style setting
Integer style = null;
if (attrset.contains(lcname)) {
style = ATTRIBUTE_STYLE_INTEGER;
} else if (elemset.contains(lcname)) {
style = ELEMENT_STYLE_INTEGER;
}
// check for existing customization
if (namemap.containsKey(name)) {
// fill in data missing from existing member customization
cust = (MemberCustom)namemap.get(name);
if (cust instanceof MemberFieldCustom) {
MemberFieldCustom mfcust = (MemberFieldCustom)cust;
mfcust.completeField((IClassItem)fieldmap.get(name), isreq, style);
} else {
String type = findPropertyType(gmeth, smeth, icl);
MemberPropertyCustom mpcust = (MemberPropertyCustom)cust;
mpcust.completeProperty(gmeth, smeth, type, isreq, style);
}
} else if (auto) {
if (isPropertyAccess()) {
if (gmeth != null || smeth != null) {
// check for a collection property
MemberPropertyCustom pcust;
String type = findPropertyType(gmeth, smeth, icl);
IClass info = icl.getClassInfo(type);
if (type.endsWith("[]") || info.isImplements("Ljava/util/Collection;")) {
pcust = new CollectionPropertyCustom(this, name);
} else {
pcust = new MemberPropertyCustom(this, name);
}
// fill in the details of the property
pcust.completeProperty(gmeth, smeth, type, isreq, style);
cust = pcust;
}
} else if (field != null) {
// check for a collection field
MemberFieldCustom fcust;
String type = field.getTypeName();
IClass info = icl.getClassInfo(type);
if (type.endsWith("[]") || info.isImplements("Ljava/util/Collection;")) {
fcust = new CollectionFieldCustom(this, name);
} else {
fcust = new MemberFieldCustom(this, name);
}
// fill in the details of the property
fcust.completeField(field, isreq, style);
cust = fcust;
}
}
// add customization to map
if (cust != null) {
m_memberMap.put(name, cust);
}
}
// check for any supplied customizations that haven't been matched
for (Iterator iter = namemap.keySet().iterator(); iter.hasNext();) {
String name = (String)iter.next();
String lcname = name.toLowerCase();
if (!m_memberMap.containsKey(name)) {
// find the optional/required setting
Boolean req = null;
if (optset != null && optset.contains(lcname)) {
req = Boolean.FALSE;
}
if (reqset != null && reqset.contains(lcname)) {
req = Boolean.TRUE;
}
// find the style setting
Integer style = null;
if (attrset.contains(lcname)) {
style = ATTRIBUTE_STYLE_INTEGER;
} else if (elemset.contains(lcname)) {
style = ELEMENT_STYLE_INTEGER;
}
// complete the customization and add to map
MemberCustom cust = (MemberCustom)namemap.get(name);
cust.complete(null, req, style);
m_memberMap.put(name, cust);
}
}
}
/**
* Get customization information for a member by name. This method may only be called after
* {@link #apply(IClassLocator)}.
*
* @param name
* @return customization, or null if none
*/
public MemberCustom getMember(String name) {
return (MemberCustom)m_memberMap.get(name);
}
/**
* Get actual class information. This method may only be called after {@link #apply(IClassLocator)}.
*
* @return class information
*/
public IClass getClassInformation() {
return m_classInformation;
}
/**
* Get collection of members in class.
*
* @return members
*/
public Collection getMembers() {
return m_memberMap.values();
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/ClassCustomizationBase.java 0000644 0001750 0001750 00000016171 10720550330 030410 0 ustar moeller moeller /*
* Copyright (c) 2007, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import org.jibx.binding.Utility;
import org.jibx.binding.classes.ClassCache;
import org.jibx.binding.classes.ClassFile;
import org.jibx.binding.model.IClassLocator;
import org.jibx.custom.CustomizationCommandLineBase;
import org.jibx.runtime.JiBXException;
import org.jibx.schema.validation.ValidationContext;
import org.jibx.schema.validation.ValidationProblem;
/**
* Command line processor for customizable tools working with Java classes.
*
* @author Dennis M. Sosnoski
*/
public abstract class ClassCustomizationBase extends CustomizationCommandLineBase
{
/** Ordered array of usage lines. */
protected static final String[] BASE_USAGE_LINES =
new String[] { " -p path class loading path component",
" -s path source path component" };
/** List of class paths. */
private List m_classPaths;
/** List of source paths. */
private List m_sourcePaths;
/**
* Constructor.
*/
protected ClassCustomizationBase() {
m_classPaths = new ArrayList();
m_sourcePaths = new ArrayList();
}
/**
* Check if an extension parameter is recognized. Subclasses which override this method should call the base class
* method before doing their own checks, and only perform their own checks if this method returns
* false..
*
* @param alist argument list
* @return true if parameter processed, false if unknown
*/
protected boolean checkParameter(ArgList alist) {
boolean match = true;
String arg = alist.current();
if ("-p".equalsIgnoreCase(arg)) {
m_classPaths.add(alist.next());
} else if ("-s".equalsIgnoreCase(arg)) {
m_sourcePaths.add(alist.next());
} else {
match = false;
}
return match;
}
/**
* Finish processing of command line parameters. This adds the JVM classpath directories to the set of paths
* specified on the command line. Subclasses which override this method need to call this base class implementation
* as part of their processing.
*
* @param alist
*/
protected void finishParameters(ArgList alist) {
// add JVM class path directories to those specified on command line
String[] vmpaths = Utility.getClassPaths();
for (int i = 0; i < vmpaths.length; i++) {
m_classPaths.add(vmpaths[i]);
}
// set paths to be used for loading referenced classes
String[] parray = (String[])m_classPaths.toArray(new String[m_classPaths.size()]);
ClassCache.setPaths(parray);
ClassFile.setPaths(parray);
}
/**
* Print any extension details. This method may be overridden by subclasses to print extension parameter values for
* verbose output, but the base class implementation should be called first.
*/
protected void verboseDetails() {
System.out.println("Using class loading paths:");
for (int i = 0; i < m_classPaths.size(); i++) {
System.out.println(" " + m_classPaths.get(i));
}
System.out.println("Using source loading paths:");
for (int i = 0; i < m_sourcePaths.size(); i++) {
System.out.println(" " + m_sourcePaths.get(i));
}
System.out.println("Starting from classes:");
List types = getExtraArgs();
for (int i = 0; i < types.size(); i++) {
System.out.println(" " + types.get(i));
}
}
/**
* Load the customizations file. This method must load the specified customizations file, or create a default
* customizations instance, of the appropriate type.
*
* @param path customization file path
* @return true if successful, false if an error
* @throws JiBXException
* @throws IOException
*/
protected boolean loadCustomizations(String path) throws JiBXException, IOException {
// load customizations and check for errors
String[] spaths = (String[])m_sourcePaths.toArray(new String[m_sourcePaths.size()]);
ValidationContext vctx = new ValidationContext();
loadCustomizations(path, new ClassSourceLocator(spaths), vctx);
ArrayList probs = vctx.getProblems();
if (probs.size() > 0) {
for (int i = 0; i < probs.size(); i++) {
ValidationProblem prob = (ValidationProblem)probs.get(i);
System.out.print(prob.getSeverity() >=
ValidationProblem.ERROR_LEVEL ? "Error: " : "Warning: ");
System.out.println(prob.getDescription());
}
if (vctx.getErrorCount() > 0 || vctx.getFatalCount() > 0) {
return false;
}
}
return true;
}
/**
* Get the merged usage lines for this class and superclasses.
*
* @return usage lines
*/
protected String[] getBaseUsage() {
return mergeUsageLines(BASE_USAGE_LINES, COMMON_USAGE_LINES);
}
/**
* Load the customizations file. This method must load the specified customizations file, or create a default
* customizations instance, of the appropriate type.
*
* @param path customizations file path, null if none
* @param loc class locator
* @param vctx validation context
* @throws JiBXException
* @throws IOException
*/
protected abstract void loadCustomizations(String path, IClassLocator loc, ValidationContext vctx)
throws JiBXException, IOException;
} libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/ClassItemSourceWrapper.java 0000644 0001750 0001750 00000021167 10651175632 030401 0 ustar moeller moeller /*
* Copyright (c) 2004-2007, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import org.jibx.binding.classes.ClassItem;
import org.jibx.binding.model.ClassItemWrapper;
import org.jibx.binding.model.IClass;
import org.jibx.binding.model.IClassLocator;
import com.thoughtworks.qdox.model.DocletTag;
import com.thoughtworks.qdox.model.JavaClass;
import com.thoughtworks.qdox.model.JavaField;
import com.thoughtworks.qdox.model.JavaMethod;
import com.thoughtworks.qdox.model.JavaParameter;
import com.thoughtworks.qdox.model.Member;
import com.thoughtworks.qdox.model.Type;
/**
* Wrapper for class field or method item with added source information. This wraps the basic class handling
* implementation with added support for retrieving information from source files.
*
* @author Dennis M. Sosnoski
*/
public class ClassItemSourceWrapper extends ClassItemWrapper
{
private boolean m_checkedSource;
private Member m_itemSource;
/**
* Constructor
*
* @param clas
* @param item
*/
/* package */ClassItemSourceWrapper(IClass clas, ClassItem item) {
super(clas, item);
}
/**
* Check for source method signature match.
*
* @param method
* @return true if match to this method, false if not
*/
private boolean matchSignature(JavaMethod method) {
boolean match = true;
JavaParameter[] parms = method.getParameters();
if (parms.length == getArgumentCount()) {
for (int j = 0; j < parms.length; j++) {
Type ptype = parms[j].getType();
String type = ptype.getValue();
int ndim = ptype.getDimensions();
while (ndim-- > 0) {
type += "[]";
}
String comp = getArgumentType(j);
if (!comp.equals(type)) {
if (type.indexOf('.') >= 0 || !comp.endsWith('.' + type)) {
match = false;
break;
}
}
}
}
return match;
}
/**
* Internal method to get the source code information for this item.
*
* @return source information
*/
private Member getItemSource() {
if (!m_checkedSource) {
m_checkedSource = true;
IClass clas = getContainingClass();
IClassLocator loc = clas.getLocator();
if (loc instanceof IClassSourceLocator) {
IClassSourceLocator sloc = (IClassSourceLocator)loc;
JavaClass jc = sloc.getSourceInfo(clas.getName());
if (jc != null) {
if (isMethod()) {
String mname = getName();
JavaMethod[] methods = jc.getMethods();
for (int i = 0; i < methods.length; i++) {
JavaMethod method = methods[i];
if (mname.equals(method.getName())) {
if (matchSignature(method)) {
m_itemSource = method;
break;
}
}
}
} else {
m_itemSource = jc.getFieldByName(getName());
}
}
}
}
return m_itemSource;
}
/**
* Return JavaDoc text only if non-empty.
*
* @param text raw JavaDoc text
* @return trimmed text if non-empty, otherwise null
*/
private static String docText(String text) {
if (text != null) {
text = text.trim();
if (text.length() > 0) {
return text;
}
}
return null;
}
/*
* (non-Javadoc)
*
* @see org.jibx.binding.model.IClassItem#getJavaDoc()
*/
public String getJavaDoc() {
Member src = getItemSource();
if (src == null) {
return null;
} else if (isMethod()) {
return docText(((JavaMethod)src).getComment());
} else {
return docText(((JavaField)src).getComment());
}
}
/*
* (non-Javadoc)
*
* @see org.jibx.binding.model.IClassItem#getReturnJavaDoc()
*/
public String getReturnJavaDoc() {
if (isMethod()) {
JavaMethod jm = (JavaMethod)getItemSource();
if (jm != null) {
DocletTag tag = jm.getTagByName("return");
if (tag != null) {
return docText(tag.getValue());
}
}
return null;
} else {
throw new IllegalStateException("Internal error: not a method");
}
}
/*
* (non-Javadoc)
*
* @see org.jibx.binding.model.IClassItem#getParameterJavaDoc(int)
*/
public String getParameterJavaDoc(int index) {
if (isMethod()) {
JavaMethod jm = (JavaMethod)getItemSource();
if (jm != null) {
String name = jm.getParameters()[index].getName();
DocletTag[] tags = jm.getTagsByName("param");
for (int i = 0; i < tags.length; i++) {
DocletTag tag = tags[i];
String[] parms = tag.getParameters();
if (parms != null && parms.length > 0 && name.equals(parms[0])) {
String text = tag.getValue().trim();
if (text.startsWith(name)) {
text = text.substring(name.length()).trim();
}
return docText(text);
}
}
}
return null;
} else {
throw new IllegalStateException("Internal error: not a method");
}
}
/*
* (non-Javadoc)
*
* @see org.jibx.binding.model.IClassItem#getParameterName(int)
*/
public String getParameterName(int index) {
String name = super.getParameterName(index);
if (name == null) {
JavaMethod jm = (JavaMethod)getItemSource();
if (jm != null) {
name = jm.getParameters()[index].getName();
}
}
return name;
}
/*
* (non-Javadoc)
*
* @see org.jibx.binding.model.IClassItem#getExceptionJavaDoc(int)
*/
public String getExceptionJavaDoc(int index) {
if (isMethod()) {
JavaMethod jm = (JavaMethod)getItemSource();
if (jm != null) {
String name = getExceptions()[index];
DocletTag[] tags = jm.getTagsByName("throws");
for (int i = 0; i < tags.length; i++) {
DocletTag tag = tags[i];
String[] parms = tag.getParameters();
if (parms != null && parms.length > 0 && name.equals(parms[0])) {
return docText(tag.getValue());
}
}
}
return null;
} else {
throw new IllegalStateException("Internal error: not a method");
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/ClassSourceLocator.java 0000644 0001750 0001750 00000011267 10651465104 027541 0 ustar moeller moeller /*
* Copyright (c) 2007, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import java.io.File;
import java.io.IOException;
import java.util.HashSet;
import java.util.Set;
import org.jibx.binding.classes.ClassCache;
import org.jibx.binding.model.IClass;
import org.jibx.runtime.JiBXException;
import com.thoughtworks.qdox.JavaDocBuilder;
import com.thoughtworks.qdox.model.JavaClass;
/**
* Locator that supports both class file lookup and source file lookup.
*
* @author Dennis M. Sosnoski
*/
public class ClassSourceLocator implements IClassSourceLocator
{
/** Paths for source lookup. */
private final String[] m_sourcePaths;
/** Source file parser. */
private final JavaDocBuilder m_builder;
/** Set of classes parsed. */
private final Set m_lookupSet;
/**
* Constructor.
*
* @param paths source lookup paths (may be empty, but not null)
*/
public ClassSourceLocator(String[] paths) {
m_sourcePaths = paths;
m_builder = new JavaDocBuilder();
m_lookupSet = new HashSet();
}
/**
* Get the source code information for a class.
*
* @param name fully-qualified class name (using '$' as inner class marker)
* @return source code information, null if not available
*/
public JavaClass getSourceInfo(String name) {
int split = name.lastIndexOf('$');
if (split >= 0) {
JavaClass outer = getSourceInfo(name.substring(0, split));
if (outer == null) {
return null;
} else {
return outer.getNestedClassByName(name.substring(split + 1));
}
} else if (m_lookupSet.contains(name)) {
return m_builder.getClassByName(name);
} else {
for (int i = 0; i < m_sourcePaths.length; i++) {
StringBuffer buff = new StringBuffer();
buff.append(m_sourcePaths[i]);
int length = buff.length();
if (length > 0 || buff.charAt(length - 1) != File.separatorChar) {
buff.append(File.separatorChar);
}
buff.append(name.replace('.', File.separatorChar));
buff.append(".java");
File file = new File(buff.toString());
if (file.exists()) {
try {
m_builder.addSource(file);
m_lookupSet.add(name);
return m_builder.getClassByName(name);
} catch (IOException e) {
throw new IllegalStateException("Unable to access source file " + buff.toString() + ": " +
e.getMessage());
}
}
}
return null;
}
}
/**
* Get the information for a class.
*
* @param name fully-qualified class name (using '$' as inner class marker)
* @return class information
*/
public IClass getClassInfo(String name) {
try {
return new ClassSourceWrapper(this, ClassCache.getClassFile(name));
} catch (JiBXException e) {
throw new IllegalStateException("Class not found " + name);
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/ClassSourceWrapper.java 0000644 0001750 0001750 00000006061 10651175632 027556 0 ustar moeller moeller /*
* Copyright (c) 2007, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import org.jibx.binding.classes.ClassFile;
import org.jibx.binding.classes.ClassItem;
import org.jibx.binding.model.ClassWrapper;
import org.jibx.binding.model.IClassItem;
import com.thoughtworks.qdox.model.JavaClass;
/**
* Wrapper for class with added source information. This wraps the basic class handling implementation with added
* support for retrieving information from source files.
*
* @author Dennis M. Sosnoski
*/
public class ClassSourceWrapper extends ClassWrapper
{
/**
* Constructor.
*
* @param loc
* @param clas
*/
public ClassSourceWrapper(IClassSourceLocator loc, ClassFile clas) {
super(loc, clas);
}
/**
* Build an item wrapper. This override of the base class implementation always creates a wrapper which will support
* source operations.
*
* @param item
* @return wrapper
*/
protected IClassItem buildItem(ClassItem item) {
return new ClassItemSourceWrapper(this, item);
}
/*
* (non-Javadoc)
*
* @see org.jibx.binding.model.IClass#getJavaDoc()
*/
public String getJavaDoc() {
IClassSourceLocator loc = (IClassSourceLocator)getLocator();
JavaClass jc = loc.getSourceInfo(getClassFile().getName());
if (jc != null) {
String text = jc.getComment();
if (text != null) {
text = text.trim();
if (text.length() > 0) {
return text;
}
}
}
return null;
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/CollectionFieldCustom.java 0000644 0001750 0001750 00000012034 10651175632 030216 0 ustar moeller moeller /*
* Copyright (c) 2007, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import org.apache.bcel.generic.Type;
import org.jibx.binding.model.IClassItem;
import org.jibx.binding.util.StringArray;
import org.jibx.runtime.IUnmarshallingContext;
/**
* Collection field customization information.
*
* @author Dennis M. Sosnoski
*/
public class CollectionFieldCustom extends MemberFieldCustom
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new String[] { "item-name", "item-type" }, MemberFieldCustom.s_allowedAttributes);
// values specific to member level
private String m_itemType;
private String m_itemName;
/**
* Constructor.
*
* @param parent
*/
protected CollectionFieldCustom(NestingBase parent) {
super(parent);
}
/**
* Constructor with name known.
*
* @param parent
* @param name
*/
protected CollectionFieldCustom(NestingBase parent, String name) {
super(parent, name);
}
/**
* Make sure all attributes are defined.
*
* @param uctx unmarshalling context
*/
protected void preSet(IUnmarshallingContext uctx) {
validateAttributes(uctx, s_allowedAttributes);
}
/**
* Check if collection member.
*
* @return true
*/
public boolean isCollection() {
return true;
}
/**
* Get item type.
*
* @return item type (null if none)
*/
public String getItemType() {
return m_itemType;
}
/**
* Get item element name.
*
* @return item name (null if none)
*/
public String getItemName() {
return m_itemName;
}
/**
* Complete customization information based on field information.
*
* @param field (null if none available)
* @param req required member flag (null if unknown)
* @param style representation style (null if unspecified)
*/
/* package */void completeField(IClassItem field, Boolean req, Integer style) {
super.completeField(field, req, style);
if (field != null) {
// set information from field
String tname = getWorkingType();
if (m_itemType == null) {
if (tname.endsWith("[]")) {
m_itemType = tname.substring(0, tname.length() - 2);
} else {
String sig = field.getGenericsSignature();
if (sig != null) {
int start = sig.indexOf('<');
int end = sig.lastIndexOf('>');
if (start > 0 && end > 0 && start < end) {
String tsig = sig.substring(start + 1, end);
if (tsig.indexOf('<') < 0) {
m_itemType = Type.getType(tsig).toString();
}
}
}
}
}
if (m_itemName == null) {
m_itemName = deriveItemName(getXmlName(), m_itemType, getParent().getNameStyle());
}
}
if (m_itemType == null) {
m_itemType = "java.lang.Object";
}
if (m_itemName == null) {
m_itemName = "item";
}
}
private static CollectionFieldCustom factory(IUnmarshallingContext ictx) {
return new CollectionFieldCustom(getContainingClass(ictx));
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/CollectionPropertyCustom.java 0000644 0001750 0001750 00000012455 10651175632 031026 0 ustar moeller moeller /*
* Copyright (c) 2007, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import org.apache.bcel.generic.Type;
import org.jibx.binding.model.IClassItem;
import org.jibx.binding.util.StringArray;
import org.jibx.runtime.IUnmarshallingContext;
/**
* Collection field customization information.
*
* @author Dennis M. Sosnoski
*/
public class CollectionPropertyCustom extends MemberPropertyCustom
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new String[] { "item-name", "item-type" }, MemberPropertyCustom.s_allowedAttributes);
// values specific to member level
private String m_itemType;
private String m_itemName;
/**
* Constructor.
*
* @param parent
*/
protected CollectionPropertyCustom(NestingBase parent) {
super(parent);
}
/**
* Constructor with name known.
*
* @param parent
* @param name
*/
protected CollectionPropertyCustom(NestingBase parent, String name) {
super(parent, name);
}
/**
* Make sure all attributes are defined.
*
* @param uctx unmarshalling context
*/
protected void preSet(IUnmarshallingContext uctx) {
validateAttributes(uctx, s_allowedAttributes);
}
/**
* Check if collection member.
*
* @return true
*/
public boolean isCollection() {
return true;
}
/**
* Get item type.
*
* @return item type (null if none)
*/
public String getItemType() {
return m_itemType;
}
/**
* Get item element name.
*
* @return item name (null if none)
*/
public String getItemName() {
return m_itemName;
}
/**
* Complete customization information based on access method information.
*
* @param gmeth read access method (null if none)
* @param smeth write access method (null if none)
* @param type value type
* @param req required member flag (null if unknown)
* @param style representation style (null if unspecified)
*/
/* package */void completeProperty(IClassItem gmeth, IClassItem smeth, String type, Boolean req, Integer style) {
super.completeProperty(gmeth, smeth, type, req, style);
if (type != null) {
// set information from field
String tname = getWorkingType();
if (m_itemType == null) {
if (tname.endsWith("[]")) {
m_itemType = tname.substring(0, tname.length() - 2);
} else {
String sig;
if (gmeth == null) {
sig = smeth.getGenericsSignature();
} else {
sig = gmeth.getGenericsSignature();
}
int start = sig.indexOf('<');
int end = sig.lastIndexOf('>');
if (start > 0 && end > 0 && start < end) {
String tsig = sig.substring(start + 1, end);
if (tsig.indexOf('<') < 0) {
m_itemType = Type.getType(tsig).toString();
}
}
}
}
if (m_itemName == null) {
m_itemName = deriveItemName(getXmlName(), m_itemType, getParent().getNameStyle());
}
}
if (m_itemType == null) {
m_itemType = "java.lang.Object";
}
if (m_itemName == null) {
m_itemName = "item";
}
}
private static CollectionPropertyCustom factory(IUnmarshallingContext ictx) {
return new CollectionPropertyCustom(getContainingClass(ictx));
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/CustomBase.java 0000644 0001750 0001750 00000033427 10752422106 026033 0 ustar moeller moeller /*
* Copyright (c) 2007, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import java.util.Collection;
import org.jibx.binding.util.NameUtilities;
import org.jibx.binding.util.StringArray;
import org.jibx.runtime.EnumSet;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.impl.UnmarshallingContext;
import org.jibx.schema.validation.ValidationContext;
/**
* Base class for all customizations. This defines a way to navigate up the tree of nested components without making
* assumptions about the specific type of the containing components. This allows for other types of customizations,
* beyond the binding customizations included directly in this package. This also includes enumeration definitions which
* are used with both base and extension customizations.
*
* @author Dennis M. Sosnoski
*/
public class CustomBase
{
// name style value set information
public static final int CAMEL_CASE_NAMES = 0;
public static final int UPPER_CAMEL_CASE_NAMES = 1;
public static final int HYPHENATED_NAMES = 2;
public static final int DOTTED_NAMES = 3;
public static final int UNDERSCORED_NAMES = 4;
public static final EnumSet s_nameStyleEnum =
new EnumSet(CAMEL_CASE_NAMES, new String[] { "camel-case", "upper-camel-case", "hyphenated", "dotted",
"underscored" });
// require value set information
public static final int REQUIRE_NONE = 0;
public static final int REQUIRE_PRIMITIVES = 1;
public static final int REQUIRE_OBJECTS = 2;
public static final int REQUIRE_ALL = 3;
public static final EnumSet s_requireEnum =
new EnumSet(REQUIRE_NONE, new String[] { "none", "primitives", "objects", "all" });
// derive-namespace value set information
public static final int DERIVE_NONE = 0;
public static final int DERIVE_BY_PACKAGE = 1;
public static final int DERIVE_FIXED = 2;
public static final EnumSet s_namespaceStyleEnum =
new EnumSet(DERIVE_NONE, new String[] { "none", "package", "fixed" });
// parent element (null if none) - would be final, except for unmarshalling
private SharedNestingBase m_parent;
/**
* Constructor.
*
* @param parent
*/
public CustomBase(SharedNestingBase parent) {
m_parent = parent;
}
/**
* Get container.
*
* @return container
*/
public SharedNestingBase getParent() {
return m_parent;
}
/**
* Get global customizations root.
*
* @return global customization
*/
public GlobalCustom getGlobal() {
CustomBase parent = m_parent;
while (!(parent instanceof GlobalCustom)) {
parent = parent.getParent();
}
return (GlobalCustom)parent;
}
/**
* Convert class, method, or parameter name to XML name.
*
* @param base class or simple field name to be converted
* @param code conversion format style code
* @return XML name
*/
public static String convertName(String base, int code) {
// strip off trailing array indication
while (base.endsWith("[]")) {
base = base.substring(0, base.length() - 2);
}
// skip any leading special characters in name
int length = base.length();
int offset = -1;
char chr = 0;
while (++offset < length && ((chr = base.charAt(offset)) == '_' || (chr == '$')));
if (offset >= length) {
return "_";
} else {
// make sure valid first character of name
StringBuffer buff = new StringBuffer();
if (Character.isDigit(chr)) {
buff.append('_');
}
// scan for word splits in supplied name
boolean split = true;
boolean caps = false;
while (offset < length) {
// split if underscore or change to upper case, or upper ending
chr = base.charAt(offset++);
boolean nextlower = offset < length && !Character.isUpperCase(base.charAt(offset));
if (chr == '_') {
split = true;
continue;
} else if (Character.isUpperCase(chr)) {
if (!caps || nextlower) {
split = true;
}
if (code != CAMEL_CASE_NAMES && code != UPPER_CAMEL_CASE_NAMES) {
chr = Character.toLowerCase(chr);
}
}
if (split) {
// convert word break
caps = !nextlower;
boolean tolower = false;
char separator = 0;
switch (code) {
case CAMEL_CASE_NAMES: {
if (buff.length() != 0) {
chr = Character.toUpperCase(chr);
tolower = false;
} else {
tolower = nextlower || offset == length;
}
break;
}
case UPPER_CAMEL_CASE_NAMES: {
tolower = false;
chr = Character.toUpperCase(chr);
break;
}
case HYPHENATED_NAMES: {
separator = '-';
break;
}
case DOTTED_NAMES: {
separator = '.';
break;
}
case UNDERSCORED_NAMES: {
separator = '_';
break;
}
}
if (separator > 0 && buff.length() > 0) {
buff.append(separator);
}
if (tolower) {
chr = Character.toLowerCase(chr);
}
split = false;
}
if (chr != '$') {
// no split, just append the character
buff.append(chr);
}
}
return buff.toString();
}
}
/**
* Derive name for item in a collection. If the supplied collection name ends in a recognized plural form the
* derived item name is the singular version of the collection name. Otherwise, it is the converted name of the
* collection item class, or just "item" if the class is unknown. TODO: internationalization?
*
* @param cname collection name
* @param type item type (null if unknown)
* @param code conversion format style code
* @return item name
*/
public static String deriveItemName(String cname, String type, int code) {
String name = NameUtilities.depluralize(cname);
if (!name.equals(cname)) {
return name;
} else if (type != null && !"java.lang.Object".equals(type)) {
return convertName(type.substring(type.lastIndexOf('.') + 1), code);
} else {
return "item";
}
}
/**
* Get the package from a fully-qualified type name.
*
* @param type fully-qualified type name
* @return package of the type (empty string if in default package)
*/
public static String packageOfType(String type) {
int split = type.lastIndexOf('.');
if (split >= 0) {
return type.substring(0, split);
} else {
return "";
}
}
/**
* Create a namespace URL from a package path.
*
* @param pkgpth fully-qualified package name
* @return namespace based on package (null if none)
*/
public static String packageToNamespace(String pkgpth) {
int mark = pkgpth.indexOf('.');
if (mark >= 0) {
StringBuffer buff = new StringBuffer();
buff.append("http://");
String comp = pkgpth.substring(0, mark);
int base = mark + 1;
char delim = '.';
if ("com".equals(comp) || "net".equals(comp) || "org".equals(comp)) {
mark = pkgpth.indexOf('.', base);
if (mark > 0) {
buff.append(pkgpth.substring(base, mark));
} else {
buff.append(pkgpth.substring(base));
}
buff.append('.');
base = mark + 1;
delim = '/';
}
buff.append(comp);
while (mark > 0) {
buff.append(delim);
base = mark + 1;
mark = pkgpth.indexOf('.', base);
if (mark > 0) {
buff.append(pkgpth.substring(base, mark));
} else {
buff.append(pkgpth.substring(base));
}
}
return buff.toString();
} else {
return null;
}
}
/**
* Derive namespace using specified technique.
*
* @param uri base namespace URI (null if none)
* @param pkgpth fully qualified package name
* @param style namespace style code
* @return derived namespace
*/
public static String deriveNamespace(String uri, String pkgpth, int style) {
switch (style) {
case DERIVE_NONE:
return null;
case DERIVE_FIXED:
return uri;
case DERIVE_BY_PACKAGE: {
if (uri == null) {
return packageToNamespace(pkgpth);
} else if (pkgpth == null) {
return uri;
} else {
// append the last package to passed URI
String pack;
int start = pkgpth.lastIndexOf('.');
if (start >= 0) {
pack = pkgpth.substring(start + 1);
} else {
pack = pkgpth;
}
if (uri.endsWith("/")) {
return uri + pack;
} else {
return uri + '/' + pack;
}
}
}
default:
throw new IllegalStateException("Invalid style code");
}
}
/**
* Validate attributes of element. This is designed to be called during unmarshalling as part of the pre-set method
* processing when a subclass instance is being created.
*
* @param ictx unmarshalling context
* @param attrs attributes array
*/
protected void validateAttributes(IUnmarshallingContext ictx, StringArray attrs) {
// setup for attribute access
ValidationContext vctx = (ValidationContext)ictx.getUserContext();
UnmarshallingContext uctx = (UnmarshallingContext)ictx;
// loop through all attributes of current element
for (int i = 0; i < uctx.getAttributeCount(); i++) {
// check if nonamespace attribute is in the allowed set
String name = uctx.getAttributeName(i);
if (uctx.getAttributeNamespace(i).length() == 0) {
if (attrs.indexOf(name) < 0) {
vctx.addWarning("Undefined attribute " + name, this);
}
}
}
}
/**
* Gets the parent element link from the unmarshalling stack. This method is for use by factories during
* unmarshalling.
*
* @param ictx unmarshalling context
* @return containing class
*/
protected static Object getContainingObject(IUnmarshallingContext ictx) {
Object parent = ictx.getStackTop();
if (parent instanceof Collection) {
parent = ictx.getStackObject(1);
}
return parent;
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/GlobalCustom.java 0000644 0001750 0001750 00000051473 10651175632 026371 0 ustar moeller moeller /*
* Copyright (c) 2007, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.jibx.binding.classes.ClassCache;
import org.jibx.binding.model.ClassWrapper;
import org.jibx.binding.model.IClass;
import org.jibx.binding.model.IClassLocator;
import org.jibx.binding.util.StringArray;
import org.jibx.runtime.EnumSet;
import org.jibx.runtime.IBindingFactory;
import org.jibx.runtime.IUnmarshaller;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.impl.UnmarshallingContext;
/**
* Global customization information. This includes some options specific to the <binding> element of the definition,
* as well as controls for structuring of the generated binding(s). It handles the binding customization child elements
* directly, by invoking the abstract unmarshallers for the child elements to process the content. It also allows for
* extension elements which are not part of the binding customization structure, as long as the binding in use defines
* the unmarshalling for these elements.
*
* @author Dennis M. Sosnoski
*/
public class GlobalCustom extends NestingBase
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new String[] { "add-constructors", "direction", "force-classes", "namespace-modular",
"track-source" }, NestingBase.s_allowedAttributes);
/** Element name in XML customization file. */
public static final String ELEMENT_NAME = "custom";
//
// Value set information
public static final int IN_BINDING = 0;
public static final int OUT_BINDING = 1;
public static final int BOTH_BINDING = 2;
/* package */static final EnumSet s_directionEnum =
new EnumSet(IN_BINDING, new String[] { "input", "output", "both" });
//
// Instance data
// structure for package hierarchy
private Map m_packageMap;
// class locator
private final IClassLocator m_classLocator;
// extension elements
private List m_extensionChildren;
// values applied directly to element (or to structure)
private boolean m_addConstructors;
private boolean m_forceClasses;
private boolean m_trackSource;
private boolean m_namespaceModular;
private boolean m_isInput;
private boolean m_isOutput;
private ArrayList m_unmarshalledClasses;
/**
* Constructor with class locator supplied.
*
* @param loc
*/
public GlobalCustom(IClassLocator loc) {
super(null);
m_packageMap = new HashMap();
m_classLocator = loc;
PackageCustom dflt = new PackageCustom("", "", this);
m_packageMap.put("", dflt);
m_isInput = true;
m_isOutput = true;
m_unmarshalledClasses = new ArrayList();
}
/**
* Constructor. This always creates the default package as the only direct child, since other packages will be
* treated as children of the default package.
*/
public GlobalCustom() {
this(new IClassLocator() {
public IClass getClassInfo(String name) {
try {
return new ClassWrapper(this, ClassCache.getClassFile(name));
} catch (JiBXException e) {
throw new IllegalStateException("Class not found " + name);
}
}
});
}
/**
* Make sure all attributes are defined.
*
* @param uctx unmarshalling context
*/
private void preSet(IUnmarshallingContext uctx) {
validateAttributes(uctx, s_allowedAttributes);
}
/**
* Get global customizations root.
*
* @return global customization
*/
public GlobalCustom getGlobal() {
return this;
}
/**
* Get list of unmarshalled classes. This list is populated by the custom unmarshalling code as the customizations
* document is unmarshalled.
*
* @return list
*/
public ArrayList getUnmarshalledClasses() {
return m_unmarshalledClasses;
}
//
// Access methods for values applied only at top level
/**
* Get 'add-constructors' setting.
*
* @return 'add-constructors' value
*/
public boolean isAddConstructors() {
return m_addConstructors;
}
/**
* Set 'add-constructors' value.
*
* @param add 'add-constructors' value
*/
public void setAddConstructors(boolean add) {
m_addConstructors = add;
}
/**
* Get 'force-classes' setting.
*
* @return 'force-classes' value
*/
public boolean isForceClasses() {
return m_forceClasses;
}
/**
* Set 'force-classes' value.
*
* @param force 'force-classes' value
*/
public void setForceClasses(boolean force) {
m_forceClasses = force;
}
/**
* Get 'track-source' attribute value.
*
* @return 'track-source' value
*/
public boolean isTrackSource() {
return m_trackSource;
}
/**
* Set 'track-source' value.
*
* @param track 'track-source' value
*/
public void setTrackSource(boolean track) {
m_trackSource = track;
}
/**
* Check if using namespace modular bindings.
*
* @return flag for bindings to be modular by namespace
*/
public boolean isNamespaceModular() {
return m_namespaceModular;
}
/**
* Check for an input binding.
*
* @return input flag
*/
public boolean isInput() {
return m_isInput;
}
/**
* Set input binding flag.
*
* @param input
*/
public void setInput(boolean input) {
m_isInput = input;
}
/**
* Check for an output binding.
*
* @return output flag
*/
public boolean isOutput() {
return m_isOutput;
}
/**
* Set output binding falg.
*
* @param output
*/
public void setOutput(boolean output) {
m_isOutput = output;
}
/**
* Get class locator.
*
* @return locator
*/
protected IClassLocator getClassLocator() {
return m_classLocator;
}
/**
* Get class information.
*
* @param type fully-qualified class name
* @return information
*/
public IClass getClassInfo(String type) {
return m_classLocator.getClassInfo(type);
}
/**
* Get the extension elements used in this customization. This does not include the <package> or <class> child
* elements, which are added directly to the customization structures.
*
* @return child list
*/
public List getExtensionChildren() {
if (m_extensionChildren == null) {
return Collections.EMPTY_LIST;
} else {
return m_extensionChildren;
}
}
/**
* Internal method used during unmarshalling to add a child extension element.
*
* @param child
*/
protected void internalAddExtensionChild(Object child) {
if (m_extensionChildren == null) {
m_extensionChildren = new ArrayList();
}
m_extensionChildren.add(child);
}
/**
* Add a child extension element. This both adds the child to the list and invokeds the extension element's
* {@link IApply#apply(IClassLocator)} method, if present.
*
* @param child
*/
public void addExtensionChild(Object child) {
internalAddExtensionChild(child);
if (child instanceof IApply) {
((IApply)child).apply(m_classLocator);
}
}
/**
* Check if a class is included in the customization information. This method does not alter the structures in any
* way, it only checks if the class customization information is part of the existing structure.
*
* @param type fully qualified class name
* @return true if class includes, false if not
*/
public boolean isClassUsed(String type) {
int split = type.lastIndexOf('.');
if (split < 0) {
split = 0;
}
PackageCustom pack = (PackageCustom)m_packageMap.get(type.substring(0, split));
if (pack == null) {
return false;
} else {
return pack.getClassCustomization(type.substring(split + 1)) != null;
}
}
/**
* Get class customization information.
*
* @param type fully qualified class name
* @return class information (null if not defined)
*/
public ClassCustom getClassCustomization(String type) {
int split = type.lastIndexOf('.');
if (split < 0) {
split = 0;
}
PackageCustom pack = (PackageCustom)m_packageMap.get(type.substring(0, split));
if (pack == null) {
return null;
} else {
return pack.getClassCustomization(type.substring(split + 1));
}
}
/**
* Add new class customization information. This creates the customization information and adds it to the internal
* structures, initializing all values based on the settings inherited from <package> and <global> elements of
* the structure. This method should only be used after first calling {@link #getClassCustomization(String)} and
* obtaining a null result.
*
* @param type fully qualified class name
* @return class information
*/
public ClassCustom addClassCustomization(String type) {
int split = type.lastIndexOf('.');
if (split < 0) {
split = 0;
}
PackageCustom pack = getPackage(type.substring(0, split));
ClassCustom clas = pack.addClassCustomization(type.substring(split + 1));
clas.apply(m_classLocator);
return clas;
}
/**
* Get class customization information, creating it if it doesn't already exist.
*
* @param type fully qualified class name
* @return class information
*/
public ClassCustom forceClassCustomization(String type) {
ClassCustom custom = getClassCustomization(type);
if (custom == null) {
custom = addClassCustomization(type);
}
return custom;
}
/**
* Check if type represents a known mapping.
*
* @param type fully qualified class name
* @return known mapping flag
*/
public boolean isKnownMapping(String type) {
// TODO: add known mappings for org.w3c.dom.*, etc.
return false;
}
/**
* Direction set text method. This is intended for use during unmarshalling. TODO: add validation
*
* @param text
* @param ictx
*/
private void setDirectionText(String text, IUnmarshallingContext ictx) {
int direct = s_directionEnum.getValue(text);
if (direct < 0) {
throw new IllegalArgumentException("Value '" + text + "' not recognized for 'direction' attribute");
} else {
m_isInput = direct != OUT_BINDING;
m_isOutput = direct != IN_BINDING;
}
}
/**
* Direction get text method. This is intended for use during marshalling.
*
* @return text
*/
private String getDirectionText() {
if (m_isInput && m_isOutput) {
return s_directionEnum.getName(BOTH_BINDING);
} else if (m_isInput) {
return s_directionEnum.getName(IN_BINDING);
} else {
return s_directionEnum.getName(OUT_BINDING);
}
}
/**
* Initialize the global default namespace, along with special classes with built-in defaults. This needs to be done
* as a separate step before unmarshalling, so that the special classes are available for use.
*/
public void initClasses() {
// set default namespace
if (getNamespace() == null) {
setNamespace(getSpecifiedNamespace());
}
// create information for some special classes
ClassCustom custom = forceClassCustomization("java.util.List");
if (custom.getCreateType() == null && custom.getFactoryMethod() == null) {
custom.setCreateType("java.util.ArrayList");
}
custom = forceClassCustomization("java.util.Set");
if (custom.getCreateType() == null && custom.getFactoryMethod() == null) {
custom.setCreateType("java.util.HashSet");
}
custom = forceClassCustomization("java.util.Collection");
if (custom.getCreateType() == null && custom.getFactoryMethod() == null) {
custom.setCreateType("java.util.ArrayList");
}
}
/**
* Fills in class information based on inspection of the actual class data. This needs to be done as a separate step
* following unmarshalling, so that the full details of the unmarshalled customizations are available.
*/
public void fillClasses() {
// fill in details for all packages
for (Iterator iter = m_packageMap.values().iterator(); iter.hasNext();) {
PackageCustom pack = (PackageCustom)iter.next();
pack.apply(m_classLocator);
}
// fill in details for any extension elements
if (m_extensionChildren != null) {
for (int i = 0; i < m_extensionChildren.size(); i++) {
Object child = m_extensionChildren.get(i);
if (child instanceof IApply) {
((IApply)child).apply(m_classLocator);
}
}
}
}
//
// Package structure support
/**
* Get package customizations. If the requested package is already defined the existing instance will be returned,
* otherwise a new instance will be created (along with any ancestor packages) and added to the structure.
*
* @param name
* @return package
*/
public PackageCustom getPackage(String name) {
// find existing package information
PackageCustom pack = (PackageCustom)m_packageMap.get(name);
if (pack == null) {
// create new package information
PackageCustom parent = null;
int split = name.lastIndexOf('.');
String simple = name;
String full = name;
if (split > 0) {
parent = getPackage(name.substring(0, split));
simple = name.substring(split + 1);
full = parent.getName() + '.' + simple;
} else if (name.length() > 0) {
parent = getPackage("");
}
pack = new PackageCustom(simple, full, parent);
m_packageMap.put(name, pack);
pack.apply(m_classLocator);
}
return pack;
}
/**
* Unmarshaller implementation for class. This handles the nested structure of packages and classes, using the
* abstract mappings defined by the binding to handle all the actual details.
*/
public static class Mapper implements IUnmarshaller
{
private int m_packageIndex;
private int m_classIndex;
public boolean isPresent(IUnmarshallingContext ictx) throws JiBXException {
return true;
}
/**
* Build the fully-qualified name for a package or class by appending the supplied name attribute value to the
* fully-qualified name of the containing package.
*
* @param contain
* @param ctx
* @throws JiBXException
*/
private String buildFullName(PackageCustom contain, UnmarshallingContext ctx) throws JiBXException {
String lead = "";
if (contain != null) {
lead = contain.getName() + '.';
}
return lead + ctx.attributeText(null, "name");
}
private PackageCustom unmarshalPackage(GlobalCustom global, PackageCustom contain, UnmarshallingContext ctx)
throws JiBXException {
// create class instance and populate mapped values
PackageCustom inst = global.getPackage(buildFullName(contain, ctx));
ctx.pushTrackedObject(inst);
ctx.getUnmarshaller(m_packageIndex).unmarshal(inst, ctx);
// handle nested package and class information
while (ctx.isStart()) {
String element = ctx.getName();
if (PackageCustom.ELEMENT_NAME.equals(element)) {
unmarshalPackage(global, inst, ctx);
} else if (ClassCustom.ELEMENT_NAME.equals(element)) {
unmarshalClass(global, inst, ctx);
}
}
ctx.popObject();
ctx.parsePastEndTag(null, PackageCustom.ELEMENT_NAME);
return inst;
}
private ClassCustom unmarshalClass(GlobalCustom global, PackageCustom contain, UnmarshallingContext ctx)
throws JiBXException {
// create class instance and populate mapped values
String name = buildFullName(contain, ctx);
int split = name.lastIndexOf('.');
if (split < 0) {
split = 0;
}
PackageCustom pack = global.getPackage(name.substring(0, split));
String simple = name.substring(split + 1);
ClassCustom inst = pack.getClassCustomization(simple);
if (inst == null) {
inst = pack.addClassCustomization(simple);
}
ctx.pushTrackedObject(inst);
ctx.getUnmarshaller(m_classIndex).unmarshal(inst, ctx);
ctx.popObject();
ctx.parsePastEndTag(null, ClassCustom.ELEMENT_NAME);
// add to list unmarshalled
global.getUnmarshalledClasses().add(inst);
return inst;
}
public Object unmarshal(Object obj, IUnmarshallingContext ictx) throws JiBXException {
// set up the mapping indexes
UnmarshallingContext ctx = (UnmarshallingContext)ictx;
IBindingFactory factory = ((UnmarshallingContext)ictx).getFactory();
m_packageIndex = factory.getTypeIndex(PackageCustom.ELEMENT_NAME);
m_classIndex = factory.getTypeIndex(ClassCustom.ELEMENT_NAME);
if (m_packageIndex < 0 || m_classIndex < 0) {
throw new JiBXException("Missing required abstract mappings");
}
// initialize namespace and special classes
GlobalCustom global = (GlobalCustom)obj;
global.initClasses();
// process all child elements
while (ctx.isStart()) {
// check type of child present
String element = ctx.getName();
if (PackageCustom.ELEMENT_NAME.equals(element)) {
unmarshalPackage(global, null, ctx);
} else if (ClassCustom.ELEMENT_NAME.equals(element)) {
unmarshalClass(global, null, ctx);
} else {
global.internalAddExtensionChild(ctx.unmarshalElement());
}
}
return global;
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/IApply.java 0000644 0001750 0001750 00000004133 10651175632 025163 0 ustar moeller moeller /*
* Copyright (c) 2007, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import org.jibx.binding.model.IClassLocator;
/**
* Apply customizations interface. This is used by the {@link GlobalCustom} class to fill out the customization details
* for all unmarshalled components, including extension components from other packages.
*
* @author Dennis M. Sosnoski
*/
public interface IApply
{
/**
* Apply customizations to default values. This is called to fill in the details for this customization (and all
* child customization components).
*
* @param loc class locator
*/
public void apply(IClassLocator loc);
}
libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/IClassSourceLocator.java 0000644 0001750 0001750 00000004157 10651175632 027656 0 ustar moeller moeller /*
* Copyright (c) 2007, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import org.jibx.binding.model.IClassLocator;
import com.thoughtworks.qdox.model.JavaClass;
/**
* Locator for class and/or source information. Looks up class and source data as requested, using whatever method is
* appropriate for the usage environment.
*
* @author Dennis M. Sosnoski
*/
public interface IClassSourceLocator extends IClassLocator
{
/**
* Get source information.
*
* @param name fully-qualified name of class to be found
* @return source information, or null if source not found
*/
public JavaClass getSourceInfo(String name);
}
libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/MemberCustom.java 0000644 0001750 0001750 00000032171 10651175632 026372 0 ustar moeller moeller /*
* Copyright (c) 2007, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import org.jibx.binding.classes.ClassItem;
import org.jibx.binding.util.StringArray;
import org.jibx.runtime.EnumSet;
import org.jibx.runtime.IUnmarshallingContext;
/**
* Member field or property customization information.
*
* @author Dennis M. Sosnoski
*/
public abstract class MemberCustom extends CustomBase
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new String[] { "actual-type", "attribute", "create-type", "element", "factory", "required" });
// values specific to member level
private String m_baseName; // internal use, not included in binding
private String m_statedType; // internal use, not included in binding
private String m_workingType; // internal use, not included in binding
private boolean m_isPrimitive; // internal use, not included in binding
private Integer m_style; // internal use, not included in binding
private String m_xmlName;
private String m_actualType;
private String m_createType;
private String m_factoryMethod;
private Boolean m_required;
/**
* Constructor.
*
* @param parent
*/
protected MemberCustom(SharedNestingBase parent) {
super(parent);
}
/**
* Constructor with name known.
*
* @param parent
* @param name
*/
protected MemberCustom(SharedNestingBase parent, String name) {
this(parent);
m_baseName = name;
}
/**
* Get member (field or property) name. In the case of a field, this is the name with any prefix or suffix stripped;
* in the case of a property, it's the property name. For both field and property names, the initial letter is
* converted to lowercase unless the second letter is lowercase.
*
* @return name
*/
public String getBaseName() {
return m_baseName;
}
/**
* Set member (field or property) name. This is only for use by subclasses.
*
* @param name
*/
protected void setBaseName(String name) {
m_baseName = name;
}
/**
* Get stated type of member.
*
* @return stated type
*/
public String getStatedType() {
return m_statedType;
}
/**
* Get working type of member.
*
* @return working type
*/
public String getWorkingType() {
return m_workingType;
}
/**
* Convert case of member name derived from method or field name. If the supplied name starts with an uppercase
* letter followed by a lowercase letter, the initial letter is converted to lowercase in order to obtain a standard
* form of the name.
*
* @param name
* @return converted name
*/
public static String convertMemberNameCase(String name) {
if (name.length() > 0) {
char lead = name.charAt(0);
if (name.length() > 1) {
if (Character.isUpperCase(lead) && Character.isLowerCase(name.charAt(1))) {
StringBuffer buff = new StringBuffer(name);
buff.setCharAt(0, Character.toLowerCase(lead));
name = buff.toString();
}
} else {
name = name.toLowerCase();
}
}
return name;
}
/**
* Get the member name for a property from the read method name. This means stripping off the leading "get" or "is"
* prefix, then case-converting the result.
*
* @param name
* @return member name
* @see #convertMemberNameCase(String)
* @see #memberNameFromSetMethod(String)
* @see #memberNameFromField(String, String[], String[])
*/
public static String memberNameFromGetMethod(String name) {
if (name.startsWith("get")) {
name = name.substring(3);
} else if (name.startsWith("is")) {
name = name.substring(2);
}
return convertMemberNameCase(name);
}
/**
* Get the member name for a property from the write method name. This means stripping off the leading "set" prefix,
* then case-converting the result.
*
* @param name
* @return member name
* @see #convertMemberNameCase(String)
* @see #memberNameFromGetMethod(String)
* @see #memberNameFromField(String, String[], String[])
*/
public static String memberNameFromSetMethod(String name) {
if (name.startsWith("set")) {
name = name.substring(3);
}
return convertMemberNameCase(name);
}
/**
* Get the member name for a field from the field name. This means stripping off and leading field name prefix
* and/or trailing suffix, then case-converting the result.
*
* @param name
* @param prefs field prefixes to be stripped
* @param suffs field suffixes to be stripped
* @return member name
* @see #convertMemberNameCase(String)
* @see #memberNameFromGetMethod(String)
* @see #memberNameFromSetMethod(String)
*/
public static String memberNameFromField(String name, String[] prefs, String[] suffs) {
if (prefs != null) {
for (int i = 0; i < prefs.length; i++) {
if (name.startsWith(prefs[i])) {
name = name.substring(prefs[i].length());
break;
}
}
}
if (suffs != null) {
for (int i = 0; i < suffs.length; i++) {
if (name.endsWith(prefs[i])) {
name = name.substring(name.length() - prefs[i].length());
break;
}
}
}
return convertMemberNameCase(name);
}
/**
* Get style code.
*
* @return value from {@link NestingBase#s_valueStyleEnum} enumeration
*/
public int getStyle() {
if (m_style == null) {
return ((NestingBase)getParent()).getValueStyle(m_workingType);
} else {
return m_style.intValue();
}
}
/**
* Get XML element or attribute name.
*
* @return name (null if none)
*/
public String getXmlName() {
return m_xmlName;
}
/**
* Get member actual type.
*
* @return member actual type (null if none)
*/
public String getActualType() {
return m_actualType;
}
/**
* Get member create type.
*
* @return type used for creating new instance (null if none)
*/
public String getCreateType() {
return m_createType;
}
/**
* Get factory method.
*
* @return method used for creating new instance (null if none)
*/
public String getFactoryMethod() {
return m_factoryMethod;
}
/**
* Check if value is required.
*
* @return true if required, false if not
*/
public boolean isRequired() {
if (m_required == null) {
if (m_isPrimitive) {
return getParent().isPrimitiveRequired(m_workingType);
} else {
return getParent().isObjectRequired(m_workingType);
}
} else {
return m_required.booleanValue();
}
}
/**
* Set element name method. This is intended for use during unmarshalling. TODO: add validation
*
* @param text
* @param ictx
*/
private void setElement(String text, IUnmarshallingContext ictx) {
m_xmlName = text;
m_style = new Integer(NestingBase.ELEMENT_VALUE_STYLE);
}
/**
* Set attribute name method. This is intended for use during unmarshalling. TODO: add validation
*
* @param text
* @param ictx
*/
private void setAttribute(String text, IUnmarshallingContext ictx) {
m_xmlName = text;
m_style = new Integer(NestingBase.ATTRIBUTE_VALUE_STYLE);
}
/**
* Style get text method. This is intended for use during marshalling. TODO: add validation
*
* @return text
*/
private String getStyleText() {
if (m_style == null) {
return null;
} else {
return NestingBase.s_valueStyleEnum.getName(m_style.intValue());
}
}
//
// Methods overridden by subclasses
/**
* Check if member represents a property.
*
* @return true if property, false if not
*/
public abstract boolean isProperty();
/**
* Check if a private member.
*
* @return true if private, false if not
*/
public abstract boolean isPrivate();
/**
* Check if collection member.
*
* @return true if collection, false if not
*/
public boolean isCollection() {
return false;
}
/**
* Get field name.
*
* @return field name (null if none)
*/
public String getFieldName() {
return null;
}
/**
* Get 'get' method name.
*
* @return 'get' method name (null if none)
*/
public String getGetName() {
return null;
}
/**
* Get 'set' method name.
*
* @return 'set' method name (null if none)
*/
public String getSetName() {
return null;
}
/**
* Get collection item type.
*
* @return item type (null if none)
*/
public String getItemType() {
return null;
}
/**
* Get collection item element name.
*
* @return item name (null if none)
*/
public String getItemName() {
return null;
}
/**
* Complete customization information based on supplied type. If the type information has not previously been set,
* this will set it. It will also derive the appropriate XML name, if not previously set.
*
* @param type (null if none available)
* @param req required member flag (null if unspecified)
* @param style representation style (null if unspecified)
*/
/* package */void complete(String type, Boolean req, Integer style) {
m_statedType = type;
if (m_actualType == null) {
if (type == null) {
m_workingType = "java.lang.Object";
} else {
m_workingType = type;
}
} else {
m_workingType = m_actualType;
}
if (m_xmlName == null) {
m_xmlName = getParent().convertName(m_baseName);
}
m_isPrimitive = ClassItem.isPrimitive(m_workingType);
// TODO: check consistency of setting
if (m_required == null) {
m_required = req;
}
if (m_style == null) {
m_style = style;
}
if (!m_isPrimitive && m_createType == null && m_factoryMethod == null) {
ClassCustom cust = getGlobal().getClassCustomization(m_workingType);
if (cust != null) {
m_createType = cust.getCreateType();
m_factoryMethod = cust.getFactoryMethod();
}
}
}
/**
* Gets the parent class link from the unmarshalling stack. This method is for use by factories during
* unmarshalling.
*
* @param ictx unmarshalling context
* @return containing class
*/
protected static ClassCustom getContainingClass(IUnmarshallingContext ictx) {
return (ClassCustom)getContainingObject(ictx);
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/MemberFieldCustom.java 0000644 0001750 0001750 00000011342 10651175632 027333 0 ustar moeller moeller /*
* Copyright (c) 2007, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import java.lang.reflect.Modifier;
import org.jibx.binding.model.IClassItem;
import org.jibx.binding.util.StringArray;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
/**
* Member field customization information.
*
* @author Dennis M. Sosnoski
*/
public class MemberFieldCustom extends MemberCustom
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new String[] { "field" }, MemberCustom.s_allowedAttributes);
// values specific to member level
private boolean m_isPrivate; // internal use, not included in binding
private String m_fieldName;
/**
* Constructor.
*
* @param parent
*/
protected MemberFieldCustom(NestingBase parent) {
super(parent);
}
/**
* Constructor with name known.
*
* @param parent
* @param name
*/
protected MemberFieldCustom(NestingBase parent, String name) {
super(parent, name);
}
/**
* Make sure all attributes are defined.
*
* @param uctx unmarshalling context
*/
protected void preSet(IUnmarshallingContext uctx) {
validateAttributes(uctx, s_allowedAttributes);
}
/**
* Check if member represents a property.
*
* @return false
*/
public boolean isProperty() {
return false;
}
/**
* Check if a private member.
*
* @return true if private, false if not
*/
public boolean isPrivate() {
return m_isPrivate;
}
/**
* Check if collection member.
*
* @return false
*/
public boolean isCollection() {
return false;
}
/**
* Get field name.
*
* @return field name (null if none)
*/
public String getFieldName() {
return m_fieldName;
}
/**
* Post-set method that converts the field name to a member name.
*
* @throws JiBXException
*/
protected void postSet() throws JiBXException {
if (m_fieldName == null) {
throw new JiBXException("'field' attribute is required for element");
} else {
ClassCustom clas = (ClassCustom)getParent();
setBaseName(memberNameFromField(m_fieldName, clas.getStripPrefixes(), clas.getStripSuffixes()));
}
}
/**
* Complete customization information based on field information.
*
* @param field (null if none available)
* @param req required member flag (null if unspecified)
* @param style representation style (null if unspecified)
*/
/* package */void completeField(IClassItem field, Boolean req, Integer style) {
if (m_fieldName == null) {
m_fieldName = field.getName();
}
m_isPrivate = Modifier.isPrivate(field.getAccessFlags());
complete(field == null ? null : field.getTypeName(), req, style);
}
private static MemberFieldCustom factory(IUnmarshallingContext ictx) {
return new MemberFieldCustom(getContainingClass(ictx));
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/MemberPropertyCustom.java 0000644 0001750 0001750 00000012567 10651175632 030146 0 ustar moeller moeller /*
* Copyright (c) 2007, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import java.lang.reflect.Modifier;
import org.jibx.binding.model.IClassItem;
import org.jibx.binding.util.StringArray;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
/**
* Member property customization information.
*
* @author Dennis M. Sosnoski
*/
public class MemberPropertyCustom extends MemberCustom
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new String[] { "get-name", "set-name" }, MemberCustom.s_allowedAttributes);
// values specific to member level
private boolean m_isPrivate; // internal use, not included in binding
private String m_getName;
private String m_setName;
/**
* Constructor.
*
* @param parent
*/
protected MemberPropertyCustom(NestingBase parent) {
super(parent);
}
/**
* Constructor with name known.
*
* @param parent
* @param name
*/
protected MemberPropertyCustom(NestingBase parent, String name) {
super(parent, name);
}
/**
* Make sure all attributes are defined.
*
* @param uctx unmarshalling context
*/
protected void preSet(IUnmarshallingContext uctx) {
validateAttributes(uctx, s_allowedAttributes);
}
/**
* Check if member represents a property.
*
* @return true
*/
public boolean isProperty() {
return true;
}
/**
* Check if a private member.
*
* @return true if private, false if not
*/
public boolean isPrivate() {
return m_isPrivate;
}
/**
* Check if collection member.
*
* @return false
*/
public boolean isCollection() {
return false;
}
/**
* Get 'get' method name.
*
* @return 'get' method name (null if none)
*/
public String getGetName() {
return m_getName;
}
/**
* Get 'set' method name.
*
* @return 'set' method name (null if none)
*/
public String getSetName() {
return m_setName;
}
/**
* Post-set method that converts the get/set method names to a member name.
*
* @throws JiBXException
*/
protected void postSet() throws JiBXException {
if (m_getName == null && m_setName == null) {
throw new JiBXException("'get-name' or 'set-name' attribute is required for element");
} else {
if (m_setName == null) {
setBaseName(memberNameFromGetMethod(m_getName));
} else {
setBaseName(memberNameFromSetMethod(m_setName));
}
}
}
/**
* Complete customization information based on access method information.
*
* @param gmeth read access method (null if none)
* @param smeth write access method (null if none)
* @param type value type
* @param req required member flag (null if unknown)
* @param style representation style (null if unspecified)
*/
/* package */void completeProperty(IClassItem gmeth, IClassItem smeth, String type, Boolean req, Integer style) {
if (m_getName == null && gmeth != null) {
m_getName = gmeth.getName();
}
if (m_setName == null && smeth != null) {
m_setName = smeth.getName();
}
m_isPrivate = (gmeth == null || Modifier.isPrivate(gmeth.getAccessFlags())) &&
(smeth == null || Modifier.isPrivate(smeth.getAccessFlags()));
complete(type, req, style);
}
private static MemberPropertyCustom factory(IUnmarshallingContext ictx) {
return new MemberPropertyCustom(getContainingClass(ictx));
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/NestingBase.java 0000644 0001750 0001750 00000017635 10673566260 026207 0 ustar moeller moeller /*
* Copyright (c) 2007, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import org.jibx.binding.util.StringArray;
import org.jibx.runtime.EnumSet;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.util.Types;
/**
* Base class for all standard binding customizations that can contain other customizations.
*
* @author Dennis M. Sosnoski
*/
public abstract class NestingBase extends SharedNestingBase
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new String[] { "force-mapping", "map-abstract", "property-access", "strip-prefixes",
"strip-suffixes", "value-style", "wrap-collections" }, SharedNestingBase.s_allowedAttributes);
private static final String[] EMPTY_STRING_ARRAY = {};
// value style value set information
public static final int ATTRIBUTE_VALUE_STYLE = 0;
public static final int ELEMENT_VALUE_STYLE = 1;
public static final int TEXT_VALUE_STYLE = 2;
public static final Integer ATTRIBUTE_STYLE_INTEGER = new Integer(ATTRIBUTE_VALUE_STYLE);
public static final Integer ELEMENT_STYLE_INTEGER = new Integer(ELEMENT_VALUE_STYLE);
public static final Integer TEXT_STYLE_INTEGER = new Integer(TEXT_VALUE_STYLE);
public static final EnumSet s_valueStyleEnum =
new EnumSet(ATTRIBUTE_VALUE_STYLE, new String[] { "attribute", "element", "text" });
// values inherited through nesting
private Integer m_valueStyle;
private Boolean m_propertyAccess;
private String[] m_stripPrefixes;
private String[] m_stripSuffixes;
private Boolean m_mapAbstract;
private Boolean m_wrapCollections;
private Boolean m_forceMapping;
/**
* Constructor.
*
* @param parent
*/
public NestingBase(SharedNestingBase parent) {
super(parent);
}
//
// Access methods for values inherited through nesting
/**
* Check abstract mapping flag.
*
* @return abstract mapping flag
*/
public boolean isMapAbstract() {
if (m_mapAbstract == null) {
if (getParent() == null) {
return true;
} else {
return ((NestingBase)getParent()).isMapAbstract();
}
} else {
return m_mapAbstract.booleanValue();
}
}
/**
* Set abstract mapping flag.
*
* @param abs
*/
public void setMapAbstract(Boolean abs) {
m_mapAbstract = abs;
}
/**
* Check force mapping flag.
*
* @return force mapping flag
*/
public boolean isForceMapping() {
if (m_forceMapping == null) {
if (getParent() == null) {
return false;
} else {
return ((NestingBase)getParent()).isForceMapping();
}
} else {
return m_forceMapping.booleanValue();
}
}
/**
* Check wrap collections flag.
*
* @return wrap collections flag
*/
public boolean isWrapCollections() {
if (m_wrapCollections == null) {
if (getParent() == null) {
return false;
} else {
return ((NestingBase)getParent()).isWrapCollections();
}
} else {
return m_wrapCollections.booleanValue();
}
}
/**
* Check property access mode flag.
*
* @return true if bean-style get/set methods to be used, false if fields to be used
* directly
*/
public boolean isPropertyAccess() {
if (m_propertyAccess == null) {
if (getParent() == null) {
return false;
} else {
return ((NestingBase)getParent()).isPropertyAccess();
}
} else {
return m_propertyAccess.booleanValue();
}
}
/**
* Get prefixes to be stripped from field names.
*
* @return strip prefixes (null if none)
*/
public String[] getStripPrefixes() {
if (m_stripPrefixes == null) {
if (getParent() == null) {
return EMPTY_STRING_ARRAY;
} else {
return ((NestingBase)getParent()).getStripPrefixes();
}
} else {
return m_stripPrefixes;
}
}
/**
* Get suffixes to be stripped from field names.
*
* @return strip suffix (null if none)
*/
public String[] getStripSuffixes() {
if (m_stripSuffixes == null) {
if (getParent() == null) {
return EMPTY_STRING_ARRAY;
} else {
return ((NestingBase)getParent()).getStripSuffixes();
}
} else {
return m_stripSuffixes;
}
}
/**
* Get value style code.
*
* @param type value type name
* @return value from {@link NestingBase#s_valueStyleEnum} enumeration
*/
public int getValueStyle(String type) {
if (m_valueStyle == null) {
if (getParent() == null) {
if (!"java.lang.String".equals(type) && Types.isSimpleValue(type)) {
return ATTRIBUTE_VALUE_STYLE;
} else {
return ELEMENT_VALUE_STYLE;
}
} else {
return ((NestingBase)getParent()).getValueStyle(type);
}
} else {
return m_valueStyle.intValue();
}
}
/**
* Set value style.
*
* @param style (null if none at this level)
*/
public void setValueStyle(Integer style) {
m_valueStyle = style;
}
/**
* Value style set text method. This is intended for use during unmarshalling. TODO: add validation
*
* @param text
* @param ictx
*/
private void setValueStyleText(String text, IUnmarshallingContext ictx) {
if (text == null) {
m_valueStyle = null;
} else {
m_valueStyle = new Integer(s_valueStyleEnum.getValue(text));
}
}
/**
* Value style get text method. This is intended for use during marshalling.
*
* @return text
*/
private String getValueStyleText() {
if (m_valueStyle == null) {
return null;
} else {
return s_valueStyleEnum.getName(m_valueStyle.intValue());
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/PackageCustom.java 0000644 0001750 0001750 00000012365 10651175632 026521 0 ustar moeller moeller /*
* Copyright (c) 2007, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import org.jibx.binding.model.IClassLocator;
import org.jibx.binding.util.StringArray;
import org.jibx.runtime.IUnmarshallingContext;
/**
* Package customization information.
*
* @author Dennis M. Sosnoski
*/
public class PackageCustom extends NestingBase implements IApply
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new String[] { "name" }, NestingBase.s_allowedAttributes);
/** Element name in XML customization file. */
public static final String ELEMENT_NAME = "package";
// values specific to package level
private String m_simpleName;
private String m_fullName;
// flag for namespace derivation done (from apply() method)
private boolean m_fixedNamespace;
// map from simple name to class information for classes in package
private Map m_classMap;
/**
* Constructor. This has package access so that it can be used from the {@link GlobalCustom} class.
*
* @param simple simple package name
* @param full fully-qualified package name
* @param parent
*/
/* package */PackageCustom(String simple, String full, NestingBase parent) {
super(parent);
m_simpleName = simple;
m_fullName = full;
m_classMap = new HashMap();
}
/**
* Make sure all attributes are defined.
*
* @param uctx unmarshalling context
*/
private void preSet(IUnmarshallingContext uctx) {
validateAttributes(uctx, s_allowedAttributes);
}
/**
* Get fully-qualified package name.
*
* @return package name (empty string if default package)
*/
public String getName() {
return m_fullName;
}
/**
* Get existing information for class in this package.
*
* @param name simple class name (without package)
* @return class information (null if no existing information)
*/
public ClassCustom getClassCustomization(String name) {
return (ClassCustom)m_classMap.get(name);
}
/**
* Add information for class in this package. This just creates the basic class information structure and returns
* it, without populating the class details.
*
* @param name simple class name (without package)
* @return class information (null if no existing information)
*/
/* package */ClassCustom addClassCustomization(String name) {
ClassCustom clas = new ClassCustom(this, name);
m_classMap.put(name, clas);
return clas;
}
/**
* Apply customizations to default values. This fills in the information for classes in this package by deriving
* information for fields or properties in each class. This is intended to be used once, after customizations have
* been unmarshalled.
*
* @param loc class locator
*/
public void apply(IClassLocator loc) {
// derive namespace from parent setting, if not specified
String ns = getSpecifiedNamespace();
if (ns == null) {
SharedNestingBase parent = getParent();
if (parent instanceof PackageCustom && !((PackageCustom)parent).m_fixedNamespace) {
((PackageCustom)parent).apply(loc);
}
ns = deriveNamespace(parent.getNamespace(), m_fullName, getNamespaceStyle());
}
setNamespace(ns);
m_fixedNamespace = true;
// apply customizations for all classes
for (Iterator iter = m_classMap.values().iterator(); iter.hasNext();) {
((ClassCustom)iter.next()).apply(loc);
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/SchemaDetailDirectory.java 0000644 0001750 0001750 00000046446 10767273606 030222 0 ustar moeller moeller /*
* Copyright (c) 2007, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import org.jibx.binding.model.BindingElement;
import org.jibx.binding.model.BindingHolder;
import org.jibx.binding.model.CollectionElement;
import org.jibx.binding.model.ContainerElementBase;
import org.jibx.binding.model.IClass;
import org.jibx.binding.model.IClassLocator;
import org.jibx.binding.model.IComponent;
import org.jibx.binding.model.MappingElement;
import org.jibx.binding.model.ModelVisitor;
import org.jibx.binding.model.StructureElement;
import org.jibx.binding.model.StructureElementBase;
import org.jibx.binding.model.TemplateElementBase;
import org.jibx.binding.model.ValidationContext;
import org.jibx.binding.model.ValueElement;
import org.jibx.runtime.QName;
import org.jibx.util.Types;
/**
* Directory for components included in schema generation. This includes both <mapping> elements of the bindings and
* special formats, with the latter currently limited to enumeration types. The building code works from a supplied list
* of bindings, walking the tree structure of the bindings to find all mappings and processing each mapping directly
* using the lists of child components. It creates mapping details and sets flags for the types of access to each
* mapping, as well as creating enumeration details and counting usage to select globals.
*
* @author Dennis M. Sosnoski
*/
public class SchemaDetailDirectory
{
/** Locator for class information (null if none). */
private final IClassLocator m_locator;
/** Binding customization information. */
private final GlobalCustom m_custom;
/** Validation context for bindings. */
private final ValidationContext m_context;
/** Map from <mapping> definition to mapping detail. */
private final Map m_mappingMap;
/** Map from class name to enumeration detail. */
private final Map m_enumMap;
/**
* Constructor.
*
* @param loc locator for class information (null if none)
* @param custom binding customization information (used for creating names as needed)
* @param vctx binding validation context
*/
public SchemaDetailDirectory(IClassLocator loc, GlobalCustom custom, ValidationContext vctx) {
m_locator = loc;
m_custom = custom;
m_context = vctx;
m_mappingMap = new HashMap();
m_enumMap = new HashMap();
}
/**
* Populate the mapping directory from a supplied list of root bindings. This uses a visitor to analyze the
* bindings, building the detail information to be used during the actual generation process.
*
* @param holders
*/
public void populate(ArrayList holders) {
AnalysisVisitor visitor = new AnalysisVisitor(m_context);
for (int i = 0; i < holders.size(); i++) {
BindingHolder holder = (BindingHolder)holders.get(i);
m_context.tourTree(holder.getBinding(), visitor);
}
}
/**
* Check if a <structure> element represents a type derivation. If the element is empty, has no name or property,
* is required, and is a mapping reference, then it can be handled as a type derivation.
*
* @param struct
* @return true if a type derivation, false if not
*/
private static boolean isTypeDerivation(StructureElement struct) {
return struct.children().size() == 0 && !struct.hasName() && !struct.hasProperty() && !struct.isOptional()
&& (struct.getDeclaredType() != null || struct.getEffectiveMapping() != null);
}
/**
* Check if class is an enumeration type.
*
* @param clas
* @return enumeration type flag
*/
private boolean isEnumeration(IClass clas) {
return clas.isSuperclass("java.lang.Enum");
}
/**
* Check if class is a simple value type.
*
* @param clas
* @return simple value type flag
*/
private boolean isSimpleValue(IClass clas) {
return Types.isSimpleValue(clas.getName());
}
/**
* Count the usage of an enumeration type. The first time this is called for a type it just creates the enumeration
* detail, then if called again for the same type it flags it as a global.
*
* @param type
*/
private void countEnumUsage(String type) {
SchemaEnumDetail detail = (SchemaEnumDetail)m_enumMap.get(type);
if (detail == null) {
ClassCustom custom = m_custom.forceClassCustomization(type);
detail = new SchemaEnumDetail(custom);
m_enumMap.put(type, detail);
} else {
detail.setGlobal(true);
}
}
/**
* Check references to mappings or enumeration types from component children of binding container element. This
* allows the starting offset for content children to be passed in, so that mappings with type extension components
* can be handled (with the extension component processed separately, since it's a special case).
*
* @param cont container element
* @param offset starting offset for content
*/
private void checkReferences(ContainerElementBase cont, int offset) {
// process all child components of container
ArrayList childs = cont.children();
for (int i = offset; i < childs.size(); i++) {
Object child = childs.get(i);
if (child instanceof ValueElement) {
// check value reference to enumeration type
IClass type = ((ValueElement)child).getType();
if (isEnumeration(type)) {
countEnumUsage(type.getName());
}
} else if (child instanceof CollectionElement) {
// check for collection item type
CollectionElement collect = (CollectionElement)child;
IClass itype = collect.getItemTypeClass();
if (isEnumeration(itype)) {
// collection items are enumeration type, count directly
countEnumUsage(itype.getName());
} else if (!isSimpleValue(itype)) {
// find implied mapping, if one defined
String type = itype.getName();
TemplateElementBase ref = collect.getDefinitions().getSpecificTemplate(type);
if (ref instanceof MappingElement) {
MappingElement mapref = (MappingElement)ref;
SchemaMappingDetail detail = forceMappingDetail(mapref);
detail.setElement(true);
}
}
// check for nested type reference(s)
checkReferences(collect, 0);
} else if (child instanceof StructureElement) {
// structure, check for nested definition
StructureElement struct = (StructureElement)child;
if (struct.children().size() > 0) {
// just handle references from nested components
checkReferences(struct, 0);
} else {
// no nested definition, check for mapping reference
MappingElement ref = (MappingElement)struct.getEffectiveMapping();
if (ref == null) {
m_context.addError("No handling defined for empty structure with no mapping reference", struct);
} else {
// get the referenced mapping information
SchemaMappingDetail detail = forceMappingDetail(ref);
if (struct.getName() == null) {
if (ref.isAbstract()) {
// abstract inline treated as group
detail.setGroup(true);
} else {
// concrete treated as element reference
detail.setElement(true);
}
} else if (!ref.isAbstract()) {
// concrete with name should never happen
m_context.addError("No handling defined for name on concrete mapping reference", struct);
}
}
}
}
}
}
/**
* Create the detail information for a <mapping>. This creates the detail information and adds it to the map,
* then analyzes the structure of the mapping to find references to other mappings and to enumeration types.
*
* @param map
* @return detail
*/
private SchemaMappingDetail addDetail(MappingElement map) {
// check structure of mapping definition for schema type extension
MappingElement base = null;
ArrayList contents = map.getContentComponents();
if (contents.size() > 0) {
// type extension requires reference as first content component
Object content = contents.get(0);
if (content instanceof StructureElement) {
StructureElement struct = (StructureElement)content;
if (isTypeDerivation(struct)) {
base = (MappingElement)struct.getEffectiveMapping();
}
}
}
// next search recursively for text and/or child element components this is done at this point (with loop
// recursion, if needed) so that the flags can be set when creating the detail instance
boolean haschild = false;
boolean hastext = false;
ArrayList expands = new ArrayList();
expands.add(map);
for (int i = 0; i < expands.size(); i++) {
// check for container with element name or text content
ContainerElementBase contain = (ContainerElementBase)expands.get(i);
contents = contain.getContentComponents();
for (int j = 0; j < contents.size(); j++) {
IComponent comp = (IComponent)contents.get(j);
if (comp.hasName()) {
// component with name means child element
haschild = true;
} else if (comp instanceof ValueElement) {
// value with no name implies text content
hastext = true;
} else if (comp instanceof CollectionElement) {
// collection implies child element (repeating)
haschild = true;
} else {
// structure, check for mapping reference
StructureElement struct = (StructureElement)comp;
if (struct.children().size() > 0) {
// add container structure to expansion list
expands.add(comp);
} else {
MappingElement ref = (MappingElement)struct.getEffectiveMapping();
if (ref != null) {
// mapping element reference, check if named
if (ref.getName() != null) {
haschild = true;
} else {
expands.add(ref);
}
}
}
}
}
}
// get the names for this mapping
ClassCustom custom = m_custom.forceClassCustomization(map.getClassName());
QName tname = map.getTypeQName();
if (tname == null) {
tname = custom.getTypeQName();
}
QName oname = null;
String name = map.getName();
if (name == null) {
oname = custom.getElementQName();
} else {
oname = new QName(map.getNamespace().getUri(), name);
}
// add new mapping detail based on information found
SchemaMappingDetail detail = new SchemaMappingDetail(map, haschild, hastext, base, tname, oname);
m_mappingMap.put(map, detail);
// check for mapping to element name
if (map.getName() == null) {
// require base type generation as type
if (base != null) {
SchemaMappingDetail basedetail = forceMappingDetail(base);
basedetail.setType(true);
}
} else {
// force generating an element for this mapping
detail.setElement(true);
}
// error if mapping extension doesn't map to type extension
MappingElement extended = map.getExtendsMapping();
if (extended != null) {
// recursively check for extension type match
boolean isext = false;
MappingElement ancest = base;
while (ancest != null) {
if (ancest.getClassName().equals(extended.getClassName())) {
isext = true;
break;
} else {
ancest = forceMappingDetail(ancest).getExtensionBase();
}
}
if (isext) {
// flag generation as element in substitution group
SchemaMappingDetail extdetail = forceMappingDetail(extended);
extdetail.setElement(true);
detail.setSubstitution(extdetail.getOtherName());
detail.setElement(true);
} else {
m_context.addError("'extends' mapping not usable as schema extension base", map);
}
}
// process all references from this mapping
checkReferences(map, base == null ? 0 : 1);
return detail;
}
/**
* Find detail information for a <mapping>. If this is the first time a particular mapping was requested, a new
* detail information will be created for that mapping and returned.
*
* @param map
* @return detail
*/
protected SchemaMappingDetail forceMappingDetail(MappingElement map) {
SchemaMappingDetail detail = (SchemaMappingDetail)m_mappingMap.get(map);
if (detail == null) {
detail = addDetail(map);
}
return detail;
}
/**
* Get detail information for a <mapping>. If the detail information does not exist, this throws an exception.
*
* @param map
* @return detail
*/
public SchemaMappingDetail getMappingDetail(MappingElement map) {
SchemaMappingDetail detail = (SchemaMappingDetail)m_mappingMap.get(map);
if (detail == null) {
throw new IllegalStateException("Detail not found");
} else {
return detail;
}
}
/**
* Get detail information for a simple type. If the detail information does not exist, this throws an exception.
*
* @param type
* @return detail
*/
public SchemaEnumDetail getSimpleDetail(String type) {
SchemaEnumDetail detail = (SchemaEnumDetail)m_enumMap.get(type);
if (detail == null) {
throw new IllegalStateException("Detail not found");
} else {
return detail;
}
}
/**
* Get all complex type details.
*
* @return collection of {@link SchemaMappingDetail}
*/
public Collection getComplexDetails() {
return m_mappingMap.values();
}
/**
* Get all simple type details.
*
* @return collection of {@link SchemaEnumDetail}
*/
public Collection getSimpleDetails() {
return m_enumMap.values();
}
/**
* Model visitor for analyzing the structure of bindings and determining the appropriate schema components.
*/
public class AnalysisVisitor extends ModelVisitor
{
/** Validation context running this visitor. */
private final ValidationContext m_context;
/**
* Constructor.
*
* @param vctx validation context that will run this visitor
*/
public AnalysisVisitor(ValidationContext vctx) {
m_context = vctx;
}
/**
* Visit mapping element. This just adds the mapping definition, if not already added.
*
* @param node
* @return expansion flag
*/
public boolean visit(MappingElement node) {
// check for nested mapping
if (!(m_context.getParentElement() instanceof BindingElement)) {
m_context.addWarning("No schema equivalent for nested type definitions - converting to global type");
}
// add the definition
forceMappingDetail(node);
return super.visit(node);
}
/**
* Visit structure or collection element. This just stops the expansion, since the content of mapping
* definitions is processed at the time the mapping is added.
*
* @param node
* @return false to block further expansion
*/
public boolean visit(StructureElementBase node) {
return false;
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/SchemaEnumDetail.java 0000644 0001750 0001750 00000005274 10651175632 027144 0 ustar moeller moeller /*
* Copyright (c) 2007, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
/**
* Holder for details about an enumeration type to be included in the schema definition. An instance of this class is
* created for each enumeration type found. The actual generation process may be either in-line or as a separate
* simpleType, depending on whether the same enumeration is used more than once.
*
* @author Dennis M. Sosnoski
*/
public class SchemaEnumDetail
{
/** Enumeration class customization information. */
private final ClassCustom m_custom;
/** Global type definition flag. */
private boolean m_isGlobal;
/**
* Constructor.
*
* @param cust
*/
public SchemaEnumDetail(ClassCustom cust) {
m_custom = cust;
}
/**
* Check if global type definition.
*
* @return flag
*/
public boolean isGlobal() {
return m_isGlobal;
}
/**
* Set global type definition.
*
* @param global
*/
public void setGlobal(boolean global) {
m_isGlobal = global;
}
/**
* Get class customization information.
*
* @return custom
*/
public ClassCustom getCustom() {
return m_custom;
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/SchemaGenerator.java 0000644 0001750 0001750 00000132334 10767273656 027056 0 ustar moeller moeller /*
* Copyright (c) 2007, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.AbstractList;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.jibx.binding.model.BindingHolder;
import org.jibx.binding.model.CollectionElement;
import org.jibx.binding.model.ContainerElementBase;
import org.jibx.binding.model.DocumentFormatter;
import org.jibx.binding.model.IClass;
import org.jibx.binding.model.IClassItem;
import org.jibx.binding.model.IClassLocator;
import org.jibx.binding.model.IComponent;
import org.jibx.binding.model.MappingElement;
import org.jibx.binding.model.StructureElement;
import org.jibx.binding.model.StructureElementBase;
import org.jibx.binding.model.TemplateElementBase;
import org.jibx.binding.model.ValidationContext;
import org.jibx.binding.model.ValidationProblem;
import org.jibx.binding.model.ValueElement;
import org.jibx.runtime.QName;
import org.jibx.schema.ISchemaResolver;
import org.jibx.schema.SchemaHolder;
import org.jibx.schema.TreeWalker;
import org.jibx.schema.elements.AllElement;
import org.jibx.schema.elements.AnnotatedBase;
import org.jibx.schema.elements.AnnotationElement;
import org.jibx.schema.elements.AttributeElement;
import org.jibx.schema.elements.AttributeGroupElement;
import org.jibx.schema.elements.AttributeGroupRefElement;
import org.jibx.schema.elements.ChoiceElement;
import org.jibx.schema.elements.CommonCompositorDefinition;
import org.jibx.schema.elements.ComplexContentElement;
import org.jibx.schema.elements.ComplexExtensionElement;
import org.jibx.schema.elements.ComplexTypeElement;
import org.jibx.schema.elements.DocumentationElement;
import org.jibx.schema.elements.ElementElement;
import org.jibx.schema.elements.FilteredSegmentList;
import org.jibx.schema.elements.GroupElement;
import org.jibx.schema.elements.GroupRefElement;
import org.jibx.schema.elements.SchemaElement;
import org.jibx.schema.elements.SequenceElement;
import org.jibx.schema.elements.SimpleContentElement;
import org.jibx.schema.elements.SimpleExtensionElement;
import org.jibx.schema.elements.SimpleRestrictionElement;
import org.jibx.schema.elements.SimpleTypeElement;
import org.jibx.schema.elements.FacetElement.Enumeration;
import org.jibx.schema.types.Count;
import org.jibx.schema.validation.PrevalidationVisitor;
import org.jibx.schema.validation.RegistrationVisitor;
import org.jibx.schema.validation.ValidationVisitor;
import org.jibx.util.Types;
import org.w3c.dom.Node;
/**
* Schema generator from binding definition.
*
* @author Dennis M. Sosnoski
*/
public class SchemaGenerator
{
/** Locator for class information (null if none). */
private final IClassLocator m_locator;
/** Binding customization information. */
private final GlobalCustom m_custom;
/** Document used for annotations (null if none). */
private final DocumentFormatter m_formatter;
/** Map from fully-qualified class name to qualified simple type name. */
private final Map m_simpleTypeMap;
/** Map from namespace to schema holder. */
private final Map m_uriSchemaMap;
/** Validation context for bindings. */
private final ValidationContext m_context;
/** Details for mappings and enum usages. */
private final SchemaDetailDirectory m_detailDirectory;
/**
* Constructor.
*
* @param loc locator for class information (null if none)
* @param custom binding customization information (used for creating names as needed)
*/
public SchemaGenerator(IClassLocator loc, GlobalCustom custom) {
m_locator = loc;
if (loc == null) {
m_formatter = null;
} else {
m_formatter = new DocumentFormatter();
}
m_custom = custom;
m_simpleTypeMap = new HashMap();
m_uriSchemaMap = new HashMap();
m_context = new ValidationContext(loc);
m_detailDirectory = new SchemaDetailDirectory(loc, custom, m_context);
}
/**
* Find the schema to be used for a particular namespace. If this is the first time a particular namespace was
* requested, a new schema will be created for that namespace and returned, using a default file name.
*
* @param uri namespace URI (null if no namespace)
* @return schema holder
*/
public SchemaHolder findSchema(String uri) {
SchemaHolder hold = (SchemaHolder)m_uriSchemaMap.get(uri);
if (hold == null) {
hold = new SchemaHolder(uri);
m_uriSchemaMap.put(uri, hold);
String sname;
if (uri == null) {
sname = "nonamespace.xsd";
} else {
sname = uri.substring(uri.lastIndexOf('/') + 1) + ".xsd";
}
hold.setFileName(sname);
}
return hold;
}
/**
* Get the qualified name of the simple type used for a component, if a named simple type. If this returns
* null, the {@link #buildSimpleType(IComponent)} method needs to be able to construct the
* appropriate simple type definition.
*
* @param comp
* @return qualified type name, null if inline definition needed
*/
private QName getSimpleTypeQName(IComponent comp) {
IClass type = comp.getType();
String tname = comp.getType().getName();
QName qname = Types.schemaType(tname);
if (qname == null) {
qname = (QName)m_simpleTypeMap.get(tname);
if (qname == null) {
if (!type.isSuperclass("java.lang.Enum")) {
m_context.addWarning("No schema equivalent known for type - treating as string", comp);
qname = Types.STRING_QNAME;
}
}
}
return qname;
}
/**
* Add class-level documentation to a schema component.
*
* @param info
* @param root
*/
private void addDocumentation(IClass info, AnnotatedBase root) {
if (info != null) {
List nodes = m_formatter.docToNodes(info.getJavaDoc());
if (nodes != null) {
AnnotationElement anno = new AnnotationElement();
DocumentationElement doc = new DocumentationElement();
for (Iterator iter = nodes.iterator(); iter.hasNext();) {
Node node = (Node)iter.next();
doc.addContent(node);
}
anno.getItemsList().add(doc);
root.setAnnotation(anno);
}
}
}
/**
* Set the documentation for a schema component matching a class member.
*
* @param elem
* @param item
*/
private void setDocumentation(IClassItem item, AnnotatedBase elem) {
List nodes = m_formatter.docToNodes(item.getJavaDoc());
if (nodes != null) {
AnnotationElement anno = new AnnotationElement();
DocumentationElement doc = new DocumentationElement();
for (Iterator iter = nodes.iterator(); iter.hasNext();) {
Node node = (Node)iter.next();
doc.addContent(node);
}
anno.getItemsList().add(doc);
elem.setAnnotation(anno);
}
}
/**
* Add documentation for a particular field or property.
*
* @param struct
* @param elem
*/
private void addItemDocumentation(StructureElementBase struct, AnnotatedBase elem) {
IClassItem item = struct.getField();
if (item == null) {
item = struct.getGet();
}
if (item != null) {
setDocumentation(item, elem);
}
}
/**
* Add documentation for a particular field or property.
*
* @param value
* @param elem
*/
private void addItemDocumentation(ValueElement value, AnnotatedBase elem) {
IClassItem item = value.getField();
if (item == null) {
item = value.getGet();
}
if (item != null) {
setDocumentation(item, elem);
}
}
/**
* Create the simple type definition for a type. This is only used for cases where
* {@link #getSimpleTypeQName(IComponent)} returns null. The current implementation only supports
* Java 5 Enum types, but in the future should be extended to support <format>-type conversions with supplied
* schema definitions. This code requires a Java 5+ JVM to execute, but uses reflection to allow this class to be
* loaded on older JVMs.
*
* @param type
* @return type definition
*/
private SimpleTypeElement buildSimpleType(IClass type) {
SchemaEnumDetail detail = m_detailDirectory.getSimpleDetail(type.getName());
try {
Class clas = type.loadClass();
Method valsmeth = clas.getMethod("values", (Class[])null);
String totxtname = detail.getCustom().getEnumValueMethod();
if (totxtname == null) {
totxtname = "name";
}
Method namemeth = clas.getMethod(totxtname, (Class[])null);
try {
valsmeth.setAccessible(true);
} catch (RuntimeException e) { /* deliberately empty */
}
try {
namemeth.setAccessible(true);
} catch (RuntimeException e) { /* deliberately empty */
}
Object[] values = (Object[])valsmeth.invoke(null, (Object[])null);
SimpleTypeElement simple = new SimpleTypeElement();
SimpleRestrictionElement restr = new SimpleRestrictionElement();
restr.setBase(Types.STRING_QNAME);
for (int i = 0; i < values.length; i++) {
Enumeration enumel = new Enumeration();
enumel.setValue(namemeth.invoke(values[i], (Object[])null).toString());
restr.getFacetsList().add(enumel);
}
simple.setDerivation(restr);
addDocumentation(detail.getCustom().getClassInformation(), simple);
return simple;
} catch (SecurityException e) {
e.printStackTrace();
} catch (NoSuchMethodException e) {
e.printStackTrace();
} catch (IllegalArgumentException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
} catch (InvocationTargetException e) {
e.printStackTrace();
}
return null;
}
/**
* Convenience method to create the simple type definition for the type of a component.
*
* @param comp
* @return type definition
*/
private SimpleTypeElement buildSimpleType(IComponent comp) {
return buildSimpleType(comp.getType());
}
/**
* General object comparison method. Don't know why Sun hasn't seen fit to include this somewhere, but at least it's
* easy to write (over and over again).
*
* @param a first object to be compared
* @param b second object to be compared
* @return true if both objects are null, or if a.equals(b);
* false otherwise
*/
public static boolean isEqual(Object a, Object b) {
return (a == null) ? b == null : a.equals(b);
}
/**
* Check if a name references a different schema.
*
* @param qname name to be checked
* @param hold schema holder
* @return true if different, false if the same
*/
public static boolean isDifferentSchema(QName qname, SchemaHolder hold) {
return qname != null && !isEqual(qname.getUri(), hold.getNamespace())
&& !isEqual(qname.getUri(), Types.SCHEMA_NAMESPACE);
}
/**
* Check for dependency on another schema. This creates an import for the target schema, and assigns a prefix for
* referencing the target schema namespace.
*
* @param qname name referenced by this schema
* @param hold schema holder
*/
public void checkDependency(QName qname, SchemaHolder hold) {
if (isDifferentSchema(qname, hold)) {
String uri = qname.getUri();
SchemaHolder tohold = findSchema(uri);
hold.addReference(tohold);
hold.getPrefix(uri);
}
}
/**
* Check for dependency between two schemas. This creates schema imports in both directions, and assigns a prefix
* for referencing the target schema namespace from within the current schema.
*
* @param qname name referenced by this schema
* @param hold schema holder
*/
private void checkBidirectionalDependency(QName qname, SchemaHolder hold) {
if (isDifferentSchema(qname, hold)) {
String uri = qname.getUri();
SchemaHolder tohold = findSchema(uri);
hold.addReference(tohold);
hold.getPrefix(uri);
tohold.addReference(hold);
}
}
/**
* Build a schema element description from a binding content component.
*
* @param comp source component
* @param repeat repeated element flag
* @param hold
* @return element
*/
private ElementElement buildElement(IComponent comp, boolean repeat, SchemaHolder hold) {
// create the basic element structure
ElementElement elem = new ElementElement();
if (repeat) {
elem.setMinOccurs(Count.COUNT_ZERO);
elem.setMaxOccurs(Count.COUNT_UNBOUNDED);
} else if (comp.isOptional()) {
elem.setMinOccurs(Count.COUNT_ZERO);
}
// set or create the element type definition
boolean isref = false;
if (comp instanceof ValueElement) {
QName qname = getSimpleTypeQName(comp);
if (qname == null) {
elem.setTypeDefinition(buildSimpleType(comp));
} else {
setElementType(qname, elem, hold);
}
addItemDocumentation((ValueElement)comp, elem);
} else if (comp instanceof CollectionElement) {
CollectionElement coll = (CollectionElement)comp;
if (coll.children().size() > 0) {
// collection with children, choice or sequence from order
ComplexTypeElement type = new ComplexTypeElement();
if (coll.isOrdered()) {
// ordered children go to sequence element, repeating
SequenceElement seq = new SequenceElement();
type.setContentDefinition(seq);
} else {
// unordered children go to repeated choice element
ChoiceElement choice = new ChoiceElement();
type.setContentDefinition(choice);
}
type.setContentDefinition(buildCompositor(coll, 0, true, hold));
elem.setTypeDefinition(type);
} else {
// empty collection, item-type must reference a concrete mapping
String itype = coll.getItemTypeName();
TemplateElementBase ref = coll.getDefinitions().getSpecificTemplate(itype);
if (ref instanceof MappingElement) {
// item type with concrete mapping, make it an element
SchemaMappingDetail detail = m_detailDirectory.getMappingDetail((MappingElement)ref);
ComplexTypeElement type = new ComplexTypeElement();
SequenceElement seq = new SequenceElement();
type.setContentDefinition(seq);
ElementElement item = new ElementElement();
setElementRef(detail.getOtherName(), item, hold);
item.setMinOccurs(Count.COUNT_ZERO);
item.setMaxOccurs(Count.COUNT_UNBOUNDED);
seq.getParticleList().add(item);
elem.setTypeDefinition(type);
addItemDocumentation(coll, item);
} else {
// TODO: handle this with xs:any strict?
m_context.addWarning("Handling not implemented for unspecified mapping", coll);
}
}
} else {
// must be a structure, check children
StructureElement struct = (StructureElement)comp;
if (struct.children().size() > 0) {
// structure with children, choice or sequence from order
ComplexTypeElement type = new ComplexTypeElement();
if (struct.isOrdered()) {
// ordered children go to sequence element
SequenceElement seq = new SequenceElement();
type.setContentDefinition(seq);
} else {
// unordered children go to repeated choice element
ChoiceElement choice = new ChoiceElement();
type.setContentDefinition(choice);
}
type.setContentDefinition(buildCompositor(struct, 0, false, hold));
fillAttributes(struct, 0, type.getAttributeList(), hold);
elem.setTypeDefinition(type);
} else {
// no children, must be a mapping reference
MappingElement ref = (MappingElement)struct.getEffectiveMapping();
if (ref == null) {
// TODO: handle this with xs:any strict?
m_context.addWarning("Handling not implemented for unspecified mapping", struct);
} else {
// implicit mapping reference, find the handling
SchemaMappingDetail detail = m_detailDirectory.getMappingDetail(ref);
if (detail.isElement()) {
// structure with concrete mapping
setElementRef(detail.getOtherName(), elem, hold);
isref = true;
} else {
// set element type to that constructed from mapping
setElementType(detail.getTypeName(), elem, hold);
}
}
}
addItemDocumentation(struct, elem);
}
if (!isref) {
elem.setName(comp.getName());
}
return elem;
}
/**
* Add a compositor as a particle in another compositor. If the compositor being added has only one particle, the
* particle is directly added to the containing compositor.
*
* @param part compositor being added as a particle
* @param comp target compositor for add
*/
private static void addCompositorPart(CommonCompositorDefinition part, CommonCompositorDefinition comp) {
FilteredSegmentList parts = part.getParticleList();
Count maxo = part.getMaxOccurs();
Count mino = part.getMinOccurs();
if (parts.size() == 1 && (maxo == null || maxo.isEqual(1)) && (mino == null || mino.isEqual(1))) {
comp.getParticleList().add(parts.get(0));
} else if (parts.size() > 1) {
comp.getParticleList().add(part);
}
}
/**
* Build compositor for type definition. This creates and returns the appropriate form of compositor for the
* container, populated with particles matching the child element components of the binding container.
*
* @param cont container element defining structure
* @param offset offset for first child component to process
* @param repeat repeated item flag
* @param hold holder for schema under construction
* @return constructed compositor
*/
private CommonCompositorDefinition buildCompositor(ContainerElementBase cont, int offset, boolean repeat,
SchemaHolder hold) {
// start with the appropriate type of compositor
CommonCompositorDefinition cdef;
if (cont.isChoice()) {
// choice container goes directly to choice compositor
cdef = new ChoiceElement();
} else if (cont.isOrdered()) {
// ordered container goes directly to sequence compositor
cdef = new SequenceElement();
} else if (repeat) {
// unordered repeat treated as repeated choice compositor
cdef = new ChoiceElement();
cdef.setMaxOccurs(Count.COUNT_UNBOUNDED);
} else {
// unordered non-repeat treated as all compositor
// TODO: verify conditions for all
cdef = new AllElement();
}
// generate schema equivalents for content components of container
ArrayList comps = cont.getContentComponents();
for (int i = offset; i < comps.size(); i++) {
IComponent comp = (IComponent)comps.get(i);
if (comp.hasName()) {
// create element for named content component
ElementElement element = buildElement(comp, repeat, hold);
if (comp instanceof StructureElementBase) {
addItemDocumentation((StructureElementBase)comp, element);
}
cdef.getParticleList().add(element);
} else if (comp instanceof ContainerElementBase) {
ContainerElementBase contain = (ContainerElementBase)comp;
boolean iscoll = comp instanceof CollectionElement;
if (contain.children().size() > 0) {
// no element name, but children; handle with recursive call
CommonCompositorDefinition part = buildCompositor(contain, 0, iscoll, hold);
addCompositorPart(part, cdef);
} else if (iscoll) {
// collection without a wrapper element
CollectionElement coll = (CollectionElement)comp;
String itype = coll.getItemTypeName();
TemplateElementBase ref = coll.getDefinitions().getSpecificTemplate(itype);
if (ref instanceof MappingElement) {
// item type with concrete mapping, make it an element
SchemaMappingDetail detail = m_detailDirectory.getMappingDetail((MappingElement)ref);
ElementElement item = new ElementElement();
QName oname = detail.getOtherName();
setElementRef(oname, item, hold);
item.setMinOccurs(Count.COUNT_ZERO);
item.setMaxOccurs(Count.COUNT_UNBOUNDED);
addItemDocumentation(coll, item);
cdef.getParticleList().add(item);
} else {
// TODO: handle this with xs:any strict?
m_context.addWarning("Handling not implemented for unspecified mapping", coll);
}
} else if (comp instanceof StructureElement) {
// no children, must be mapping reference
StructureElement struct = (StructureElement)comp;
MappingElement ref = (MappingElement)struct.getEffectiveMapping();
if (ref == null) {
// TODO: handle this with xs:any strict?
m_context.addWarning("Handling not implemented for unspecified mapping", struct);
} else {
// handle mapping reference based on form and name use
SchemaMappingDetail detail = m_detailDirectory.getMappingDetail(ref);
if (ref.isAbstract()) {
// abstract inline treated as group
GroupRefElement group = new GroupRefElement();
setGroupRef(detail.getOtherName(), group, hold);
if (comp.isOptional()) {
group.setMinOccurs(Count.COUNT_ZERO);
}
cdef.getParticleList().add(group);
} else {
// concrete treated as element reference
ElementElement elem = new ElementElement();
setElementRef(detail.getOtherName(), elem, hold);
if (comp.isOptional()) {
elem.setMinOccurs(Count.COUNT_ZERO);
}
addItemDocumentation(struct, elem);
cdef.getParticleList().add(elem);
}
}
} else {
m_context.addError("Unsupported binding construct", comp);
}
} else {
m_context.addError("Unsupported component", comp);
}
}
// simplify by eliminating this level if only child a compositor
if ((cont.isOrdered() || cont.isChoice()) && cdef.getParticleList().size() == 1) {
Object child = cdef.getParticleList().get(0);
if (child instanceof CommonCompositorDefinition) {
cdef = (CommonCompositorDefinition)child;
}
}
return cdef;
}
/**
* Set group reference, adding schema reference if necessary.
*
* @param qname reference name
* @param group
* @param hold schema holder
*/
public void setGroupRef(QName qname, AttributeGroupRefElement group, SchemaHolder hold) {
checkDependency(qname, hold);
group.setRef(qname);
}
/**
* Set group reference, adding schema reference if necessary.
*
* @param qname reference name
* @param group
* @param hold schema holder
*/
public void setGroupRef(QName qname, GroupRefElement group, SchemaHolder hold) {
checkDependency(qname, hold);
group.setRef(qname);
}
/**
* Set element reference, adding schema reference if necessary.
*
* @param qname reference name
* @param elem
* @param hold schema holder
*/
public void setElementRef(QName qname, ElementElement elem, SchemaHolder hold) {
checkDependency(qname, hold);
elem.setRef(qname);
}
/**
* Set attribute type, adding schema reference if necessary.
*
* @param qname type name
* @param elem
* @param hold schema holder
*/
public void setAttributeType(QName qname, AttributeElement elem, SchemaHolder hold) {
elem.setType(qname);
checkDependency(qname, hold);
}
/**
* Set element type, adding schema reference if necessary.
*
* @param qname type name
* @param elem
* @param hold schema holder
*/
public void setElementType(QName qname, ElementElement elem, SchemaHolder hold) {
elem.setType(qname);
checkDependency(qname, hold);
}
/**
* Set element substitution group, adding schema references in each direction if necessary.
*
* @param qname substitution group element name
* @param elem
* @param hold schema holder
*/
public void setSubstitutionGroup(QName qname, ElementElement elem, SchemaHolder hold) {
elem.setSubstitutionGroup(qname);
checkBidirectionalDependency(qname, hold);
}
/**
* Build attributes as part of complex type definition.
*
* @param cont container element defining structure
* @param offset offset for first child component to process
* @param attrs complex type attribute list
* @param hold holder for schema under construction
*/
private void fillAttributes(ContainerElementBase cont, int offset, AbstractList attrs, SchemaHolder hold) {
// add child attribute components
ArrayList comps = cont.getAttributeComponents();
for (int i = 0; i < comps.size(); i++) {
IComponent comp = (IComponent)comps.get(i);
if (comp instanceof ValueElement) {
// simple attribute definition
AttributeElement attr = new AttributeElement();
attr.setName(comp.getName());
QName qname = getSimpleTypeQName(comp);
if (qname == null) {
attr.setTypeDefinition(buildSimpleType(comp));
} else {
setAttributeType(qname, attr, hold);
}
if (!comp.isOptional()) {
attr.setUse(AttributeElement.REQUIRED_USE);
}
addItemDocumentation((ValueElement)comp, attr);
attrs.add(attr);
} else if (comp instanceof ContainerElementBase) {
ContainerElementBase contain = (ContainerElementBase)comp;
if (contain.children().size() > 0) {
// handle children with recursive call
fillAttributes(contain, 0, attrs, hold);
} else if (comp instanceof StructureElement) {
// no children, must be mapping reference
StructureElement struct = (StructureElement)comp;
if (struct.isOptional()) {
m_context.addError("No schema equivalent for optional abstract mapping with attributes", comp);
} else {
MappingElement ref = (MappingElement)struct.getEffectiveMapping();
if (ref != null && ref.isAbstract()) {
// abstract inline treated as group
SchemaMappingDetail detail = m_detailDirectory.getMappingDetail(ref);
AttributeGroupRefElement group = new AttributeGroupRefElement();
setGroupRef(detail.getOtherName(), group, hold);
attrs.add(group);
} else {
throw new IllegalStateException("Unsupported binding construct " + comp);
}
}
} else {
m_context.addError("Unsupported binding construct", comp);
}
} else {
m_context.addError("Unsupported component", comp);
}
}
}
/**
* Check if a container element of the binding represents complex content.
*
* @param cont
* @return true if complex content, false if not
*/
private static boolean isComplexContent(ContainerElementBase cont) {
ArrayList contents = cont.getContentComponents();
for (int i = 0; i < contents.size(); i++) {
Object item = contents.get(i);
if (item instanceof IComponent && ((IComponent)item).hasName()) {
return true;
} else if (item instanceof ContainerElementBase && isComplexContent((ContainerElementBase)item)) {
return true;
}
}
return false;
}
/**
* Build the complex type definition for a mapping.
*
* @param detail mapping detail
* @param hold target schema for definition
* @return constructed complex type
*/
private ComplexTypeElement buildComplexType(SchemaMappingDetail detail, SchemaHolder hold) {
// create the type and compositor
ComplexTypeElement type = new ComplexTypeElement();
MappingElement mapping = detail.getMapping();
MappingElement base = detail.getExtensionBase();
if (base == null) {
if (detail.isGroup()) {
// create type using references to group and/or attributeGroup
SequenceElement seq = new SequenceElement();
if (detail.hasChild()) {
GroupRefElement gref = new GroupRefElement();
setGroupRef(detail.getOtherName(), gref, hold);
seq.getParticleList().add(gref);
}
type.setContentDefinition(seq);
if (detail.hasAttribute()) {
AttributeGroupRefElement gref = new AttributeGroupRefElement();
setGroupRef(detail.getOtherName(), gref, hold);
type.getAttributeList().add(gref);
}
} else {
// create type directly
type.setContentDefinition(buildCompositor(mapping, 0, false, hold));
fillAttributes(mapping, 0, type.getAttributeList(), hold);
}
} else {
// create type as extension of base type
SchemaMappingDetail basedet = m_detailDirectory.getMappingDetail(base);
if (isComplexContent(base) || isComplexContent(mapping)) {
// complex extension with complex content
ComplexExtensionElement ext = new ComplexExtensionElement();
setComplexExtensionBase(basedet.getTypeName(), ext, hold);
CommonCompositorDefinition comp = buildCompositor(mapping, 1, false, hold);
if (comp.getParticleList().size() > 0) {
ext.setContentDefinition(comp);
}
fillAttributes(mapping, 0, ext.getAttributeList(), hold);
ComplexContentElement cont = new ComplexContentElement();
cont.setDerivation(ext);
type.setContentType(cont);
} else {
// simple extension with simple content
SimpleExtensionElement ext = new SimpleExtensionElement();
setSimpleExtensionBase(basedet.getTypeName(), ext, hold);
fillAttributes(mapping, 0, ext.getAttributeList(), hold);
SimpleContentElement cont = new SimpleContentElement();
cont.setDerivation(ext);
type.setContentType(cont);
}
}
return type;
}
/**
* Set the base for a complex extension type.
*
* @param qname
* @param ext
* @param hold
*/
private void setComplexExtensionBase(QName qname, ComplexExtensionElement ext, SchemaHolder hold) {
ext.setBase(qname);
checkBidirectionalDependency(qname, hold);
}
/**
* Set the base for a simple extension type.
*
* @param qname
* @param ext
* @param hold
*/
private void setSimpleExtensionBase(QName qname, SimpleExtensionElement ext, SchemaHolder hold) {
ext.setBase(qname);
checkBidirectionalDependency(qname, hold);
}
/**
* Add mapping to schema definitions. This generates the appropriate schema representation for the mapping based on
* the detail flags, which may include group and/or attributeGroup, complexType, and element definitions.
*
* @param detail
*/
private void addMapping(SchemaMappingDetail detail) {
// get the documentation to be used for type
IClass info = null;
if (m_locator != null) {
info = m_locator.getClassInfo(detail.getMapping().getClassName());
}
// start by generating group/attributeGroup schema components
MappingElement mapping = detail.getMapping();
if (detail.isGroup()) {
// TODO: extend base type for group/attributeGroup?
QName qname = detail.getOtherName();
SchemaHolder hold = findSchema(qname.getUri());
if (detail.hasChild()) {
GroupElement group = new GroupElement();
group.setName(qname.getName());
group.setDefinition(buildCompositor(mapping, 0, false, hold));
addDocumentation(info, group);
hold.getSchema().getTopLevelChildren().add(group);
}
if (detail.hasAttribute()) {
AttributeGroupElement attgrp = new AttributeGroupElement();
attgrp.setName(qname.getName());
fillAttributes(mapping, 0, attgrp.getAttributeList(), hold);
addDocumentation(info, attgrp);
hold.getSchema().getTopLevelChildren().add(attgrp);
}
}
// next generate the complex type definition
if (detail.isType()) {
// set up the basic definition structure
QName qname = detail.getTypeName();
SchemaHolder hold = findSchema(qname.getUri());
ComplexTypeElement type = buildComplexType(detail, hold);
type.setName(qname.getName());
addDocumentation(info, type);
hold.getSchema().getTopLevelChildren().add(type);
}
// finish by generating element definition
if (detail.isElement()) {
QName qname = detail.getOtherName();
SchemaHolder hold = findSchema(qname.getUri());
ElementElement elem = new ElementElement();
elem.setName(qname.getName());
setSubstitutionGroup(detail.getSubstitution(), elem, hold);
if (detail.isType()) {
setElementType(detail.getTypeName(), elem, hold);
} else {
// check for just an element wrapper around type reference
MappingElement ext = detail.getExtensionBase();
if (ext != null && !detail.hasAttribute() && mapping.getContentComponents().size() == 1) {
setElementType(ext.getTypeQName(), elem, hold);
} else {
// add documentation to element which is not also a type
addDocumentation(info, elem);
elem.setTypeDefinition(buildComplexType(detail, hold));
}
}
hold.getSchema().getTopLevelChildren().add(elem);
}
}
/**
* Generate a list of schemas from a list of bindings. The two lists are not necessarily in any particular
* relationship to each other.
*
* @param holders list of {@link BindingHolder}
* @return schemas list of {@link SchemaHolder}
*/
public ArrayList generate(ArrayList holders) {
// start by scanning all bindings to build mapping and enum details
m_detailDirectory.populate(holders);
// process all the simple type definitions (formats or enums)
Collection simples = m_detailDirectory.getSimpleDetails();
for (Iterator iter = simples.iterator(); iter.hasNext();) {
SchemaEnumDetail detail = (SchemaEnumDetail)iter.next();
if (detail.isGlobal()) {
ClassCustom custom = detail.getCustom();
SimpleTypeElement type = buildSimpleType(custom.getClassInformation());
type.setName(custom.getTypeName());
SchemaHolder hold = findSchema(custom.getNamespace());
hold.getSchema().getTopLevelChildren().add(type);
m_simpleTypeMap.put(custom.getName(), custom.getTypeQName());
}
}
// process all the mapping definitions from directory
Collection mappings = m_detailDirectory.getComplexDetails();
for (Iterator iter = mappings.iterator(); iter.hasNext();) {
SchemaMappingDetail detail = (SchemaMappingDetail)iter.next();
addMapping(detail);
}
// report any problems found in schema generation
ArrayList probs = m_context.getProblems();
boolean error = m_context.getErrorCount() > 0 || m_context.getFatalCount() > 0;
if (probs.size() > 0) {
System.out.print(error ? "Errors" : "Warnings");
System.out.println(" in generated binding:");
for (int j = 0; j < probs.size(); j++) {
ValidationProblem prob = (ValidationProblem)probs.get(j);
System.out.print(prob.getSeverity() >= ValidationProblem.ERROR_LEVEL ? "Error: " : "Warning: ");
System.out.println(prob.getDescription());
}
}
// fix all references between schemas
ArrayList schemas = new ArrayList(m_uriSchemaMap.values());
for (int i = 0; i < schemas.size(); i++) {
SchemaHolder hold = (SchemaHolder)schemas.get(i);
hold.finish();
}
// validate the schemas and report any problems
org.jibx.schema.validation.ValidationContext vctx = new org.jibx.schema.validation.ValidationContext();
for (int i = 0; i < schemas.size(); i++) {
SchemaHolder holder = (SchemaHolder)schemas.get(i);
String id = holder.getFileName();
SchemaElement schema = holder.getSchema();
schema.setResolver(new MemoryResolver(id));
vctx.setSchema(id, schema);
}
TreeWalker wlkr = new TreeWalker(vctx, vctx);
vctx.clearTraversed();
for (int i = 0; i < schemas.size(); i++) {
wlkr.walkSchema(((SchemaHolder)schemas.get(i)).getSchema(), new PrevalidationVisitor(vctx));
}
vctx.clearTraversed();
for (int i = 0; i < schemas.size(); i++) {
wlkr.walkSchema(((SchemaHolder)schemas.get(i)).getSchema(), new RegistrationVisitor(vctx));
}
vctx.clearTraversed();
for (int i = 0; i < schemas.size(); i++) {
wlkr.walkSchema(((SchemaHolder)schemas.get(i)).getSchema(), new ValidationVisitor(vctx));
}
probs = vctx.getProblems();
if (probs.size() > 0) {
for (int j = 0; j < probs.size(); j++) {
org.jibx.schema.validation.ValidationProblem prob =
(org.jibx.schema.validation.ValidationProblem)probs.get(j);
System.out.print(prob.getSeverity() >= ValidationProblem.ERROR_LEVEL ? "Error: " : "Warning: ");
System.out.println(prob.getDescription());
}
}
return schemas;
}
/**
* Get details of schema handling of a mapping.
*
* @param map
* @return mapping details
*/
public SchemaMappingDetail getMappingDetail(MappingElement map) {
return m_detailDirectory.forceMappingDetail(map);
}
private static class MemoryResolver implements ISchemaResolver
{
private final String m_id;
public MemoryResolver(String id) {
m_id = id;
}
public InputStream getContent() throws IOException {
throw new IOException("Source not available");
}
public String getName() {
return m_id;
}
public String getId() {
return m_id;
}
public ISchemaResolver resolve(String loc) throws IOException {
return new MemoryResolver(loc);
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/SchemaMappingDetail.java 0000644 0001750 0001750 00000011766 10651175632 027636 0 ustar moeller moeller package org.jibx.binding.generator;
import org.jibx.binding.model.MappingElement;
import org.jibx.runtime.QName;
/**
* Holder for the details of how a mapping is to be represented in a schema. Each mapping is converted to a complex
* type, but the complex type may be either global or local to a containing global element. In the case of a mapping
* used as the base for one or more extension types, both a global complex type and a global element that references the
* type are required. This also tracks the content form for the complex type definition.
*
* @author Dennis M. Sosnoski
*/
public class SchemaMappingDetail
{
/** Mapping to be generated. */
private final MappingElement m_mapping;
/** Schema type extension base mapping. */
private final MappingElement m_extensionBase;
/** Has child element(s) flag. */
private final boolean m_hasChild;
/** Has child text(s) flag. */
private final boolean m_hasText;
/** Has attribute(s) flag. */
private final boolean m_hasAttribute;
/** Type name (ignored if not generated as complex type). */
private final QName m_typeName;
/**
* Element/group/attributeGroup name (ignored if not generated as any of these).
*/
private final QName m_otherName;
/** Substitution group base name. */
private QName m_substitutionName;
/** Generate as complex type flag. */
private boolean m_isType;
/** Generate as element flag. */
private boolean m_isElement;
/**
* Generate as group/attributeGroup flag. If set, will be generated as either a group (if elements defined), an
* attributeGroup (if attributes defined), or both.
*/
private boolean m_isGroup;
/**
* Constructor.
*
* @param map mapping definition
* @param haschild has child element(s) flag
* @param hastext has child text(s) flag
* @param base base mapping for schema type extension
* @param tname name as type
* @param oname name as element/group/attributeGroup
*/
public SchemaMappingDetail(MappingElement map, boolean haschild, boolean hastext, MappingElement base, QName tname,
QName oname) {
m_mapping = map;
m_extensionBase = base;
m_hasChild = haschild;
m_hasText = hastext;
m_hasAttribute = map.getAttributeComponents().size() > 0;
m_typeName = tname;
m_otherName = oname;
if (map.isAbstract() && map.getTypeName() != null) {
m_isType = true;
} else if (!map.isAbstract()) {
m_isElement = true;
}
}
/**
* Check if generating as an element.
*
* @return flag
*/
public boolean isElement() {
return m_isElement;
}
/**
* Set generating as an element.
*
* @param gen
*/
public void setElement(boolean gen) {
m_isElement = gen;
}
/**
* Check if generating as a group.
*
* @return flag
*/
public boolean isGroup() {
return m_isGroup;
}
/**
* Set generating as a group.
*
* @param gen
*/
public void setGroup(boolean gen) {
m_isGroup = gen;
}
/**
* Check if generating as a group.
*
* @return flag
*/
public boolean isType() {
return m_isType;
}
/**
* Set generating as a type.
*
* @param gen
*/
public void setType(boolean gen) {
m_isType = gen;
}
/**
* Get base mapping for schema type extension.
*
* @return extension base
*/
public MappingElement getExtensionBase() {
return m_extensionBase;
}
/**
* Check if attribute component present.
*
* @return flag
*/
public boolean hasAttribute() {
return m_hasAttribute;
}
/**
* Check if child element component present.
*
* @return flag
*/
public boolean hasChild() {
return m_hasChild;
}
/**
* Check if text component present.
*
* @return flag
*/
public boolean hasText() {
return m_hasText;
}
/**
* Get mapping.
*
* @return mapping
*/
public MappingElement getMapping() {
return m_mapping;
}
/**
* Get name for type.
*
* @return name
*/
public QName getTypeName() {
return m_typeName;
}
/**
* Get element name.
*
* @return element name for concrete mapping (null if abstract)
*/
public QName getOtherName() {
return m_otherName;
}
/**
* Get substitution group base name.
*
* @return substitution group base name
*/
public QName getSubstitution() {
return m_substitutionName;
}
/**
* Set substitution group base name.
*
* @param qname
*/
public void setSubstitution(QName qname) {
m_substitutionName = qname;
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/SharedNestingBase.java 0000644 0001750 0001750 00000020425 10651175632 027320 0 ustar moeller moeller /*
* Copyright (c) 2007, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import org.jibx.binding.util.StringArray;
import org.jibx.runtime.IUnmarshallingContext;
/**
* Base class for all binding customizations that can contain other customizations. This includes inherited values
* shared with customization extensions (in particular, the WSDL extensions).
*
* @author Dennis M. Sosnoski
*/
public abstract class SharedNestingBase extends CustomBase
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new String[] { "name-style", "namespace", "namespace-style", "require" });
// values inherited through nesting
private String m_namespace;
private Integer m_namespaceStyle;
private Integer m_nameStyle;
private Integer m_require;
// value set by subclasses
private String m_actualNamespace;
/**
* Constructor.
*
* @param parent
*/
public SharedNestingBase(SharedNestingBase parent) {
super(parent);
}
//
// Access methods for values inherited through nesting
/**
* Get namespace specified on this element. This method is only intended for use by subclasses - otherwise the
* {@link #getNamespace()} method should instead be used.
*
* @return namespace (null if none)
*/
protected String getSpecifiedNamespace() {
return m_namespace;
}
/**
* Get namespace style.
*
* @return namespace style
*/
public int getNamespaceStyle() {
if (m_namespaceStyle == null) {
if (getParent() == null) {
return DERIVE_BY_PACKAGE;
} else {
return getParent().getNamespaceStyle();
}
} else {
return m_namespaceStyle.intValue();
}
}
/**
* Set name style.
*
* @param style (null if none at this level)
*/
public void setNamespaceStyle(Integer style) {
m_namespaceStyle = style;
}
/**
* Get name style.
*
* @return name style
*/
public int getNameStyle() {
if (m_nameStyle == null) {
if (getParent() == null) {
return CAMEL_CASE_NAMES;
} else {
return getParent().getNameStyle();
}
} else {
return m_nameStyle.intValue();
}
}
/**
* Set name style.
*
* @param style (null if none at this level)
*/
public void setNameStyle(Integer style) {
m_nameStyle = style;
}
/**
* Get the namespace for schema definitions. This value must be set by subclasses using the
* {@link #setNamespace(String)} method.
*
* @return schema namespace
*/
public final String getNamespace() {
return m_actualNamespace;
}
/**
* Set the namespace to be used for schema definitions. This method is only intended for use by subclasses.
*
* @param ns
*/
protected void setNamespace(String ns) {
m_actualNamespace = ns;
}
/**
* Check if primitive value should be treated as required.
*
* @param type primitive type
* @return true if required value, false if not
*/
public boolean isPrimitiveRequired(String type) {
if (m_require == null) {
if (getParent() == null) {
return true;
} else {
return getParent().isPrimitiveRequired(type);
}
} else {
return m_require.intValue() == REQUIRE_ALL || m_require.intValue() == REQUIRE_PRIMITIVES;
}
}
/**
* Check if object value should be treated as required.
*
* @param type object type
* @return true if required value, false if not
*/
public boolean isObjectRequired(String type) {
if (m_require == null) {
if (getParent() == null) {
return false;
} else {
return getParent().isObjectRequired(type);
}
} else {
return m_require.intValue() == REQUIRE_ALL || m_require.intValue() == REQUIRE_OBJECTS;
}
}
/**
* Convert class or unprefixed field name to element or attribute name using current format.
*
* @param base class or simple field name to be converted
* @return element or attribute name
*/
public String convertName(String base) {
return convertName(base, getNameStyle());
}
/**
* Name style set text method. This is intended for use during unmarshalling. TODO: add validation
*
* @param text
* @param ictx
*/
private void setNameStyleText(String text, IUnmarshallingContext ictx) {
if (text == null) {
m_nameStyle = null;
} else {
m_nameStyle = new Integer(s_nameStyleEnum.getValue(text));
}
}
/**
* Name style get text method. This is intended for use during marshalling.
*
* @return text
*/
private String getNameStyleText() {
if (m_nameStyle == null) {
return null;
} else {
return s_nameStyleEnum.getName(m_nameStyle.intValue());
}
}
/**
* Namespace style set text method. This is intended for use during unmarshalling. TODO: add validation
*
* @param text
* @param ictx
*/
private void setNamespaceStyleText(String text, IUnmarshallingContext ictx) {
if (text == null) {
m_namespaceStyle = null;
} else {
m_namespaceStyle = new Integer(s_namespaceStyleEnum.getValue(text));
}
}
/**
* Namespace style get text method. This is intended for use during marshalling.
*
* @return text
*/
private String getNamespaceStyleText() {
if (m_namespaceStyle == null) {
return null;
} else {
return s_namespaceStyleEnum.getName(m_namespaceStyle.intValue());
}
}
/**
* Required set text method. This is intended for use during unmarshalling. TODO: add validation
*
* @param text
* @param ictx
*/
private void setRequireText(String text, IUnmarshallingContext ictx) {
if (text == null) {
m_require = null;
} else {
m_require = new Integer(s_requireEnum.getValue(text));
}
}
/**
* Required get text method. This is intended for use during marshalling.
*
* @return text
*/
private String getRequireText() {
if (m_require == null) {
return null;
} else {
return s_requireEnum.getName(m_require.intValue());
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/UniqueNameSet.java 0000644 0001750 0001750 00000010506 10756324060 026506 0 ustar moeller moeller /*
* Copyright (c) 2007-2008, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Set;
import org.apache.log4j.Logger;
/**
* Set of unique names for a context. This assures uniqueness as names are added to the set.
*
* @author Dennis M. Sosnoski
*/
public class UniqueNameSet
{
/** Logger for class. */
private static final Logger s_logger = Logger.getLogger(UniqueNameSet.class.getName());
/** Set of names used. */
private final Set m_nameSet;
/**
* Constructor.
*/
public UniqueNameSet() {
m_nameSet = new HashSet();
}
/**
* Copy constructor. Creates a name set initialized to contain all the names from another name set.
*
* @param original
*/
public UniqueNameSet(UniqueNameSet original) {
this();
addAll(original);
}
/**
* Check if a name is already present in context.
*
* @param name
* @return true if present, false if not
*/
public boolean contains(String name) {
return m_nameSet.contains(name);
}
/**
* Add all the names from another name set to this set. This does not check for conflicts between the names in the
* two sets.
*
* @param other
*/
public void addAll(UniqueNameSet other) {
m_nameSet.addAll(other.m_nameSet);
}
/**
* Add name to set. If the supplied name is already present, it is modified by appending a variable suffix. If the
* supplied name ends with a digit, the suffix is generated starting with the letter 'a'; otherwise, it's generated
* starting at '1'. Either way, the suffix is incremented as many times as necessary to obtain a unique name.
*
* @param base name to try adding
* @return assigned name
*/
public String add(String base) {
String name = base;
int index = 1;
boolean usealpha = base.length() > 0 && Character.isDigit(base.charAt(base.length()-1));
while (m_nameSet.contains(name)) {
if (usealpha) {
String suffix = "";
int value = index++ - 1;
do {
int modulo = value % 52;
if (modulo > 26) {
suffix = (char)('A' + modulo - 26) + suffix;
} else {
suffix = (char)('a' + modulo) + suffix;
}
value /= 52;
} while (value > 0);
name = base + suffix;
} else {
name = base + index++;
}
}
m_nameSet.add(name);
return name;
}
/**
* Get iterator for names in set.
*
* @return iterator
*/
public Iterator iterator() {
return m_nameSet.iterator();
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/generator/binding.xml 0000644 0001750 0001750 00000016362 10752422164 025262 0 ustar moeller moeller libjibx-java-1.1.6a/build/src/org/jibx/binding/model/ 0000755 0001750 0001750 00000000000 11023035622 022217 5 ustar moeller moeller libjibx-java-1.1.6a/build/src/org/jibx/binding/model/AttributeBase.java 0000644 0001750 0001750 00000005345 10210703670 025631 0 ustar moeller moeller /*
Copyright (c) 2004-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
/**
* Base class for all attribute group structures in binding definition model.
* This just provides the basic validation hooks.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public abstract class AttributeBase
{
/**
* Prevalidate attribute information. The prevalidation step is used to
* check attribute values in isolation, such as the settings for enumerated
* values and class file information. This empty base class implementation
* should be overridden by each subclass that requires prevalidation
* handling.
*
* @param vctx validation context
*/
public void prevalidate(ValidationContext vctx) {}
/**
* Validate attribute information. The validation step is used for checking
* the interactions between attributes, such as references to named elements
* and namespace usage. The {@link #prevalidate} method will always be
* called for every component in the binding definition before this method
* is called for any component. This empty base class implementation should
* be overridden by each subclass that requires validation handling.
*
* @param vctx validation context
*/
public void validate(ValidationContext vctx) {}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/BindingDirectory.java 0000644 0001750 0001750 00000034070 10767273606 026351 0 ustar moeller moeller /*
* Copyright (c) 2008, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.Set;
import org.jibx.runtime.IBindingFactory;
import org.jibx.runtime.IMarshallable;
import org.jibx.runtime.IMarshallingContext;
import org.jibx.runtime.JiBXException;
import org.jibx.util.InsertionOrderedMap;
/**
* Organizer for a set of bindings under construction. This tracks the individual bindings by default namespace, and
* manages the relationships between the different bindings.
*
* @author Dennis M. Sosnoski
*/
public class BindingDirectory
{
//
// Flags to initialize constructed bindings
private final boolean m_forceClasses;
private final boolean m_trackSource;
private final boolean m_addConstructors;
private final boolean m_inBinding;
private final boolean m_outBinding;
/** Map from namespace URI to binding holder. */
private final InsertionOrderedMap m_uriBindingMap;
/**
* Constructor taking flags used with constructed bindings.
*
* @param force force classes flag
* @param track track source flag
* @param addcon add constructors flag
* @param in input binding flag
* @param out output binding flag
*/
public BindingDirectory(boolean force, boolean track, boolean addcon, boolean in, boolean out) {
m_forceClasses = force;
m_trackSource = track;
m_addConstructors = addcon;
m_inBinding = in;
m_outBinding = out;
m_uriBindingMap = new InsertionOrderedMap();
}
/**
* Find the binding to be used for a particular namespace. If this is the first time a particular namespace was
* requested, a new binding will be created for that namespace and returned.
*
* @param uri namespace URI (null if no namespace)
* @return binding holder
*/
public BindingHolder findBinding(String uri) {
BindingHolder hold = (BindingHolder)m_uriBindingMap.get(uri);
if (hold == null) {
hold = new BindingHolder(uri, m_uriBindingMap.size() + 1, this);
m_uriBindingMap.put(uri, hold);
BindingElement binding = hold.getBinding();
binding.setForceClasses(m_forceClasses);
binding.setTrackSource(m_trackSource);
binding.setAddConstructors(m_addConstructors);
binding.setInBinding(m_inBinding);
binding.setOutBinding(m_outBinding);
}
return hold;
}
/**
* General object comparison method. Don't know why Sun hasn't seen fit to include this somewhere, but at least it's
* easy to write (over and over again).
*
* @param a first object to be compared
* @param b second object to be compared
* @return true if both objects are null, or if a.equals(b);
* false otherwise
*/
public static boolean isEqual(Object a, Object b) {
return (a == null) ? b == null : a.equals(b);
}
/**
* Add dependency on another binding.
*
* @param uri namespace for binding of referenced component
* @param hold binding holder
*/
public void addDependency(String uri, BindingHolder hold) {
if (!isEqual(uri, hold.getNamespace())) {
BindingHolder tohold = findBinding(uri);
hold.addReference(tohold);
}
}
/**
* Fix all references between bindings. This needs to be called after the generation of binding components is
* completed, in order to make sure that required namespace definitions are included in the output bindings.
*/
public void finish() {
ArrayList uris = getNamespaces();
for (int i = 0; i < uris.size(); i++) {
String uri = (String)uris.get(i);
BindingHolder holder = (BindingHolder)m_uriBindingMap.get(uri);
holder.finish();
}
}
/**
* Get the existing binding definition for a namespace.
*
* @param uri
* @return binding holder, or null if none
*/
public BindingHolder getBinding(String uri) {
return (BindingHolder)m_uriBindingMap.get(uri);
}
/**
* Get the list of binding namespace URIs.
*
* @return namespaces
*/
public ArrayList getNamespaces() {
return m_uriBindingMap.keyList();
}
/**
* Add namespace declarations to binding. This is used to define any namespaces which are not directly used by the
* binding(s) but need to be present in the binding definition.
*
* @param adduris
* @param binding
*/
private void addNamespaceDeclarations(String[] adduris, BindingElement binding) {
int offset = -1;
int nsnum = m_uriBindingMap.size();
for (int i = 0; i < adduris.length; i++) {
String adduri = adduris[i];
if (!m_uriBindingMap.containsKey(adduri)) {
ArrayList childs = binding.topChildren();
if (offset < 0) {
while (++offset < childs.size() && (childs.get(offset) instanceof NamespaceElement));
}
NamespaceElement ns = new NamespaceElement();
ns.setDefaultName("none");
ns.setUri(adduri);
ns.setPrefix("ns" + ++nsnum);
childs.add(offset++, ns);
}
}
}
/**
* Check if a character is an ASCII alpha character.
*
* @param chr
* @return alpha character flag
*/
private static boolean isAsciiAlpha(char chr) {
return (chr >= 'a' && chr <= 'z') || (chr >= 'A' && chr <= 'Z');
}
/**
* Check if a character is an ASCII numeric character.
*
* @param chr
* @return numeric character flag
*/
private static boolean isAsciiNum(char chr) {
return chr >= '0' && chr <= '9';
}
/**
* Check if a character is an ASCII alpha or numeric character.
*
* @param chr
* @return alpha or numeric character flag
*/
private static boolean isAsciiAlphaNum(char chr) {
return isAsciiAlpha(chr) || isAsciiNum(chr);
}
/**
* Configure the names to be used for writing bindings to files. If only one binding has been defined, it just gets
* the supplied name. If multiple bindings have been defined, a single root binding is constructed which includes
* all the other bindings, and that root binding is given the supplied name while the other bindings are given
* unique names within the same directory.
*
* @param name file name for root or singleton binding definition
* @param adduris list of namespaces to be added to bindings, if not already defined
* @param pack target package for binding
* @return root or singleton binding holder
*/
public BindingHolder configureFiles(String name, String[] adduris, String pack) {
BindingHolder rhold;
BindingElement root;
ArrayList uris = getNamespaces();
if (uris.size() == 1) {
// single binding, just write it using supplied name and added namespaces
rhold = (BindingHolder)m_uriBindingMap.get(uris.get(0));
root = rhold.getBinding();
} else {
// get or create no namespace binding
rhold = findBinding(null);
root = rhold.getBinding();
// set file names and add to root binding
Set nameset = new HashSet();
for (int i = 0; i < uris.size(); i++) {
String uri = (String)uris.get(i);
BindingHolder holder = (BindingHolder)m_uriBindingMap.get(uri);
if (holder != rhold) {
// get last part of namespace URI as file name candidate
String bindname;
String raw = holder.getNamespace();
if (raw == null) {
bindname = "nonamespaceBinding";
} else {
// strip off protocol and any trailing slash
raw = raw.replace('\\', '/');
int split = raw.indexOf("://");
if (split >= 0) {
raw = raw.substring(split + 3);
}
while (raw.endsWith("/")) {
raw = raw.substring(0, raw.length()-1);
}
// strip off host portion if present and followed by path
split = raw.indexOf('/');
if (split > 0 && raw.substring(0, split).indexOf('.') > 0) {
raw = raw.substring(split+1);
}
// eliminate any invalid characters in name
StringBuffer buff = new StringBuffer();
int index = 0;
char chr = raw.charAt(0);
if (isAsciiAlpha(chr)) {
buff.append(chr);
index = 1;
} else {
buff.append('_');
}
boolean toupper = false;
while (index < raw.length()) {
chr = raw.charAt(index++);
if (isAsciiAlphaNum(chr)) {
if (toupper) {
chr = Character.toUpperCase(chr);
toupper = false;
}
buff.append(chr);
} else if (chr == '.') {
toupper = true;
}
}
buff.append("Binding");
bindname = buff.toString();
}
// ensure uniqueness of the name
String uname = bindname.toLowerCase();
int pass = 0;
while (nameset.contains(uname)) {
bindname = bindname + pass;
uname = bindname.toLowerCase();
}
nameset.add(uname);
holder.setFileName(bindname + ".xml");
// include within the root binding
IncludeElement include = new IncludeElement();
include.setIncludePath(holder.getFileName());
rhold.addInclude(include);
}
}
}
// add any necessary namespace declarations to binding root
addNamespaceDeclarations(adduris, root);
// set the file name on the singleton or root binding
rhold.setFileName(name);
// set the binding name based on the file name
int split = name.lastIndexOf('.');
if (split > 0) {
root.setName(name.substring(0, split));
} else {
root.setName(name);
}
// set the target package for code generation
root.setTargetPackage(pack);
return rhold;
}
/**
* Write the bindings to supplied destination path. This first finalizes the binding defintions with a call to
* {@link #finish()}, then writes the completed bindings. The binding file names must be set before calling this
* method, generally by a call to {@link #configureFiles(String, String[], String)}.
*
* @param dir target directory for writing binding definitions
* @throws JiBXException
* @throws IOException
*/
public void writeBindings(File dir) throws JiBXException, IOException {
finish();
IBindingFactory fact = org.jibx.runtime.BindingDirectory.getFactory(BindingElement.class);
IMarshallingContext ictx = fact.createMarshallingContext();
ictx.setIndent(2);
ArrayList uris = getNamespaces();
for (int i = 0; i < uris.size(); i++) {
String uri = (String)uris.get(i);
BindingHolder holder = (BindingHolder)m_uriBindingMap.get(uri);
File file = new File(dir, holder.getFileName());
ictx.setOutput(new FileOutputStream(file), null);
((IMarshallable)holder.getBinding()).marshal(ictx);
ictx.getXmlWriter().flush();
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/BindingElement.java 0000644 0001750 0001750 00000074472 11002542656 025773 0 ustar moeller moeller /*
Copyright (c) 2004-2008, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import org.jibx.binding.classes.ClassCache;
import org.jibx.binding.util.StringArray;
import org.jibx.runtime.BindingDirectory;
import org.jibx.runtime.EnumSet;
import org.jibx.runtime.IBindingFactory;
import org.jibx.runtime.IMarshallingContext;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.IXMLWriter;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.Utility;
import org.jibx.runtime.impl.UnmarshallingContext;
/**
* Model component for binding element.
*
* @author Dennis M. Sosnoski
*/
public class BindingElement extends NestingElementBase
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new String[] { "add-constructors", "direction",
"force-classes", "forwards", "name", "package", "track-source" },
NestingElementBase.s_allowedAttributes);
//
// Value set information
public static final int IN_BINDING = 0;
public static final int OUT_BINDING = 1;
public static final int BOTH_BINDING = 2;
/*package*/ static final EnumSet s_directionEnum = new EnumSet(IN_BINDING,
new String[] { "input", "output", "both" });
//
// Instance data
/** Binding name. */
private String m_name;
/** Binding direction. */
private String m_direction;
/** Input binding flag. */
private boolean m_isInput;
/** Output binding flag. */
private boolean m_isOutput;
/** Support forward references to IDs flag. */
private boolean m_isForward;
/** Generate souce tracking interface flag. */
private boolean m_isTrackSource;
/** Generate souce tracking interface flag. */
private boolean m_isForceClasses;
/** Add default constructors where needed flag. */
private boolean m_isAddConstructors;
/** Package for generated context factory. */
private String m_targetPackage;
/** Base URL for use with relative include paths. */
private URL m_baseUrl;
/** Set of paths for includes. */
private final Set m_includePaths;
/** Map from include path to actual binding. */
private final Map m_includeBindings;
/** List of child elements. */
private final ArrayList m_children;
/** Set of class names which can be referenced by ID. */
private Set m_idClassSet;
/** List of namespace declarations to be added on output (lazy create,
null if none). */
private ArrayList m_namespaceDeclares;
/**
* Default constructor.
*/
public BindingElement() {
super(BINDING_ELEMENT);
m_includePaths = new HashSet();
m_includeBindings = new HashMap();
m_children = new ArrayList();
m_isForward = true;
}
/**
* Set binding name.
*
* @param name binding definition name
*/
public void setName(String name) {
m_name = name;
}
/**
* Get binding name.
*
* @return binding definition name
*/
public String getName() {
return m_name;
}
/**
* Set forward references to IDs be supported in XML.
*
* @param forward true if forward references supported,
* false if not
*/
public void setForward(boolean forward) {
m_isForward = forward;
}
/**
* Check if forward references to IDs must be supported in XML.
*
* @return true if forward references required,
* false if not
*/
public boolean isForward() {
return m_isForward;
}
/**
* Set source position tracking for unmarshalling.
*
* @param track true if source position tracking enabled,
* false if not
*/
public void setTrackSource(boolean track) {
m_isTrackSource = track;
}
/**
* Check if source position tracking enabled for unmarshalling.
*
* @return true if source position tracking enabled,
* false if not
*/
public boolean isTrackSource() {
return m_isTrackSource;
}
/**
* Set force marshaller/unmarshaller class creation for top-level non-base
* abstract mappings.
*
* @param force true if class generation forced,
* false if not
*/
public void setForceClasses(boolean force) {
m_isForceClasses = force;
}
/**
* Check if marshaller/unmarshaller class creation for top-level non-base
* abstract mappings is forced.
*
* @return true if class generation forced,
* false if not
*/
public boolean isForceClasses() {
return m_isForceClasses;
}
/**
* Set default constructor generation.
*
* @param add true if constructors should be added,
* false if not
*/
public void setAddConstructors(boolean add) {
m_isAddConstructors = add;
}
/**
* Check if default constructor generation is enabled.
*
* @return true if default constructor generation enabled,
* false if not
*/
public boolean isAddConstructors() {
return m_isAddConstructors;
}
/**
* Set package for generated context factory class.
*
* @param pack generated context factory package
*/
public void setTargetPackage(String pack) {
m_targetPackage = pack;
}
/**
* Get package for generated context factory class.
*
* @return package for generated context factory
*/
public String getTargetPackage() {
return m_targetPackage;
}
/**
* Set base URL for relative include paths.
*
* @param base
*/
public void setBaseUrl(URL base) {
m_baseUrl = base;
}
/**
* Get base URL for relative include paths.
*
* @return base URL
*/
public URL getBaseUrl() {
return m_baseUrl;
}
/**
* Set the correct direction text. This should be used whenever the
* individual in and out flags are set, so that modifications are output
* correctly when a binding is marshalled.
*/
private void setDirection() {
int direct = m_isInput ? (m_isOutput ? BOTH_BINDING : IN_BINDING) :
OUT_BINDING;
m_direction = s_directionEnum.getName(direct);
}
/**
* Set binding component applies for marshalling XML.
*
* @param out true if binding supports output,
* false if not
*/
public void setOutBinding(boolean out) {
m_isOutput = out;
setDirection();
}
/**
* Check if this binding component applies for marshalling XML.
*
* @return true if binding supports output, false
* if not
*/
public boolean isOutBinding() {
return m_isOutput;
}
/**
* Set binding component applies for unmarshalling XML.
*
* @param in true if binding supports input,
* false if not
*/
public void setInBinding(boolean in) {
m_isInput = in;
setDirection();
}
/**
* Check if this binding component applies for unmarshalling XML.
*
* @return true if binding supports input, false
* if not
*/
public boolean isInBinding() {
return m_isInput;
}
/**
* Add include path to set processed.
*
* @param path
* @return true if new path, false if duplicate
*/
public boolean addIncludePath(String path) {
return m_includePaths.add(path);
}
/**
* Get included binding. If the binding was supplied directly it's just
* returned; otherwise, it's read from the URL. This method should only be
* called if {@link #addIncludePath(String)} returns true,
* so that each unique included binding is only processed once.
*
* @param url binding path
* @param root binding containing the include
* @param vctx validation context
* @return binding
* @throws IOException
* @throws JiBXException
*/
public BindingElement getIncludeBinding(URL url, BindingElement root,
ValidationContext vctx) throws IOException, JiBXException {
String path = url.toExternalForm();
BindingElement bind = (BindingElement)m_includeBindings.get(path);
if (bind == null) {
// get base name from path
path = path.replace('\\', '/');
int split = path.lastIndexOf('/');
String fname = path;
if (split >= 0) {
fname = fname.substring(split+1);
}
// read stream to create object model
InputStream is = url.openStream();
bind = BindingElement.readBinding(is, fname, root, vctx);
}
// set binding base, and context from root context
bind.setBaseUrl(url);
bind.setDefinitions(root.getDefinitions().getIncludeCopy());
m_includeBindings.put(path, bind);
return bind;
}
/**
* Get existing included binding.
*
* @param url binding path
* @return binding if it exists, otherwise null
*/
public BindingElement getExistingIncludeBinding(URL url) {
return (BindingElement)m_includeBindings.get(url.toExternalForm());
}
/**
* Add binding accessible to includes. This allows bindings to be supplied
* directly, without needing to be parsed from an input document.
*
* @param path URL string identifying the binding (virtual path)
* @param bind
*/
public void addIncludeBinding(String path, BindingElement bind) {
if (addIncludePath(path)) {
m_includeBindings.put(path, bind);
}
}
/**
* Add a class defined with a ID value. This is used to track the classes
* with ID values for validating ID references in the binding. If the
* binding uses global IDs, the actual ID class is added to the table along
* with all interfaces implemented by the class and all superclasses, since
* instances of the ID class can be referenced in any of those forms. If the
* binding does not use global IDs, only the actual ID class is added, since
* references must be type-specific.
*
* @param clas information for class with ID value
*/
public void addIdClass(IClass clas) {
// create the set if not already present
if (m_idClassSet == null) {
m_idClassSet = new HashSet();
}
// add the class if not already present
if (m_idClassSet.add(clas.getName())) {
// new class, add all interfaces if not previously defined
String[] inames = clas.getInterfaces();
for (int i = 0; i < inames.length; i++) {
m_idClassSet.add(inames[i]);
}
while (clas != null && m_idClassSet.add(clas.getName())) {
clas = clas.getSuperClass();
}
}
}
/**
* Check if a class can be referenced by ID. This just checks if any classes
* compatible with the reference type are bound with ID values.
*
* @param name fully qualified name of class
* @return true if class is bound with an ID,
* false if not
*/
public boolean isIdClass(String name) {
if (m_idClassSet == null) {
return false;
} else {
return m_idClassSet.contains(name);
}
}
/**
* Add top-level child element.
* TODO: should be ElementBase argument, but JiBX doesn't allow yet
*
* @param child element to be added as child of this element
*/
public void addTopChild(Object child) {
m_children.add(child);
}
/**
* Get list of top-level child elements.
*
* @return list of child elements, or null if none
*/
public ArrayList topChildren() {
return m_children;
}
/**
* Get iterator for top-level child elements.
*
* @return iterator for child elements
*/
public Iterator topChildIterator() {
return m_children.iterator();
}
/**
* Add namespace declaration for output when marshalling.
*
* @param prefix
* @param uri
*/
public void addNamespaceDecl(String prefix, String uri) {
if (m_namespaceDeclares == null) {
m_namespaceDeclares = new ArrayList();
}
m_namespaceDeclares.add(prefix);
m_namespaceDeclares.add(uri);
}
//
// Overrides of base class methods.
/* (non-Javadoc)
* @see org.jibx.binding.model.ElementBase#hasAttribute()
*/
public boolean hasAttribute() {
throw new IllegalStateException
("Internal error: method should never be called");
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ElementBase#hasContent()
*/
public boolean hasContent() {
throw new IllegalStateException
("Internal error: method should never be called");
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ElementBase#isOptional()
*/
public boolean isOptional() {
throw new IllegalStateException
("Internal error: method should never be called");
}
/**
* Get default style value for child components. This call is only
* meaningful after validation.
*
* @return default style value for child components
*/
public int getDefaultStyle() {
int style = super.getDefaultStyle();
if (style < 0) {
style = NestingAttributes.s_styleEnum.getValue("element");
}
return style;
}
//
// Marshalling/unmarshalling methods
/**
* Marshalling hook method to add namespace declarations to <binding>
* element.
*
* @param ictx
* @throws IOException
*/
private void preGet(IMarshallingContext ictx) throws IOException {
if (m_namespaceDeclares != null) {
// set up information for namespace indexes and prefixes
IXMLWriter writer = ictx.getXmlWriter();
String[] uris = new String[m_namespaceDeclares.size()/2];
int[] indexes = new int[uris.length];
String[] prefs = new String[uris.length];
int base = writer.getNamespaceCount();
for (int i = 0; i < uris.length; i++) {
indexes[i] = base + i;
prefs[i] = (String)m_namespaceDeclares.get(i*2);
uris[i] = (String)m_namespaceDeclares.get(i*2+1);
}
// add the namespace declarations to current element
writer.pushExtensionNamespaces(uris);
writer.openNamespaces(indexes, prefs);
for (int i = 0; i < uris.length; i++) {
String prefix = prefs[i];
String name = prefix.length() > 0 ?
"xmlns:" + prefix : "xmlns";
writer.addAttribute(0, name, uris[i]);
}
}
}
//
// Validation methods
/**
* Make sure all attributes are defined.
*
* @param ictx unmarshalling context
* @exception JiBXException on unmarshalling error
*/
private void preSet(IUnmarshallingContext ictx) throws JiBXException {
// validate the attributes defined for this element
validateAttributes(ictx, s_allowedAttributes);
// get the unmarshal wrapper
UnmarshalWrapper wrapper =
(UnmarshalWrapper)ictx.getStackObject(ictx.getStackDepth()-1);
if (wrapper.getContainingBinding() != null) {
// check attributes not allowed on included binding
BindingElement root = wrapper.getContainingBinding();
ValidationContext vctx = wrapper.getValidation();
UnmarshallingContext uctx = (UnmarshallingContext)ictx;
for (int i = 0; i < uctx.getAttributeCount(); i++) {
// check if nonamespace attribute is in the allowed set
String name = uctx.getAttributeName(i);
if (uctx.getAttributeNamespace(i).length() == 0) {
if (s_allowedAttributes.indexOf(name) >= 0) {
String value = uctx.getAttributeValue(i);
if ("direction".equals(name)) {
if (!root.m_direction.equals(value)) {
vctx.addError("'direction' value on included binding must match the root binding",
this);
}
} else if ("track-source".equals(name)) {
boolean flag = Utility.parseBoolean(value);
if (root.m_isTrackSource != flag) {
vctx.addError("'track-source' value on included binding must match the root binding",
this);
}
} else if ("value-style".equals(name)) {
if (!root.getStyleName().equals(value)) {
vctx.addError("'value-style' value on included binding must match the root binding",
this);
}
} else if ("force-classes".equals(name)) {
boolean flag = Utility.parseBoolean(value);
if (root.m_isForceClasses != flag) {
vctx.addError("'force-classes' value on included binding must match the root binding",
this);
}
} else if ("add-constructors".equals(name)) {
boolean flag = Utility.parseBoolean(value);
if (root.m_isAddConstructors != flag) {
vctx.addError("'add-constructors' value on included binding must match the root binding",
this);
}
} else if ("forwards".equals(name)) {
boolean flag = Utility.parseBoolean(value);
if (root.m_isForward != flag) {
vctx.addError("'forwards' value on included binding must match the root binding",
this);
}
} else {
vctx.addError("Attribute '" + name + "' not allowed on included binding",
this);
}
}
}
}
}
}
/**
* Prevalidate all attributes of element in isolation.
*
* @param vctx validation context
*/
public void prevalidate(ValidationContext vctx) {
// set the direction flags
int index = -1;
if (m_direction != null) {
index = s_directionEnum.getValue(m_direction);
if (index < 0) {
vctx.addError("Value \"" + m_direction +
"\" is not a valid choice for direction");
}
} else {
index = BOTH_BINDING;
}
m_isInput = index == IN_BINDING || index == BOTH_BINDING;
m_isOutput = index == OUT_BINDING || index == BOTH_BINDING;
// check for illegal characters in name
if (m_name != null) {
int length = m_name.length();
for (int i = 0; i < length; i++) {
if (!Character.isJavaIdentifierPart(m_name.charAt(i))) {
vctx.addError("Binding name '" + m_name +
" contains invalid characters (only Java identifier part characters allowed)",
this);
break;
}
}
}
super.prevalidate(vctx);
}
private static FormatElement buildFormat(String name, String type,
boolean use, String sname, String dname, String dflt) {
FormatElement format = new FormatElement();
format.setLabel(name);
format.setTypeName(type);
format.setDefaultFormat(use);
format.setSerializerName(sname);
format.setDeserializerName(dname);
format.setDefaultText(dflt);
return format;
}
private void defineBaseFormat(FormatElement format,
DefinitionContext dctx, ValidationContext vctx) {
format.prevalidate(vctx);
format.validate(vctx);
dctx.addFormat(format, vctx);
}
/**
* Run the actual validation of a binding model.
*
* @param vctx context for controlling validation
*/
public void runValidation(ValidationContext vctx) {
// initially enable both directions for format setup
m_isInput = true;
m_isOutput = true;
// create outer definition context
DefinitionContext dctx = new DefinitionContext(null);
vctx.setGlobalDefinitions(dctx);
for (int i = 0; i < FormatDefaults.s_defaultFormats.length; i++) {
defineBaseFormat(FormatDefaults.s_defaultFormats[i], dctx, vctx);
}
FormatElement format = buildFormat("char.string", "char", false,
"org.jibx.runtime.Utility.serializeCharString",
"org.jibx.runtime.Utility.deserializeCharString", "0");
format.setDefaultFormat(false);
format.prevalidate(vctx);
format.validate(vctx);
dctx.addFormat(format, vctx);
NamespaceElement ns = new NamespaceElement();
ns.setDefaultName("all");
ns.prevalidate(vctx);
dctx.addNamespace(ns);
// TODO: check for errors in basic configuration
// create a definition context for the binding
setDefinitions(new DefinitionContext(dctx));
// run the actual validation
vctx.prevalidate(this);
RegistrationVisitor rvisitor = new RegistrationVisitor(vctx);
rvisitor.visitTree(this);
vctx.validate(this);
}
/**
* Read a binding definition (possibly as an include) to construct binding
* model.
*
* @param is input stream for reading binding
* @param fname name of input file (null if unknown)
* @param contain containing binding (null if none)
* @param vctx validation context used during unmarshalling
* @return root of binding definition model
* @throws JiBXException on error in reading binding
*/
public static BindingElement readBinding(InputStream is, String fname,
BindingElement contain, ValidationContext vctx) throws JiBXException {
// look up the binding factory
IBindingFactory bfact =
BindingDirectory.getFactory(BindingElement.class);
// unmarshal document to construct objects
IUnmarshallingContext uctx = bfact.createUnmarshallingContext();
uctx.setDocument(is, fname, null);
uctx.pushObject(new UnmarshalWrapper(vctx, contain));
BindingElement binding = (BindingElement)uctx.unmarshalElement();
uctx.popObject();
return binding;
}
/**
* Read a binding definition to construct binding model.
*
* @param is input stream for reading binding
* @param fname name of input file (null if unknown)
* @param vctx validation context used during unmarshalling
* @return root of binding definition model
* @throws JiBXException on error in reading binding
*/
public static BindingElement readBinding(InputStream is, String fname,
ValidationContext vctx) throws JiBXException {
return readBinding(is, fname, null, vctx);
}
/**
* Validate a binding definition.
*
* @param name binding definition name
* @param path binding definition URL
* @param is input stream for reading binding
* @param vctx validation context to record problems
* @return root of binding definition model, or null if error
* in unmarshalling
* @throws JiBXException on error in binding XML structure
*/
public static BindingElement validateBinding(String name, URL path,
InputStream is, ValidationContext vctx) throws JiBXException {
// construct object model for binding
BindingElement binding = readBinding(is, name, vctx);
binding.setBaseUrl(path);
vctx.setBindingRoot(binding);
// validate the binding definition
binding.runValidation(vctx);
// list validation errors
ArrayList probs = vctx.getProblems();
if (probs.size() > 0) {
for (int i = 0; i < probs.size(); i++) {
ValidationProblem prob = (ValidationProblem)probs.get(i);
System.out.print(prob.getSeverity() >=
ValidationProblem.ERROR_LEVEL ? "Error: " : "Warning: ");
System.out.println(prob.getDescription());
}
}
return binding;
}
/**
* Create a default validation context.
*
* @return new validation context
*/
public static ValidationContext newValidationContext() {
IClassLocator locate = new IClassLocator() {
public IClass getClassInfo(String name) {
try {
return new ClassWrapper(this, ClassCache.getClassFile(name));
} catch (JiBXException e) {
return null;
}
}
};
return new ValidationContext(locate);
}
/* // test runner
// This code only used in testing, to roundtrip binding definitions
public static void test(String ipath, String opath, ValidationContext vctx)
throws Exception {
// validate the binding definition
FileInputStream is = new FileInputStream(ipath);
URL url = new URL("file://" + ipath);
BindingElement binding = validateBinding(ipath, url, is, vctx);
// marshal back out for comparison purposes
IBindingFactory bfact =
BindingDirectory.getFactory(BindingElement.class);
IMarshallingContext mctx = bfact.createMarshallingContext();
mctx.setIndent(2);
mctx.marshalDocument(binding, null, null, new FileOutputStream(opath));
System.out.println("Wrote output binding " + opath);
// compare input document with output document
DocumentComparator comp = new DocumentComparator(System.err);
boolean match = comp.compare(new FileReader(ipath),
new FileReader(opath));
if (!match) {
System.err.println("Mismatch from input " + ipath +
" to output " + opath);
}
}
// test runner
public static void main(String[] args) throws Exception {
// configure class loading
String[] paths = new String[] { "." };
ClassCache.setPaths(paths);
ClassFile.setPaths(paths);
ValidationContext vctx = newValidationContext();
// process all bindings listed on command line
for (int i = 0; i < args.length; i++) {
try {
String ipath = args[i];
int split = ipath.lastIndexOf(File.separatorChar);
String opath = "x" + ipath.substring(split+1);
test(ipath, opath, vctx);
} catch (Exception e) {
System.err.println("Error handling binding " + args[i]);
e.printStackTrace();
}
}
} */
/**
* Inner class as wrapper for binding element on unmarshalling. This
* provides a handle for passing the validation context, allowing elements
* to check for problems during unmarshalling.
*/
public static class UnmarshalWrapper
{
private final ValidationContext m_validationContext;
private final BindingElement m_containingBinding;
protected UnmarshalWrapper(ValidationContext vctx,
BindingElement contain) {
m_validationContext = vctx;
m_containingBinding = contain;
}
public ValidationContext getValidation() {
return m_validationContext;
}
public BindingElement getContainingBinding() {
return m_containingBinding;
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/BindingHolder.java 0000644 0001750 0001750 00000014200 10767273436 025614 0 ustar moeller moeller /*
* Copyright (c) 2007-2008, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import java.util.ArrayList;
import java.util.Iterator;
import org.jibx.schema.support.LazyList;
import org.jibx.util.HolderBase;
/**
* External data for a binding definition. This tracks references to other bindings, along with the associated namespace
* information.
*
* TODO: replace the lists for individual child element types with filtered lists on the binding element
*
* @author Dennis M. Sosnoski
*/
public class BindingHolder extends HolderBase
{
/** Directory managing this holder. */
private final BindingDirectory m_directory;
/** Actual binding definition. */
private BindingElement m_binding;
/** Binding finalized flag. */
private boolean m_finished;
/** List of format definitions in binding. */
private final LazyList m_formats;
/** List of includes for binding. */
private final LazyList m_includes;
/** List of mapping definitions in binding. */
private final LazyList m_mappings;
/**
* Constructor.
*
* @param uri (null if no-namespace binding)
* @param index binding index number
* @param dir directory managing this holder
*/
public BindingHolder(String uri, int index, BindingDirectory dir) {
super(uri);
m_directory = dir;
m_binding = new BindingElement();
m_formats = new LazyList();
m_includes = new LazyList();
m_mappings = new LazyList();
if (uri != null) {
NamespaceElement ns = new NamespaceElement();
ns.setDefaultName("elements");
ns.setUri(uri);
ns.setPrefix("ns" + index);
m_binding.addTopChild(ns);
m_binding.addNamespaceDecl("tns", uri);
}
}
/**
* Get the binding directory managing this holder.
*
* @return directory
*/
public BindingDirectory getDirectory() {
return m_directory;
}
/**
* Get the binding element.
*
* @return binding
*/
public BindingElement getBinding() {
return m_binding;
}
/**
* Set the binding element. This method is provided so that the generated binding element can be replaced by one
* which has been read in from a file after being written.
*
* @param bind
*/
public void setBinding(BindingElement bind) {
m_binding = bind;
}
/**
* Internal check method to verify that the binding is still modifiable.
*/
private void checkModifiable() {
if (m_finished) {
throw new IllegalStateException("Internal error - attempt to modify binding after finalized");
}
}
/**
* Implementation method to handle adding a namespace declaration. This sets up the namespace declaration for output
* in the generated XML.
*
* @param prefix
* @param uri
*/
protected void addNamespaceDecl(String prefix, String uri) {
checkModifiable();
m_binding.addNamespaceDecl(prefix, uri);
}
/**
* Add a format definition to the binding.
*
* @param format
*/
public void addFormat(FormatElement format) {
checkModifiable();
m_formats.add(format);
}
/**
* Add an include to the binding.
*
* @param include
*/
public void addInclude(IncludeElement include) {
checkModifiable();
m_includes.add(include);
}
/**
* Add a mapping definition to the binding.
*
* @param mapping
*/
public void addMapping(MappingElement mapping) {
checkModifiable();
m_mappings.add(mapping);
}
/**
* Add dependency on another binding.
*
* @param uri namespace for binding of referenced component
*/
public void addDependency(String uri) {
checkModifiable();
m_directory.addDependency(uri, this);
}
/**
* Complete the construction of the binding. This includes processing references to other bindings, as well as the
* actual mappings and formats which are included in the binding. This method must be called after all references
* and binding components have been added.
*/
public void finish() {
if (!m_finished) {
for (Iterator iter = getReferences().iterator(); iter.hasNext();) {
getPrefix(((BindingHolder)iter.next()).getNamespace());
}
ArrayList topchilds = m_binding.topChildren();
topchilds.addAll(m_formats);
topchilds.addAll(m_includes);
topchilds.addAll(m_mappings);
m_finished = true;
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/ClassHierarchyContext.java 0000644 0001750 0001750 00000020173 10767275612 027361 0 ustar moeller moeller /*
Copyright (c) 2005-2008, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Set;
/**
* Context for components using a hierarchy of definitions based on class type.
* This is used to track conversion definitions in the form of format and
* template elements. The access methods take the different levels of
* nesting into account, automatically delegating to the containing context (if
* defined) when a lookup fails.
*
* @author Dennis M. Sosnoski
*/
public class ClassHierarchyContext
{
/** Link to containing context. */
private final ClassHierarchyContext m_outerContext;
/** Map from type name to binding component. */
private HashMap m_typeToComponentMap;
/** Set of compatible type names. */
private HashSet m_compatibleTypeSet;
/** Map from format names to String conversions (lazy create). */
private HashMap m_nameToComponentMap;
/**
* Constructor.
*
* @param outer containing context (null if at root of tree)
*/
protected ClassHierarchyContext(ClassHierarchyContext outer) {
m_outerContext = outer;
m_typeToComponentMap = new HashMap();
m_compatibleTypeSet = new HashSet();
m_nameToComponentMap = new HashMap();
}
/**
* Get containing context.
*
* @return containing context information (null if at root of
* tree)
*/
public ClassHierarchyContext getContaining() {
return m_outerContext;
}
/**
* Accumulate all the interfaces implemented (both directly and indirectly)
* by a class.
*
* @param clas
* @param intfset set of interfaces
*/
private void accumulateInterfaces(IClass clas, Set intfset) {
String[] interfaces = clas.getInterfaces();
for (int i = 0; i < interfaces.length; i++) {
String name = interfaces[i];
if (!intfset.contains(name)) {
intfset.add(name);
IClassLocator locator = clas.getLocator();
accumulateInterfaces(locator.getClassInfo(name), intfset);
}
}
}
/**
* Add typed component to set defined at this level. This associates the
* component with the type for class hierarchy-based lookups.
*
* @param clas class information to be associated with component
* @param comp definition component to be added
* @param vctx validation context in use
*/
public void addTypedComponent(IClass clas, ElementBase comp,
ValidationContext vctx) {
String type = clas.getName();
if (m_typeToComponentMap.put(type, comp) == null) {
// new type, add all interfaces and supertypes to compatible set
IClass sclas = clas;
do {
m_compatibleTypeSet.add(sclas.getName());
accumulateInterfaces(sclas, m_compatibleTypeSet);
} while ((sclas = sclas.getSuperClass()) != null);
} else {
vctx.addError("Duplicate conversion defined for type " + type,
comp);
}
}
/**
* Add named component to set defined at this level.
* TODO: Make this use qname instead of text
*
* @param label name to be associated with component
* @param comp definition component to be added
* @param vctx validation context in use
*/
public void addNamedComponent(String label, ElementBase comp,
ValidationContext vctx) {
if (m_nameToComponentMap.put(label, comp) != null) {
if (label.startsWith("{}")) {
label = label.substring(2);
}
vctx.addError("Duplicate name " + label, comp);
}
}
/**
* Get specific binding component for type. Looks for an exact match on the
* type name, checking the containing definitions if a matching component is
* not found at this level.
*
* @param name fully qualified class name to be converted
* @return binding component for class, or null if not
* found
*/
public ElementBase getSpecificComponent(String name) {
ElementBase comp = null;
if (m_typeToComponentMap != null) {
comp = (ElementBase)m_typeToComponentMap.get(name);
}
if (comp == null && m_outerContext != null) {
comp = m_outerContext.getSpecificComponent(name);
}
return comp;
}
/**
* Get named binding component definition. Finds the component with the
* supplied name, checking the containing definitions if the component is
* not found at this level.
*
* @param name component name to be found
* @return binding component with name, or null if not
* found
*/
public ElementBase getNamedComponent(String name) {
ElementBase comp = null;
if (m_nameToComponentMap != null) {
comp = (ElementBase)m_nameToComponentMap.get(name);
}
if (comp == null && m_outerContext != null) {
comp = m_outerContext.getNamedComponent(name);
}
return comp;
}
/**
* Get best binding component for class. Finds the component based on a
* fully qualified class name. If a specific component for the actual
* class is not found (either in this or a containing level) this returns
* the most specific superclass component.
*
* @param clas information for target class
* @return binding component definition for class, or null if
* none found
*/
public ElementBase getMostSpecificComponent(IClass clas) {
ElementBase comp = getSpecificComponent(clas.getName());
while (comp == null) {
IClass sclas = clas.getSuperClass();
if (sclas == null) {
break;
}
clas = sclas;
comp = getSpecificComponent(clas.getName());
}
return comp;
}
/**
* Checks if a class is compatible with one or more components. If a
* specific component for the actual class is not found (either in this or a
* containing level) this checks for components that handle subclasses or
* implementations of the class.
*
* @param clas information for target class
* @return true if compatible type, false if not
*/
public boolean isCompatibleType(IClass clas) {
if (m_compatibleTypeSet.contains(clas.getName())) {
return true;
} else if (m_outerContext != null) {
return m_outerContext.isCompatibleType(clas);
} else {
return false;
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/ClassItemWrapper.java 0000644 0001750 0001750 00000013034 10602534664 026324 0 ustar moeller moeller /*
Copyright (c) 2004-2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import org.jibx.binding.classes.ClassItem;
/**
* Wrapper for class field or method item information. This wraps the BCEL-based
* class handling implementation to support the interface defined for use with
* the binding model.
*
* @author Dennis M. Sosnoski
*/
public class ClassItemWrapper implements IClassItem
{
private final IClass m_class;
private final ClassItem m_item;
/**
* Constructor.
*
* @param clas
* @param item
*/
protected ClassItemWrapper(IClass clas, ClassItem item) {
m_class = clas;
m_item = item;
}
/**
* Get containing class information.
*
* @return class information
*/
protected IClass getContainingClass() {
return m_class;
}
/**
* Get class item information.
*
* @return item information
*/
protected ClassItem getClassItem() {
return m_item;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClassItem#getOwningClass()
*/
public IClass getOwningClass() {
return m_class;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClassItem#getName()
*/
public String getName() {
return m_item.getName();
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClassItem#getJavaDoc()
*/
public String getJavaDoc() {
return null;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClassItem#getType()
*/
public String getTypeName() {
return m_item.getTypeName();
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClassItem#getReturnJavaDoc()
*/
public String getReturnJavaDoc() {
if (m_item.isMethod()) {
return null;
} else {
throw new IllegalStateException("Internal error: not a method");
}
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClassItem#getArgumentCount()
*/
public int getArgumentCount() {
return m_item.getArgumentCount();
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClassItem#getArgumentType(int)
*/
public String getArgumentType(int index) {
return m_item.getArgumentTypes()[index];
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClassItem#getParameterJavaDoc(int)
*/
public String getParameterJavaDoc(int index) {
if (m_item.isMethod()) {
return null;
} else {
throw new IllegalStateException("Internal error: not a method");
}
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClassItem#getParameterName(int)
*/
public String getParameterName(int index) {
return m_item.getParameterName(index);
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClassItem#getAccessFlags()
*/
public int getAccessFlags() {
return m_item.getAccessFlags();
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClassItem#getSignature()
*/
public String getSignature() {
return m_item.getSignature();
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClassItem#isMethod()
*/
public boolean isMethod() {
return m_item.isMethod();
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClassItem#isInitializer()
*/
public boolean isInitializer() {
return m_item.isInitializer();
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClassItem#getExceptions()
*/
public String[] getExceptions() {
return m_item.getExceptions();
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClassItem#getExceptionJavaDoc(int)
*/
public String getExceptionJavaDoc(int index) {
if (m_item.isMethod()) {
return null;
} else {
throw new IllegalStateException("Internal error: not a method");
}
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClassItem#getGenericsSignature()
*/
public String getGenericsSignature() {
return m_item.getGenericsSignature();
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/ClassUtils.java 0000644 0001750 0001750 00000024534 10767275736 025212 0 ustar moeller moeller /*
Copyright (c) 2004-2008, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import java.util.HashMap;
/**
* Utilities for working with class, field, or method information.
*
* @author Dennis M. Sosnoski
*/
public class ClassUtils
{
/** Map for primitive type signature variants. */
private static HashMap s_variantMap = new HashMap();
/** Map for signatures corresponding to class names. */
private static HashMap s_signatureMap = new HashMap();
static {
// initialize primitive type variants
s_variantMap.put("boolean", new String[] { "Z" });
s_variantMap.put("byte", new String[] { "B", "S", "I" });
s_variantMap.put("char", new String[] { "C", "I" });
s_variantMap.put("double", new String[] { "D" });
s_variantMap.put("float", new String[] { "F" });
s_variantMap.put("int", new String[] { "I" });
s_variantMap.put("long", new String[] { "J" });
s_variantMap.put("short", new String[] { "S", "I" });
s_variantMap.put("void", new String[] { "V" });
// initialize signatures for primitive types
s_signatureMap.put("boolean", "Z");
s_signatureMap.put("byte", "B");
s_signatureMap.put("char", "C");
s_signatureMap.put("double", "D");
s_signatureMap.put("float", "F");
s_signatureMap.put("int", "I");
s_signatureMap.put("long", "J");
s_signatureMap.put("short", "S");
s_signatureMap.put("void", "V");
}
/**
* Check if type name is a primitive.
*
* @param type
* @return true if a primitive, false if not
*/
public static boolean isPrimitive(String type) {
return s_variantMap.get(type) != null;
}
/**
* Get virtual method by fully qualified name. This splits the class
* name from the method name, finds the class, and then tries to find a
* matching method name in that class or a superclass.
*
* @param name fully qualified class and method name
* @param sigs possible method signatures
* @param vctx validation context (used for class lookup)
* @return information for the method, or null if not found
*/
public static IClassItem findVirtualMethod(String name, String[] sigs,
ValidationContext vctx) {
// get the class containing the method
int split = name.lastIndexOf('.');
String cname = name.substring(0, split);
String mname = name.substring(split+1);
IClass iclas = vctx.getClassInfo(cname);
if (iclas != null) {
// find the method in class or superclass
for (int i = 0; i < sigs.length; i++) {
IClassItem method = iclas.getMethod(mname, sigs[i]);
if (method != null) {
return method;
}
}
}
return null;
}
/**
* Get static method by fully qualified name. This splits the class
* name from the method name, finds the class, and then tries to find a
* matching method name in that class.
*
* @param name fully qualified class and method name
* @param sigs possible method signatures
* @param vctx validation context (used for class lookup)
* @return information for the method, or null if not found
*/
public static IClassItem findStaticMethod(String name, String[] sigs,
ValidationContext vctx) {
// get the class containing the method
int split = name.lastIndexOf('.');
if (split > 0) {
String cname = name.substring(0, split);
String mname = name.substring(split+1);
IClass iclas = vctx.getClassInfo(cname);
if (iclas != null) {
// find the method in class or superclass
for (int i = 0; i < sigs.length; i++) {
IClassItem method = iclas.getStaticMethod(mname, sigs[i]);
if (method != null) {
return method;
}
}
}
}
return null;
}
/**
* Get all variant signatures for a fully qualified class name. The
* returned array gives all signatures (for interfaces or classes) which
* instances of the class can match.
*
* @param name fully qualified class name
* @param vctx validation context (used for class lookup)
* @return possible signature variations for instances of the class
*/
public static String[] getSignatureVariants(String name,
ValidationContext vctx) {
Object obj = s_variantMap.get(name);
if (obj == null) {
IClass iclas = vctx.getRequiredClassInfo(name);
return iclas.getInstanceSigs();
} else {
return (String[])obj;
}
}
/**
* Gets the signature string corresponding to a type. The base for the type
* may be a primitive or class name, and may include trailing array
* brackets.
*
* @param type type name
* @return signature string for type
*/
public static String getSignature(String type) {
//. check if already built signature for this type
String sig = (String)s_signatureMap.get(type);
if (sig == null) {
// check if this is an array type
int dim = 0;
int split = type.indexOf('[');
if (split >= 0) {
// count pairs of array brackets
int mark = split;
while ((type.length()-mark) >= 2) {
if (type.charAt(mark) == '[' ||
type.charAt(mark+1) == ']') {
dim++;
mark += 2;
} else {
throw new IllegalArgumentException
("Invalid type name " + type);
}
}
// make sure only bracket pairs at end
if (mark < type.length()) {
throw new IllegalArgumentException("Invalid type name " +
type);
}
// see if signature for base object type needs to be added
String cname = type.substring(0, split);
String base = (String)s_signatureMap.get(cname);
if (base == null) {
// add base type signature to map
base = "L" + cname.replace('.', '/') + ';';
s_signatureMap.put(cname, base);
}
// prepend appropriate number of
StringBuffer buff = new StringBuffer(dim + base.length());
for (int i = 0; i < dim; i++) {
buff.append('[');
}
buff.append(base);
sig = buff.toString();
} else {
// define signature for ordinary object type
sig = "L" + type.replace('.', '/') + ';';
}
// add signature definition to map
s_signatureMap.put(type, sig);
}
// return signature for type
return sig;
}
/**
* Check if a value of one type can be directly assigned to another type.
* This is basically the equivalent of the instanceof operator, but with
* application to primitive types as well as object types.
*
* @param from fully qualified class name of initial type
* @param to fully qualified class name of assignment type
* @param vctx validation context (used for class lookup)
* @return true if assignable, false if not
*/
public static boolean isAssignable(String from, String to,
ValidationContext vctx) {
// always assignable if the two are the same
if (from.equals(to)) {
return true;
} else {
// try direct lookup for primitive types
Object fobj = s_variantMap.get(from);
Object tobj = s_variantMap.get(to);
if (fobj == null && tobj == null) {
// find the actual class information
IClass fclas = vctx.getRequiredClassInfo(from);
IClass tclas = vctx.getRequiredClassInfo(to);
// assignable if from type has to as a possible signature
String[] sigs = fclas.getInstanceSigs();
String match = tclas.getSignature();
for (int i = 0; i < sigs.length; i++) {
if (match.equals(sigs[i])) {
return true;
}
}
return false;
} else if (fobj != null && tobj != null) {
// assignable if from type has to as a possible signature
String[] fsigs = (String[])fobj;
String[] tsigs = (String[])tobj;
if (tsigs.length == 1) {
for (int i = 0; i < fsigs.length; i++) {
if (fsigs[i] == tsigs[0]) {
return true;
}
}
}
return false;
} else {
// primitive and object types never assignable
return false;
}
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/ClassWrapper.java 0000644 0001750 0001750 00000024710 10624254264 025507 0 ustar moeller moeller /*
Copyright (c) 2004-2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import org.jibx.binding.classes.ClassFile;
import org.jibx.binding.classes.ClassItem;
import org.jibx.runtime.JiBXException;
/**
* Wrapper for class information. This wraps the BCEL-based class handling
* implementation to support the interface defined for use with the binding
* model.
*
* @author Dennis M. Sosnoski
*/
public class ClassWrapper implements IClass
{
private final IClassLocator m_locator;
private final ClassFile m_class;
private IClassItem[] m_fields;
private IClassItem[] m_methods;
/**
* Constructor.
*
* @param loc
* @param clas
*/
public ClassWrapper(IClassLocator loc, ClassFile clas) {
m_locator = loc;
m_class = clas;
}
/**
* Build an item wrapper. This method may be overridden by subclasses to
* return a specialized form of wrapper.
*
* @param item
* @return wrapper
*/
protected IClassItem buildItem(ClassItem item) {
return new ClassItemWrapper(this, item);
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClass#getName()
*/
public String getName() {
return m_class.getName();
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClass#getSignature()
*/
public String getSignature() {
return m_class.getSignature();
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClass#getPackage()
*/
public String getPackage() {
return m_class.getPackage();
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClass#getSuperClass()
*/
public IClass getSuperClass() {
ClassFile scf = m_class.getSuperFile();
if (scf == null) {
return null;
} else {
return new ClassWrapper(m_locator, m_class.getSuperFile());
}
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClass#getInterfaces()
*/
public String[] getInterfaces() {
return m_class.getInterfaces();
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClass#getInstanceSigs()
*/
public String[] getInstanceSigs() {
try {
return m_class.getInstanceSigs();
} catch (JiBXException e) {
// TODO need to handle this differently - perhaps get all when created
throw new IllegalStateException("Internal error: instance " +
"signatures not found for class " + m_class.getName());
}
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClass#isImplements(java.lang.String)
*/
public boolean isImplements(String sig) {
try {
return m_class.isImplements(sig);
} catch (JiBXException e) {
// TODO need to handle this differently - perhaps get all when created
throw new IllegalStateException("Internal error: instance " +
"signatures not found for class " + m_class.getName());
}
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClass#isAbstract()
*/
public boolean isAbstract() {
return m_class.isAbstract();
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClass#isInterface()
*/
public boolean isInterface() {
return m_class.isInterface();
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClass#isModifiable()
*/
public boolean isModifiable() {
return m_class.isModifiable();
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClass#isSuperclass(org.jibx.binding.model.IClass)
*/
public boolean isSuperclass(String name) {
ClassFile current = m_class;
while (current != null) {
if (current.getName().equals(name)) {
return true;
} else {
current = current.getSuperFile();
}
}
return false;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClass#getDirectField(java.lang.String)
*/
public IClassItem getDirectField(String name) {
ClassItem item = m_class.getDirectField(name);
if (item == null) {
return null;
} else {
return buildItem(item);
}
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClass#getField(java.lang.String)
*/
public IClassItem getField(String name) {
try {
return buildItem(m_class.getField(name));
} catch (JiBXException e) {
// TODO need to handle this differently - perhaps get all when created
return null;
}
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClass#getMethod(java.lang.String, java.lang.String)
*/
public IClassItem getMethod(String name, String sig) {
ClassItem item = m_class.getMethod(name, sig);
if (item == null) {
return null;
} else {
return buildItem(item);
}
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClass#getMethod(java.lang.String, java.lang.String[])
*/
public IClassItem getMethod(String name, String[] sigs) {
ClassItem item = m_class.getMethod(name, sigs);
if (item == null) {
return null;
} else {
return buildItem(item);
}
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClass#getInitializerMethod(java.lang.String)
*/
public IClassItem getInitializerMethod(String sig) {
ClassItem item = m_class.getInitializerMethod(sig);
if (item == null) {
return null;
} else {
return buildItem(item);
}
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClass#getStaticMethod(java.lang.String, java.lang.String)
*/
public IClassItem getStaticMethod(String name, String sig) {
ClassItem item = m_class.getStaticMethod(name, sig);
if (item == null) {
return null;
} else {
return buildItem(item);
}
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClass#isAccessible(org.jibx.binding.model.IClassItem)
*/
public boolean isAccessible(IClassItem item) {
return m_class.isAccessible(((ClassItemWrapper)item).getClassItem());
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClass#isAssignable(org.jibx.binding.model.IClass)
*/
public boolean isAssignable(IClass other) {
String[] sigs;
try {
sigs = m_class.getInstanceSigs();
} catch (JiBXException e) {
throw new IllegalStateException
("Internal error: class information not available");
}
String match = other.getSignature();
for (int i = 0; i < sigs.length; i++) {
if (match.equals(sigs[i])) {
return true;
}
}
return false;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClass#getBestMethod(java.lang.String, java.lang.String, java.lang.String[])
*/
public IClassItem getBestMethod(String name, String type, String[] args) {
ClassItem item = m_class.getBestMethod(name, type, args);
if (item == null) {
return null;
} else {
return buildItem(item);
}
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClass#getClassFile()
* TODO: eliminate this method
*/
public ClassFile getClassFile() {
return m_class;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClass#loadClass()
*/
public Class loadClass() {
String name = m_class.getName();
Class clas = ClassFile.loadClass(name);
if (clas == null) {
// TODO: this is a kludge
try {
clas = ClassUtils.class.getClassLoader().loadClass(name);
} catch (ClassNotFoundException ex) { /* deliberately empty */ }
}
return clas;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClass#getFields()
*/
public IClassItem[] getFields() {
if (m_fields == null) {
ClassItem[] items = m_class.getFieldItems();
m_fields = new IClassItem[items.length];
for (int i = 0; i < items.length; i++) {
m_fields[i] = buildItem(items[i]);
}
}
return m_fields;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClass#getMethods()
*/
public IClassItem[] getMethods() {
if (m_methods == null) {
ClassItem[] items = m_class.getMethodItems();
m_methods = new IClassItem[items.length];
for (int i = 0; i < items.length; i++) {
m_methods[i] = buildItem(items[i]);
}
}
return m_methods;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClass#getJavaDoc()
*/
public String getJavaDoc() {
return null;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IClass#getLocator()
*/
public IClassLocator getLocator() {
return m_locator;
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/CollectionElement.java 0000644 0001750 0001750 00000067224 10767276064 026527 0 ustar moeller moeller /*
Copyright (c) 2004-2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import org.jibx.binding.util.StringArray;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
/**
* Model component for collection element of binding definition.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class CollectionElement extends StructureElementBase
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new String[] { "add-method", "item-type", "iter-method",
"load-method", "size-method", "store-method" },
StructureElementBase.s_allowedAttributes);
/** Load method name. */
private String m_loadMethodName;
/** Size method name. */
private String m_sizeMethodName;
/** Store method name. */
private String m_storeMethodName;
/** Add method name. */
private String m_addMethodName;
/** Iterator method name. */
private String m_iterMethodName;
/** Item type name. */
private String m_itemTypeName;
/** Load method information. */
private IClassItem m_loadMethodItem;
/** Size method information. */
private IClassItem m_sizeMethodItem;
/** Store method information. */
private IClassItem m_storeMethodItem;
/** Add method information. */
private IClassItem m_addMethodItem;
/** Iterator method information. */
private IClassItem m_iterMethodItem;
/** Item type information. */
private IClass m_itemTypeClass;
/**
* Default constructor.
*/
public CollectionElement() {
super(COLLECTION_ELEMENT);
}
/**
* Get item type name.
*
* @return item type name (or null if none)
*/
public String getItemTypeName() {
return m_itemTypeName;
}
/**
* Set item type name.
*
* @param type item type name (or null if none)
*/
public void setItemTypeName(String type) {
m_itemTypeName = type;
}
/**
* Get item type information. This call is only meaningful after
* validation.
*
* @return item type information
*/
public IClass getItemTypeClass() {
return m_itemTypeClass;
}
/**
* Get add method name.
*
* @return add method name (or null if none)
*/
public String getAddMethodName() {
return m_addMethodName;
}
/**
* Set add method name.
*
* @param name add method name (or null if none)
*/
public void setAddMethodName(String name) {
m_addMethodName = name;
}
/**
* Get add method information. This call is only meaningful after
* validation.
*
* @return add method information (or null if none)
*/
public IClassItem getAddMethodItem() {
return m_addMethodItem;
}
/**
* Get iterator method name.
*
* @return iterator method name (or null if none)
*/
public String getIterMethodName() {
return m_iterMethodName;
}
/**
* Set iterator method name.
*
* @param name iterator method name (or null if none)
*/
public void setIterMethodName(String name) {
m_iterMethodName = name;
}
/**
* Get iterator method information. This call is only meaningful after
* validation.
*
* @return iterator method information (or null if none)
*/
public IClassItem getIterMethodItem() {
return m_iterMethodItem;
}
/**
* Get load method name.
*
* @return load method name (or null if none)
*/
public String getLoadMethodName() {
return m_loadMethodName;
}
/**
* Set load method name.
*
* @param name load method name (or null if none)
*/
public void setLoadMethodName(String name) {
m_loadMethodName = name;
}
/**
* Get load method information. This call is only meaningful after
* validation.
*
* @return load method information (or null if none)
*/
public IClassItem getLoadMethodItem() {
return m_loadMethodItem;
}
/**
* Get size method name.
*
* @return size method name (or null if none)
*/
public String getSizeMethodName() {
return m_sizeMethodName;
}
/**
* Set size method name.
*
* @param name size method name (or null if none)
*/
public void setSizeMethodName(String name) {
m_sizeMethodName = name;
}
/**
* Get size method information. This call is only meaningful after
* validation.
*
* @return size method information (or null if none)
*/
public IClassItem getSizeMethodItem() {
return m_sizeMethodItem;
}
/**
* Get store method name.
*
* @return store method name (or null if none)
*/
public String getStoreMethodName() {
return m_storeMethodName;
}
/**
* Set store method name.
*
* @param name store method name (or null if none)
*/
public void setStoreMethodName(String name) {
m_storeMethodName = name;
}
/**
* Get store method information. This call is only meaningful after
* validation.
*
* @return store method information (or null if none)
*/
public IClassItem getStoreMethodItem() {
return m_storeMethodItem;
}
//
// Overrides of base class methods
/**
* Set ID property. This is never supported for an object coming from a
* collection.
*
* @param child child defining the ID property
* @return true if successful, false if ID
* already defined
*/
public boolean setIdChild(IComponent child) {
throw new IllegalStateException
("Internal error: method should never be called");
}
/**
* Check for object present. Always true for collection.
*
* @return true
*/
public boolean hasObject() {
return true;
}
/**
* Check for attribute definition. Always false for collection.
*
* @return false
*/
public boolean hasAttribute() {
return false;
}
/**
* Check for content definition. Always true for collection.
*
* @return true
*/
public boolean hasContent() {
return true;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ContainerElementBase#getChildObjectType()
*/
public IClass getChildObjectType() {
return getItemTypeClass();
}
//
// Validation methods
/**
* Make sure all attributes are defined.
*
* @param uctx unmarshalling context
* @exception JiBXException on unmarshalling error
*/
private void preSet(IUnmarshallingContext uctx) throws JiBXException {
validateAttributes(uctx, s_allowedAttributes);
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ElementBase#prevalidate(org.jibx.binding.model.ValidationContext)
*/
public void prevalidate(ValidationContext vctx) {
// first process attributes and check for errors
super.prevalidate(vctx);
if (!vctx.isSkipped(this)) {
// check for ignored attributes
if (isAllowRepeats()) {
vctx.addWarning("'allow-repeats' attribute ignored on collection");
}
if (isChoice()) {
vctx.addWarning("'choice' attribute ignored on collection");
}
// get the actual collection type and item type
IClass clas = getType();
if (clas == null) {
clas = vctx.getContextObject().getObjectType();
}
String tname = m_itemTypeName;
if (tname == null) {
String ctype = clas.getName();
if (ctype.endsWith("[]")) {
tname = ctype.substring(0, ctype.length()-2);
} else {
tname = "java.lang.Object";
}
}
m_itemTypeClass = vctx.getClassInfo(tname);
if (m_itemTypeClass == null) {
vctx.addFatal("Can't find class " + tname);
}
// handle input and output bindings separately
if (vctx.isInBinding()) {
// check store techniques
String sname = m_storeMethodName;
String aname = m_addMethodName;
if (sname != null && aname != null) {
vctx.addWarning("Both store-method and add-method supplied; using add-method");
sname = null;
}
// set defaults based on collection type if needed
if (sname == null && aname == null) {
if (clas.isSuperclass("java.util.ArrayList") ||
clas.isSuperclass("java.util.Vector") ||
clas.isImplements("Ljava/util/Collection;")) {
aname = "add";
} else if (!clas.getName().endsWith("[]")) {
vctx.addError("Need store-method or add-method for input binding");
}
}
// find the actual method information
if (sname != null) {
m_storeMethodItem = clas.getBestMethod(sname,
null, new String[] { "int", tname });
if (m_storeMethodItem == null) {
vctx.addError("store-method " + sname +
" not found in class " + clas.getName());
}
}
if (aname != null) {
m_addMethodItem = clas.getBestMethod(aname,
null, new String[] { tname });
if (m_addMethodItem == null) {
vctx.addError("add-method " + aname +
" not found in class " + clas.getName());
}
}
}
if (vctx.isOutBinding()) {
// precheck load techniques
String lname = m_loadMethodName;
String sname = m_sizeMethodName;
String iname = m_iterMethodName;
if (lname == null) {
if (sname != null) {
vctx.addWarning("size-method requires load-method; ignoring supplied size-method");
sname = null;
}
} else {
if (sname == null) {
vctx.addWarning("load-method requires size-method; ignoring supplied load-method");
lname = null;
} else {
if (iname != null) {
vctx.addWarning("Both load-method and iter-method supplied; using load-method");
iname = null;
}
}
}
// set defaults based on collection type if needed
if (lname == null && iname == null) {
if (clas.isSuperclass("java.util.ArrayList") ||
clas.isSuperclass("java.util.Vector")) {
lname = "get";
sname = "size";
} else if (clas.isImplements("Ljava/util/Collection;")) {
iname = "iterator";
}
}
// postcheck load techniques with defaults set
if (lname == null) {
if (iname == null && !clas.getName().endsWith("[]")) {
vctx.addError("Need load-method and size-method, or iter-method, for output binding");
}
} else {
if (sname == null && iname == null) {
vctx.addError("Need load-method and size-method, or iter-method, for output binding");
}
}
// find the actual method information
if (lname != null) {
m_loadMethodItem = clas.getBestMethod(lname,
tname, new String[] { "int" });
if (m_loadMethodItem == null) {
vctx.addError("load-method " + lname +
" not found in class " + clas.getName());
}
}
if (iname != null) {
m_iterMethodItem = clas.getBestMethod(iname,
"java.util.Iterator", new String[0]);
if (m_iterMethodItem == null) {
vctx.addError("iter-method " + iname +
" not found in class " + clas.getName());
}
}
}
}
}
/**
* Check that child components are of types compatible with the collection
* item-type. This method may call itself recursively to process the
* children of child components which do not themselves set a type. The
* result is used for recursive checking to detect conditions where an
* inner structure defines a type but an outer one does not (which causes
* errors in the current code generation).
*
* @param vctx validation context
* @param type collection item type
* @param children list of child components to be checked
* @return true if only child is a <value> element with
* type, false if not
*/
private boolean checkCollectionChildren(ValidationContext vctx,
IClass type, ArrayList children) {
boolean valonly = children.size() == 1;
for (int i = 0; i < children.size(); i++) {
ElementBase child = (ElementBase)children.get(i);
if (!vctx.isSkipped(child)) {
// track whether children of this child must be type-checked
boolean expand = true;
valonly = valonly && (child instanceof ValueElement);
if (child instanceof IComponent) {
// first make sure a name is present
IComponent comp = (IComponent)child;
if (vctx.isInBinding() && !comp.hasName() &&
comp instanceof ValueElement) {
vctx.addFatal(" elements within a collection must define element name for unmarshalling", comp);
}
// find the type associated with this component (if any)
IClass ctype = comp.getType();
expand = false;
if (comp instanceof ContainerElementBase) {
ContainerElementBase contain = (ContainerElementBase)comp;
if (contain.hasObject()) {
ctype = contain.getObjectType();
} else {
expand = true;
}
}
// see if a type was found (no need to look at children)
if (!expand) {
// verify that type is compatible with collection
if (!ctype.isAssignable(type)) {
vctx.addFatal("References to collection items must use compatible types: " +
ctype.getName() + " cannot be used as " +
type.getName(), child);
}
}
}
// recurse on children if necessary for type-checking
if (expand && child instanceof NestingElementBase) {
NestingElementBase nest = (NestingElementBase)child;
if (nest.children().size() > 0) {
// type check child definitions
boolean valchild = checkCollectionChildren(vctx, type,
((NestingElementBase)child).children());
// now check for structure element with no type
if (!valchild && child instanceof StructureElement) {
vctx.addError("Type must be specified on outermost element within collection", child);
}
}
}
}
}
return valonly;
}
/**
* Check children of unordered collection for consistency. In an input
* binding each child element must define a unique qualified name. In an
* output binding each child element must define a unique type or supply
* a test method to allow checking when that element should be generated for
* an object.
*
* @param vctx validation context
* @param children list of child components
*/
private void checkUnorderedChildren(ValidationContext vctx,
ArrayList children) {
HashMap typemap = new HashMap();
HashMap namemap = new HashMap();
for (int i = 0; i < children.size(); i++) {
ElementBase child = (ElementBase)children.get(i);
if (child instanceof IComponent && !vctx.isSkipped(child)) {
IComponent comp = (IComponent)child;
if (vctx.isInBinding()) {
// names must be distinct in input binding
String name = comp.getName();
String uri = comp.getUri();
if (uri == null) {
uri = "";
}
Object value = namemap.get(name);
if (value == null) {
// first instance of name, store directly
namemap.put(name, comp);
} else if (value instanceof HashMap) {
// multiple instances already found, match on URI
HashMap urimap = (HashMap)value;
if (urimap.get(uri) != null) {
vctx.addError("Duplicate names are not allowed in unordered collection", comp);
} else {
urimap.put(uri, comp);
}
} else {
// duplicate name, check URI
IComponent match = (IComponent)value;
if ((uri == null && match.getUri() == null) ||
(uri != null && uri.equals(match.getUri()))) {
vctx.addError("Duplicate names are not allowed in unordered collection", comp);
} else {
// multiple namespaces for same name, use map
HashMap urimap = new HashMap();
urimap.put(uri, comp);
String muri = match.getUri();
if (muri == null) {
muri = "";
}
urimap.put(muri, match);
namemap.put(name, urimap);
}
}
}
if (vctx.isOutBinding()) {
// just accumulate lists of each type in this loop
String type = comp.getType().getName();
Object value = typemap.get(type);
if (value == null) {
typemap.put(type, comp);
} else if (value instanceof ArrayList) {
ArrayList types = (ArrayList)value;
types.add(comp);
} else {
ArrayList types = new ArrayList();
types.add(value);
types.add(comp);
typemap.put(type, types);
}
}
}
}
// check for duplicate type usage in output binding
for (Iterator iter = typemap.values().iterator(); iter.hasNext();) {
Object value = iter.next();
if (value instanceof ArrayList) {
// multiple instances of type, make sure we can distinguish
ArrayList types = (ArrayList)value;
for (int i = 0; i < types.size(); i++) {
Object child = types.get(i);
if (child instanceof ValueElement) {
ValueElement vel = (ValueElement)child;
if (vel.getTest() == null) {
vctx.addError("test-method needed for multiple instances of same type in unordered collection", vel);
}
} else if (child instanceof StructureElementBase) {
StructureElementBase sel = (StructureElementBase)child;
if (sel.getTest() == null) {
vctx.addError("test-method needed for multiple instances of same type in unordered collection", sel);
}
}
}
}
}
}
/**
* Check children of ordered collection for consistency. In an input binding
* each child element must use a different qualified name from the preceding
* child element. In an output binding each child element must define a
* different type from the preceding child element, or the preceding child
* element must supply a test method to allow checking when that element
* should be generated for an object.
*
* @param vctx validation context
* @param children list of child components
*/
private void checkOrderedChildren(ValidationContext vctx,
ArrayList children) {
IComponent prior = null;
for (int i = 0; i < children.size(); i++) {
ElementBase child = (ElementBase)children.get(i);
if (child instanceof IComponent && !vctx.isSkipped(child)) {
IComponent comp = (IComponent)child;
if (prior == null) {
prior = comp;
} else {
if (vctx.isInBinding()) {
// make sure names are different
String uri = comp.getUri();
String cname = comp.getName();
String pname = prior.getName();
if (cname != null && pname != null &&
cname.equals(pname) &&
((uri == null && prior.getUri() == null) ||
(uri != null && uri.equals(prior.getUri())))) {
vctx.addError("Successive elements of collection cannot use duplicate names for unmarshalling", comp);
}
}
if (vctx.isOutBinding()) {
// make sure types differ or test method supplied
IClass type = comp.getType();
if (type.isAssignable(prior.getType())) {
IClassItem test = null;
if (prior instanceof ValueElement) {
test = ((ValueElement)prior).getTest();
} else if (prior instanceof StructureElementBase) {
test = ((StructureElementBase)prior).getTest();
}
if (test == null) {
vctx.addError("Collection component must specify a test-method to distinguish from next component of compatible type for marshalling", prior);
}
}
}
}
}
}
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ElementBase#validate(org.jibx.binding.model.ValidationContext)
*/
public void validate(ValidationContext vctx) {
// call base class method first
super.validate(vctx);
// check for way to determine if named collection present on output
if (vctx.isOutBinding() && hasName() && !hasProperty() &&
isOptional() && getTest() == null &&
!(vctx.getParentContainer() instanceof CollectionElement)) {
vctx.addError
("Need test method for optional collection output element");
}
// TODO: this should really check that item-type on an empty collection
// specifies a concrete mapping
// make sure only element components are present
ArrayList children = children();
for (int i = 0; i < children.size(); i++) {
IComponent child = (IComponent)children.get(i);
if (child.hasAttribute()) {
vctx.addFatal
("Attributes not allowed as child components of collection",
child);
}
}
// check each child component
checkCollectionChildren(vctx, m_itemTypeClass, children);
// make sure child components can be distinguished
if (children.size() > 1) {
if (isOrdered()) {
checkOrderedChildren(vctx, children);
} else {
checkUnorderedChildren(vctx, children);
}
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/ContainerElementBase.java 0000644 0001750 0001750 00000055303 11006326624 027125 0 ustar moeller moeller /*
Copyright (c) 2004-2008, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import java.util.ArrayList;
import org.jibx.binding.util.StringArray;
/**
* Model component for elements that can contain detailed binding information in
* the form of nested child components. Elements of this type include
* mapping, template, structure, and collection
* elements.
*
* @author Dennis M. Sosnoski
*/
public abstract class ContainerElementBase extends NestingElementBase
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(NestingElementBase.s_allowedAttributes,
new StringArray(ObjectAttributes.s_allowedAttributes,
StructureAttributes.s_allowedAttributes));
/** Object attributes information for nesting. */
private ObjectAttributes m_objectAttrs;
/** Structure attributes information for nesting. */
private StructureAttributes m_structureAttrs;
/** Label for this structure definition. */
private String m_label;
/** Label for structure to be used as definition. */
private String m_using;
/** Child component that contributes an ID (null if none). */
private IComponent m_idChild;
/** Flag for child classification in progress. */
private boolean m_inClassify;
/** Child components defining content (created during validation, contains
subset of child components defining element or character data content). */
private ArrayList m_contentComponents;
/** Child components defining attributes (created during validation,
contains subset of child components defining attributes). */
private ArrayList m_attributeComponents;
/**
* Constructor.
*
* @param type element type code
*/
protected ContainerElementBase(int type) {
super(type);
m_objectAttrs = new ObjectAttributes();
m_structureAttrs = new StructureAttributes();
}
/**
* Get label for this definition.
*
* @return label for this definition
*/
public String getLabel() {
return m_label;
}
/**
* Set label for this definition.
*
* @param label label for this definition
*/
public void setLabel(String label) {
m_label = label;
}
/**
* Get label for definition to be used.
*
* @return label for definition to be used
*/
public String getUsing() {
return m_using;
}
/**
* Set label for definition to be used.
*
* @param label label for definition to be used
*/
public void setUsing(String label) {
m_using = label;
}
/**
* Get list of child components contributing content items to this
* container element. This call is only meaningful after validation.
*
* @return list of child binding components defining content items
*/
public ArrayList getContentComponents() {
return m_contentComponents == null ?
EmptyList.INSTANCE : m_contentComponents;
}
/**
* Get list of child components contributing attribute items to this
* container element. This call is only meaningful after validation.
*
* @return list of child binding components defining attribute items
*/
public ArrayList getAttributeComponents() {
return m_attributeComponents == null ?
EmptyList.INSTANCE : m_attributeComponents;
}
/**
* Check if this container defines a context object.
*
* @return true if defines context object,
* false if not
*/
public abstract boolean hasObject();
/**
* Get class linked to binding element. This call is only meaningful after
* validation.
*
* @return information for class linked by binding
*/
public abstract IClass getObjectType();
/**
* Get class passed to child components. This call is only meaningful after
* validation.
*
* @return information for class linked by binding
*/
public IClass getChildObjectType() {
return getObjectType();
}
/**
* Set ID property child. Used to set the ID property associated with a
* particular class instance. There can only be at most one child ID
* property for each actual object instance.
*
* @param child child defining the ID property
* @param vctx validation context
*/
public final void setIdChild(IComponent child, ValidationContext vctx) {
if (m_idChild == null) {
m_idChild = child;
vctx.getBindingRoot().addIdClass(getObjectType());
} else {
vctx.addError("Only one child ID property allowed for an object " +
"- " + ValidationProblem.componentDescription(m_idChild) +
" and " + ValidationProblem.componentDescription(child) +
" refer to the same object");
}
}
/**
* Get ID property child.
*
* @return ID child
*/
public IComponent getId() {
return m_idChild;
}
//
// Object attribute delegate methods
/**
* Get factory method name.
*
* @return fully-qualified factory class and method name (or
* null if none)
*/
public String getFactoryName() {
return m_objectAttrs.getFactoryName();
}
/**
* Get factory method information. This call is only meaningful after
* a call to {@link #prevalidate(ValidationContext)}.
*
* @return factory method information (or null if none)
*/
public IClassItem getFactory() {
return m_objectAttrs.getFactory();
}
/**
* Set factory method name.
*
* @param name fully qualified class and method name for object factory
*/
public void setFactoryName(String name) {
m_objectAttrs.setFactoryName(name);
}
/**
* Get pre-set method name.
*
* @return pre-set method name (or null if none)
*/
public String getPresetName() {
return m_objectAttrs.getPresetName();
}
/**
* Get pre-set method information. This call is only meaningful after
* a call to {@link #prevalidate(ValidationContext)}.
*
* @return pre-set method information (or null if none)
*/
public IClassItem getPreset() {
return m_objectAttrs.getPreset();
}
/**
* Set pre-set method name.
*
* @param name member method name to be called before unmarshalling
*/
public void setPresetName(String name) {
m_objectAttrs.setPresetName(name);
}
/**
* Get post-set method name.
*
* @return post-set method name (or null if none)
*/
public String getPostsetName() {
return m_objectAttrs.getPostsetName();
}
/**
* Get post-set method information. This call is only meaningful after
* a call to {@link #prevalidate(ValidationContext)}.
*
* @return post-set method information (or null if none)
*/
public IClassItem getPostset() {
return m_objectAttrs.getPostset();
}
/**
* Set post-set method name.
*
* @param name member method name to be called after unmarshalling
*/
public void setPostsetName(String name) {
m_objectAttrs.setPostsetName(name);
}
/**
* Get pre-get method name.
*
* @return pre-get method name (or null if none)
*/
public String getPregetName() {
return m_objectAttrs.getPregetName();
}
/**
* Get pre-get method information. This call is only meaningful after
* a call to {@link #prevalidate(ValidationContext)}.
*
* @return pre-get method information (or null if none)
*/
public IClassItem getPreget() {
return m_objectAttrs.getPreget();
}
/**
* Set pre-get method name.
*
* @param name member method name to be called before marshalling
*/
public void setPreget(String name) {
m_objectAttrs.setPreget(name);
}
/**
* Get marshaller class name.
*
* @return marshaller class name (or null if none)
*/
public String getMarshallerName() {
return m_objectAttrs.getMarshallerName();
}
/**
* Get marshaller class information. This call is only meaningful after
* a call to {@link #prevalidate(ValidationContext)}.
*
* @return class information for marshaller (or null if none)
*/
public IClass getMarshaller() {
return m_objectAttrs.getMarshaller();
}
/**
* Set marshaller class name.
*
* @param name class name to be used for marshalling
*/
public void setMarshallerName(String name) {
m_objectAttrs.setMarshallerName(name);
}
/**
* Get unmarshaller class name.
*
* @return unmarshaller class name (or null if none)
*/
public String getUnmarshallerName() {
return m_objectAttrs.getUnmarshallerName();
}
/**
* Get unmarshaller class information. This call is only meaningful after
* a call to {@link #prevalidate(ValidationContext)}.
*
* @return class information for unmarshaller (or null if none)
*/
public IClass getUnmarshaller() {
return m_objectAttrs.getUnmarshaller();
}
/**
* Set unmarshaller class name.
*
* @param name class name to be used for unmarshalling
*/
public void setUnmarshallerName(String name) {
m_objectAttrs.setUnmarshallerName(name);
}
/**
* Check if nillable object.
*
* @return nillable flag
*/
public boolean isNillable() {
return m_objectAttrs.isNillable();
}
/**
* Set nillable flag.
*
* @param nillable flag
*/
public void setNillable(boolean nillable) {
m_objectAttrs.setNillable(nillable);
}
/**
* Get type to be used for creating new instance.
*
* @return class name for type to be created (or null if none)
*/
public String getCreateType() {
return m_objectAttrs.getCreateType();
}
/**
* Get new instance creation class information. This method is only usable
* a call to {@link #prevalidate(ValidationContext)}.
*
* @return class information for type to be created (or null if
* none)
*/
public IClass getCreateClass() {
return m_objectAttrs.getCreateClass();
}
/**
* Set new instance type class name.
*
* @param name class name to be used for creating new instance
*/
public void setCreateType(String name) {
m_objectAttrs.setCreateType(name);
}
//
// Structure attribute delegate methods
/**
* Get flexible flag.
*
* @return flexible flag
*/
public boolean isFlexible() {
return m_structureAttrs.isFlexible();
}
/**
* Set flexible flag.
*
* @param flexible
*/
public void setFlexible(boolean flexible) {
m_structureAttrs.setFlexible(flexible);
}
/**
* Check if child components are ordered.
*
* @return true if ordered, false if not
*/
public boolean isOrdered() {
return m_structureAttrs.isOrdered();
}
/**
* Set child components ordered flag.
*
* @param ordered true if ordered, false if not
*/
public void setOrdered(boolean ordered) {
m_structureAttrs.setOrdered(ordered);
}
/**
* Check if child components are a choice.
*
* @return true if choice, false if not
*/
public boolean isChoice() {
return m_structureAttrs.isChoice();
}
/**
* Set child components choice flag.
*
* @param choice true if choice, false if not
*/
public void setChoice(boolean choice) {
m_structureAttrs.setChoice(choice);
}
/**
* Check if repeated child elements are allowed.
*
* @return true if repeats allowed, false if not
*/
public boolean isAllowRepeats() {
return m_structureAttrs.isAllowRepeats();
}
/**
* Set repeated child elements allowed flag.
*
* @param ignore true if repeated child elements to be allowed,
* false if not
*/
public void setAllowRepeats(boolean ignore) {
m_structureAttrs.setAllowRepeats(ignore);
}
//
// Validation methods.
/**
* Check that there's a way to construct an instance of an object class for
* input bindings. This can be a factory method, an unmarshaller, a
* no-argument constructor already defined in the class, or a modifiable
* class with constructor generation enabled. If a create-type is specified,
* this is used in place of the declared type. The call always succeeds if
* the binding is output-only.
*
* Note that this method should not be changed to pass the "this" object
* when reporting errors, because it may be called indirectly during the
* validation of other elements. Because of this, it needs to only use
* values defined after {@link #prevalidate(ValidationContext)}.
*
* @param vctx validation context
* @param type constructed object type
*/
protected void verifyConstruction(ValidationContext vctx, IClass type) {
if (vctx.isInBinding() && getFactory() == null &&
getUnmarshaller() == null) {
IClass create = getCreateClass();
if (create != null) {
if (create.isAssignable(type)) {
type = create;
} else {
vctx.addError("Specified create-type '" + create.getName() +
"' is not compatible with type '" +
type.getName() + '\'');
}
}
if (type.isAbstract()) {
vctx.addError("factory-method needed for abstract type '" +
type.getName() + '\'');
} else if (!type.getName().endsWith("[]") &&
type.getInitializerMethod("()V") == null) {
BindingElement binding = vctx.getBindingRoot();
if (binding.isAddConstructors()) {
if (!type.isModifiable()) {
vctx.addError("Need no-argument constructor or " +
"factory method for unmodifiable class " +
type.getName());
} else {
IClass suptype = type;
while ((suptype = suptype.getSuperClass()) != null) {
IClassItem cons = suptype.getInitializerMethod("()V");
if ((cons == null || !type.isAccessible(cons)) &&
!suptype.isModifiable()) {
vctx.addError("Need accessible no-argument constructor for unmodifiable class " +
suptype.getName() + " (superclass of " + type.getName() + ')');
}
}
}
} else {
vctx.addError("Need no-argument constructor or " +
"factory method for class " + type.getName());
}
}
}
}
/**
* Check that child components are of types compatible with the container
* object type. This method may call itself recursively to process the
* children of child components which do not themselves set a type. It's not
* used directly, but is here for use by subclasses.
*
* @param vctx validation context
* @param type structure object type
* @param children list of child components to be checked
*/
protected void checkCompatibleChildren(ValidationContext vctx, IClass type,
ArrayList children) {
for (int i = 0; i < children.size(); i++) {
ElementBase child = (ElementBase)children.get(i);
boolean expand = true;
if (child instanceof IComponent && !vctx.isSkipped(child)) {
IComponent comp = (IComponent)child;
IClass ctype = comp.getType();
if (comp instanceof ContainerElementBase) {
ContainerElementBase contain = (ContainerElementBase)comp;
expand = !contain.hasObject();
}
if (comp.isImplicit()) {
if (!type.isAssignable(ctype)) {
vctx.addFatal
("References to structure object must have " +
"compatible types: " + type.getName() +
" cannot be used as " + ctype.getName(), child);
}
}
}
if (expand && child instanceof NestingElementBase) {
checkCompatibleChildren(vctx, type,
((NestingElementBase)child).children());
}
}
}
/**
* Check for child components classified. This is a convenience method for
* subclasses to check if classification has already been done.
*
* @return true if classified, false if not
*/
protected boolean isClassified() {
return m_attributeComponents != null;
}
/**
* Classify child components as contributing attributes, content, or both.
* This method is needed to handle on-demand classification during
* validation. When a child component is another instance of this class, the
* method calls itself on the child component prior to checking the child
* component's contribution.
*
* @param vctx
*/
protected void classifyComponents(ValidationContext vctx) {
if (m_attributeComponents == null && !m_inClassify) {
ArrayList childs = children();
if (childs == null || childs.size() == 0) {
// no children, so no components of either type
m_attributeComponents = EmptyList.INSTANCE;
m_contentComponents = EmptyList.INSTANCE;
} else {
// classify child components, setting flag to catch recursion
m_inClassify = true;
m_attributeComponents = new ArrayList();
m_contentComponents = new ArrayList();
for (int i = 0; i < childs.size(); i++) {
Object child = childs.get(i);
if (child instanceof ContainerElementBase) {
((ContainerElementBase)child).classifyComponents(vctx);
}
if (child instanceof IComponent) {
IComponent comp = (IComponent)child;
if (comp.hasAttribute()) {
m_attributeComponents.add(child);
}
if (comp.hasContent()) {
m_contentComponents.add(child);
if (!comp.hasName()) {
if (isFlexible()) {
vctx.addError("All child components must define element names for flexible='true'", comp);
} else if (comp instanceof ValueElement &&
!isOrdered()) {
vctx.addError("Text values cannot be used with ordered='false'", comp);
}
}
}
}
}
m_inClassify = false;
}
}
}
/**
* Set child attribute and content components directly. This is provided for
* use by subclasses requiring special handling, in particular the
* <structure> element used as a mapping reference.
*
* @param attribs
* @param contents
*/
protected void setComponents(ArrayList attribs, ArrayList contents) {
m_attributeComponents = attribs;
m_contentComponents = contents;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ElementBase#prevalidate(org.jibx.binding.model.ValidationContext)
*/
public void prevalidate(ValidationContext vctx) {
m_objectAttrs.prevalidate(vctx);
m_structureAttrs.prevalidate(vctx);
if (m_using != null && children().size() > 0) {
vctx.addFatal("Child elements not allowed with using attribute");
}
super.prevalidate(vctx);
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ElementBase#validate(org.jibx.binding.model.ValidationContext)
*/
public void validate(ValidationContext vctx) {
super.validate(vctx);
m_objectAttrs.validate(vctx);
m_structureAttrs.validate(vctx);
classifyComponents(vctx);
if (isChoice() && m_attributeComponents.size() > 0) {
vctx.addError("Attributes cannot be included in choice");
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/DefinitionContext.java 0000644 0001750 0001750 00000057730 11002542726 026540 0 ustar moeller moeller /*
Copyright (c) 2004-2008, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import java.util.ArrayList;
import java.util.HashMap;
/**
* Definition context information. This is used to track definitions of items
* that can be referenced by other items. The contexts are nested, so that names
* not found in a context may be defined by a containing context. The access
* methods take this into account, automatically delegating to the containing
* context (if defined) when a lookup fails.
*
* @author Dennis M. Sosnoski
*/
public class DefinitionContext
{
/** Link to containing definition context. */
private final DefinitionContext m_outerContext;
/** Namespace used by default at this level for attributes. */
private NamespaceElement m_attributeDefault;
/** Namespace used by default at this level for elements. */
private NamespaceElement m_elementDefault;
/** Namespaces defined at level (lazy create). */
private ArrayList m_namespaces;
/** Mapping from prefix to namespace definition (lazy create). */
private HashMap m_prefixMap;
/** Mapping from URI to namespace definition (lazy create). */
private HashMap m_uriMap;
/** Map from element names to mappings defined at level (lazy create). */
private HashMap m_mappingMap;
/** Class hierarchy context for format definitions (lazy create). */
private ClassHierarchyContext m_formatContext;
/** Class hierarchy context for template definitions (lazy create). */
private ClassHierarchyContext m_templateContext;
/** Named binding components (lazy create). */
private HashMap m_namedStructureMap;
/**
* Constructor.
*
* @param outer containing definition context (null if
* at root of tree)
*/
protected DefinitionContext(DefinitionContext outer) {
m_outerContext = outer;
}
/**
* Copy a context for use by an included binding. The duplicated context has
* the same containing context as the original, and shared reference
* structures for formats and templates, but only a static copy of the
* namespace definitions.
*
* @return context copy for included binding
*/
/*package*/ DefinitionContext getIncludeCopy() {
DefinitionContext dupl = new DefinitionContext(m_outerContext);
if (m_mappingMap == null) {
m_mappingMap = new HashMap();
}
dupl.m_mappingMap = m_mappingMap;
if (m_formatContext == null) {
m_formatContext =
new ClassHierarchyContext(getContainingFormatContext());
}
dupl.m_formatContext = m_formatContext;
if (m_templateContext == null) {
m_templateContext =
new ClassHierarchyContext(getContainingTemplateContext());
}
dupl.m_templateContext = m_templateContext;
return dupl;
}
/**
* Inject namespaces from this context into another context. This is
* intended for includes, where the included binding inherits the
* namespace declarations of the containing binding.
*
* @param to
*/
/*package*/ void injectNamespaces(DefinitionContext to) {
to.m_attributeDefault = m_attributeDefault;
to.m_elementDefault = m_elementDefault;
if (m_namespaces != null) {
to.m_namespaces = new ArrayList(m_namespaces);
to.m_prefixMap = new HashMap(m_prefixMap);
to.m_uriMap = new HashMap(m_uriMap);
}
}
/**
* Get containing context.
*
* @return containing context information (null if at root of
* tree)
*/
public DefinitionContext getContaining() {
return m_outerContext;
}
/**
* Get containing format context.
*
* @return innermost containing context for format definitions
* (null none defined)
*/
private ClassHierarchyContext getContainingFormatContext() {
if (m_outerContext == null) {
return null;
} else {
return m_outerContext.getFormatContext();
}
}
/**
* Get current format context.
*
* @return innermost context for format definitions (null none
* defined)
*/
private ClassHierarchyContext getFormatContext() {
if (m_formatContext == null) {
return getContainingFormatContext();
} else {
return m_formatContext;
}
}
/**
* Get containing template context.
*
* @return innermost containing context for template definitions
* (null none defined)
*/
private ClassHierarchyContext getContainingTemplateContext() {
if (m_outerContext == null) {
return null;
} else {
return m_outerContext.getTemplateContext();
}
}
/**
* Get current template context.
*
* @return innermost context for template definitions (null none
* defined)
*/
private ClassHierarchyContext getTemplateContext() {
if (m_templateContext == null) {
return getContainingTemplateContext();
} else {
return m_templateContext;
}
}
/**
* Add namespace to set defined at this level.
*
* @param def namespace definition element to be added
* @return problem information, or null if no problem
*/
/* public ValidationProblem addNamespace(NamespaceElement def) {
// initialize structures if first namespace definition
if (m_namespaces == null) {
m_namespaces = new ArrayList();
m_prefixMap = new HashMap();
m_uriMap = new HashMap();
}
// check for conflict as default for attributes
if (def.isAttributeDefault()) {
if (m_attributeDefault == null) {
m_attributeDefault = def;
} else {
return new ValidationProblem
("Conflicting attribute namespaces", def);
}
}
// check for conflict as default for elements
if (def.isElementDefault()) {
if (m_elementDefault == null) {
m_elementDefault = def;
} else {
return new ValidationProblem
("Conflicting element namespaces", def);
}
}
// check for conflict on prefix
String prefix = def.getPrefix();
if (m_prefixMap.get(prefix) != null) {
return new ValidationProblem("Namespace prefix conflict", def);
}
// check for duplicate definition of same URI
String uri = def.getUri();
Object prior = m_uriMap.get(uri);
if (prior != null && ((NamespaceElement)prior).getPrefix() != null) {
// TODO: is this needed? multiple prefixes should be allowed
return null;
}
// add only if successful in all tests
m_namespaces.add(def);
m_prefixMap.put(prefix, def);
m_uriMap.put(uri, def);
return null;
} */
/**
* Get namespace for prefix.
*
* @param prefix
* @return namespace definition in this context, null if none
*/
public NamespaceElement getNamespaceForPrefix(String prefix) {
if (m_prefixMap == null) {
return null;
} else {
return (NamespaceElement)m_prefixMap.get(prefix);
}
}
/**
* Check for namespace using the same prefix. This also intializes the
* namespace structures for this context the first time the method is
* called.
*
* @param def
* @return namespace definition using same prefix, null if none
*/
private NamespaceElement checkDuplicatePrefix(NamespaceElement def) {
// create structures if not already done
if (m_namespaces == null) {
m_namespaces = new ArrayList();
m_prefixMap = new HashMap();
m_uriMap = new HashMap();
}
// check for conflict (or duplicate) on prefix
String prefix = def.getPrefix();
return (NamespaceElement)m_prefixMap.get(prefix);
}
/**
* Add namespace to internal tables.
*
* @param def
*/
private void internalAddNamespace(NamespaceElement def) {
String uri = def.getUri();
String prefix = def.getPrefix();
m_namespaces.add(def);
m_prefixMap.put(prefix, def);
m_uriMap.put(uri, def);
}
/**
* Add namespace to set defined at this level.
*
* @param def namespace definition element to be added (duplicates ignored)
* @return problem information, or null if no problem
*/
public ValidationProblem addNamespace(NamespaceElement def) {
String uri = def.getUri();
NamespaceElement dup = checkDuplicatePrefix(def);
if (dup == null) {
// check for no definition of same URI with prefix
NamespaceElement prior = (NamespaceElement)m_uriMap.get(uri);
if (prior == null || prior.getPrefix() == null) {
// check for conflict as default for attributes
if (def.isAttributeDefault()) {
if (m_attributeDefault == null) {
m_attributeDefault = def;
} else {
return new ValidationProblem
("Conflicting attribute namespaces", def);
}
}
// check for conflict as default for elements
if (def.isElementDefault()) {
if (m_elementDefault == null) {
m_elementDefault = def;
} else {
return new ValidationProblem
("Conflicting element namespaces", def);
}
}
// no conflicts, add it
internalAddNamespace(def);
}
} else if (!uri.equals(dup.getUri())) {
String prefix = def.getPrefix();
if (prefix == null) {
return new ValidationProblem
("Default namespace conflict", def);
} else {
return new ValidationProblem
("Namespace prefix conflict for prefix '" + prefix +
'\'', def);
}
}
return null;
}
/**
* Add namespace declaration to set defined at this level. This method
* treats all namespaces as though they were declared with default="none".
*
* @param def namespace definition to be added (duplicates ignored)
* @param ref binding element referencing the namespace
* @return problem information, or null if no problem
*/
public ValidationProblem addImpliedNamespace(NamespaceElement def,
ElementBase ref) {
String uri = def.getUri();
NamespaceElement dup = checkDuplicatePrefix(def);
DefinitionContext ctx = this;
String prefix = def.getPrefix();
while (dup == null && (ctx = ctx.getContaining()) != null) {
dup = getNamespaceForPrefix(prefix);
}
if (dup == null) {
// check for no definition of same URI with prefix
NamespaceElement prior = (NamespaceElement)m_uriMap.get(uri);
if (prior == null || prior.getPrefix() == null) {
// no conflicts, add it
internalAddNamespace(def);
}
} else if (!uri.equals(dup.getUri())) {
if (prefix == null) {
return new ValidationProblem
("Default namespace conflict on mapping reference", ref);
} else {
return new ValidationProblem
("Namespace conflict on mapping reference, for prefix '" + prefix +
'\'', ref);
}
}
return null;
}
/**
* Get namespace definition for element name.
* TODO: handle multiple prefixes for namespace, proper screening
*
* @param name attribute group defining name
* @return namespace definition, or null if none that matches
*/
public NamespaceElement getElementNamespace(NameAttributes name) {
String uri = name.getUri();
String prefix = name.getPrefix();
NamespaceElement ns = null;
if (uri != null) {
if (m_uriMap != null) {
ns = (NamespaceElement)m_uriMap.get(uri);
if (ns != null && prefix != null) {
if (!prefix.equals(ns.getPrefix())) {
ns = null;
}
}
}
} else if (prefix != null) {
if (m_prefixMap != null) {
ns = (NamespaceElement)m_prefixMap.get(prefix);
}
} else {
ns = m_elementDefault;
}
if (ns == null && m_outerContext != null) {
ns = m_outerContext.getElementNamespace(name);
}
return ns;
}
/**
* Get namespace definition for attribute name.
* TODO: handle multiple prefixes for namespace, proper screening
*
* @param name attribute group defining name
* @return namespace definition, or null if none that matches
*/
public NamespaceElement getAttributeNamespace(NameAttributes name) {
String uri = name.getUri();
String prefix = name.getPrefix();
NamespaceElement ns = null;
if (uri != null) {
if (m_uriMap != null) {
ns = (NamespaceElement)m_uriMap.get(uri);
if (ns != null && prefix != null) {
if (!prefix.equals(ns.getPrefix())) {
ns = null;
}
}
}
} else if (prefix != null) {
if (m_prefixMap != null) {
ns = (NamespaceElement)m_prefixMap.get(prefix);
}
} else {
ns = m_attributeDefault;
}
if (ns == null && m_outerContext != null) {
ns = m_outerContext.getAttributeNamespace(name);
}
return ns;
}
/**
* Add format to set defined at this level.
*
* @param def format definition element to be added
* @param vctx validation context in use
*/
public void addFormat(FormatElement def, ValidationContext vctx) {
if (m_formatContext == null) {
m_formatContext =
new ClassHierarchyContext(getContainingFormatContext());
}
if (def.isDefaultFormat()) {
IClass clas = def.getType();
m_formatContext.addTypedComponent(clas, def, vctx);
}
String label = def.getLabel();
if (label != null) {
m_formatContext.addNamedComponent(label, def, vctx);
}
}
/**
* Get specific format definition for type. Finds with an exact match
* on the class name, checking the containing definitions if a format
* is not found at this level.
*
* @param type fully qualified class name to be converted
* @return conversion definition for class, or null if not
* found
*/
public FormatElement getSpecificFormat(String type) {
ClassHierarchyContext ctx = getFormatContext();
if (ctx == null) {
return null;
} else {
return (FormatElement)ctx.getSpecificComponent(type);
}
}
/**
* Get named format definition. Finds the format with the supplied
* name, checking the containing definitions if the format is not found
* at this level.
*
* @param name conversion name to be found
* @return conversion definition with specified name, or null
* if no conversion with that name
*/
public FormatElement getNamedFormat(String name) {
ClassHierarchyContext ctx = getFormatContext();
if (ctx == null) {
return null;
} else {
return (FormatElement)ctx.getNamedComponent(name);
}
}
/**
* Get best format definition for class. Finds the format based on the
* inheritance hierarchy for the supplied class. If a specific format for
* the actual class is not found (either in this or a containing level) this
* returns the most specific superclass format.
*
* @param clas information for target conversion class
* @return conversion definition for class, or null if no
* compatible conversion defined
*/
public FormatElement getBestFormat(IClass clas) {
ClassHierarchyContext ctx = getFormatContext();
if (ctx == null) {
return null;
} else {
return (FormatElement)ctx.getMostSpecificComponent(clas);
}
}
/**
* Add mapped name to set defined at this level.
*
* @param name mapped name
* @param def mapping definition
* @param vctx validation context
*/
public void addMappedName(NameAttributes name, MappingElement def,
ValidationContext vctx) {
if (m_mappingMap == null) {
m_mappingMap = new HashMap();
}
String fullname = name.getName();
NamespaceElement namespace = getElementNamespace(name);
if (namespace != null && namespace.getUri() != null) {
fullname = '{' + namespace.getUri() + '}' + fullname;
}
if (m_mappingMap.containsKey(fullname)) {
if (vctx.isInBinding()) {
vctx.addError
("Duplicate mapping name not allowed for unmarshalling");
}
} else {
m_mappingMap.put(fullname, def);
}
}
/**
* Add template or mapping to set defined at this level.
*
* @param def template definition element to be added
* @param vctx validation context in use
*/
public void addTemplate(TemplateElementBase def, ValidationContext vctx) {
if (m_templateContext == null) {
m_templateContext =
new ClassHierarchyContext(getContainingTemplateContext());
}
if (def.isDefaultTemplate()) {
IClass clas = def.getHandledClass();
m_templateContext.addTypedComponent(clas, def, vctx);
}
if (def instanceof TemplateElement) {
TemplateElement tdef = (TemplateElement)def;
if (tdef.getLabel() != null) {
m_templateContext.addNamedComponent(tdef.getLabel(), def, vctx);
}
} else {
// TODO: Remove for 2.0
MappingElement mdef = (MappingElement)def;
if (mdef.getTypeName() != null) {
m_templateContext.addNamedComponent(mdef.getTypeName(),
def, vctx);
}
}
}
/**
* Get specific template definition for type. Finds with an exact match
* on the class name, checking the containing definitions if a template
* is not found at this level.
*
* @param type fully qualified class name to be converted
* @return template definition for type, or null if not
* found
*/
public TemplateElementBase getSpecificTemplate(String type) {
ClassHierarchyContext ctx = getTemplateContext();
if (ctx == null) {
return null;
} else {
return (TemplateElementBase)ctx.getSpecificComponent(type);
}
}
/**
* Get named template definition. Finds the template with the supplied
* name, checking the containing definitions if the template is not found
* at this level.
* TODO: Make this specific to TemplateElement in 2.0
*
* @param name conversion name to be found
* @return template definition for class, or null if no
* template with that name
*/
public TemplateElementBase getNamedTemplate(String name) {
ClassHierarchyContext ctx = getTemplateContext();
if (ctx == null) {
return null;
} else {
return (TemplateElementBase)ctx.getNamedComponent(name);
}
}
/**
* Checks if a class is compatible with one or more templates. This checks
* based on the inheritance hierarchy for the supplied class, looks for the
* class or interface itself as well as any subclasses or implementations.
*
* @param clas information for target class
* @return true if compatible type, false if not
*/
public boolean isCompatibleTemplateType(IClass clas) {
ClassHierarchyContext chctx = getTemplateContext();
if (chctx == null) {
return false;
} else {
return chctx.isCompatibleType(clas);
}
}
/**
* Add named structure to set defined in this context. For named structures
* only the definition context associated with the binding element should be
* used. This is a kludge, but will go away in 2.0.
*
* @param def structure definition
* @return problem information, or null if no problem
*/
public ValidationProblem addNamedStructure(ContainerElementBase def) {
// create structure if not already done
if (m_namedStructureMap == null) {
m_namedStructureMap = new HashMap();
}
// check for conflict on label before adding to definitions
String label = def.getLabel();
if (m_namedStructureMap.get(label) == null) {
m_namedStructureMap.put(label, def);
return null;
} else {
return new ValidationProblem("Duplicate label \"" + label + '"',
def);
}
}
/**
* Get labeled structure definition within this context. For named
* structures only the definition context associated with the binding
* element should be used. This is a kludge, but will go away in 2.0.
*
* @param label structure definition label
* @return structure definition with specified label, or null
* if not defined
*/
public ContainerElementBase getNamedStructure(String label) {
if (m_namedStructureMap == null) {
return null;
} else {
return (ContainerElementBase)m_namedStructureMap.get(label);
}
}
/**
* Get the namespaces defined in this context
*
* @return namespace definitions (may be null if none)
*/
public ArrayList getNamespaces() {
return m_namespaces;
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/DocumentFormatter.java 0000644 0001750 0001750 00000012075 10611640246 026537 0 ustar moeller moeller /*
Copyright (c) 2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import java.util.ArrayList;
import java.util.List;
import javax.xml.parsers.DocumentBuilderFactory;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
/**
* Formatter for JavaDoc conversion to XML documentation components.
*/
public class DocumentFormatter
{
/** Document used for constructing DOM components. */
private final Document m_document;
/**
* Constructor.
*/
public DocumentFormatter() {
try {
DocumentBuilderFactory fact =
DocumentBuilderFactory.newInstance();
m_document = fact.newDocumentBuilder().newDocument();
} catch (Exception e) {
throw new RuntimeException("Internal error: unable to create DOM builder", e);
}
}
/**
* Reformat a segment of JavaDoc text as either a CDATA section (if it
* contains embedded HTML tags) or a simple text node. This also replaces
* line breaks with single spaces, so that the output format will not use
* indenting based on the original supplied text.
*
* @param jdoc raw JavaDoc text
* @return formatted text
*/
public Node reformDocSegment(String jdoc) {
StringBuffer buff = new StringBuffer(jdoc);
int index = 0;
boolean dirty = false;
while (index < buff.length()) {
char chr = buff.charAt(index);
if (chr < 0x20) {
if (chr == '\n' || chr == '\r') {
if ((index > 0 && buff.charAt(index) == ' ') ||
(index+1 < buff.length() && buff.charAt(index+1) == ' ')) {
buff.deleteCharAt(index);
} else {
buff.setCharAt(index, ' ');
}
} else {
buff.deleteCharAt(index);
}
} else {
dirty = dirty || chr == '&' || chr == '<';
index++;
}
}
String text = buff.toString();
if (dirty) {
return m_document.createCDATASection(text);
} else {
return m_document.createTextNode(text);
}
}
/**
* Convert JavaDoc text to a list of formatted nodes.
*
* @param jdoc JavaDoc text (may be null)
* @return formatted representation (may be null)
*/
public List docToNodes(String jdoc) {
if (jdoc != null) {
jdoc = jdoc.trim();
if (jdoc.length() > 0) {
List nodes = new ArrayList();
boolean dirty = jdoc.indexOf('<') >= 0;
if (dirty) {
String ldoc = jdoc.toLowerCase();
int split;
int base = 0;
while ((split = ldoc.indexOf("
", base)) > 0) {
if (split > base) {
nodes.add(reformDocSegment(jdoc.substring(base, split)));
}
int end = ldoc.lastIndexOf("
");
if (end < 0) {
end = ldoc.length();
}
nodes.add(reformDocSegment(jdoc.substring(split, end)));
base = end+1;
}
if (base < jdoc.length()) {
nodes.add(reformDocSegment(jdoc.substring(base)));
}
} else {
nodes.add(reformDocSegment(jdoc));
}
return nodes;
}
}
return null;
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/ElementBase.java 0000644 0001750 0001750 00000016104 10651176146 025265 0 ustar moeller moeller /*
Copyright (c) 2004-2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import org.jibx.binding.util.StringArray;
import org.jibx.runtime.ITrackSource;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.impl.UnmarshallingContext;
/**
* Base class for all element structures in binding definition model. This just
* provides the linkages for the binding definition tree structure and related
* validation hooks.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public abstract class ElementBase
{
//
// Element type definitions.
public static final int BINDING_ELEMENT = 0;
public static final int COLLECTION_ELEMENT = 1;
public static final int FORMAT_ELEMENT = 2;
public static final int MAPPING_ELEMENT = 3;
public static final int NAMESPACE_ELEMENT = 4;
public static final int STRUCTURE_ELEMENT = 5;
public static final int TEMPLATE_ELEMENT = 6;
public static final int VALUE_ELEMENT = 7;
// special elements eliminated during splitting
public static final int INCLUDE_ELEMENT = 8;
public static final int SPLIT_ELEMENT = 9;
public static final int INPUT_ELEMENT = 10;
public static final int OUTPUT_ELEMENT = 11;
public static final String[] ELEMENT_NAMES =
{
"binding", "collection", "format", "mapping", "namespace", "structure",
"template", "value", "include", "split", "input", "output"
};
//
// Instance data.
/** Element type. */
private final int m_type;
/** Comment associated with element. */
private String m_comment;
/**
* Constructor.
*
* @param type element type code
*/
protected ElementBase(int type) {
m_type = type;
}
/**
* Get element type.
*
* @return type code for this element
*/
public final int type() {
return m_type;
}
/**
* Get element name.
*
* @return type code for this element
*/
public final String name() {
return ELEMENT_NAMES[m_type];
}
/**
* Get element comment.
*
* @return comment for this element
*/
public final String getComment() {
return m_comment;
}
/**
* Set element comment.
*
* @param text comment for this element
*/
public final void setComment(String text) {
m_comment = text;
}
/**
* Validate attributes of element. This is designed to be called during
* unmarshalling as part of the pre-set method processing when a subclass
* instance is being created.
*
* @param ictx unmarshalling context
* @param attrs attributes array
*/
protected void validateAttributes(IUnmarshallingContext ictx,
StringArray attrs) {
// setup for attribute access
int count = ictx.getStackDepth();
BindingElement.UnmarshalWrapper wrapper =
(BindingElement.UnmarshalWrapper)ictx.getStackObject(count-1);
ValidationContext vctx = wrapper.getValidation();
UnmarshallingContext uctx = (UnmarshallingContext)ictx;
// loop through all attributes of current element
for (int i = 0; i < uctx.getAttributeCount(); i++) {
// check if nonamespace attribute is in the allowed set
String name = uctx.getAttributeName(i);
if (uctx.getAttributeNamespace(i).length() == 0) {
if (attrs.indexOf(name) < 0) {
vctx.addWarning("Undefined attribute " + name, this);
}
}
}
}
/**
* Prevalidate element information. The prevalidation step is used to
* check isolated aspects of an element, such as the settings for enumerated
* values on the element and attributes. This empty base class
* implementation should be overridden by each subclass that requires
* prevalidation handling.
*
* @param vctx validation context
*/
public void prevalidate(ValidationContext vctx) {}
/**
* Validate element information. The validation step is used for checking
* the interactions between elements, such as name references to other
* elements. The {@link #prevalidate} method will always be called for every
* element in the binding definition before this method is called for any
* element. This empty base class implementation should be overridden by
* each subclass that requires validation handling.
*
* @param vctx validation context
*/
public void validate(ValidationContext vctx) {}
/**
* Simple text representation of binding definition element. This uses the
* element name, along with position information if present.
*
* @return text representation
*/
public String toString() {
StringBuffer buff = new StringBuffer();
buff.append('<');
buff.append(name());
buff.append('>');
buff.append(" element");
if (this instanceof ITrackSource) {
ITrackSource track = (ITrackSource)this;
int line = track.jibx_getLineNumber();
if (line >= 0) {
buff.append(" (line ");
buff.append(line);
buff.append(", column ");
buff.append(track.jibx_getColumnNumber());
String dname = track.jibx_getDocumentName();
if (dname == null) {
buff.append(')');
} else {
buff.append(" in '");
buff.append(dname);
buff.append("')");
}
}
}
return buff.toString();
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/EmptyList.java 0000644 0001750 0001750 00000007344 10673571520 025040 0 ustar moeller moeller /*
Copyright (c) 2004-2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import java.util.ArrayList;
import java.util.Collection;
/**
* Unmodifiable empty array list. This defines a singleton instance of itself,
* which can then be used whereever an empty list is convenient. This class is
* required to support methods which return instances of java.util.ArrayList in
* order to guarantee random access to the returned list in constant time as
* part of the method contract. java.util.Collection.EMPTY_LIST is not an
* instance of java.util.ArrayList, so it cannot be used.
*
* @author Dennis M. Sosnoski
*/
public class EmptyList extends ArrayList
{
public static final EmptyList INSTANCE = new EmptyList();
private EmptyList() {}
public void add(int index, Object element) {
throw new UnsupportedOperationException("List is not modifiable");
}
public boolean add(Object o) {
throw new UnsupportedOperationException("List is not modifiable");
}
public boolean addAll(Collection c) {
throw new UnsupportedOperationException("List is not modifiable");
}
public boolean addAll(int index, Collection c) {
throw new UnsupportedOperationException("List is not modifiable");
}
public void ensureCapacity(int minCapacity) {
throw new UnsupportedOperationException("List is not modifiable");
}
public void clear() {
throw new UnsupportedOperationException("List is not modifiable");
}
public Object remove(int index) {
throw new UnsupportedOperationException("List is not modifiable");
}
public boolean remove(Object o) {
throw new UnsupportedOperationException("List is not modifiable");
}
protected void removeRange(int fromIndex, int toIndex) {
throw new UnsupportedOperationException("List is not modifiable");
}
public Object set(int index, Object element) {
throw new UnsupportedOperationException("List is not modifiable");
}
public void trimToSize() {
throw new UnsupportedOperationException("List is not modifiable");
}
public boolean removeAll(Collection c) {
throw new UnsupportedOperationException("List is not modifiable");
}
public boolean retainAll(Collection c) {
throw new UnsupportedOperationException("List is not modifiable");
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/FormatDefaults.java 0000644 0001750 0001750 00000011137 11002542656 026014 0 ustar moeller moeller /*
* Copyright (c) 2008, Dennis M. Sosnoski. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
/**
* Default <format> definitions.
*
* @author Dennis M. Sosnoski
*/
public abstract class FormatDefaults
{
/** Default format definitions. */
public static final FormatElement[] s_defaultFormats = {
buildFormat("byte.default", "byte", true, "org.jibx.runtime.Utility.serializeByte",
"org.jibx.runtime.Utility.parseByte", "0"),
buildFormat("char.default", "char", true, "org.jibx.runtime.Utility.serializeChar",
"org.jibx.runtime.Utility.parseChar", "0"),
buildFormat("double.default", "double", true, "org.jibx.runtime.Utility.serializeDouble",
"org.jibx.runtime.Utility.parseDouble", "0.0"),
buildFormat("float.default", "float", true, "org.jibx.runtime.Utility.serializeFloat",
"org.jibx.runtime.Utility.parseFloat", "0.0"),
buildFormat("int.default", "int", true, "org.jibx.runtime.Utility.serializeInt",
"org.jibx.runtime.Utility.parseInt", "0"),
buildFormat("long.default", "long", true, "org.jibx.runtime.Utility.serializeLong",
"org.jibx.runtime.Utility.parseLong", "0"),
buildFormat("short.default", "short", true, "org.jibx.runtime.Utility.serializeShort",
"org.jibx.runtime.Utility.parseShort", "0"),
buildFormat("boolean.default", "boolean", true, "org.jibx.runtime.Utility.serializeBoolean",
"org.jibx.runtime.Utility.parseBoolean", "false"),
buildFormat("Date.default", "java.util.Date", true, "org.jibx.runtime.Utility.serializeDateTime",
"org.jibx.runtime.Utility.deserializeDateTime", null),
//#!j2me{
buildFormat("SqlDate.default", "java.sql.Date", true, "org.jibx.runtime.Utility.serializeSqlDate",
"org.jibx.runtime.Utility.deserializeSqlDate", null),
buildFormat("SqlTime.default", "java.sql.Time", true, "org.jibx.runtime.Utility.serializeSqlTime",
"org.jibx.runtime.Utility.deserializeSqlTime", null),
buildFormat("SqlTimestamp.default", "java.sql.Timestamp", true, "org.jibx.runtime.Utility.serializeTimestamp",
"org.jibx.runtime.Utility.deserializeTimestamp", null),
//#j2me}
buildFormat("byte-array.default", "byte[]", true, "org.jibx.runtime.Utility.serializeBase64",
"org.jibx.runtime.Utility.deserializeBase64", null),
buildFormat("String.default", "java.lang.String", true, null, null, null),
buildFormat("Object.default", "java.lang.Object", true, null, null, null)
};
/**
* Default format builder.
*
* @param name
* @param type
* @param use
* @param sname
* @param dname
* @param dflt
* @return constructed format
*/
private static FormatElement buildFormat(String name, String type, boolean use, String sname, String dname,
String dflt) {
FormatElement format = new FormatElement();
format.setLabel(name);
format.setTypeName(type);
format.setDefaultFormat(use);
format.setSerializerName(sname);
format.setDeserializerName(dname);
format.setDefaultText(dflt);
return format;
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/FormatElement.java 0000644 0001750 0001750 00000025216 10752421640 025641 0 ustar moeller moeller /*
Copyright (c) 2004-2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import org.jibx.binding.util.StringArray;
import org.jibx.runtime.IMarshallingContext;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.QName;
/**
* Model component for format element. This element defines conversion to
* and from simple unstructured text representations.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class FormatElement extends ElementBase
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new String[] { "label", "type" },
StringAttributes.s_allowedAttributes);
/** Format label. */
private String m_label;
/** Format qualified name. */
private QName m_qname;
/** Default format for type flag. */
private boolean m_isDefault;
/** Name of value type. */
private String m_typeName;
/** Value type information. */
private IClass m_type;
/** String attributes information for value. */
private StringAttributes m_stringAttrs;
/**
* Constructor.
*/
public FormatElement() {
super(FORMAT_ELEMENT);
m_stringAttrs = new StringAttributes();
}
/**
* Get format label.
*
* @return format label (null if none)
*/
public String getLabel() {
return m_label;
}
/**
* Set format label. This method changes the qualified name to match the
* label.
*
* @param label format label (null if none)
*/
public void setLabel(String label) {
m_label = label;
m_qname = (label == null) ? null : new QName(label);
}
/**
* Get format qualified name.
*
* @return format qualified name (null if none)
*/
public QName getQName() {
return m_qname;
}
/**
* Set format qualified name. This method changes the label value to match
* the qualified name.
*
* @param qname format qualified name (null if none)
*/
public void setQName(QName qname) {
m_qname = qname;
m_label = (qname == null) ? null : qname.toString();
}
/**
* Check if default format for type.
*
* @return true if default for type, false if not
*/
public boolean isDefaultFormat() {
return m_isDefault;
}
/**
* Set default format for type.
*
* @param dflt true if default for type, false if
* not
*/
public void setDefaultFormat(boolean dflt) {
m_isDefault = dflt;
}
/**
* Get value type. This method is only usable after a
* call to {@link #validate}.
*
* @return default value object
*/
public IClass getType() {
return m_type;
}
/**
* Get value type name.
*
* @return value type name
*/
public String getTypeName() {
return m_typeName;
}
/**
* Set value type name.
*
* @param value type name
*/
public void setTypeName(String value) {
m_typeName = value;
}
//
// String attribute delegate methods
/**
* Get default value text.
*
* @return default value text
*/
public String getDefaultText() {
return m_stringAttrs.getDefaultText();
}
/**
* Get default value. This call is only meaningful after validation.
*
* @return default value object
*/
public Object getDefault() {
return m_stringAttrs.getDefault();
}
/**
* Set default value text.
*
* @param value default value text
*/
public void setDefaultText(String value) {
m_stringAttrs.setDefaultText(value);
}
/**
* Get enum value method information. This method is only usable after a
* call to {@link #validate(ValidationContext)}.
*
* @return enum value method information (or null if none)
*/
public IClassItem getEnumValue() {
return m_stringAttrs.getEnumValue();
}
/**
* Get enum value method name.
*
* @return enum value method name (or null if none)
*/
public String getEnumValueName() {
return m_stringAttrs.getEnumValueName();
}
/**
* Set enum value method name.
*
* @param name enum value method name (null if none)
*/
public void setEnumValueName(String name) {
m_stringAttrs.setEnumValueName(name);
}
/**
* Get serializer name.
*
* @return fully qualified class and method name for serializer (or
* null if none)
*/
public String getSerializerName() {
return m_stringAttrs.getSerializerName();
}
/**
* Get serializer method information. This call is only meaningful after
* validation.
*
* @return serializer information (or null if none)
*/
public IClassItem getSerializer() {
return m_stringAttrs.getSerializer();
}
/**
* Set serializer method name.
*
* @param fully qualified class and method name for serializer
*/
public void setSerializerName(String name) {
m_stringAttrs.setSerializerName(name);
}
/**
* Get deserializer name.
*
* @return fully qualified class and method name for deserializer (or
* null if none)
*/
public String getDeserializerName() {
return m_stringAttrs.getDeserializerName();
}
/**
* Get deserializer method information. This call is only meaningful after
* validation.
*
* @return deserializer information (or null if none)
*/
public IClassItem getDeserializer() {
return m_stringAttrs.getDeserializer();
}
/**
* Set deserializer method name.
*
* @param fully qualified class and method name for deserializer
*/
public void setDeserializerName(String name) {
m_stringAttrs.setDeserializerName(name);
}
/**
* Get base format information. This method is only usable after a
* call to {@link #validate}.
*
* @return base format element (or null if none)
*/
public FormatElement getBaseFormat() {
return m_stringAttrs.getBaseFormat();
}
//
// Validation methods
/**
* JiBX access method to set format label as qualified name.
*
* @param label format label text (null if none)
* @param ictx unmarshalling context
* @throws JiBXException on deserialization error
*/
private void setQualifiedLabel(String label, IUnmarshallingContext ictx)
throws JiBXException {
setQName(QName.deserialize(label, ictx));
}
/**
* JiBX access method to get format label as qualified name.
*
* @param ictx marshalling context
* @return format label text (null if none)
* @throws JiBXException on deserialization error
*/
private String getQualifiedLabel(IMarshallingContext ictx)
throws JiBXException {
return QName.serialize(getQName(), ictx);
}
/**
* Make sure all attributes are defined.
*
* @param uctx unmarshalling context
* @exception JiBXException on unmarshalling error
*/
private void preSet(IUnmarshallingContext uctx) throws JiBXException {
validateAttributes(uctx, s_allowedAttributes);
}
/**
* Set default flag based on whether name supplied or not.
* TODO: use explicit flag for 2.0
*/
private void postSet() {
m_isDefault = m_label == null;
}
/**
* Prevalidate attributes of element in isolation. Note that this adds the
* format information to the context, which is necessary because the string
* attributes for values need to have access to the format information for
* their own prevalidation. This is the only type of registration which is
* done during the prevalidation pass.
*
* @param vctx validation context
*/
public void prevalidate(ValidationContext vctx) {
// prevalidate this format
if (m_typeName != null) {
m_type = vctx.getClassInfo(m_typeName);
if (m_type != null) {
m_stringAttrs.setType(m_type);
m_stringAttrs.prevalidate(vctx);
} else {
vctx.addFatal("Unable to find type " + m_typeName);
}
} else {
vctx.addFatal("Missing required type name");
}
// now try adding to context (except when run during setup) - kludgy
if (vctx.getParentElement() != null) {
vctx.getFormatDefinitions().addFormat(this, vctx);
}
super.prevalidate(vctx);
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ElementBase#validate(org.jibx.binding.model.ValidationContext)
*/
public void validate(ValidationContext vctx) {
m_stringAttrs.validate(vctx);
super.validate(vctx);
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/IClass.java 0000644 0001750 0001750 00000020736 10756324254 024266 0 ustar moeller moeller /*
Copyright (c) 2004-2008, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import org.jibx.binding.classes.ClassFile;
/**
* Interface for class file information. Provides access to class field and
* method information.
*
* @author Dennis M. Sosnoski
*/
public interface IClass
{
/**
* Get class file information.
* TODO: eliminate this sucker
*
* @return class file information
*/
public ClassFile getClassFile();
/**
* Get fully qualified class name.
*
* @return fully qualified name for class
*/
public String getName();
/**
* Get signature for class as type.
*
* @return signature for class used as type
*/
public String getSignature();
/**
* Get package name.
*
* @return package name for class
*/
public String getPackage();
/**
* Get superclass.
*
* @return superclass information
*/
public IClass getSuperClass();
/**
* Get names of all interfaces implemented directly by class.
*
* @return names of all interfaces implemented directly by class
*/
public String[] getInterfaces();
/**
* Get signatures for all types of which instances of this type are
* instances.
*
* @return all signatures suppored by instances
*/
public String[] getInstanceSigs();
/**
* Check if class implements an interface.
*
* @param sig signature of interface to be checked
* @return true if interface is implemented by class,
* false if not
*/
public boolean isImplements(String sig);
/**
* Check if class is abstract.
*
* @return true if class is abstract, false if not
*/
public boolean isAbstract();
/**
* Check if class is an interface.
*
* @return true if class is an interface, false if
* not
*/
public boolean isInterface();
/**
* Check if class is modifiable.
*
* @return true if class is modifiable, false if
* not
*/
public boolean isModifiable();
/**
* Check if another class is a superclass of this one.
*
* @param name potential superclass to be checked
* @return true if named class is a superclass of this one,
* false if not
*/
public boolean isSuperclass(String name);
/**
* Get information for field. This only checks for fields that are actually
* members of the class (not superclasses).
* TODO: make this work with both static and member fields
*
* @param name field name
* @return field information, or null if field not found
*/
public IClassItem getDirectField(String name);
/**
* Get information for field. If the field is not found directly,
* superclasses are checked for inherited fields matching the supplied name.
* TODO: make this work with both static and member fields
*
* @param name field name
* @return field information, or null if field not found
*/
public IClassItem getField(String name);
/**
* Get information for best matching method. This tries to find a method
* which matches the specified name, return type, and argument types. If an
* exact match is not found it looks for a method with a return type that
* is extended or implemented by the specified type and arguments that are
* extended or implemented by the specified types. If no match is found for
* this class superclasses are checked.
* TODO: make this work with both static and member methods
*
* @param name method name
* @param type return value type name (null if indeterminant)
* @param args argument value type names
* @return method information, or null if method not found
*/
public IClassItem getBestMethod(String name, String type, String[] args);
/**
* Get information for method without respect to potential trailing
* arguments or return value. If the method is not found directly,
* superclasses are checked for inherited methods matching the supplied
* name. This compares the supplied partial signature against the actual
* method signature, and considers it a match if the actual sigature starts
* with the supplied signature.
* TODO: make this work with both static and member methods
*
* @param name method name
* @param sig partial method signature to be matched
* @return method information, or null if method not found
*/
public IClassItem getMethod(String name, String sig);
/**
* Get information for method matching one of several possible signatures.
* If a match is not found directly, superclasses are checked for inherited
* methods matching the supplied name and signatures. The signature
* variations are checked in the order supplied.
* TODO: make this work with both static and member methods
*
* @param name method name
* @param sigs possible signatures for method (including return type)
* @return method information, or null if method not found
*/
public IClassItem getMethod(String name, String[] sigs);
/**
* Get information for initializer. Only the class itself is checked for an
* initializer matching the argument list signature.
*
* @param sig encoded argument list signature
* @return method information, or null if method not found
*/
public IClassItem getInitializerMethod(String sig);
/**
* Get information for static method without respect to return value. Only
* the class itself is checked for a method matching the supplied name and
* argument list signature.
*
* @param name method name
* @param sig encoded argument list signature
* @return method information, or null if method not found
*/
public IClassItem getStaticMethod(String name, String sig);
/**
* Check accessible method. Check if a field or method in another class is
* accessible from within this class.
*
* @param item field or method information
* @return true if accessible, false if not
*/
public boolean isAccessible(IClassItem item);
/**
* Check if a value of this type can be directly assigned to another type.
* This is basically the equivalent of the instanceof operator.
*
* @param other type to be assigned to
* @return true if assignable, false if not
*/
public boolean isAssignable(IClass other);
/**
* Load class in executable form.
*
* @return loaded class, or null if unable to load
*/
public Class loadClass();
/**
* Get all methods of class.
*
* @return methods
*/
public IClassItem[] getMethods();
/**
* Get all fields of class.
*
* @return fields
*/
public IClassItem[] getFields();
/**
* Get the JavaDoc comment for this class.
*
* @return comment text, or null if none or no source available
*/
public String getJavaDoc();
/**
* Get the locator which provided this class.
*
* @return locator
*/
public IClassLocator getLocator();
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/IClassItem.java 0000644 0001750 0001750 00000011316 10611640402 025061 0 ustar moeller moeller /*
Copyright (c) 2004-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
/**
* Interface for field or method information. Provides the information needed
* for access to the item.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public interface IClassItem
{
/**
* Get owning class information.
*
* @return owning class information
*/
public IClass getOwningClass();
/**
* Get item name.
*
* @return item name
*/
public String getName();
/**
* Get item JavaDoc description, if available.
*
* @return non-empty JavaDoc text (null if not available)
*/
public String getJavaDoc();
/**
* Get item type as fully qualified class name.
*
* @return item type name
*/
public String getTypeName();
/**
* Get return JavaDoc description for method, if available.
*
* @return non-empty JavaDoc text (null if not available)
*/
public String getReturnJavaDoc();
/**
* Get number of arguments for method.
*
* @return argument count for method, or -1 if not a method
*/
public int getArgumentCount();
/**
* Get argument type as fully qualified class name. This method will throw a
* runtime exception if called on a field.
*
* @param index argument number
* @return argument type name
*/
public String getArgumentType(int index);
/**
* Get method parameter name, if available. This method will throw a
* runtime exception if called on a field.
*
* @param index parameter number
* @return parameter name (null if not available)
*/
public String getParameterName(int index);
/**
* Get method parameter JavaDoc description, if available. This method will
* throw a runtime exception if called on a field.
*
* @param index parameter number
* @return non-empty JavaDoc text (null if not available)
*/
public String getParameterJavaDoc(int index);
/**
* Get access flags.
*
* @return flags for access type of field or method
*/
public int getAccessFlags();
/**
* Get field or method signature.
*
* @return encoded method signature
*/
public String getSignature();
/**
* Check if item is a method.
*
* @return true if a method, false if a field
*/
public boolean isMethod();
/**
* Check if item is an initializer.
*
* @return true if an initializer, false if a
* field or normal method
*/
public boolean isInitializer();
/**
* Get names of exceptions thrown by method.
*
* @return array of exceptions thrown by method, or null if
* a field
*/
public String[] getExceptions();
/**
* Get method throws JavaDoc description, if available. This method will
* throw a runtime exception if called on a field.
*
* @param index exception index (into array returned by
* {@link #getExceptions()}
* @return non-empty JavaDoc text (null if not available)
*/
public String getExceptionJavaDoc(int index);
/**
* Get the generics signature information for item.
*
* @return generics signature (null if none)
*/
public String getGenericsSignature();
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/IClassLocator.java 0000644 0001750 0001750 00000003645 10602535544 025606 0 ustar moeller moeller /*
Copyright (c) 2004-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
/**
* Locator for class information. Looks up classes using whatever method is
* appropriate for the usage environment.
*
* @author Dennis M. Sosnoski
*/
public interface IClassLocator
{
/**
* Get class information.
*
* @param name fully-qualified name of class to be found
* @return class information, or null if class not found
*/
public IClass getClassInfo(String name);
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/IComponent.java 0000644 0001750 0001750 00000007361 10264375314 025157 0 ustar moeller moeller /*
Copyright (c) 2004-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
/**
* Child component interface definition. This is the basic interface implemented
* by every binding definition element that actually participates in the nested
* structure of a binding (as opposed to elements such as format
* elements, which are simply convenience shortcuts). It defines the hooks used
* to handle structure validation of a binding definition model.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public interface IComponent
{
/**
* Check if component is an optional item.
*
* @return true if optional, false if required
*/
public boolean isOptional();
/**
* Check if component defines one or more attribute values of the
* containing element. This method is only valid after the call to {@link
* setLinkages}.
*
* @return true if one or more attribute values defined for
* containing element, false if not
*/
public boolean hasAttribute();
/**
* Check if component defines one or more elements or text values as
* children of the containing element. This method is only valid after the
* call to {@link setLinkages}.
*
* @return true if one or more content values defined
* for containing element, false if not
*/
public boolean hasContent();
/**
* Check if component has a name.
*
* @return true if component has a name, false if
* not
*/
public boolean hasName();
/**
* Get name.
*
* @return name text
*/
public String getName();
/**
* Get specified namespace URI.
*
* @return namespace URI (null if not set)
*/
public String getUri();
/**
* Get value type information. This call is only meaningful after
* prevalidation.
*
* @return type information
*/
public IClass getType();
/**
* Check if this structure implicitly uses the containing object. This call
* is only meaningful after prevalidation.
*
* @return true if using the containing object,
* false if own object
*/
public boolean isImplicit();
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/IncludeElement.java 0000644 0001750 0001750 00000012334 10602537500 025766 0 ustar moeller moeller /*
Copyright (c) 2004-2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import java.io.IOException;
import java.net.URL;
import org.jibx.binding.util.StringArray;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
/**
* Model component for include element of binding definition. During
* prevalidation this reads the included binding definition. All further
* processing of the included components needs to be handled directly by the
* tree walking code in {@link org.jibx.binding.model.TreeContext}, since the
* components of the included binding need to be treated as though they were
* direct children of the container of this element (and accessed in the
* appropriate order).
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class IncludeElement extends NestingElementBase
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new String[] { "path" });
/** Path to included binding definition. */
private String m_includePath;
/** Object model for included binding. */
private BindingElement m_binding;
/**
* Constructor.
*/
public IncludeElement() {
super(INCLUDE_ELEMENT);
}
/**
* Set path to included binding.
*
* @param path
*/
public void setIncludePath(String path) {
m_includePath = path;
}
/**
* Get path to included binding.
*
* @return
*/
public String getIncludePath() {
return m_includePath;
}
/**
* Get the included binding model. This call is only valid after
* prevalidation.
*
* @return binding element, or null if redundant include
*/
public BindingElement getBinding() {
return m_binding;
}
//
// Validation methods
/**
* Make sure all attributes are defined.
*
* @param uctx unmarshalling context
* @exception JiBXException on unmarshalling error
*/
private void preSet(IUnmarshallingContext uctx) throws JiBXException {
validateAttributes(uctx, s_allowedAttributes);
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ElementBase#prevalidate(org.jibx.binding.model.ValidationContext)
*/
public void prevalidate(ValidationContext vctx) {
if (m_includePath == null) {
vctx.addFatal("No include path specified");
} else {
try {
// locate the innermost binding element
int limit = vctx.getNestingDepth();
BindingElement root = null;
for (int i = 1; i < limit; i++) {
ElementBase parent = vctx.getParentElement(i);
if (parent instanceof BindingElement) {
root = (BindingElement)parent;
break;
}
}
if (root == null) {
throw new JiBXException("No binding element found");
}
// access the included binding as input stream
URL base = root.getBaseUrl();
URL url = new URL(base, m_includePath);
String path = url.toExternalForm();
BindingElement real = vctx.getBindingRoot();
if (real.addIncludePath(path)) {
m_binding = real.getIncludeBinding(url, root, vctx);
}
} catch (JiBXException e) {
vctx.addFatal(e.getMessage());
} catch (IOException e) {
vctx.addFatal("Error accessing included binding with path \"" +
m_includePath + "\": " + e.getMessage());
}
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/InputElement.java 0000644 0001750 0001750 00000003555 10210703670 025505 0 ustar moeller moeller /*
Copyright (c) 2004-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
/**
* Model component for input element of binding definition. This is only
* used for structuring purposes and doesn't require any actual processing.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class InputElement extends NestingElementBase
{
/**
* Constructor.
*/
public InputElement() {
super(INPUT_ELEMENT);
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/MappingElement.java 0000644 0001750 0001750 00000035702 10756324616 026016 0 ustar moeller moeller /*
Copyright (c) 2004-2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import java.util.ArrayList;
import org.jibx.binding.util.StringArray;
import org.jibx.runtime.IMarshallingContext;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.QName;
/**
* Model component for mapping element of binding definition.
*
* @author Dennis M. Sosnoski
*/
public class MappingElement extends TemplateElementBase
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new String[]
{ "abstract", "class", "extends", "type-name" },
new StringArray(NameAttributes.s_allowedAttributes,
ContainerElementBase.s_allowedAttributes));
// TODO: move "mapping" to TemplateElementBase in 2.0
/** Abstract mapping flag. */
private boolean m_isAbstract;
/** Name attributes information for nesting. */
private NameAttributes m_nameAttrs;
/** Name of mapped class extended by this mapping. */
private String m_extendsName;
/** Type qualified name (defaults to fully-qualified class name in
no-namespace namespace). */
private QName m_typeQName;
/** Mapping extended by this mapping. */
private MappingElement m_extendsMapping;
/** Constructability verified flag. */
private boolean m_constructVerified;
/**
* Default constructor.
*/
public MappingElement() {
super(MAPPING_ELEMENT);
m_nameAttrs = new NameAttributes();
m_topChildren = new ArrayList();
}
/**
* Check for abstract mapping.
*
* @return true if abstract, false if not
*/
public boolean isAbstract() {
return m_isAbstract;
}
/**
* Set abstract mapping.
*
* @param abs true if abstract, false if not
*/
public void setAbstract(boolean abs) {
m_isAbstract = abs;
}
/**
* Get type name.
*
* @return type name
*/
public String getTypeName() {
return (m_typeQName == null) ? null : m_typeQName.toString();
}
/**
* Set type name.
*
* @param name type name
*/
public void setTypeName(String name) {
m_typeQName = new QName(name);
}
/**
* Get type qualified name.
*
* @return type qualified name
*/
public QName getTypeQName() {
return m_typeQName;
}
/**
* Set type qualified name.
*
* @param qname type qualified name
*/
public void setTypeQName(QName qname) {
m_typeQName = qname;
}
/**
* Set name of mapped class extended by this one.
*
* @param name
*/
public void setExtendsName(String name) {
m_extendsName = name;
}
/**
* Get name of mapped class extended by this one.
*
* @return name
*/
public String getExtendsName() {
return m_extendsName;
}
/**
* Get mapping extended by this one.
*
* @return mapping extended by this one
*/
public MappingElement getExtendsMapping() {
return m_extendsMapping;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.TemplateElementBase#isDefaultTemplate()
*/
public boolean isDefaultTemplate() {
return m_typeQName == null;
}
//
// Access methods
/**
* Get name attributes. This is provided for use with the name attributes as
* a hash key.
*
* @return name attributes structure
*/
public NameAttributes getNameAttributes() {
return m_nameAttrs;
}
//
// Name attribute delegate methods
/**
* Get name.
*
* @return name text
*/
public String getName() {
return m_nameAttrs.getName();
}
/**
* Set name.
*
* @param name text for name
*/
public void setName(String name) {
m_nameAttrs.setName(name);
}
/**
* Get specified namespace URI.
*
* @return namespace URI (null if not set)
*/
public String getUri() {
return m_nameAttrs.getUri();
}
/**
* Set namespace URI.
*
* @param uri namespace URI (null if not set)
*/
public void setUri(String uri) {
m_nameAttrs.setUri(uri);
}
/**
* Get specified namespace prefix.
*
* @return namespace prefix (null if not set)
*/
public String getPrefix() {
return m_nameAttrs.getPrefix();
}
/**
* Set namespace prefix.
*
* @param prefix namespace prefix (null if not set)
*/
public void setPrefix(String prefix) {
m_nameAttrs.setPrefix(prefix);
}
/**
* Get effective namespace information. This call is only meaningful after
* validation.
*
* @return effective namespace information
*/
public NamespaceElement getNamespace() {
return m_nameAttrs.getNamespace();
}
//
// Validation methods
/**
* JiBX access method to set mapping type name as qualified name.
*
* @param text mapping name text (null if none)
* @param ictx unmarshalling context
* @throws JiBXException on deserialization error
*/
private void setQualifiedTypeName(String text, IUnmarshallingContext ictx)
throws JiBXException {
m_typeQName = QName.deserialize(text, ictx);
}
/**
* JiBX access method to get mapping type name as qualified name.
*
* @param ictx marshalling context
* @return mapping type name text (null if none)
* @throws JiBXException on deserialization error
*/
private String getQualifiedTypeName(IMarshallingContext ictx)
throws JiBXException {
return QName.serialize(m_typeQName, ictx);
}
/**
* Verify that instances of the mapped class can be constructed. This
* method may be called during the {@link #validate(ValidationContext)}
* processing of other elements. If this mapping has any extensions, the
* check is ignored.
* TODO: check that at least one of the extensions can be created
*
* @param vctx
*/
public void verifyConstruction(ValidationContext vctx) {
if (!m_constructVerified && getExtensionTypes().size() == 0) {
verifyConstruction(vctx, getHandledClass());
}
}
/**
* Make sure all attributes are defined.
*
* @param uctx unmarshalling context
* @exception JiBXException on unmarshalling error
*/
private void preSet(IUnmarshallingContext uctx) throws JiBXException {
validateAttributes(uctx, s_allowedAttributes);
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ElementBase#prevalidate(org.jibx.binding.model.ValidationContext)
*/
public void prevalidate(ValidationContext vctx) {
m_nameAttrs.prevalidate(vctx);
if (m_isAbstract) {
if (m_typeQName != null && m_nameAttrs.getName() != null) {
vctx.addError("Type name cannot be used with an element name");
}
if (isNillable()) {
vctx.addError
("nillable='true' cannot be used on an abstract mapping");
}
} else {
if (m_nameAttrs.getName() == null) {
if ((vctx.isInBinding() && getUnmarshallerName() == null) ||
(vctx.isOutBinding() && getMarshallerName() == null)) {
vctx.addError
("Non-abstract mapping must define an element name");
}
if (isNillable()) {
vctx.addError
("nillable='true' cannot be used without an element name");
}
}
if (m_typeQName != null) {
vctx.addError
("Type name can only be used with an abstract mapping");
}
}
super.prevalidate(vctx);
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ElementBase#validate(org.jibx.binding.model.ValidationContext)
*/
public void validate(ValidationContext vctx) {
m_nameAttrs.validate(vctx);
// check use of text values in children of structure with name
SequenceVisitor visitor = new SequenceVisitor(null, vctx);
TreeContext tctx = vctx.getChildContext();
tctx.tourTree(this, visitor);
// make sure we can construct instances of concrete mapped class
if (!m_isAbstract) {
verifyConstruction(vctx, getHandledClass());
m_constructVerified = true;
}
// check for class that probably should extend another mapped class
if (m_extendsName == null) {
if (!m_isAbstract) {
// first check ancestor classes for ones with specific mappings
IClass sclass = getHandledClass();
DefinitionContext defc = vctx.getCurrentDefinitions();
while ((sclass = sclass.getSuperClass()) != null) {
TemplateElementBase stmpl =
defc.getSpecificTemplate(sclass.getName());
if (stmpl != null) {
if (stmpl instanceof MappingElement) {
MappingElement smap = (MappingElement)stmpl;
if (smap.getExtensionTypes().size() > 0) {
vctx.addWarning("Class " + getClassName() +
" extends " + smap.getClassName() +
" which has a base mapping with extensions, but this mapping does not extend it");
}
}
break;
}
}
// next check interfaces for ones with specific mappings
String[] interfaces = getHandledClass().getInterfaces();
for (int i = 0; i < interfaces.length; i++) {
String iname = interfaces[i];
TemplateElementBase itmpl = defc.getSpecificTemplate(iname);
if (itmpl != null) {
if (itmpl instanceof MappingElement) {
MappingElement smap = (MappingElement)itmpl;
if (smap.getExtensionTypes().size() > 0) {
vctx.addWarning("Class " + getClassName() +
" implements " + iname +
" which has a base mapping with extensions, but this mapping does not extend it");
}
}
break;
}
}
}
} else {
if (m_extendsName.equals(getClassName())) {
vctx.addError("Mapping cannot extend itself");
}
if (m_isAbstract && getExtensionTypes().size() == 0) {
vctx.addWarning("Only concrete mappings should be 'leaf' mappings for extensions; you should either remove 'extends' attribute or add concrete extension mappings for this abstract mapping");
}
}
// run base class validation
super.validate(vctx);
}
/**
* Special validation method to link extension mappings to base mappings.
* This is called as a special step following registration, so that the
* normal validation pass can make use of the linkage information.
*
* @param vctx validation context
*/
public void validateExtension(ValidationContext vctx) {
if (m_extendsName != null) {
// find the base class mapping
TemplateElementBase base =
vctx.getDefinitions().getSpecificTemplate(m_extendsName);
if (base instanceof MappingElement) {
if (base != this) {
// check base class using custom marshaller/unmarshaller
MappingElement mbase = (MappingElement)base;
if (mbase.getMarshaller() != null ||
mbase.getUnmarshaller() != null) {
vctx.addError("Cannot extend a mapping using custom " +
"marshaller/unmarshaller");
}
// add reference to base class
mbase.addExtensionType(this);
m_extendsMapping = mbase;
// check for circular references
MappingElement mark = this;
boolean skip = true;
while (mbase != null) {
if (mbase == mark) {
vctx.addError("Circular 'extends' reference chain",
mbase);
break;
} else if (skip) {
skip = false;
} else {
mark = mbase;
skip = true;
}
mbase = mbase.getExtendsMapping();
}
}
} else {
vctx.addFatal("No mapping found for class " + m_extendsName);
}
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/ModelVisitor.java 0000644 0001750 0001750 00000025263 10410213252 025506 0 ustar moeller moeller /*
Copyright (c) 2004-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
/**
* Binding model visitor base class. This works with the {@link
* org.jibx.binding.model.TreeContext} class for handling tree-based
* operations on the binding definition. Subclasses can override any or all of
* the base class visit and exit methods, including both those for abstract base
* classes and those for concrete classes, but should normally call the base
* class implementation of the method in order to implement the class
* inheritance hierarchy handling. Elements in the binding definition are always
* visited in tree order (down and across).
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public abstract class ModelVisitor
{
//
// Visit methods for base classes
/**
* Visit element. This method will be called for every element in the model.
*
* @param node element being visited
* @return true if children to be processed, false
* if not
*/
public boolean visit(ElementBase node) {
return true;
}
/**
* Visit nesting element. This method will be called for any form of nesting
* element.
*
* @param node nesting element being visited
* @return true if children to be processed, false
* if not
*/
public boolean visit(NestingElementBase node) {
return visit((ElementBase)node);
}
/**
* Visit container element. This method will be called for any form of
* container element.
*
* @param node container element being visited
* @return true if children to be processed, false
* if not
*/
public boolean visit(ContainerElementBase node) {
return visit((NestingElementBase)node);
}
/**
* Visit structure element. This method will be called for any form of
* structure element.
*
* @param node structure element being visited
* @return true if children to be processed, false
* if not
*/
public boolean visit(StructureElementBase node) {
return visit((ContainerElementBase)node);
}
/**
* Visit template element. This method will be called for any form of
* template element.
*
* @param node template element being visited
* @return true if children to be processed, false
* if not
*/
public boolean visit(TemplateElementBase node) {
return visit((ContainerElementBase)node);
}
//
// Visit methods for concrete classes
/**
* Visit binding element.
*
* @param node binding element being visited
* @return true if children to be processed, false
* if not
*/
public boolean visit(BindingElement node) {
return visit((NestingElementBase)node);
}
/**
* Visit collection element.
*
* @param node collection element being visited
* @return true if children to be processed, false
* if not
*/
public boolean visit(CollectionElement node) {
return visit((StructureElementBase)node);
}
/**
* Visit format element.
*
* @param node format element being visited
* @return true if children to be processed, false
* if not
*/
public boolean visit(FormatElement node) {
return visit((ElementBase)node);
}
/**
* Visit include element.
*
* @param node include element being visited
* @return true if children to be processed, false
* if not
*/
public boolean visit(IncludeElement node) {
return visit((ElementBase)node);
}
/**
* Visit input element.
*
* @param node input element being visited
* @return true if children to be processed, false
* if not
*/
public boolean visit(InputElement node) {
return visit((NestingElementBase)node);
}
/**
* Visit mapping element.
*
* @param node mapping element being visited
* @return true if children to be processed, false
* if not
*/
public boolean visit(MappingElement node) {
return visit((TemplateElementBase)node);
}
/**
* Visit namespace element.
*
* @param node namespace element being visited
* @return true if children to be processed, false
* if not
*/
public boolean visit(NamespaceElement node) {
return visit((ElementBase)node);
}
/**
* Visit output element.
*
* @param node output element being visited
* @return true if children to be processed, false
* if not
*/
public boolean visit(OutputElement node) {
return visit((NestingElementBase)node);
}
/**
* Visit split element.
*
* @param node split element being visited
* @return true if children to be processed, false
* if not
*/
public boolean visit(SplitElement node) {
return visit((NestingElementBase)node);
}
/**
* Visit structure element.
*
* @param node structure element being visited
* @return true if children to be processed, false
* if not
*/
public boolean visit(StructureElement node) {
return visit((StructureElementBase)node);
}
/**
* Visit template element.
*
* @param node template element being visited
* @return true if children to be processed, false
* if not
*/
public boolean visit(TemplateElement node) {
return visit((TemplateElementBase)node);
}
/**
* Visit value element.
*
* @param node value element being visited
* @return true if children to be processed, false
* if not
*/
public boolean visit(ValueElement node) {
return visit((ElementBase)node);
}
//
// Exit methods for base classes
/**
* Exit any element.
*
* @param node element being exited
*/
public void exit(ElementBase node) {}
/**
* Exit any nesting element.
*
* @param node nesting element being exited
*/
public void exit(NestingElementBase node) {
exit((ElementBase)node);
}
/**
* Exit any container element.
*
* @param node container element being exited
*/
public void exit(ContainerElementBase node) {
exit((NestingElementBase)node);
}
/**
* Exit any structure element.
*
* @param node structure element being exited
*/
public void exit(StructureElementBase node) {
exit((ContainerElementBase)node);
}
/**
* Exit any template element.
*
* @param node template element being exited
*/
public void exit(TemplateElementBase node) {
exit((NestingElementBase)node);
}
//
// Exit methods for concrete classes
/**
* Exit binding element.
*
* @param node binding element being exited
*/
public void exit(BindingElement node) {
exit((NestingElementBase)node);
}
/**
* Exit collection element.
*
* @param node collection element being exited
*/
public void exit(CollectionElement node) {
exit((StructureElementBase)node);
}
/**
* Exit include element.
*
* @param node input element being exited
*/
public void exit(IncludeElement node) {
exit((ElementBase)node);
}
/**
* Exit input element.
*
* @param node input element being exited
*/
public void exit(InputElement node) {
exit((NestingElementBase)node);
}
/**
* Exit mapping element.
*
* @param node mapping element being exited
*/
public void exit(MappingElement node) {
exit((TemplateElementBase)node);
}
/**
* Exit output element.
*
* @param node output element being exited
*/
public void exit(OutputElement node) {
exit((NestingElementBase)node);
}
/**
* Exit split element.
*
* @param node split element being exited
*/
public void exit(SplitElement node) {
exit((NestingElementBase)node);
}
/**
* Exit structure element.
*
* @param node structure element being exited
*/
public void exit(StructureElement node) {
exit((StructureElementBase)node);
}
/**
* Exit template element.
*
* @param node template element being exited
*/
public void exit(TemplateElement node) {
exit((TemplateElementBase)node);
}
/**
* Exit value element.
*
* @param node value element being exited
*/
public void exit(ValueElement node) {
exit((ElementBase)node);
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/NameAttributes.java 0000644 0001750 0001750 00000013643 10752662244 026036 0 ustar moeller moeller /*
Copyright (c) 2004-2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import org.jibx.binding.util.StringArray;
import org.jibx.runtime.Utility;
/**
* Model component for name attribute group in binding definition.
*
* @author Dennis M. Sosnoski
*/
public class NameAttributes extends AttributeBase
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new String[] { "name", "ns" });
// TODO: add "prefix" to set for 2.0
/** Name text. */
private String m_name;
/** Namespace URI. */
private String m_uri;
/** Namespace prefix. */
private String m_prefix;
/** Name represents an attribute flag. */
private boolean m_isAttribute;
/** Namespace definition used by this name. */
private NamespaceElement m_namespace;
/**
* Default constructor.
*/
public NameAttributes() {}
/**
* Set flag for an attribute name. This information is necessary for
* resolving the namespace definition to be used with a name, but has to be
* determined by the element owning this attribute group. It must be set (if
* different from the default of false) prior to validation.
*
* @param isattr flag for name represents an attribute
*/
public void setIsAttribute(boolean isattr) {
m_isAttribute = isattr;
}
/**
* Get flag for an attribute name.
*
* @return true if an attribute, false if an
* element
*/
public boolean isAttribute() {
return m_isAttribute;
}
/**
* Get name.
*
* @return name text
*/
public String getName() {
return m_name;
}
/**
* Set name.
*
* @param name text for name
*/
public void setName(String name) {
m_name = name;
}
/**
* Get specified namespace URI.
*
* @return namespace URI (null if not set)
*/
public String getUri() {
return m_uri;
}
/**
* Set namespace URI.
*
* @param uri namespace URI (null if not set)
*/
public void setUri(String uri) {
m_uri = uri;
}
/**
* Get specified namespace prefix.
*
* @return namespace prefix (null if not set)
*/
public String getPrefix() {
return m_prefix;
}
/**
* Set namespace prefix.
*
* @param prefix namespace prefix (null if not set)
*/
public void setPrefix(String prefix) {
m_prefix = prefix;
}
/**
* Get effective namespace definition. This call can only be used after
* validation.
*
* @return definition for namespace used by this name
*/
public NamespaceElement getNamespace() {
return m_namespace;
}
//
// Overrides of base class methods
/* (non-Javadoc)
* @see org.jibx.binding.model.AttributeBase#validate(org.jibx.binding.model.ValidationContext)
*/
public void validate(ValidationContext vctx) {
if (m_name != null) {
DefinitionContext dctx = null;
ElementBase elem = vctx.peekElement();
if (elem instanceof ContainerElementBase) {
dctx = ((ContainerElementBase)elem).getDefinitions();
}
if (dctx == null) {
dctx = vctx.getDefinitions();
}
if (m_isAttribute) {
m_namespace = dctx.getAttributeNamespace(this);
} else {
m_namespace = dctx.getElementNamespace(this);
}
}
super.validate(vctx);
}
/* (non-Javadoc)
* @see java.lang.Object#equals(java.lang.Object)
*/
public boolean equals(Object obj) {
if (obj instanceof NameAttributes) {
NameAttributes comp = (NameAttributes)obj;
if (Utility.safeEquals(m_name, comp.m_name)) {
if (m_namespace == null) {
return comp.m_namespace == null;
} else {
return Utility.safeEquals(m_namespace.getUri(),
comp.m_namespace.getUri());
}
} else {
return false;
}
} else {
return false;
}
}
/* (non-Javadoc)
* @see java.lang.Object#hashCode()
*/
public int hashCode() {
if (m_uri == null) {
return m_name.hashCode();
} else {
return m_name.hashCode() + m_uri.hashCode();
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/NamespaceElement.java 0000644 0001750 0001750 00000012471 10434260370 026302 0 ustar moeller moeller /*
Copyright (c) 2004-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import org.jibx.binding.util.StringArray;
import org.jibx.runtime.EnumSet;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
/**
* Model component for namespace element of binding definition.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class NamespaceElement extends ElementBase
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new String[] { "default", "prefix", "uri" });
//
// Enumeration for namespace usage.
public static final int NODEFAULT_USAGE = 0;
public static final int ELEMENTS_USAGE = 1;
public static final int ATTRIBUTES_USAGE = 2;
public static final int ALLDEFAULT_USAGE = 3;
public static final EnumSet s_defaultEnum =
new EnumSet(NODEFAULT_USAGE,
new String[] { "none", "elements", "attributes", "all" });
//
// Actual instance data
/** Default type name. */
private String m_defaultName = s_defaultEnum.getName(NODEFAULT_USAGE);
/** Actual selected default. */
private int m_defaultIndex;
/** Namespace URI. */
private String m_uri;
/** Namespace prefix (may be null, but not ""). */
private String m_prefix;
/**
* Constructor.
*/
public NamespaceElement() {
super(NAMESPACE_ELEMENT);
}
/**
* Get prefix.
*
* @return prefix text
*/
public String getPrefix() {
return m_prefix;
}
/**
* Set prefix.
*
* @param prefix text
*/
public void setPrefix(String text) {
m_prefix = text;
}
/**
* Get namespace URI.
*
* @return namespace URI (null if no-namespace namespace)
*/
public String getUri() {
return m_uri;
}
/**
* Set namespace URI.
*
* @param uri namespace URI (null if no-namespace namespace)
*/
public void setUri(String uri) {
m_uri = uri;
}
/**
* Set namespace default type name.
*
* @param name namespace default type
*/
public void setDefaultName(String name) {
m_defaultName = name;
}
/**
* Get namespace default type name.
*
* @return namespace default type name
*/
public String getDefaultName() {
return m_defaultName;
}
/**
* Check if default namespace for attributes. This method is only meaningful
* after a call to {@link #validate}.
*
* @return true if default namespace for attributes,
* false if not
*/
public boolean isAttributeDefault() {
return m_defaultIndex == ATTRIBUTES_USAGE ||
m_defaultIndex == ALLDEFAULT_USAGE;
}
/**
* Check if default namespace for elements. This method is only meaningful
* after a call to {@link #validate}.
*
* @return true if default namespace for elements,
* false if not
*/
public boolean isElementDefault() {
return m_defaultIndex == ELEMENTS_USAGE ||
m_defaultIndex == ALLDEFAULT_USAGE;
}
//
// Validation methods
/**
* Make sure all attributes are defined.
*
* @param uctx unmarshalling context
* @exception JiBXException on unmarshalling error
*/
private void preSet(IUnmarshallingContext uctx) throws JiBXException {
validateAttributes(uctx, s_allowedAttributes);
}
/**
* Prevalidate attributes of element in isolation.
*
* @param vctx validation context
*/
public void prevalidate(ValidationContext vctx) {
m_defaultIndex = s_defaultEnum.getValue(m_defaultName);
if (m_defaultIndex < 0) {
vctx.addError("Value \"" + m_defaultName +
"\" is not a valid choice for namespace default usage");
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/NestingAttributes.java 0000644 0001750 0001750 00000007407 10602537162 026560 0 ustar moeller moeller /*
Copyright (c) 2004-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import org.jibx.binding.util.StringArray;
import org.jibx.runtime.EnumSet;
/**
* Model component for nesting attribute group in binding definition.
*
* @author Dennis M. Sosnoski
*/
public class NestingAttributes extends AttributeBase
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new String[] { "value-style" });
//
// Value set information
public static final int ATTRIBUTE_STYLE = 0;
public static final int ELEMENT_STYLE = 1;
/*package*/ static final EnumSet s_styleEnum = new EnumSet(ATTRIBUTE_STYLE,
new String[] { "attribute", "element" });
//
// Instance data
/** Supplied style name. */
private String m_styleName;
/** Actual selected style. */
private int m_styleIndex;
/**
* Get style string value.
*
* @return style string value (null if undefined at this level)
*/
public String getStyleName() {
return m_styleName;
}
/**
* Get style value. This method is only usable after a call to {@link
* #validate}.
*
* @return style value
*/
public int getStyle() {
return m_styleIndex;
}
/**
* Set style name.
*
* @param name style name (null to undefine style at this
* level)
*/
public void setStyleName(String name) {
m_styleName = name;
}
//
// Overrides of base class methods
/* (non-Javadoc)
* @see org.jibx.binding.model.AttributeBase#prevalidate(org.jibx.binding.model.ValidationContext)
*/
public void prevalidate(ValidationContext vctx) {
if (m_styleName == null) {
NestingElementBase parent = vctx.getParentElement();
if (parent == null) {
m_styleIndex = ELEMENT_STYLE;
} else {
m_styleIndex = parent.getDefaultStyle();
}
} else {
int style = s_styleEnum.getValue(m_styleName);
if (style < 0) {
vctx.addError("Value \"" + m_styleName +
"\" is not a valid style");
} else {
m_styleIndex = style;
}
}
super.prevalidate(vctx);
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/NestingElementBase.java 0000644 0001750 0001750 00000012701 10624255526 026614 0 ustar moeller moeller /*
Copyright (c) 2004-2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import java.util.ArrayList;
import java.util.Iterator;
import org.jibx.binding.util.StringArray;
/**
* Model component for elements that can contain other component elements.
* TODO: The list of child elements here conflicts with that in BindingElement;
* should change the type hierarchy to better reflect usage
*
* @author Dennis M. Sosnoski
*/
public abstract class NestingElementBase extends ElementBase
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new String[] { "value-style" });
/** Value style attribute information. */
private NestingAttributes m_nestingAttrs;
/** Definition context for this nesting (created by validation). */
private DefinitionContext m_defContext;
/** List of child elements. */
private ArrayList m_children;
/**
* Constructor.
*
* @param type element type code
*/
protected NestingElementBase(int type) {
super(type);
m_nestingAttrs = new NestingAttributes();
m_children = new ArrayList();
}
/**
* Add child element.
* TODO: should be ElementBase argument, but JiBX doesn't allow yet
*
* @param child element to be added as child of this element
*/
public final void addChild(Object child) {
m_children.add(child);
}
/**
* Get list of child elements.
*
* @return list of child elements (never null)
*/
public final ArrayList children() {
return m_children;
}
/**
* Get iterator for child elements.
*
* @return iterator for child elements
*/
public final Iterator childIterator() {
return m_children.iterator();
}
/**
* Get definition context.
*
* @return definition context, or null if no definition context
* for this element
*/
public final DefinitionContext getDefinitions() {
return m_defContext;
}
/**
* Set definition context.
*
* @param ctx definition context to be set
*/
/*package*/ void setDefinitions(DefinitionContext ctx) {
m_defContext = ctx;
}
//
// Nesting attribute delegate methods
/**
* Get style name set on this nesting element.
*
* @return style string value (null if undefined at this level)
*/
public String getStyleName() {
return m_nestingAttrs.getStyleName();
}
/**
* Get style value set on this nesting element. This call is only meaningful
* after validation.
*
* @return style value (-1 if undefined at this level)
*/
public int getStyle() {
return m_nestingAttrs.getStyle();
}
/**
* Set style name on this nesting element.
*
* @param name style name (null to undefine style at this
* level)
*/
public void setStyleName(String name) {
m_nestingAttrs.setStyleName(name);
}
/**
* Get default style value for child components. This call is only
* meaningful after validation.
*
* @return default style value for child components (-1 if not
* defined at this level)
*/
public int getDefaultStyle() {
return m_nestingAttrs.getStyle();
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ElementBase#prevalidate(org.jibx.binding.model.ValidationContext)
*/
public void prevalidate(ValidationContext vctx) {
m_nestingAttrs.prevalidate(vctx);
super.prevalidate(vctx);
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ElementBase#validate(org.jibx.binding.model.ValidationContext)
*/
public void validate(ValidationContext vctx) {
if (m_defContext == null) {
m_defContext = vctx.getCurrentDefinitions();
}
m_nestingAttrs.validate(vctx);
super.validate(vctx);
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/ObjectAttributes.java 0000644 0001750 0001750 00000043206 10767275736 026376 0 ustar moeller moeller /*
Copyright (c) 2004-2008, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import org.jibx.binding.util.StringArray;
/**
* Model component for object attribute group in binding definition.
*
* @author Dennis M. Sosnoski
*/
public class ObjectAttributes extends AttributeBase
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new String[] { "create-type", "factory", "marshaller",
"nillable", "post-set", "pre-get", "pre-set", "unmarshaller" });
//
// Constants and such related to code generation.
// recognized marshal hook method (pre-get) signatures.
private static final String[] MARSHAL_HOOK_SIGNATURES =
{
"(Lorg/jibx/runtime/IMarshallingContext;)V",
"(Ljava/lang/Object;)V",
"()V"
};
// recognized factory hook method signatures.
private static final String[] FACTORY_HOOK_SIGNATURES =
{
"(Lorg/jibx/runtime/IUnmarshallingContext;)",
"(Ljava/lang/Object;)",
"()"
};
// recognized unmarshal hook method (pre-set, post-set) signatures.
private static final String[] UNMARSHAL_HOOK_SIGNATURES =
{
"(Lorg/jibx/runtime/IUnmarshallingContext;)V",
"(Ljava/lang/Object;)V",
"()V"
};
// marshaller/unmarshaller definitions
private static final String UNMARSHALLER_INTERFACE =
"org.jibx.runtime.IUnmarshaller";
private static final String MARSHALLER_INTERFACE =
"org.jibx.runtime.IMarshaller";
private static final String UNMARSHALLER_INTERFACETYPE =
"Lorg/jibx/runtime/IUnmarshaller;";
private static final String MARSHALLER_INTERFACETYPE =
"Lorg/jibx/runtime/IMarshaller;";
//
// Instance data.
/** Factory method name (fully qualified, including package and class). */
private String m_factoryName;
/** Pre-set method name. */
private String m_preSetName;
/** Post-set method name. */
private String m_postSetName;
/** Pre-get method name. */
private String m_preGetName;
/** Object marshaller class name. */
private String m_marshallerName;
/** Object unmarshaller class name. */
private String m_unmarshallerName;
/** Nillable object flag. */
private boolean m_isNillable;
/** Instance type for creation (fully qualified, including package and
class). */
private String m_createType;
/** Factory method information. */
private IClassItem m_factoryItem;
/** Pre-set method information. */
private IClassItem m_preSetItem;
/** Post-set method information. */
private IClassItem m_postSetItem;
/** Pre-get method information. */
private IClassItem m_preGetItem;
/** Object marshaller class. */
private IClass m_marshallerClass;
/** Object unmarshaller class. */
private IClass m_unmarshallerClass;
/** Class to use for new instance creation. */
private IClass m_createClass;
/**
* Constructor.
*/
public ObjectAttributes() {}
/**
* Get factory method name.
*
* @return fully-qualified factory class and method name (or
* null if none)
*/
public String getFactoryName() {
return m_factoryName;
}
/**
* Get factory method information. This method is only usable after a
* call to {@link #prevalidate(ValidationContext)}.
*
* @return factory method information (or null if none)
*/
public IClassItem getFactory() {
return m_factoryItem;
}
/**
* Set factory method name.
*
* @param name fully qualified class and method name for object factory
*/
public void setFactoryName(String name) {
m_factoryName = name;
}
/**
* Get pre-set method name.
*
* @return pre-set method name (or null if none)
*/
public String getPresetName() {
return m_preSetName;
}
/**
* Get pre-set method information. This method is only usable after a
* call to {@link #prevalidate(ValidationContext)}.
*
* @return pre-set method information (or null if none)
*/
public IClassItem getPreset() {
return m_preSetItem;
}
/**
* Set pre-set method name.
*
* @param name member method name to be called before unmarshalling
*/
public void setPresetName(String name) {
m_preSetName = name;
}
/**
* Get post-set method name.
*
* @return post-set method name (or null if none)
*/
public String getPostsetName() {
return m_postSetName;
}
/**
* Get post-set method information. This method is only usable after a
* call to {@link #prevalidate(ValidationContext)}.
*
* @return post-set method information (or null if none)
*/
public IClassItem getPostset() {
return m_postSetItem;
}
/**
* Set post-set method name.
*
* @param name member method name to be called after unmarshalling
*/
public void setPostsetName(String name) {
m_postSetName = name;
}
/**
* Get pre-get method name.
*
* @return pre-get method name (or null if none)
*/
public String getPregetName() {
return m_preGetName;
}
/**
* Get pre-get method information. This method is only usable after a
* call to {@link #prevalidate(ValidationContext)}.
*
* @return pre-get method information (or null if none)
*/
public IClassItem getPreget() {
return m_preGetItem;
}
/**
* Set pre-get method name.
*
* @param name member method name to be called before marshalling
*/
public void setPreget(String name) {
m_preGetName = name;
}
/**
* Get marshaller class name.
*
* @return marshaller class name (or null if none)
*/
public String getMarshallerName() {
return m_marshallerName;
}
/**
* Get marshaller class information. This method is only usable after a
* call to {@link #prevalidate(ValidationContext)}.
*
* @return class information for marshaller (or null if none)
*/
public IClass getMarshaller() {
return m_marshallerClass;
}
/**
* Set marshaller class name.
*
* @param name class name to be used for marshalling
*/
public void setMarshallerName(String name) {
m_marshallerName = name;
}
/**
* Get unmarshaller class name.
*
* @return unmarshaller class name (or null if none)
*/
public String getUnmarshallerName() {
return m_unmarshallerName;
}
/**
* Get unmarshaller class information. This method is only usable after a
* call to {@link #prevalidate(ValidationContext)}.
*
* @return class information for unmarshaller (or null if none)
*/
public IClass getUnmarshaller() {
return m_unmarshallerClass;
}
/**
* Set unmarshaller class name.
*
* @param name class name to be used for unmarshalling
*/
public void setUnmarshallerName(String name) {
m_unmarshallerName = name;
}
/**
* Check if nillable object.
*
* @return nillable flag
*/
public boolean isNillable() {
return m_isNillable;
}
/**
* Set nillable flag.
*
* @param nillable flag
*/
public void setNillable(boolean nillable) {
m_isNillable = nillable;
}
/**
* Get type to be used for creating new instance.
*
* @return class name for type to be created (or null if none)
*/
public String getCreateType() {
return m_createType;
}
/**
* Get new instance creation class information. This method is only usable
* after a call to {@link #prevalidate(ValidationContext)}.
*
* @return class information for type to be created (or null if
* none)
*/
public IClass getCreateClass() {
return m_createClass;
}
/**
* Set new instance type class name.
*
* @param name class name to be used for creating new instance
*/
public void setCreateType(String name) {
m_createType = name;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.AttributeBase#prevalidate(org.jibx.binding.model.ValidationContext)
*/
public void prevalidate(ValidationContext vctx) {
// first check for actual object association
IClass iclas;
ElementBase element = vctx.getParentElement(0);
if (element instanceof StructureElementBase) {
if (!((StructureElementBase)element).hasObject()) {
if (m_factoryName != null) {
vctx.addWarning("No object for structure; factory attribute ignored");
m_factoryName = null;
}
if (m_preSetName != null) {
vctx.addWarning("No object for structure; pre-set attribute ignored");
m_preSetName = null;
}
if (m_preGetName != null) {
vctx.addWarning("No object for structure; pre-get attribute ignored");
m_preGetName = null;
}
if (m_postSetName != null) {
vctx.addWarning("No object for structure; post-set attribute ignored");
m_postSetName = null;
}
if (m_marshallerName != null) {
vctx.addWarning("No object for structure; marshaller attribute ignored");
m_marshallerName = null;
}
if (m_unmarshallerName != null) {
vctx.addWarning("No object for structure; unmarshaller attribute ignored");
m_unmarshallerName = null;
}
if (m_createType != null) {
vctx.addWarning("No object for structure; create-type attribute ignored");
m_createType = null;
}
if (m_isNillable) {
vctx.addError("No object for structure; nillable attribute forbidden");
m_isNillable = false;
}
return;
} else {
iclas = ((StructureElementBase)element).getType();
}
} else if (element instanceof MappingElement) {
iclas = ((MappingElement)element).getHandledClass();
} else {
throw new IllegalStateException
("Unknown element for object attributes");
}
String type = iclas.getName();
// first check for marshaller and unmarshaller classes
if (m_marshallerName != null) {
if (vctx.isOutBinding()) {
IClass mclas = vctx.getClassInfo(m_marshallerName);
if (mclas == null) {
vctx.addError("Marshaller class " + m_marshallerName + " not found");
} else if (!mclas.isImplements(MARSHALLER_INTERFACETYPE)) {
vctx.addError("Marshaller class " + m_marshallerName + " does not implement interface " + MARSHALLER_INTERFACE);
} else {
m_marshallerClass = mclas;
}
} else {
vctx.addWarning("marshaller attribute ignored for input-only binding");
}
}
if (m_unmarshallerName != null) {
if (vctx.isInBinding()) {
// get the unmarshaller information
IClass uclas = vctx.getClassInfo(m_unmarshallerName);
if (uclas == null) {
vctx.addError("Unmarshaller class " + m_unmarshallerName + " not found");
} else if (!uclas.isImplements(UNMARSHALLER_INTERFACETYPE)) {
vctx.addError("Unmarshaller class " + m_unmarshallerName + " does not implement interface " + UNMARSHALLER_INTERFACE);
} else {
m_unmarshallerClass = uclas;
}
// check for incompatible attributes
if (m_factoryName != null) {
vctx.addWarning("unmarshaller supplied, factory attribute ignored");
m_factoryName = null;
}
if (m_createType != null) {
vctx.addWarning
("unmarshaller supplied, create-type attribute ignored");
m_createType = null;
}
} else {
vctx.addWarning("unmarshaller attribute ignored for output-only binding");
}
}
// make sure both are supplied if either is supplied
if (vctx.isInBinding() && vctx.isOutBinding()) {
if (m_unmarshallerName != null && m_marshallerName == null) {
vctx.addError("Marshaller is required if unmarshaller is supplied");
} else if (m_marshallerName != null && m_unmarshallerName == null) {
vctx.addError("Unmarshaller is required if marshaller is supplied");
}
}
// next check for factory supplied
if (m_factoryName != null) {
if (vctx.isInBinding()) {
// find factory method and verify signature
m_factoryItem = ClassUtils.findStaticMethod(m_factoryName,
FACTORY_HOOK_SIGNATURES, vctx);
if (m_factoryItem == null) {
if (m_factoryName.indexOf('.') > 0) {
vctx.addError("Static factory method " + m_factoryName + " not found");
} else {
vctx.addError("Need class name for static method " + m_factoryName);
}
} else {
String ftype = m_factoryItem.getTypeName();
if (!ClassUtils.isAssignable(ftype, type, vctx) &&
!ClassUtils.isAssignable(type, ftype, vctx))
vctx.addError("Static factory method " + m_factoryName + " return type is not compatible with " + type);
}
// check for incompatible attributes
if (m_createType != null) {
vctx.addWarning("unmarshaller supplied, create-type attribute ignored");
m_createType = null;
}
} else {
vctx.addWarning("factory attribute ignored for output-only binding");
}
}
// check for create-type attribute
if (m_createType != null) {
if (vctx.isInBinding()) {
// find create type class and verify compatibility
m_createClass = vctx.getClassInfo(m_createType);
if (m_createClass == null) {
vctx.addError("create-type class " + m_createType + " not found");
} else {
if (!ClassUtils.isAssignable(m_createType, type, vctx) &&
!ClassUtils.isAssignable(type, m_createType, vctx))
vctx.addError("create-type " + m_createType + " is not compatible with expected type " + type);
}
} else {
vctx.addWarning
("create-type attribute ignored for output-only binding");
}
}
// handle pre-set, post-set, and pre-get methods
if (vctx.isInBinding()) {
if (m_preSetName != null) {
m_preSetItem = iclas.getMethod(m_preSetName,
UNMARSHAL_HOOK_SIGNATURES);
if (m_preSetItem == null) {
vctx.addError("Nonstatic pre-set method " + m_preSetName + " not found");
}
}
if (m_postSetName != null) {
m_postSetItem = iclas.getMethod(m_postSetName,
UNMARSHAL_HOOK_SIGNATURES);
if (m_postSetItem == null) {
vctx.addError("Nonstatic post-set method " + m_postSetName + " not found");
}
}
}
if (vctx.isOutBinding()) {
if (m_preGetName != null) {
m_preGetItem = iclas.getMethod(m_preGetName,
MARSHAL_HOOK_SIGNATURES);
if (m_preGetItem == null) {
vctx.addError("Nonstatic pre-get method " + m_preGetName + " not found");
}
}
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/OutputElement.java 0000644 0001750 0001750 00000003561 10210703670 025703 0 ustar moeller moeller /*
Copyright (c) 2004-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
/**
* Model component for output element of binding definition. This is only
* used for structuring purposes and doesn't require any actual processing.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class OutputElement extends NestingElementBase
{
/**
* Constructor.
*/
public OutputElement() {
super(OUTPUT_ELEMENT);
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/PropertyAttributes.java 0000644 0001750 0001750 00000043375 10756324440 027004 0 ustar moeller moeller /*
Copyright (c) 2004-2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import java.util.ArrayList;
import org.jibx.binding.util.StringArray;
import org.jibx.runtime.EnumSet;
/**
* Model component for property attribute group in binding definition.
*
* @author Dennis M. Sosnoski
*/
public class PropertyAttributes extends AttributeBase
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new String[] { "field", "get-method", "set-method",
"test-method", "type", "usage" });
// recognized test-method signatures.
private static final String[] TEST_METHOD_SIGNATURES =
{
"(Lorg/jibx/runtime/IMarshallingContext;)Z",
"()Z"
};
// recognized get-method signatures.
private static final String[] GET_METHOD_SIGNATURES =
{
"(Lorg/jibx/runtime/IMarshallingContext;)",
"()"
};
//
// Value set information
public static final int REQUIRED_USAGE = 0;
public static final int OPTIONAL_USAGE = 1;
public static final int OPTIONAL_IN_USAGE = 2;
public static final int OPTIONAL_OUT_USAGE = 3;
private static final EnumSet s_usageEnum = new EnumSet(REQUIRED_USAGE,
new String[] { "required", "optional", "opt-in", "opt-out" });
//
// Instance data.
/** Usage type code. */
private int m_usage;
/** Usage name. */
private String m_usageName = s_usageEnum.getName(REQUIRED_USAGE);
/** Property type name. */
private String m_declaredType;
/** Property field name. */
private String m_fieldName;
/** Test method name. */
private String m_testName;
/** Get method name. */
private String m_getName;
/** Set method name. */
private String m_setName;
/** Type for value loaded on stack. */
private IClass m_getType;
/** Type for value stored from stack. */
private IClass m_setType;
/** Property type information. */
private IClass m_type;
/** Property field information. */
private IClassItem m_fieldItem;
/** Test method information. */
private IClassItem m_testItem;
/** Get method information. */
private IClassItem m_getItem;
/** Set method information. */
private IClassItem m_setItem;
/** Flag for no actual property definition. */
private boolean m_isImplicit;
/**
* Get usage name.
*
* @return usage name
*/
public String getUsageName() {
return s_usageEnum.getName(m_usage);
}
/**
* Get usage value. This method is only usable after a call to {@link
* #prevalidate(ValidationContext)}.
*
* @return usage value
*/
public int getUsage() {
return m_usage;
}
/**
* Set usage name.
*
* @param name usage name
*/
public void setUsageName(String name) {
m_usageName = name;
}
/**
* Set usage value.
*
* @param use value
*/
public void setUsage(int use) {
m_usage = use;
m_usageName = s_usageEnum.getName(use);
}
/**
* Check if property is defined. This method is only usable after a call to
* {@link #prevalidate(ValidationContext)}.
*
* @return true if property defined, false if not
*/
public boolean hasProperty() {
return !m_isImplicit && m_type != null;
}
/**
* Get declared type name.
*
* @return declared type name (or null if none)
*/
public String getDeclaredType() {
return m_declaredType;
}
/**
* Set declared type name.
*
* @param type declared type name (or null if none)
*/
public void setDeclaredType(String type) {
m_declaredType = type;
}
/**
* Get field name.
*
* @return field name (or null if none)
*/
public String getFieldName() {
return m_fieldName;
}
/**
* Get field information. This method is only usable after a call to {@link
* #prevalidate(ValidationContext)}.
*
* @return field information (or null if none)
*/
public IClassItem getField() {
return m_fieldItem;
}
/**
* Set field name.
*
* @param field field name (or null if none)
*/
public void setFieldName(String field) {
m_fieldName = field;
}
/**
* Get test method name.
*
* @return test method name (or null if none)
*/
public String getTestName() {
return m_testName;
}
/**
* Get test method information. This method is only usable after a call to
* {@link #prevalidate(ValidationContext)}.
*
* @return test method information (or null if none)
*/
public IClassItem getTest() {
return m_testItem;
}
/**
* Set test method name.
*
* @param test test method name (or null if none)
*/
public void setTestName(String test) {
m_testName = test;
}
/**
* Get get method name.
*
* @return get method name (or null if none)
*/
public String getGetName() {
return m_getName;
}
/**
* Get get method information. This method is only usable after a call to
* {@link #prevalidate(ValidationContext)}.
*
* @return get method information (or null if none)
*/
public IClassItem getGet() {
return m_getItem;
}
/**
* Get type for value loaded to stack. This method is only usable after a
* call to {@link #prevalidate(ValidationContext)}.
*
* @return get value type (or null if none)
*/
public IClass getGetType() {
return m_getType;
}
/**
* Set get method name.
*
* @param get get method name (or null if none)
*/
public void setGetName(String get) {
m_getName = get;
}
/**
* Get set method name.
*
* @return set method name (or null if none)
*/
public String getSetName() {
return m_setName;
}
/**
* Get set method information. This method is only usable after a call to
* {@link #prevalidate(ValidationContext)}.
*
* @return set method information (or null if none)
*/
public IClassItem getSet() {
return m_setItem;
}
/**
* Get type for value stored from stack. This method is only usable after a
* call to {@link #prevalidate(ValidationContext)}.
*
* @return set value type (or null if none)
*/
public IClass getSetType() {
return m_setType;
}
/**
* Set set method name.
*
* @param set set method name (or null if none)
*/
public void setSetName(String set) {
m_setName = set;
}
/**
* Get type information. This method is only usable after a call to {@link
* #prevalidate(ValidationContext)}.
*
* @return type information (or null if none)
*/
public IClass getType() {
return m_type;
}
/**
* Check if empty property definition. Empty property definitions occur
* because every collection, structure, and value
* element has associated property attributes but these may not actually
* reference a property (when using the containing object). This call is
* only meaningful after prevalidation.
*
* @return true if implicit property, false if not
*/
public boolean isImplicit() {
return m_isImplicit;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.AttributeBase#prevalidate(org.jibx.binding.model.ValidationContext)
*/
public void prevalidate(ValidationContext vctx) {
// check usage value
if (m_usageName != null) {
m_usage = s_usageEnum.getValue(m_usageName);
if (m_usage < 0) {
vctx.addError("Value \"" + m_usageName +
"\" is not a valid choice for usage");
}
} else {
m_usage = vctx.getParentElement().getDefaultStyle();
}
// handle basic lookups and checks
ContainerElementBase parent = vctx.getParentContainer();
IClass cobj = parent.getChildObjectType();
String dtype = null;
String gtype = null;
String stype = null;
boolean err = false;
m_isImplicit = true;
if (m_fieldName != null) {
// field means this is real (not implicit)
m_isImplicit = false;
// look up the field information
m_fieldItem = cobj.getField(m_fieldName);
if (m_fieldItem == null) {
vctx.addFatal("Nonstatic field " + m_fieldName +
" not found in class " + cobj.getName());
err = true;
} else {
dtype = gtype = stype = m_fieldItem.getTypeName();
}
}
if (m_testName != null) {
// make sure only used with optional
if (m_usage == REQUIRED_USAGE) {
vctx.addError("test-method can only be used with optional property");
} else {
// look up the method information
m_testItem = cobj.getMethod(m_testName, TEST_METHOD_SIGNATURES);
if (m_testItem == null) {
vctx.addError("Nonstatic test-method " + m_testName +
" not found in class " + cobj.getName());
}
}
}
if (m_getName != null) {
// get-method means this is real (not implicit)
m_isImplicit = false;
// look up the get method by name (no overload possible)
m_getItem = cobj.getMethod(m_getName, GET_METHOD_SIGNATURES);
if (m_getItem == null) {
vctx.addFatal("Nonstatic get-method " + m_getName +
" not found in class " + cobj.getName());
err = true;
} else {
gtype = m_getItem.getTypeName();
if (dtype == null) {
dtype = gtype;
}
}
// check for only get-method supplied when both directions needed
if (vctx.isInBinding() && m_fieldName == null &&
m_setName == null) {
vctx.addError("Need field or set-method for input handling");
}
}
if (m_setName != null) {
// set-method means this is real (not implicit)
m_isImplicit = false;
// need to handle overloads, so generate possible signatures
ArrayList sigs = new ArrayList();
if (m_getItem != null) {
String psig = ClassUtils.getSignature(gtype);
sigs.add("(" + psig +
"Lorg/jibx/runtime/IUnmarshallingContext;" + ")V");
sigs.add("(" + psig + ")V");
}
if (m_declaredType != null) {
String psig = ClassUtils.getSignature(m_declaredType);
sigs.add("(" + psig +
"Lorg/jibx/runtime/IUnmarshallingContext;" + ")V");
sigs.add("(" + psig + ")V");
}
if (m_fieldItem != null) {
String psig = m_fieldItem.getSignature();
sigs.add("(" + psig +
"Lorg/jibx/runtime/IUnmarshallingContext;" + ")V");
sigs.add("(" + psig + ")V");
}
sigs.add
("(Ljava/lang/Object;Lorg/jibx/runtime/IUnmarshallingContext;)V");
sigs.add("(Ljava/lang/Object;)V");
// match any of the possible signatures
m_setItem = cobj.getMethod(m_setName,
(String[])sigs.toArray(new String[0]));
if (m_setItem == null && m_declaredType == null) {
// nothing known about signature, try anything by name
m_setItem = cobj.getMethod(m_setName, "");
if (m_setItem != null) {
if (!m_setItem.getTypeName().equals("void") ||
m_setItem.getArgumentCount() > 2) {
m_setItem = null;
} else if (m_setItem.getArgumentCount() == 2) {
String xtype = m_setItem.getArgumentType(1);
if (!"org.jibx.runtime.IUnmarshallingContext".equals(xtype)) {
m_setItem = null;
}
}
}
if (m_setItem != null) {
// make sure resulting type is compatible
String type = m_setItem.getArgumentType(0);
if (dtype != null &&
!ClassUtils.isAssignable(type, dtype, vctx)) {
m_setItem = null;
} else if (gtype != null &&
!ClassUtils.isAssignable(type, gtype, vctx)) {
m_setItem = null;
}
if (m_setItem != null) {
dtype = type;
}
}
}
// check set-method found
if (m_setItem == null) {
vctx.addFatal("Nonstatic set-method " + m_setName +
" with argument of appropriate type not found in class " +
cobj.getName());
err = true;
} else {
stype = m_setItem.getArgumentType(0);
if (dtype == null) {
dtype = stype;
}
}
// check for only set-method supplied when both directions needed
if (vctx.isOutBinding() && m_fieldName == null &&
m_getName == null) {
vctx.addError("Need field or get-method for output handling");
}
}
// set the property type information
String tname = m_declaredType;
if (tname == null) {
tname = dtype;
if (tname == null) {
tname = cobj.getName();
}
} else if (dtype == null) {
dtype = gtype = stype = tname;
}
m_type = vctx.getClassInfo(tname);
if (m_type == null) {
vctx.addFatal("Unable to load class " + tname);
} else if (vctx.getContextObject() instanceof CollectionElement) {
// forbid access specifications for child of collection
if (m_fieldName != null || m_getName != null || m_setName != null) {
vctx.addWarning("Property access attributes (field, " +
"get-method, set-method) ignored for collection item");
}
} else if (!err && !m_isImplicit) {
// check that type information is consistent
boolean valid = true;
// require access specifications for child of non-collection
if (vctx.isInBinding()) {
if (stype == null) {
vctx.addError("No way to set property value");
stype = "java.lang.Object";
} else {
valid = ClassUtils.isAssignable(tname, stype, vctx) ||
ClassUtils.isAssignable(stype, tname, vctx);
}
m_setType = vctx.getClassInfo(stype);
}
if (gtype == null) {
if (vctx.isOutBinding()) {
vctx.addError("No way to get property value");
m_getType = vctx.getClassInfo("java.lang.Object");
}
} else {
if (valid) {
valid = ClassUtils.isAssignable(tname, gtype, vctx) ||
ClassUtils.isAssignable(gtype, tname, vctx);
}
m_getType = vctx.getClassInfo(gtype);
}
if (!valid) {
vctx.addError("Incompatible types used in property definition");
}
}
super.prevalidate(vctx);
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/RegistrationVisitor.java 0000644 0001750 0001750 00000016357 11002542726 027135 0 ustar moeller moeller /*
Copyright (c) 2004-2008, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import java.util.ArrayList;
/**
* Model visitor for handling item registration. This works with the {@link
* org.jibx.binding.model.ValidationContext} class to handle registration of
* items which can be referenced by name or by function (such as ID values
* within an object structure). The only items of this type which are not
* handled by this visitor are format definitions. The formats need to be
* accessed during prevalidation, so they're registered during that pass.
*
* @author Dennis M. Sosnoski
*/
public class RegistrationVisitor extends ModelVisitor
{
/** Validation context running this visitor. */
private final ValidationContext m_context;
/**
* Constructor.
*
* @param vctx validation context that will run this visitor
*/
public RegistrationVisitor(ValidationContext vctx) {
m_context = vctx;
}
/**
* Visit binding model tree to handle registration.
*
* @param root node of tree to be visited
*/
public void visitTree(ElementBase root) {
// first add all namespace declarations to contexts
m_context.tourTree(root, new ModelVisitor() {
/**
* Merge namespaces from containing binding into included binding.
*
* @param node
* @return continue expansion flag
*/
public boolean visit(IncludeElement node) {
BindingElement contain = (BindingElement)m_context.getParentElement();
BindingElement binding = node.getBinding();
if (binding != null) {
contain.getDefinitions().injectNamespaces(binding.getDefinitions());
}
return super.visit(node);
}
/**
* Add namespace definition to containing context.
*
* @param node
* @return continue expansion flag
*/
public boolean visit(NamespaceElement node) {
ValidationProblem problem =
m_context.getCurrentDefinitions().addNamespace(node);
if (problem != null) {
m_context.addProblem(problem);
}
return super.visit(node);
}
/**
* Block expansion once a structure-type element is reached.
*
* @param node
* @return false
*/
public boolean visit(StructureElementBase node) {
return false;
}
});
// next handle adding references to table
m_context.tourTree(root, this);
// then handle mapping extension linkages with separate pass
m_context.tourTree(root, new ModelVisitor() {
// expand mapping elements in case child mappings are present
public boolean visit(MappingElement node) {
node.validateExtension(m_context);
return true;
}
// don't bother expanding structure elements
public boolean visit(StructureElementBase node) {
return false;
}
});
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ModelVisitor#visit(org.jibx.binding.model.ContainerElementBase)
*/
public boolean visit(ContainerElementBase node) {
if (node.getLabel() != null) {
ValidationProblem problem = m_context.getBindingRoot().
getDefinitions().addNamedStructure(node);
if (problem != null) {
m_context.addProblem(problem);
}
}
return super.visit(node);
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ModelVisitor#visit(org.jibx.binding.model.TemplateElementBase)
*/
public boolean visit(TemplateElementBase node) {
// check for a top-level definition
if (m_context.getParentElement() instanceof BindingElement) {
// add all namespace declarations from binding to template
DefinitionContext pctx =
m_context.getParentElement().getDefinitions();
if (pctx != null) {
ArrayList nss = pctx.getNamespaces();
if (nss != null) {
DefinitionContext nctx = node.getDefinitions();
if (nctx == null) {
nctx = new DefinitionContext(pctx);
node.setDefinitions(nctx);
}
for (int i = 0; i < nss.size(); i++) {
nctx.addNamespace((NamespaceElement)nss.get(i));
}
}
}
}
return super.visit(node);
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ModelVisitor#visit(org.jibx.binding.model.MappingElement)
*/
public boolean visit(MappingElement node) {
DefinitionContext dctx = m_context.getCurrentDefinitions();
dctx.addTemplate(node, m_context);
if (!node.isAbstract()) {
// force name validation to set the namespace information
NameAttributes name = node.getNameAttributes();
name.validate(m_context);
if (name != null && name.getName() != null) {
dctx.addMappedName(name, node, m_context);
}
}
return super.visit(node);
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ModelVisitor#visit(org.jibx.binding.model.TemplateElement)
*/
public boolean visit(TemplateElement node) {
m_context.getCurrentDefinitions().addTemplate(node, m_context);
return super.visit(node);
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/SequenceVisitor.java 0000644 0001750 0001750 00000007450 10767276124 026242 0 ustar moeller moeller /*
Copyright (c) 2005-2008, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
/**
* Visitor for child tree of structure with an element definition. This
* verifies that text and CDATA components are only used in ways consistent
* with parsing (i.e., each use must be preceded by a required element).
*/
class SequenceVisitor extends ModelVisitor
{
private final StructureElementBase m_baseStructure;
private final ValidationContext m_validationContext;
private boolean m_isTextAllowed;
/**
* Constructor.
*
* @param base root of subtree being visited (null if not
* a structure)
* @param vctx validation context used for reporting errors
*/
public SequenceVisitor(StructureElementBase base,
ValidationContext vctx) {
m_baseStructure = base;
m_validationContext = vctx;
m_isTextAllowed = true;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ModelVisitor#visit(org.jibx.binding.model.StructureElementBase)
*/
public boolean visit(StructureElementBase node) {
if (node != m_baseStructure && node.hasName()) {
m_isTextAllowed = !node.isOptional();
return false;
} else {
return true;
}
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ModelVisitor#visit(org.jibx.binding.model.ValueElement)
*/
public boolean visit(ValueElement node) {
switch (node.getStyle()) {
case ValueElement.CDATA_STYLE:
case ValueElement.TEXT_STYLE:
if (m_isTextAllowed) {
m_isTextAllowed = false;
} else {
m_validationContext.addError
("Text value must be preceded by required element",
node);
}
break;
case NestingAttributes.ELEMENT_STYLE:
m_isTextAllowed = !node.isOptional();
break;
case NestingAttributes.ATTRIBUTE_STYLE:
break;
}
return false;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ModelVisitor#exit(org.jibx.binding.model.StructureElementBase)
*/
public void exit(StructureElementBase node) {
if (node.hasName()) {
m_isTextAllowed = !node.isOptional();
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/SplitElement.java 0000644 0001750 0001750 00000005773 10210703672 025507 0 ustar moeller moeller /*
Copyright (c) 2004-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
/**
* Model component for split element of binding definition. This is only
* used for structuring purposes, and is eliminated when the binding definition
* is split into specialized input and output versions.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class SplitElement extends NestingElementBase
{
/** Input side of binding (null if none). */
private InputElement m_inputSide;
/** Output side of binding (null if none). */
private OutputElement m_outputSide;
/**
* Constructor.
*/
public SplitElement() {
super(SPLIT_ELEMENT);
}
/**
* Get input side of binding.
*
* @return input side (null if none)
*/
public InputElement getInputSide() {
return m_inputSide;
}
/**
* Set input side of binding.
*
* @param input element containing input binding definition
* (null if none)
*/
public void setInputSide(InputElement input) {
m_inputSide = input;
}
/**
* Get output side of binding.
*
* @return output side (null if none)
*/
public OutputElement getOutputSide() {
return m_outputSide;
}
/**
* Set output side of binding.
*
* @param output element containing output binding definition
* (null if none)
*/
public void setOutputSide(OutputElement output) {
m_outputSide = output;
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/StringAttributes.java 0000644 0001750 0001750 00000054056 10767275736 026443 0 ustar moeller moeller /*
Copyright (c) 2004-2008, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import org.jibx.binding.util.StringArray;
import org.jibx.runtime.IMarshallingContext;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.QName;
/**
* Model component for string attribute group in binding definition.
*
* @author Dennis M. Sosnoski
*/
public class StringAttributes extends AttributeBase
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new String[] { "default", "deserializer",
"enum-value-method", "serializer" });
// TODO: add "format" for 2.0
//
// Constants and such related to code generation.
// signature variants allowed for serializer
private static final String[] SERIALIZER_SIGNATURE_VARIANTS =
{
"Lorg/jibx/runtime/IMarshallingContext;",
"Ljava/lang/Object;",
""
};
// signatures allowed for deserializer
private static final String[] DESERIALIZER_SIGNATURES =
{
"(Ljava/lang/String;Lorg/jibx/runtime/IUnmarshallingContext;)",
"(Ljava/lang/String;Ljava/lang/Object;)",
"(Ljava/lang/String;)"
};
// signatures allowed for enum-value-method
private static final String ENUM_VALUE_METHOD_SIGNATURE =
"()Ljava/lang/String;";
// signature required for constructor from string
private static final String STRING_CONSTRUCTOR_SIGNATURE =
"(Ljava/lang/String;)";
// classes of arguments to constructor or deserializer
private static final Class[] STRING_CONSTRUCTOR_ARGUMENT_CLASSES =
{
java.lang.String.class
};
//
// Instance data.
/** Referenced format name. */
private String m_formatName;
/** Format qualified name. */
private QName m_formatQName;
/** Default value text. */
private String m_defaultText;
/** Serializer fully qualified class and method name. */
private String m_serializerName;
/** Deserializer fully qualified class and method name. */
private String m_deserializerName;
/** Enum value method name. */
private String m_enumValueName;
/** Base format for conversions. */
private FormatElement m_baseFormat;
/** Value type class. */
private IClass m_typeClass;
/** Default value object. */
private Object m_default;
/** Serializer method (or toString equivalent) information. */
private IClassItem m_serializerItem;
/** Deserializer method (or constructor from string) information. */
private IClassItem m_deserializerItem;
/** Method used to get text representation of an enum. */
private IClassItem m_enumValueItem;
/**
* Default constructor.
*/
public StringAttributes() {}
/**
* Set value type. This needs to be set by the owning element prior to
* validation. Even though the type is an important part of the string
* information, it's treated as a separate item of information because it
* needs to be used as part of the property attributes.
*
* @param type value type
*/
public void setType(IClass type) {
m_typeClass = type;
}
/**
* Get value type.
*
* @return value type
*/
public IClass getType() {
return m_typeClass;
}
/**
* Get base format name.
*
* @return referenced base format
*/
public String getFormatName() {
return m_formatName;
}
/**
* Set base format name.
*
* @param name referenced base format
*/
public void setFormatName(String name) {
m_formatName = name;
m_formatQName = (name == null) ? null : new QName(name);
}
/**
* Get format qualified name.
*
* @return format qualified name (null if none)
*/
public QName getFormatQName() {
return m_formatQName;
}
/**
* Set format qualified name. This method changes the label value to match
* the qualified name.
*
* @param qname format qualified name (null if none)
*/
public void setFormatQName(QName qname) {
m_formatQName = qname;
m_formatName = (qname == null) ? null : qname.toString();
}
/**
* Get default value text.
*
* @return default value text
*/
public String getDefaultText() {
return m_defaultText;
}
/**
* Get default value. This method is only usable after a
* call to {@link #validate(ValidationContext)}.
*
* @return default value object
*/
public Object getDefault() {
return m_default;
}
/**
* Set default value text.
*
* @param value default value text
*/
public void setDefaultText(String value) {
m_defaultText = value;
}
/**
* Get serializer name.
*
* @return fully qualified class and method name for serializer (or
* null if none)
*/
public String getSerializerName() {
return m_serializerName;
}
/**
* Get serializer method information. This method is only usable after a
* call to {@link #validate(ValidationContext)}.
*
* @return serializer information (or null if none)
*/
public IClassItem getSerializer() {
return m_serializerItem;
}
/**
* Set serializer method name.
*
* @param name fully qualified class and method name for serializer
*/
public void setSerializerName(String name) {
m_serializerName = name;
}
/**
* Get deserializer name.
*
* @return fully qualified class and method name for deserializer (or
* null if none)
*/
public String getDeserializerName() {
return m_deserializerName;
}
/**
* Get deserializer method information. This method is only usable after a
* call to {@link #validate(ValidationContext)}.
*
* @return deserializer information (or null if none)
*/
public IClassItem getDeserializer() {
return m_deserializerItem;
}
/**
* Set deserializer method name.
*
* @param name fully qualified class and method name for deserializer
*/
public void setDeserializerName(String name) {
m_deserializerName = name;
}
/**
* Get enum value method name.
*
* @return enum value method name (or null if none)
*/
public String getEnumValueName() {
return m_enumValueName;
}
/**
* Get enum value method information. This method is only usable after a
* call to {@link #validate(ValidationContext)}.
*
* @return enum value method information (or null if none)
*/
public IClassItem getEnumValue() {
return m_enumValueItem;
}
/**
* Set enum value method name.
*
* @param name enum value method name (null if none)
*/
public void setEnumValueName(String name) {
m_enumValueName = name;
}
/**
* Get base format information. This method is only usable after a
* call to {@link #validate(ValidationContext)}.
*
* @return base format element (or null if none)
*/
public FormatElement getBaseFormat() {
return m_baseFormat;
}
/**
* JiBX access method to set format label as qualified name.
*
* @param label format label text (null if none)
* @param ictx unmarshalling context
* @throws JiBXException on deserialization error
*/
private void setQualifiedFormat(String label, IUnmarshallingContext ictx)
throws JiBXException {
setFormatQName(QName.deserialize(label, ictx));
}
/**
* JiBX access method to get format label as qualified name.
*
* @param ictx marshalling context
* @return format label text (null if none)
* @throws JiBXException on deserialization error
*/
private String getQualifiedFormat(IMarshallingContext ictx)
throws JiBXException {
return QName.serialize(getFormatQName(), ictx);
}
/* (non-Javadoc)
* @see org.jibx.binding.model.AttributeBase#prevalidate(org.jibx.binding.model.ValidationContext)
*/
public void prevalidate(ValidationContext vctx) {
// make sure the type has been configured
if (m_typeClass == null) {
vctx.addFatal("Missing type information for conversion to string");
} else {
// get the base format (if any)
DefinitionContext dctx = vctx.getDefinitions();
if (m_formatName == null) {
m_baseFormat = dctx.getBestFormat(m_typeClass);
} else {
m_baseFormat = dctx.getNamedFormat(m_formatName);
if (m_baseFormat == null) {
String name = m_formatName;
if (name.startsWith("{}")) {
name = name.substring(2);
}
vctx.addError("Unknown format " + name);
}
}
// check for a Java 5 enumeration
boolean isenum = false;
IClass sclas = m_typeClass;
while ((sclas = sclas.getSuperClass()) != null) {
if (sclas.getName().equals("java.lang.Enum")) {
isenum = true;
break;
}
}
// find the enum value method, if specified
if (m_enumValueName != null) {
if (isenum) {
if (m_serializerName == null &&
m_deserializerName == null) {
m_enumValueItem = m_typeClass.getMethod(m_enumValueName,
ENUM_VALUE_METHOD_SIGNATURE);
if (m_enumValueItem == null) {
vctx.addError("Nonstatic 'enum-value-method' " +
m_enumValueName + " not found in class " +
m_typeClass.getName());
}
} else {
vctx.addError("'enum-value-method' cannot be used with 'serializer' or 'deserializer'");
}
} else {
vctx.addError("'enum-value-method' may only be used with Java 5 enum classes");
}
}
// check specified serializer and deserializer
String tname = m_typeClass.getName();
if (vctx.isOutBinding()) {
if (m_serializerName == null) {
if (m_enumValueItem == null) {
// try to find an inherited serializer
FormatElement ances = m_baseFormat;
while (ances != null) {
m_serializerItem = ances.getSerializer();
if (m_serializerItem == null) {
ances = ances.getBaseFormat();
} else {
break;
}
}
if (m_serializerItem == null) {
IClassItem item = m_typeClass.getMethod("toString",
"()Ljava/lang/String;");
if (item == null) {
vctx.addError("toString method not found");
}
}
}
} else {
// build all possible signature variations
String[] tsigs = ClassUtils.
getSignatureVariants(tname, vctx);
int vcnt = SERIALIZER_SIGNATURE_VARIANTS.length;
String[] msigs = new String[tsigs.length * vcnt];
for (int i = 0; i < tsigs.length; i++) {
for (int j = 0; j < vcnt; j++) {
msigs[i*vcnt + j] = "(" + tsigs[i] +
SERIALIZER_SIGNATURE_VARIANTS[j] +
")Ljava/lang/String;";
}
}
// find a matching static method
m_serializerItem = ClassUtils.
findStaticMethod(m_serializerName, msigs, vctx);
if (m_serializerItem == null) {
if (m_serializerName.indexOf('.') > 0) {
vctx.addError("Static serializer method " + m_serializerName + " not found");
} else {
vctx.addError("Need class name for static method " + m_serializerName);
}
}
}
}
if (vctx.isInBinding() || m_defaultText != null) {
if (m_deserializerName == null) {
if (isenum) {
if (m_enumValueItem == null) {
m_deserializerItem = m_typeClass.
getMethod("valueOf", "(Ljava/lang/String;)");
}
} else {
// try to find an inherited deserializer
FormatElement ances = m_baseFormat;
while (ances != null) {
m_deserializerItem = ances.getDeserializer();
if (m_deserializerItem == null) {
ances = ances.getBaseFormat();
} else {
break;
}
}
if (m_deserializerItem == null) {
// try to find constructor from string as last resort
m_deserializerItem = m_typeClass.
getInitializerMethod(STRING_CONSTRUCTOR_SIGNATURE);
if (m_deserializerItem == null) {
// error unless predefined formats
if (vctx.getNestingDepth() > 0) {
StringBuffer buff = new StringBuffer();
buff.append("Need deserializer or constructor from string");
if (!vctx.isInBinding()) {
buff.append(" for default value of type ");
buff.append(tname);
} else {
buff.append(" for type ");
buff.append(tname);
}
vctx.addError(buff.toString());
}
}
}
}
} else {
// find a matching static method
m_deserializerItem = ClassUtils.
findStaticMethod(m_deserializerName,
DESERIALIZER_SIGNATURES, vctx);
if (m_deserializerItem == null) {
if (m_deserializerName.indexOf('.') > 0) {
vctx.addError("Static deserializer method " + m_deserializerName + " not found");
} else {
vctx.addError("Need class name for static method " + m_deserializerName);
}
} else {
String result = m_deserializerItem.getTypeName();
if (!ClassUtils.isAssignable(result, tname, vctx)) {
vctx.addError("Static deserializer method " +
m_deserializerName +
" has incompatible result type");
}
}
}
}
// check for default value to be converted
if (m_defaultText != null && m_deserializerItem != null) {
// first load the class to handle conversion
IClass iclas = m_deserializerItem.getOwningClass();
Class clas = iclas.loadClass();
Exception ex = null;
boolean construct = false;
try {
if (clas == null) {
vctx.addError("Unable to load class " +
iclas.getName() +
" for converting default value of type " + tname);
} else if (m_deserializerItem.isInitializer()) {
// invoke constructor to process default value
construct = true;
Constructor cons = clas.getConstructor
(STRING_CONSTRUCTOR_ARGUMENT_CLASSES);
try {
cons.setAccessible(true);
} catch (Exception e) { /* deliberately left empty */ }
Object[] args = new Object[1];
args[0] = m_defaultText;
m_default = cons.newInstance(args);
} else {
// invoke deserializer to convert default value
String mname = m_deserializerItem.getName();
Method deser = clas.getDeclaredMethod(mname,
STRING_CONSTRUCTOR_ARGUMENT_CLASSES);
try {
deser.setAccessible(true);
} catch (Exception e) { /* deliberately left empty */ }
Object[] args = new Object[1];
args[0] = m_defaultText;
m_default = deser.invoke(null, args);
}
} catch (SecurityException e) {
StringBuffer buff = new StringBuffer("Unable to access ");
if (construct) {
buff.append("constructor from string");
} else {
buff.append("deserializer ");
buff.append(m_deserializerName);
}
buff.append(" for converting default value of type ");
buff.append(tname);
vctx.addError(buff.toString());
} catch (NoSuchMethodException e) {
StringBuffer buff = new StringBuffer("Unable to find ");
if (construct) {
buff.append("constructor from string");
} else {
buff.append("deserializer ");
buff.append(m_deserializerName);
}
buff.append(" for converting default value of type ");
buff.append(tname);
vctx.addError(buff.toString());
} catch (IllegalArgumentException e) {
ex = e;
} catch (InstantiationException e) {
ex = e;
} catch (IllegalAccessException e) {
ex = e;
} catch (InvocationTargetException e) {
ex = e;
} finally {
if (ex != null) {
StringBuffer buff = new StringBuffer("Error calling ");
if (construct) {
buff.append("constructor from string");
} else {
buff.append("deserializer ");
buff.append(m_deserializerName);
}
buff.append(" for converting default value of type ");
buff.append(tname);
vctx.addError(buff.toString());
}
}
}
}
super.prevalidate(vctx);
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/StructureAttributes.java 0000644 0001750 0001750 00000016250 10435547056 027154 0 ustar moeller moeller /*
Copyright (c) 2004-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import org.jibx.binding.util.StringArray;
/**
* Model component for structure attribute group in binding definition.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class StructureAttributes extends AttributeBase
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new String[] { "allow-repeats", "choice", "flexible",
"label", "ordered", "using" });
//
// Instance data.
/** Flexible element handling flag. */
private boolean m_isFlexible;
/** Flag for ordered child content. */
private boolean m_isOrdered;
/** Flag for choice child content. */
private boolean m_isChoice;
/** Flag for repeated child elements to be ignored. */
private boolean m_isAllowRepeats;
/** Name for labeled child content defined elsewhere. */
private String m_usingName;
/** Name for labeled child content potentially referenced elsewhere. */
private String m_labelName;
/**
* Constructor.
*/
public StructureAttributes() {
m_isOrdered = true;
}
/**
* Get flexible flag.
*
* @return flexible flag
*/
public boolean isFlexible() {
return m_isFlexible;
}
/**
* Set flexible flag.
*
* @param flexible
*/
public void setFlexible(boolean flexible) {
m_isFlexible = flexible;
}
/**
* Check if child components are ordered.
*
* @return true if ordered, false if not
*/
public boolean isOrdered() {
return m_isOrdered;
}
/**
* Set child components ordered flag.
*
* @param ordered true if ordered, false if not
*/
public void setOrdered(boolean ordered) {
m_isOrdered = ordered;
}
/**
* Check if child components are a choice.
*
* @return true if choice, false if not
*/
public boolean isChoice() {
return m_isChoice;
}
/**
* Set child components choice flag.
*
* @param ordered true if choice, false if not
*/
public void setChoice(boolean choice) {
m_isChoice = choice;
}
/**
* Check if repeated child elements are allowed.
*
* @return true if repeats allowed, false if not
*/
public boolean isAllowRepeats() {
return m_isAllowRepeats;
}
/**
* Set repeated child elements allowed flag.
*
* @param ignore true if repeated child elements to be allowed,
* false if not
*/
public void setAllowRepeats(boolean ignore) {
m_isAllowRepeats = ignore;
}
/**
* Get name for child component list definition.
*
* @return text of name defining child components (null if
* none)
*/
public String getUsingName() {
return m_usingName;
}
/**
* Set name for child component list definition.
*
* @param name text of name defining child components (null if
* none)
*/
public void setUsingName(String name) {
m_usingName = name;
}
/**
* Get label name for child component list.
*
* @return label name text (null if none)
*/
public String getLabelName() {
return m_labelName;
}
/**
* Set label name for child component list.
*
* @param name label text for name (null if none)
*/
public void setLabelName(String name) {
m_labelName = name;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.AttributeBase#prevalidate(org.jibx.binding.model.ValidationContext)
*/
public void prevalidate(ValidationContext vctx) {
if (m_isOrdered) {
if (m_isChoice) {
vctx.addError
("choice='true' cannot be used with ordered children");
}
if (m_isFlexible) {
vctx.addError
("flexible='true' cannot be used with ordered children");
}
if (m_isAllowRepeats) {
vctx.addError
("allow-repeats='true' cannot be used with ordered children");
}
}
if (m_isChoice && m_isFlexible) {
vctx.addError
("choice='true' and flexible='true' cannot be used together");
}
if (m_isChoice && m_isAllowRepeats) {
vctx.addError
("choice='true' and allow-repeats='true' cannot be used together");
}
super.prevalidate(vctx);
}
/* (non-Javadoc)
* @see org.jibx.binding.model.AttributeBase#validate(org.jibx.binding.model.ValidationContext)
*/
public void validate(ValidationContext vctx) {
if (m_usingName != null) {
DefinitionContext dctx = vctx.getBindingRoot().getDefinitions();
if (dctx.getNamedStructure(m_usingName) == null) {
vctx.addError("Label \"" + m_usingName + "\" is not defined");
} else {
vctx.addWarning("The label/using approach is deprecated and " +
"will not be supported in the future - consider using an " +
"abstract mapping instead");
}
}
if (m_labelName != null) {
vctx.addWarning("The label/using approach is deprecated and " +
"will not be supported in the future - consider using an " +
"abstract mapping instead");
}
super.validate(vctx);
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/StructureElement.java 0000644 0001750 0001750 00000044300 10767276224 026420 0 ustar moeller moeller /*
Copyright (c) 2004-2008, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import java.util.ArrayList;
import org.jibx.binding.util.StringArray;
import org.jibx.runtime.IMarshallingContext;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.QName;
/**
* Model component for structure element of binding definition.
*
* @author Dennis M. Sosnoski
*/
public class StructureElement extends StructureElementBase
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new String[] { "map-as" },
StructureElementBase.s_allowedAttributes);
/** Mapping type name to use for this object. */
private String m_mapAsName;
/** Mapping qualified type name to use for this object. */
private QName m_mapAsQName;
/** Flag for structure has a concrete mapping, possibly indeterminant. */
private boolean m_hasMappingName;
/** Binding to use for this object. */
private TemplateElementBase m_effectiveMapping;
/**
* Default constructor.
*/
public StructureElement() {
super(STRUCTURE_ELEMENT);
}
/**
* Get name of mapping type.
*
* @return mapping type name (or null if none)
*/
public String getMapAsName() {
return m_mapAsName;
}
/**
* Set name of mapping type. This method changes the qualified name to
* match the mapping type.
*
* @param name mapping type name (or null if none)
*/
public void setMapAsName(String name) {
m_mapAsName = name;
m_mapAsQName = (name == null) ? null : new QName(name);
}
/**
* Get qualified name of mapping type.
*
* @return mapping qualified type name (or null if none)
*/
public QName getMapAsQName() {
return m_mapAsQName;
}
/**
* Set qualified name of mapping type. This method changes the mapping name
* to match the qualified name.
*
* @param name mapping qualified type name (or null if none)
*/
public void setMapAsQName(QName name) {
m_mapAsQName = name;
m_mapAsName = (name == null) ? null : name.toString();
}
/**
* Get actual type mapping. This call is only meaningful after validation.
*
* @return actual type mapping (or null if none)
*/
public TemplateElementBase getEffectiveMapping() {
return m_effectiveMapping;
}
//
// Overrides of base class methods
/* (non-Javadoc)
* @see org.jibx.binding.model.IComponent#hasName()
*/
public boolean hasName() {
if (m_effectiveMapping instanceof MappingElement) {
if (((MappingElement)m_effectiveMapping).getName() != null) {
return true;
}
} else if (m_hasMappingName) {
return true;
}
return super.hasName();
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IComponent#getName()
*/
public String getName() {
if (m_effectiveMapping instanceof MappingElement) {
String name = ((MappingElement)m_effectiveMapping).getName();
if (name != null) {
return name;
}
} else if (m_hasMappingName) {
return "#" + getType().getName();
}
return super.getName();
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IComponent#getUri()
*/
public String getUri() {
if (m_effectiveMapping instanceof MappingElement) {
String uri = ((MappingElement)m_effectiveMapping).getUri();
if (uri != null) {
return uri;
}
}
return super.getUri();
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IComponent#hasAttribute()
*/
public boolean hasAttribute() {
if (hasName()) {
return false;
} else if (m_effectiveMapping != null) {
return m_effectiveMapping.name() == null &&
m_effectiveMapping.getAttributeComponents().size() > 0;
} else {
return super.hasAttribute();
}
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IComponent#hasContent()
*/
public boolean hasContent() {
if (hasName()) {
return true;
} else if (m_effectiveMapping != null) {
return m_effectiveMapping.name() != null ||
m_effectiveMapping.getContentComponents().size() > 0;
} else {
return super.hasContent();
}
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IComponent#getType()
*/
public IClass getType() {
if (m_effectiveMapping == null) {
return super.getType();
} else {
return m_effectiveMapping.getHandledClass();
}
}
//
// Validation methods
/**
* JiBX access method to set mapping type name as qualified name.
*
* @param text mapping name text (null if none)
* @param ictx unmarshalling context
* @throws JiBXException on deserialization error
*/
private void setQualifiedMapAs(String text, IUnmarshallingContext ictx)
throws JiBXException {
m_mapAsName = text;
m_mapAsQName = QName.deserialize(text, ictx);
}
/**
* JiBX access method to get mapping type name as qualified name.
*
* @param ictx marshalling context
* @return mapping type name text (null if none)
* @throws JiBXException on deserialization error
*/
private String getQualifiedMapAs(IMarshallingContext ictx)
throws JiBXException {
return QName.serialize(m_mapAsQName, ictx);
}
/**
* Make sure all attributes are defined.
*
* @param uctx unmarshalling context
* @exception JiBXException on unmarshalling error
*/
private void preSet(IUnmarshallingContext uctx) throws JiBXException {
validateAttributes(uctx, s_allowedAttributes);
}
/**
* Merge namespaces from an implicit context to those defined for a
* reference.
*
* @param defc context supplying namespaces to be merged
* @param addc context to be merged into
* @param vctx
*/
private void mergeNamespaces(DefinitionContext defc, DefinitionContext addc,
ValidationContext vctx) {
// check for namespaces present in context
ArrayList nss = defc.getNamespaces();
if (nss != null) {
// merge namespaces with those defined by containing mapping
for (int i = 0; i < nss.size(); i++) {
NamespaceElement ns = (NamespaceElement)nss.get(i);
ValidationProblem prob =
addc.addImpliedNamespace(ns, this);
if (prob != null) {
vctx.addProblem(prob);
}
}
}
}
/**
* Check for conflicts on namespace prefix usage. Abstract mappings may
* define namespaces, but the prefixes used by the abstract mappings must
* not conflict with those used at the point of reference. This allows the
* namespace definitions from the abstract mapping to be promoted to the
* containing element.
*
* @param base
* @param vctx
*/
private void checkNamespaceUsage(TemplateElementBase base,
ValidationContext vctx) {
// check for namespace definitions needing to be handled
if (base instanceof MappingElement &&
((MappingElement)base).isAbstract()) {
// merge namespaces defined within this mapping
DefinitionContext addc = vctx.getFormatDefinitions();
DefinitionContext defc = base.getDefinitions();
if (defc != null) {
mergeNamespaces(defc, addc, vctx);
}
}
}
/**
* Classify child components as contributing attributes, content, or both.
* This method is needed to handle on-demand classification during
* validation. When a child component is another instance of this class, the
* method calls itself on the child component prior to checking the child
* component's contribution.
*
* @param vctx
*/
protected void classifyComponents(ValidationContext vctx) {
// check for classification already run
if (!isClassified()) {
// check if there's a mapping if used without children
// TODO: this isn't correct, but validation may not have reached
// this element yet so the context may not have been set. Clean
// this with parent link in all elements.
DefinitionContext dctx = vctx.getDefinitions();
if (children().size() == 0) {
if (m_mapAsQName == null) {
// make sure not just a name, allowed for skipped element
if (hasProperty() || getDeclaredType() != null) {
// see if this is using implicit marshaller/unmarshaller
if ((vctx.isInBinding() && getUnmarshallerName() == null) ||
(vctx.isOutBinding() && getMarshallerName() == null)) {
if (getUsing() == null) {
// check for specific type known
IClass type = getType();
if (type == null) {
vctx.addError("Internal error - null type");
} else if (!"java.lang.Object".equals(type.getName())) {
setMappingReference(vctx, dctx, type);
}
}
}
}
} else {
// find mapping by type name or class name
TemplateElementBase base =
dctx.getNamedTemplate(m_mapAsQName.toString());
if (base == null) {
base = dctx.getSpecificTemplate(m_mapAsName);
if (base == null) {
vctx.addFatal("No mapping with type name " +
m_mapAsQName.toString());
}
}
if (base != null) {
// make sure type is compatible
IClass type = getType();
if (type != null) {
if (!type.isAssignable(base.getHandledClass()) &&
!base.getHandledClass().isAssignable(type)) {
vctx.addError("Object type " + type.getName() +
" is incompatible with binding for class " +
base.getClassName());
}
}
m_effectiveMapping = base;
// check for namespace conflicts
checkNamespaceUsage(base, vctx);
// set flag for mapping with name
m_hasMappingName = base instanceof MappingElement &&
!((MappingElement)base).isAbstract();
}
}
// classify mapping reference as providing content, attributes, or both
if (m_effectiveMapping instanceof MappingElement) {
MappingElement mapping = (MappingElement)m_effectiveMapping;
mapping.classifyComponents(vctx);
if (hasProperty()) {
mapping.verifyConstruction(vctx);
}
if (mapping.getName() == null) {
ArrayList attribs = EmptyList.INSTANCE;
ArrayList contents = EmptyList.INSTANCE;
if (mapping.getContentComponents().size() > 0) {
contents = new ArrayList();
contents.add(m_effectiveMapping);
}
if (mapping.getAttributeComponents().size() > 0) {
attribs = new ArrayList();
attribs.add(m_effectiveMapping);
}
setComponents(attribs, contents);
} else {
ArrayList contents = new ArrayList();
contents.add(m_effectiveMapping);
setComponents(EmptyList.INSTANCE, contents);
}
}
} else if (m_mapAsName != null) {
vctx.addError("map-as attribute cannot be used with children");
}
}
// pass on call to superclass implementation
super.classifyComponents(vctx);
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ElementBase#validate(org.jibx.binding.model.ValidationContext)
*/
public void validate(ValidationContext vctx) {
// set up child components and effective mapping
classifyComponents(vctx);
IClass type = getType();
if (type != null) {
// check each child component for compatible type
ArrayList children = children();
if (hasProperty() || getDeclaredType() != null) {
checkCompatibleChildren(vctx, type, children);
}
// check for only set-method supplied
if (!vctx.isOutBinding() && getField() == null &&
getGet() == null && getSet() != null) {
// no way to handle both elements and attributes
if (hasAttribute() && hasContent()) {
vctx.addError("Need way to load existing object instance " +
"to support combined attribute and element values");
} else {
vctx.addWarning("No way to load prior value - " +
"new instance will be created on each unmarshalling");
}
}
}
// make sure name is defined if nillable
if (isNillable() && !hasName()) {
vctx.addError("Need element name for nillable='true'");
}
super.validate(vctx);
}
/**
* Validate mapping reference.
*
* @param vctx validation context
* @param dctx definition context
* @param type referenced type
*/
private void setMappingReference(ValidationContext vctx,
DefinitionContext dctx, IClass type) {
// first try to find mapping by specific type
m_effectiveMapping = dctx.getNamedTemplate(type.getName());
if (m_effectiveMapping == null) {
// see if there's a mapping specific to the reference type
String tname = type.getName();
TemplateElementBase match = dctx.getSpecificTemplate(tname);
if (match != null) {
m_effectiveMapping = match;
if (match instanceof MappingElement) {
// set flag for name defined by mapping
MappingElement base = (MappingElement)match;
m_hasMappingName = !base.isAbstract();
checkNamespaceUsage(base, vctx);
// check name usage on non-abstract or base mapping
if (super.hasName()) {
if (!base.isAbstract()) {
vctx.addError("name attribute not allowed on concrete mapping reference", this);
} else if (base.getExtensionTypes().size() > 0) {
vctx.addError("name attribute not allowed on reference to mapping with extensions", this);
}
}
}
} else if (!dctx.isCompatibleTemplateType(type)) {
vctx.addFatal("No compatible mapping defined for type " + tname, this);
}
} else if (m_effectiveMapping instanceof MappingElement) {
// set flag for name defined by mapping
MappingElement base = (MappingElement)m_effectiveMapping;
m_hasMappingName = !base.isAbstract();
checkNamespaceUsage(base, vctx);
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/StructureElementBase.java 0000644 0001750 0001750 00000030317 10767276372 027222 0 ustar moeller moeller /*
Copyright (c) 2004-2008, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import org.jibx.binding.util.StringArray;
/**
* Model component for elements that define the binding structure for an object
* property. This is the base class for structure and collection
* elements.
*
* @author Dennis M. Sosnoski
*/
public abstract class StructureElementBase
extends ContainerElementBase implements IComponent
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new StringArray(PropertyAttributes.s_allowedAttributes,
NameAttributes.s_allowedAttributes),
ContainerElementBase.s_allowedAttributes);
/** Property attributes information for nesting. */
private PropertyAttributes m_propertyAttrs;
/** Name attributes information for nesting. */
private NameAttributes m_nameAttrs;
/**
* Constructor.
*
* @param type element type code
*/
protected StructureElementBase(int type) {
super(type);
m_nameAttrs = new NameAttributes();
m_propertyAttrs = new PropertyAttributes();
}
//
// Name attribute delegate methods
/**
* Get name.
*
* @return name text
*/
public String getName() {
return m_nameAttrs.getName();
}
/**
* Set name.
*
* @param name text for name
*/
public void setName(String name) {
m_nameAttrs.setName(name);
}
/**
* Get specified namespace URI.
*
* @return namespace URI (null if not set)
*/
public String getUri() {
return m_nameAttrs.getUri();
}
/**
* Set namespace URI.
*
* @param uri namespace URI (null if not set)
*/
public void setUri(String uri) {
m_nameAttrs.setUri(uri);
}
/**
* Get specified namespace prefix.
*
* @return namespace prefix (null if not set)
*/
public String getPrefix() {
return m_nameAttrs.getPrefix();
}
/**
* Set namespace prefix.
*
* @param prefix namespace prefix (null if not set)
*/
public void setPrefix(String prefix) {
m_nameAttrs.setPrefix(prefix);
}
/**
* Get effective namespace information. This call is only meaningful after
* validation.
*
* @return effective namespace information
*/
public NamespaceElement getNamespace() {
return m_nameAttrs.getNamespace();
}
//
// Property attribute delegate methods
/**
* Get usage name.
*
* @return usage name
*/
public String getUsageName() {
return m_propertyAttrs.getUsageName();
}
/**
* Get usage value. This call is only meaningful after a call to
* {@link #prevalidate(ValidationContext)}.
*
* @return usage value
*/
public int getUsage() {
return m_propertyAttrs.getUsage();
}
/**
* Set usage name.
*
* @param name usage name
*/
public void setUsageName(String name) {
m_propertyAttrs.setUsageName(name);
}
/**
* Set usage value.
*
* @param use value
*/
public void setUsage(int use) {
m_propertyAttrs.setUsage(use);
}
/**
* Check if property is defined. This method is only meaningful after
* a call to {@link #prevalidate(ValidationContext)}.
*
* @return true if property defined, false if not
*/
public boolean hasProperty() {
return m_propertyAttrs.hasProperty();
}
/**
* Get declared type name.
*
* @return type name (or null if none)
*/
public String getDeclaredType() {
return m_propertyAttrs.getDeclaredType();
}
/**
* Set declared type name.
*
* @param type name (or null if none)
*/
public void setDeclaredType(String type) {
m_propertyAttrs.setDeclaredType(type);
}
/**
* Get field name.
*
* @return field name (or null if none)
*/
public String getFieldName() {
return m_propertyAttrs.getFieldName();
}
/**
* Get field information. This call is only meaningful after a call to
* {@link #prevalidate(ValidationContext)}.
*
* @return field information (or null if none)
*/
public IClassItem getField() {
return m_propertyAttrs.getField();
}
/**
* Set field name.
*
* @param field field name (or null if none)
*/
public void setFieldName(String field) {
m_propertyAttrs.setFieldName(field);
}
/**
* Get test method name.
*
* @return test method name (or null if none)
*/
public String getTestName() {
return m_propertyAttrs.getTestName();
}
/**
* Get test method information. This call is only meaningful after a call to
* {@link #prevalidate(ValidationContext)}.
*
* @return test method information (or null if none)
*/
public IClassItem getTest() {
return m_propertyAttrs.getTest();
}
/**
* Set test method name.
*
* @param test test method name (or null if none)
*/
public void setTestName(String test) {
m_propertyAttrs.setTestName(test);
}
/**
* Get get method name.
*
* @return get method name (or null if none)
*/
public String getGetName() {
return m_propertyAttrs.getGetName();
}
/**
* Get get method information. This call is only meaningful after a call to
* {@link #prevalidate(ValidationContext)}.
*
* @return get method information (or null if none)
*/
public IClassItem getGet() {
return m_propertyAttrs.getGet();
}
/**
* Get type for value loaded to stack. This call is only meaningful after a
* call to {@link #prevalidate(ValidationContext)}.
*
* @return get value type (or null if none)
*/
public IClass getGetType() {
return m_propertyAttrs.getGetType();
}
/**
* Set get method name.
*
* @param get get method name (or null if none)
*/
public void setGetName(String get) {
m_propertyAttrs.setGetName(get);
}
/**
* Get set method name.
*
* @return set method name (or null if none)
*/
public String getSetName() {
return m_propertyAttrs.getSetName();
}
/**
* Get set method information. This call is only meaningful after a call to
* {@link #prevalidate(ValidationContext)}.
*
* @return set method information (or null if none)
*/
public IClassItem getSet() {
return m_propertyAttrs.getSet();
}
/**
* Get type for value stored from stack. This call is only meaningful after
* a call to {@link #prevalidate(ValidationContext)}.
*
* @return set value type (or null if none)
*/
public IClass getSetType() {
return m_propertyAttrs.getSetType();
}
/**
* Set set method name.
*
* @param set set method name (or null if none)
*/
public void setSetName(String set) {
m_propertyAttrs.setSetName(set);
}
/**
* Check if this value implicitly uses the containing object. This call
* is only meaningful after a call to
* {@link #prevalidate(ValidationContext)}.
*
* @return true if using the containing object,
* false if own value
*/
public boolean isImplicit() {
return m_propertyAttrs.isImplicit();
}
//
// Implementation methods
/* (non-Javadoc)
* @see org.jibx.binding.model.ElementBase#isOptional()
*/
public boolean isOptional() {
return m_propertyAttrs.getUsage() == PropertyAttributes.OPTIONAL_USAGE;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ContainerElementBase#hasObject()
*/
public boolean hasObject() {
return !isImplicit() || getDeclaredType() != null;
}
//
// Implementation of methods from IComponent interface (used in extensions)
/* (non-Javadoc)
* @see org.jibx.binding.model.IComponent#hasAttribute()
*/
public boolean hasAttribute() {
if (m_nameAttrs.getName() != null) {
return false;
} else {
return getAttributeComponents().size() > 0;
}
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IComponent#hasContent()
*/
public boolean hasContent() {
if (m_nameAttrs.getName() != null) {
return true;
} else {
return getContentComponents().size() > 0;
}
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IComponent#hasName()
*/
public boolean hasName() {
return m_nameAttrs.getName() != null;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IComponent#getType()
*/
public IClass getType() {
return m_propertyAttrs.getType();
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ContainerElementBase#getType()
*/
public IClass getObjectType() {
return getType();
}
//
// Validation methods
/* (non-Javadoc)
* @see org.jibx.binding.model.ElementBase#prevalidate(org.jibx.binding.model.ValidationContext)
*/
public void prevalidate(ValidationContext vctx) {
m_nameAttrs.prevalidate(vctx);
m_propertyAttrs.prevalidate(vctx);
if (!vctx.isSkipped(this)) {
super.prevalidate(vctx);
}
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ElementBase#validate(org.jibx.binding.model.ValidationContext)
*/
public void validate(ValidationContext vctx) {
// validate the attribute groups
m_nameAttrs.validate(vctx);
m_propertyAttrs.validate(vctx);
if (!vctx.isSkipped(this)) {
// check for way of constructing object instance on input
if (m_propertyAttrs.hasProperty() && children().size() > 0) {
verifyConstruction(vctx, m_propertyAttrs.getType());
}
// check use of text values in children of structure with name
if (hasName()) {
SequenceVisitor visitor = new SequenceVisitor(this, vctx);
TreeContext tctx = vctx.getChildContext();
tctx.tourTree(this, visitor);
}
// finish with superclass validation
super.validate(vctx);
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/TemplateElement.java 0000644 0001750 0001750 00000015304 10222701646 026160 0 ustar moeller moeller /*
Copyright (c) 2004-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
/**
* Model component for template element of binding definition.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class TemplateElement extends TemplateElementBase
{
/** Template label. */
private String m_label;
/** Default template for type flag. */
private boolean m_isDefault;
/** Schema type name for xsi:type. */
private NameAttributes m_typeNameAttrs;
/** Base schema type name for xsi:type. */
private NameAttributes m_baseNameAttrs;
/** Base template extended by this one. */
private TemplateElement m_extendsMapping;
/**
* Default constructor.
*/
public TemplateElement() {
super(TEMPLATE_ELEMENT);
m_typeNameAttrs = new NameAttributes();
}
/**
* Get template label.
*
* @return template label (null if none)
*/
public String getLabel() {
return m_label;
}
/**
* Set template label.
*
* @param label template label (null if none)
*/
public void setLabel(String label) {
m_label = label;
}
/**
* Check if default template for type.
*
* @return true if default for type, false if not
*/
public boolean isDefaultTemplate() {
return m_isDefault;
}
/**
* Set default template for type flag.
*
* @param dflt true if default for type, false if
* not
*/
public void setDefaultTemplate(boolean dflt) {
m_isDefault = dflt;
}
//
// Type name attribute delegate methods
/**
* Get type name.
*
* @return type name text
*/
public String getTypeName() {
return m_typeNameAttrs.getName();
}
/**
* Set type name.
*
* @param name text for type name
*/
public void setTypeName(String name) {
m_typeNameAttrs.setName(name);
}
/**
* Get namespace URI specified for type.
*
* @return type namespace URI (null if not set)
*/
public String getTypeUri() {
return m_typeNameAttrs.getUri();
}
/**
* Set type namespace URI.
*
* @param uri type namespace URI (null if not set)
*/
public void setTypeUri(String uri) {
m_typeNameAttrs.setUri(uri);
}
/**
* Get namespace prefix specified for type.
*
* @return type namespace prefix (null if not set)
*/
public String getTypePrefix() {
return m_typeNameAttrs.getPrefix();
}
/**
* Set type namespace prefix.
*
* @param type prefix namespace prefix (null if not set)
*/
public void setTypePrefix(String prefix) {
m_typeNameAttrs.setPrefix(prefix);
}
/**
* Get effective namespace information for type. This call is only
* meaningful after validation.
*
* @return effective namespace information
*/
public NamespaceElement getTypeNamespace() {
return m_typeNameAttrs.getNamespace();
}
/**
* Get template extended by this one.
*
* @return template extended by this one
*/
public TemplateElement getExtendsMapping() {
return m_extendsMapping;
}
//
// Base type name attribute delegate methods
/**
* Get base type name.
*
* @return base type name text
*/
public String getBaseName() {
return m_baseNameAttrs.getName();
}
/**
* Set base type name.
*
* @param name text for base type name
*/
public void setBaseName(String name) {
m_baseNameAttrs.setName(name);
}
/**
* Get namespace URI specified for base type.
*
* @return base type namespace URI (null if not set)
*/
public String getBaseUri() {
return m_baseNameAttrs.getUri();
}
/**
* Set base type namespace URI.
*
* @param uri base type namespace URI (null if if not set)
*/
public void setBaseUri(String uri) {
m_baseNameAttrs.setUri(uri);
}
/**
* Get namespace URI specified for base type.
*
* @return base type namespace prefix (null if not set)
*/
public String getBasePrefix() {
return m_baseNameAttrs.getPrefix();
}
/**
* Set base type namespace prefix.
*
* @param type base type namespace prefix (null if not set)
*/
public void setBasePrefix(String prefix) {
m_baseNameAttrs.setPrefix(prefix);
}
/**
* Get effective namespace information for base type. This call is only
* meaningful after validation.
*
* @return effective namespace information
*/
public NamespaceElement getBaseNamespace() {
return m_typeNameAttrs.getNamespace();
}
//
// Validation methods
/**
* Prevalidate attributes of element in isolation.
*
* @param vctx validation context
*/
public void prevalidate(ValidationContext vctx) {
m_typeNameAttrs.prevalidate(vctx);
super.prevalidate(vctx);
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/TemplateElementBase.java 0000644 0001750 0001750 00000014723 10624255206 026761 0 ustar moeller moeller /*
Copyright (c) 2004-2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import java.util.ArrayList;
import java.util.Iterator;
import org.jibx.binding.util.StringArray;
/**
* Model component for elements that define how instances of a particular class
* are converted to or from XML. This includes both mapping and
* template elements.
*
* @author Dennis M. Sosnoski
*/
public abstract class TemplateElementBase extends ContainerElementBase
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new String[] { "class" },
ContainerElementBase.s_allowedAttributes);
/** Name of handled class. */
private String m_className;
/** Handled class information. */
private IClass m_handledClass;
/** List of child elements. */
protected ArrayList m_topChildren;
/** Templates or mappings that can be used in place of this one (as
* substitution group using mapping, or xsi:type with template). */
private ArrayList m_extensionTypes;
/**
* Constructor.
*
* @param type element type code
*/
public TemplateElementBase(int type) {
super(type);
m_extensionTypes = new ArrayList();
}
/**
* Set mapped class name.
*
* @param name mapped class name
*/
public void setClassName(String name) {
m_className = name;
}
/**
* Get mapped class name.
*
* @return class name
*/
public String getClassName() {
return m_className;
}
/**
* Get handled class information. This call is only meaningful after
* prevalidation.
*
* @return mapped class information
*/
public IClass getHandledClass() {
return m_handledClass;
}
/**
* Add template or mapping which derives from this one.
*
* @param ext derived template or mapping information
*/
protected void addExtensionType(TemplateElementBase ext) {
m_extensionTypes.add(ext);
}
/**
* Get templates or mappings which derive from this one.
*
* @return list of derived templates or mappings
*/
public ArrayList getExtensionTypes() {
return m_extensionTypes;
}
/**
* Check if default template for type. Needs to be implemented by subclasses
* for common handling.
*
* @return true if default for type, false if not
*/
public abstract boolean isDefaultTemplate();
/**
* Add top-level child element.
*
* @param child element to be added as child of this element
*/
public void addTopChild(Object child) {
m_topChildren.add(child);
}
/**
* Get list of top-level child elements.
*
* @return list of child elements, or null if none
*/
public ArrayList topChildren() {
return m_topChildren;
}
/**
* Get iterator for top-level child elements.
*
* @return iterator for child elements
*/
public Iterator topChildIterator() {
return m_topChildren.iterator();
}
//
// Overrides of base class methods
/* (non-Javadoc)
* @see org.jibx.binding.model.ElementBase#isOptional()
*/
public boolean isOptional() {
throw new IllegalStateException
("Internal error: method should never be called");
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IContextObj#getType()
*/
public IClass getType() {
return m_handledClass;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ContainerElementBase#isImplicit()
*/
public boolean isImplicit() {
return false;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ContainerElementBase#hasObject()
*/
public boolean hasObject() {
return true;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ContainerElementBase#getObjectType()
*/
public IClass getObjectType() {
return m_handledClass;
}
//
// Validation methods
/* (non-Javadoc)
* @see org.jibx.binding.model.ElementBase#prevalidate(org.jibx.binding.model.ValidationContext)
*/
public void prevalidate(ValidationContext vctx) {
if (m_className == null) {
vctx.addFatal("Class name is required");
} else {
m_handledClass = vctx.getClassInfo(m_className);
if (m_handledClass == null) {
vctx.addFatal("Cannot find information for class " +
m_className);
} else {
super.prevalidate(vctx);
}
}
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ContainerElementBase#validate(org.jibx.binding.model.ValidationContext)
*/
public void validate(ValidationContext vctx) {
// check each child component for compatible type
ArrayList children = children();
checkCompatibleChildren(vctx, m_handledClass, children);
super.validate(vctx);
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/TreeContext.java 0000644 0001750 0001750 00000045002 10541615360 025336 0 ustar moeller moeller /*
Copyright (c) 2004-2006, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import java.util.ArrayList;
import java.util.HashSet;
import org.jibx.binding.util.ObjectStack;
/**
* Handles walking the tree structure of a binding model, tracking
* order-dependent state information collected along the way.
*
* @author Dennis M. Sosnoski
*/
public class TreeContext
{
/** Global definition context (outside of binding). */
private DefinitionContext m_globalContext;
/** Binding element model root (may be null, if not configured
by caller). */
private BindingElement m_bindingRoot;
/** Stack of items for parent hierarchy to current node in tree. */
private ObjectStack m_treeHierarchy;
/** Class locator set by environment code. */
private IClassLocator m_locator;
/** Set of elements to be skipped in walking tree. */
private HashSet m_skipSet;
/**
* Internal null constructor.
*/
private TreeContext() {}
/**
* Constructor.
*
* @param iloc class locator to be used
*/
public TreeContext(IClassLocator iloc) {
m_treeHierarchy = new ObjectStack();
m_locator = iloc;
m_skipSet = new HashSet();
}
/**
* Get a secondary context for the same tree as this instance. The secondary
* context shares the same skip set, context, and binding root as the
* original context. This allows activites invoked during the touring of the
* original tree to start subtours of their own part of the tree.
*
* @return new context linked to original context
*/
public TreeContext getChildContext() {
TreeContext child = new TreeContext();
child.m_bindingRoot = m_bindingRoot;
child.m_globalContext = m_globalContext;
child.m_locator = m_locator;
child.m_skipSet = m_skipSet;
child.m_treeHierarchy = new ObjectStack(m_treeHierarchy);
return child;
}
/**
* Set the global definition context. This context is external to the actual
* binding definition, providing defaults that can be overridden by values
* set within the actual binding.
*
* @param dctx global definition context
*/
public void setGlobalDefinitions(DefinitionContext dctx) {
m_globalContext = dctx;
}
/**
* Tour complete binding model tree. This tours the entire binding model,
* starting from the root binding element. Using this method automatically
* sets the root binding element for access by processing performed during
* the tour. It must be used for the binding element in order to
* handle included binding definitions properly.
*
* @param root binding element root of tree
* @param visitor target visitor for element notifications
*/
public void tourTree(BindingElement root, ModelVisitor visitor) {
// set up binding root reference for access during processing
BindingElement hold = m_bindingRoot;
m_bindingRoot = root;
// run the actual tour
tourTree((ElementBase)root, visitor);
// restore prior binding root reference
m_bindingRoot = hold;
}
/**
* Tour binding model tree. This recursively traverses the binding model
* tree rooted in the supplied element, notifying the visitor of each
* element visited during the traversal. Elements with fatal errors are
* skipped in processing, along with all child elements. The method may
* itself be called recursively.
*
* @param root node of tree to be toured
* @param visitor target visitor for element notifications
*/
public void tourTree(ElementBase root, ModelVisitor visitor) {
// check for fatal error on element
if (m_skipSet.contains(root)) {
return;
}
// visit the actual root of tree
boolean expand = false;
m_treeHierarchy.push(root);
switch (root.type()) {
case ElementBase.BINDING_ELEMENT:
expand = visitor.visit((BindingElement)root);
break;
case ElementBase.COLLECTION_ELEMENT:
expand = visitor.visit((CollectionElement)root);
break;
case ElementBase.FORMAT_ELEMENT:
visitor.visit((FormatElement)root);
break;
case ElementBase.INCLUDE_ELEMENT:
expand = visitor.visit((IncludeElement)root);
break;
case ElementBase.INPUT_ELEMENT:
expand = visitor.visit((InputElement)root);
break;
case ElementBase.MAPPING_ELEMENT:
expand = visitor.visit((MappingElement)root);
break;
case ElementBase.NAMESPACE_ELEMENT:
visitor.visit((NamespaceElement)root);
break;
case ElementBase.OUTPUT_ELEMENT:
expand = visitor.visit((OutputElement)root);
break;
case ElementBase.SPLIT_ELEMENT:
expand = visitor.visit((SplitElement)root);
break;
case ElementBase.STRUCTURE_ELEMENT:
expand = visitor.visit((StructureElement)root);
break;
case ElementBase.TEMPLATE_ELEMENT:
expand = visitor.visit((TemplateElement)root);
break;
case ElementBase.VALUE_ELEMENT:
visitor.visit((ValueElement)root);
break;
default:
throw new IllegalStateException
("Internal error: unknown element type");
}
// check for expansion needed
if (expand && !m_skipSet.contains(root)) {
if (root instanceof IncludeElement) {
// include just delegates to the included binding element
BindingElement binding = ((IncludeElement)root).getBinding();
if (binding != null) {
m_treeHierarchy.pop();
tourTree((ElementBase)binding, visitor);
m_treeHierarchy.push(root);
}
} else if (root instanceof NestingElementBase) {
// process each container child as root of own tree
ArrayList childs = null;
if (root instanceof MappingElement) {
childs = ((MappingElement)root).topChildren();
for (int i = 0; i < childs.size(); i++) {
tourTree((ElementBase)childs.get(i), visitor);
}
}
if (root instanceof BindingElement) {
childs = ((BindingElement)root).topChildren();
} else {
childs = ((NestingElementBase)root).children();
}
for (int i = 0; i < childs.size(); i++) {
tourTree((ElementBase)childs.get(i), visitor);
}
}
}
// exit the actual root of tree
switch (root.type()) {
case ElementBase.BINDING_ELEMENT:
visitor.exit((BindingElement)root);
break;
case ElementBase.COLLECTION_ELEMENT:
visitor.exit((CollectionElement)root);
break;
case ElementBase.INCLUDE_ELEMENT:
visitor.exit((IncludeElement)root);
break;
case ElementBase.INPUT_ELEMENT:
visitor.exit((InputElement)root);
break;
case ElementBase.MAPPING_ELEMENT:
visitor.exit((MappingElement)root);
break;
case ElementBase.OUTPUT_ELEMENT:
visitor.exit((OutputElement)root);
break;
case ElementBase.SPLIT_ELEMENT:
visitor.exit((SplitElement)root);
break;
case ElementBase.STRUCTURE_ELEMENT:
visitor.exit((StructureElement)root);
break;
case ElementBase.TEMPLATE_ELEMENT:
visitor.exit((TemplateElement)root);
break;
case ElementBase.VALUE_ELEMENT:
visitor.exit((ValueElement)root);
break;
default:
break;
}
m_treeHierarchy.pop();
}
/**
* Get depth of nesting in binding.
*
* @return nesting depth
*/
public int getNestingDepth() {
return m_treeHierarchy.size();
}
/**
* Peek current element of hierarchy.
*
* @return current element
*/
protected ElementBase peekElement() {
return (ElementBase)m_treeHierarchy.peek();
}
/**
* Check if a component is being skipped due to a fatal error.
*
* @param obj component to be checked
* @return flag for component being skipped
*/
public boolean isSkipped(Object obj) {
return m_skipSet.contains(obj);
}
/**
* Add element to set to be skipped.
*
* @param skip
*/
protected void addSkip(Object skip) {
if (skip instanceof ElementBase) {
m_skipSet.add(skip);
}
}
/**
* Get root element of binding.
*
* @return root element of binding
* @throws IllegalStateException if no root element known
*/
public BindingElement getBindingRoot() {
if (m_bindingRoot == null) {
throw new IllegalStateException("No binding root defined");
} else {
return m_bindingRoot;
}
}
/**
* Set root element of binding. This should be called by the user if an
* element other than the binding element is going to be used as the root
* for a tour.
*
* @param root root element of binding
*/
public void setBindingRoot(BindingElement root) {
m_bindingRoot = root;
}
/**
* Get containing element. This is equivalent to the generation
* 1 parent, except that it checks for the case where there's
* no parent present.
*
* @return binding definition component for parent element, or
* null if no parent
*/
public NestingElementBase getParentElement() {
if (m_treeHierarchy.size() > 1) {
return (NestingElementBase)m_treeHierarchy.peek(1);
} else {
return null;
}
}
/**
* Get containing element at generation level. All except the zero-level
* containing element are guaranteed to be instances of {@link
* org.jibx.binding.model.NestingElementBase}.
*
* @param level generation level of parent
* @return binding definition component for parent at level
*/
public ElementBase getParentElement(int level) {
return (ElementBase)m_treeHierarchy.peek(level);
}
/**
* Get parent container information. This returns the innermost containing
* binding component which refers to an object.
*
* @return innermost containing element referencing bound object
*/
public ContainerElementBase getParentContainer() {
int index = 1;
while (index < m_treeHierarchy.size()) {
NestingElementBase nest =
(NestingElementBase)m_treeHierarchy.peek(index++);
if (nest instanceof ContainerElementBase) {
return (ContainerElementBase)nest;
}
}
throw new IllegalStateException("Internal error: no container");
}
/**
* Get parent container with linked object. This returns the innermost
* containing binding component which defines a context object.
*
* @return innermost containing element defining a context object
*/
public ContainerElementBase getContextObject() {
int index = 1;
while (index < m_treeHierarchy.size()) {
NestingElementBase nest =
(NestingElementBase)m_treeHierarchy.peek(index++);
if (nest instanceof ContainerElementBase) {
ContainerElementBase contain = (ContainerElementBase)nest;
if (contain.hasObject()) {
return contain;
}
}
}
throw new IllegalStateException("Internal error: no context object");
}
/**
* Check if binding supports input.
*
* @return true if input binding, false if not
*/
public boolean isInBinding() {
return m_bindingRoot == null ? true : m_bindingRoot.isInBinding();
}
/**
* Check if binding supports output.
*
* @return true if output binding, false if not
*/
public boolean isOutBinding() {
return m_bindingRoot == null ? true : m_bindingRoot.isOutBinding();
}
/**
* Get innermost containing definition context.
*
* @return innermost definition context containing this element
*/
public DefinitionContext getDefinitions() {
int index = 1;
while (index < m_treeHierarchy.size()) {
NestingElementBase nest =
(NestingElementBase)m_treeHierarchy.peek(index++);
if (nest.getDefinitions() != null) {
return nest.getDefinitions();
}
}
if (m_globalContext == null) {
throw new IllegalStateException
("Internal error: no definition context");
} else {
return m_globalContext;
}
}
/**
* Get definition context for innermost nesting element. If the context for
* this element isn't already defined it's created by the call.
*
* @return definition context for innermost nesting element
*/
public DefinitionContext getCurrentDefinitions() {
NestingElementBase parent = getParentElement();
DefinitionContext dctx = parent.getDefinitions();
if (dctx == null) {
dctx = new DefinitionContext(getDefinitions());
parent.setDefinitions(dctx);
}
return dctx;
}
/**
* Get definition context for innermost nesting element for use by a
* format (or namespace). If the context for this element
* isn't already defined it's created by the call, along with the contexts
* for any containing elements. This is ugly, but necessary to keep the tree
* structure of contexts from getting split when other items are added by
* the registration pass (since the formats are registered in the
* prevalidation pass).
*
* @return definition context for innermost nesting element
*/
public DefinitionContext getFormatDefinitions() {
NestingElementBase parent = getParentElement();
DefinitionContext dctx = parent.getDefinitions();
if (dctx == null) {
// scan to find innermost nesting with context
int index = 1;
DefinitionContext pctx = null;
while (++index < m_treeHierarchy.size()) {
NestingElementBase nest =
(NestingElementBase)m_treeHierarchy.peek(index);
pctx = nest.getDefinitions();
if (pctx != null) {
break;
}
}
// add contexts for all ancestors to level
while (index >= 2) {
dctx = new DefinitionContext(pctx);
NestingElementBase nest =
(NestingElementBase)m_treeHierarchy.peek(--index);
nest.setDefinitions(dctx);
pctx = dctx;
}
}
return dctx;
}
/**
* Get class information. Finds a class by name using the class locator
* configured by the environment code.
*
* @param name fully-qualified name of class to be found
* @return class information, or null if class not found
*/
public IClass getClassInfo(String name) {
return m_locator.getClassInfo(name);
}
/**
* Get requiried class information. Finds a class by name using the class
* locator configured by the environment code. If the class cannot be found
* a runtime exception is thrown.
*
* @param name fully-qualified name of class to be found
* @return class information
*/
public IClass getRequiredClassInfo(String name) {
IClass iclas = m_locator.getClassInfo(name);
if (iclas == null) {
throw new IllegalStateException("Internal error: class " + name +
" cannot be found");
} else {
return iclas;
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/ValidationContext.java 0000644 0001750 0001750 00000022157 10624255276 026547 0 ustar moeller moeller /*
Copyright (c) 2004-2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import java.util.ArrayList;
/**
* Tracks the validation state. This includes the current validation phase, as
* well as order-dependent state information collected while walking the tree
* structure of a binding model. Collects all errors and warnings and maintains
* a summary of the severity of the problems found.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class ValidationContext extends TreeContext
{
/** Number of warnings reported. */
private int m_warningCount;
/** Number of errors reported. */
private int m_errorCount;
/** Number of fatals reported. */
private int m_fatalCount;
/** List of problem items reported by validation. */
private ArrayList m_problemList;
/**
* Constructor.
*
* @param iloc class locator
*/
public ValidationContext(IClassLocator iloc) {
super(iloc);
m_problemList = new ArrayList();
}
/**
* Peek current element of hierarchy, if any. This variation should be used
* for the actual error handling, in case an error occurs during the
* initialization of the outer context definitions (canned definitions).
*
* @return current element, or null if none
*/
private ElementBase safePeekElement() {
try {
return peekElement();
} catch (ArrayIndexOutOfBoundsException e) {
// just in case there is no context element
return null;
}
}
/**
* Prevalidate binding model tree. This calls the prevalidate method for
* each element in the tree, in preorder traversal order.
*
* @param root binding node of tree to be prevalidated
*/
public void prevalidate(BindingElement root) {
PrevalidationVisitor visitor = new PrevalidationVisitor();
tourTree(root, visitor);
}
/**
* Validate binding model tree. This calls the validate method for each
* element in the tree, in postorder traversal order.
*
* @param root binding node of tree to be prevalidated
*/
public void validate(BindingElement root) {
ValidationVisitor visitor = new ValidationVisitor();
tourTree(root, visitor);
}
/**
* Get number of warning problems reported.
*
* @return warning problem count
*/
public int getWarningCount() {
return m_warningCount;
}
/**
* Get number of error problems reported.
*
* @return error problem count
*/
public int getErrorCount() {
return m_errorCount;
}
/**
* Get number of fatal problems reported.
*
* @return fatal problem count
*/
public int getFatalCount() {
return m_fatalCount;
}
/**
* Add warning item for current element. Adds a warning item to the problem
* list, which is a possible problem that still allows reasonable operation.
* This form of the call can only be used during a tree tour being
* controlled by this context.
*
* @param msg problem description
*/
public void addWarning(String msg) {
addWarning(msg, safePeekElement());
}
/**
* Add warning item. Adds a warning item to the problem list, which is a
* possible problem that still allows reasonable operation.
*
* @param msg problem description
* @param obj source object for validation error
*/
public void addWarning(String msg, Object obj) {
addProblem(new ValidationProblem
(ValidationProblem.WARNING_LEVEL, msg, obj));
}
/**
* Add error item for current element. Adds an error item to the problem
* list, which is a definite problem that still allows validation to
* proceed. This form of the call can only be used during a tree tour being
* controlled by this context.
*
* @param msg problem description
*/
public void addError(String msg) {
addError(msg, safePeekElement());
}
/**
* Add error item. Adds an error item to the problem list, which is a
* definite problem that still allows validation to proceed.
*
* @param msg problem description
* @param obj source object for validation error
*/
public void addError(String msg, Object obj) {
addProblem(new ValidationProblem
(ValidationProblem.ERROR_LEVEL, msg, obj));
}
/**
* Add fatal item for current element. Adds a fatal item to the problem
* list, which is a severe problem that blocks further validation within the
* tree branch involved. This form of the call can only be used during a
* tree tour being controlled by this context.
*
* @param msg problem description
*/
public void addFatal(String msg) {
addFatal(msg, safePeekElement());
}
/**
* Add fatal item. Adds a fatal item to the problem list, which is a severe
* problem that blocks further validation within the tree branch involved.
* The object associated with a fatal error should always be an element.
*
* @param msg problem description
* @param obj source object for validation error (should be an element)
*/
public void addFatal(String msg, Object obj) {
addProblem(new ValidationProblem
(ValidationProblem.FATAL_LEVEL, msg, obj));
}
/**
* Add problem report. The problem is added and counted as appropriate.
*
* @param problem details of problem report
*/
public void addProblem(ValidationProblem problem) {
m_problemList.add(problem);
switch (problem.getSeverity()) {
case ValidationProblem.ERROR_LEVEL:
m_errorCount++;
break;
case ValidationProblem.FATAL_LEVEL:
m_fatalCount++;
addSkip(problem.getComponent());
break;
case ValidationProblem.WARNING_LEVEL:
m_warningCount++;
break;
}
}
/**
* Get list of problems.
*
* @return problem list
*/
public ArrayList getProblems() {
return m_problemList;
}
/**
* Inner class for handling prevalidation. This visitor implementation just
* calls the {@link org.jibx.binding.model#prevalidate} method for each
* element visited in preorder.
*/
protected class PrevalidationVisitor extends ModelVisitor
{
/* (non-Javadoc)
* @see org.jibx.binding.model.ModelVisitor#visit(org.jibx.binding.model.ElementBase)
*/
public boolean visit(ElementBase node) {
try {
node.prevalidate(ValidationContext.this);
} catch (Throwable t) {
addFatal("Error during validation: " + t.getMessage());
t.printStackTrace();
return false;
}
return true;
}
}
/**
* Inner class for handling validation. This visitor implementation just
* calls the {@link org.jibx.binding.model#validate} method for each
* element visited in postorder.
*/
protected class ValidationVisitor extends ModelVisitor
{
/* (non-Javadoc)
* @see org.jibx.binding.model.ModelVisitor#exit(org.jibx.binding.model.ElementBase)
*/
public void exit(ElementBase node) {
try {
node.validate(ValidationContext.this);
} catch (Throwable t) {
addFatal("Error during validation: " + t.getMessage());
t.printStackTrace();
}
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/ValidationProblem.java 0000644 0001750 0001750 00000010702 10602536560 026506 0 ustar moeller moeller /*
Copyright (c) 2004-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import org.jibx.runtime.ITrackSource;
import org.jibx.runtime.ValidationException;
/**
* Problem reported by model validation. Provides the details for a specific
* problem item.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class ValidationProblem
{
// severity levels
public static final int WARNING_LEVEL = 0;
public static final int ERROR_LEVEL = 1;
public static final int FATAL_LEVEL = 2;
/** Problem severity level. */
private final int m_severity;
/** Supplied problem description message. */
private final String m_message;
/** Component that reported problem. */
private final Object m_component;
/**
* Full constructor.
*
* @param level severity level of problem
* @param msg problem description
* @param obj source object for validation error (may be null
* if not specific to a particular component)
*/
/*package*/ ValidationProblem(int level, String msg, Object obj) {
m_severity = level;
m_message = msg;
m_component = obj;
}
/**
* Create description text for a component of a binding definition.
*
* @param obj binding definition component
* @return description
*/
public static String componentDescription(Object obj) {
StringBuffer buff = new StringBuffer();
if (obj instanceof ElementBase) {
buff.append(ElementBase.ELEMENT_NAMES[((ElementBase)obj).type()]);
buff.append(" element");
} else {
String cname = obj.getClass().getName();
int split = cname.lastIndexOf('.');
if (split >= 0) {
cname = cname.substring(split+1);
}
buff.append(cname);
}
if (obj instanceof ITrackSource) {
buff.append(" at ");
buff.append(ValidationException.describe(obj));
} else {
buff.append(" at unknown location");
}
return buff.toString();
}
/**
* Constructor using default (error) severity level.
*
* @param msg problem description
* @param obj source object for validation error
*/
/*package*/ ValidationProblem(String msg, Object obj) {
this(ERROR_LEVEL, msg, obj);
}
/**
* Get the main binding definition item for the problem.
*
* @return element or attribute at root of problem
*/
public Object getComponent() {
return m_component;
}
/**
* Get problem description.
*
* @return problem description
*/
public String getDescription() {
if (m_component == null) {
return m_message;
} else {
return m_message + "; on " + componentDescription(m_component);
}
}
/**
* Get problem severity level.
*
* @return severity level for problem
*/
public int getSeverity() {
return m_severity;
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/ValueElement.java 0000644 0001750 0001750 00000057547 10756324440 025505 0 ustar moeller moeller /*
Copyright (c) 2004-2008, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.model;
import org.jibx.binding.util.StringArray;
import org.jibx.runtime.EnumSet;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.QName;
/**
* Model component for value element. This element defines a value that
* can be represented as a simple text string, which may be expressed as an
* attribute, element, or text component of the XML document.
*
* @author Dennis M. Sosnoski
*/
public class ValueElement extends ElementBase implements IComponent
{
/** Enumeration of allowed attribute names */
public static final StringArray s_allowedAttributes =
new StringArray(new String[] { "constant", "format", "ident",
"nillable", "style" },
new StringArray(new StringArray
(NameAttributes.s_allowedAttributes,
PropertyAttributes.s_allowedAttributes),
StringAttributes.s_allowedAttributes));
//
// Value set information
public static final int CDATA_STYLE = 2;
public static final int TEXT_STYLE = 3;
private static final EnumSet s_styleEnum =
new EnumSet(NestingAttributes.s_styleEnum, CDATA_STYLE,
new String[] { "cdata", "text" });
public static final int NONE_IDENT = 0;
public static final int DEF_IDENT = 1;
public static final int REF_IDENT = 2;
/* public static final int AUTO_IDENT = 3; */
/*package*/ static final EnumSet s_identEnum = new EnumSet(NONE_IDENT,
new String[] { "none", "def", "ref"/*, "auto"*/ });
//
// Instance data
/** Supplied constant value. */
private String m_constantValue;
/** Supplied style name. */
private String m_styleName;
/** Actual selected style. */
private int m_styleIndex;
/** Supplied identity name. */
private String m_identName = s_identEnum.getName(NONE_IDENT);
/** Nillable object flag. */
private boolean m_isNillable;
/** Actual selected identity. */
private int m_identIndex;
/** Name attributes information for value. */
private NameAttributes m_nameAttrs;
/** Property attributes information for value. */
private PropertyAttributes m_propertyAttrs;
/** String attributes information for value. */
private StringAttributes m_stringAttrs;
/**
* Constructor.
*/
public ValueElement() {
super(VALUE_ELEMENT);
m_nameAttrs = new NameAttributes();
m_propertyAttrs = new PropertyAttributes();
m_stringAttrs = new StringAttributes();
}
/**
* Get constant value.
*
* @return constant value, or null if not a constant
*/
public String getConstantValue() {
return m_constantValue;
}
/**
* Set constant value.
*
* @param value constant value, or null if not a constant
*/
public void setConstantValue(String value) {
m_constantValue = value;
}
/**
* Get style string value.
*
* @return style string value
*/
public String getStyleName() {
return m_styleName;
}
/**
* Get style value. This call is only meaningful after validation.
*
* @return style value
*/
public int getStyle() {
return m_styleIndex;
}
/**
* Set style name.
*
* @param name style name (null if to use inherited default)
*/
public void setStyleName(String name) {
m_styleName = name;
}
/**
* Get name for style that applies to this value. This call is only
* meaningful after validation.
*
* @return name for style
*/
public String getEffectiveStyleName() {
return s_styleEnum.getName(m_styleIndex);
}
/**
* Set style that applies to this value. If the specified style is different
* from the nested default it is applied directly, otherwise this value is
* configured to use the default. This method should therefore only be used
* when the nested settings are considered fixed.
* TODO: implement this with parent links
*
* @param style style value
*/
public void setEffectiveStyle(int style) {
m_styleIndex = style;
m_styleName = s_styleEnum.getName(style);
}
/**
* Get identity string value.
*
* @return identity string value
*/
public String getIdentName() {
return m_identName;
}
/**
* Get identity value. This call is only meaningful after validation.
*
* @return identity value
*/
public int getIdent() {
return m_identIndex;
}
/**
* Set identity name.
*
* @param name identity name
*/
public void setIdentName(String name) {
m_identName = name;
}
//
// Name attribute delegate methods
/**
* Get name.
*
* @return name text
*/
public String getName() {
return m_nameAttrs.getName();
}
/**
* Set name.
*
* @param name text for name
*/
public void setName(String name) {
m_nameAttrs.setName(name);
}
/**
* Get specified namespace URI.
*
* @return namespace URI (null if not set)
*/
public String getUri() {
return m_nameAttrs.getUri();
}
/**
* Set namespace URI.
*
* @param uri namespace URI (null if not set)
*/
public void setUri(String uri) {
m_nameAttrs.setUri(uri);
}
/**
* Get specified namespace prefix.
*
* @return namespace prefix (null if not set)
*/
public String getPrefix() {
return m_nameAttrs.getPrefix();
}
/**
* Set namespace prefix.
*
* @param prefix namespace prefix (null if not set)
*/
public void setPrefix(String prefix) {
m_nameAttrs.setPrefix(prefix);
}
/**
* Get effective namespace information. This call is only meaningful after
* validation.
*
* @return effective namespace information
*/
public NamespaceElement getNamespace() {
return m_nameAttrs.getNamespace();
}
//
// Property attribute delegate methods
/**
* Get usage name.
*
* @return usage name
*/
public String getUsageName() {
return m_propertyAttrs.getUsageName();
}
/**
* Get usage value. This call is only meaningful after a call to
* {@link #prevalidate(ValidationContext)}.
*
* @return usage value
*/
public int getUsage() {
return m_propertyAttrs.getUsage();
}
/**
* Set usage name.
*
* @param name usage name
*/
public void setUsageName(String name) {
m_propertyAttrs.setUsageName(name);
}
/**
* Set usage value.
*
* @param use value
*/
public void setUsage(int use) {
m_propertyAttrs.setUsage(use);
}
/**
* Check if property is defined. This method is only meaningful after
* a call to {@link #prevalidate(ValidationContext)}.
*
* @return true if property defined, false if not
*/
public boolean hasProperty() {
return m_propertyAttrs.hasProperty();
}
/**
* Get declared type name.
*
* @return type name (or null if none)
*/
public String getDeclaredType() {
return m_propertyAttrs.getDeclaredType();
}
/**
* Set declared type name.
*
* @param type name (or null if none)
*/
public void setDeclaredType(String type) {
m_propertyAttrs.setDeclaredType(type);
}
/**
* Get field name.
*
* @return field name (or null if none)
*/
public String getFieldName() {
return m_propertyAttrs.getFieldName();
}
/**
* Get field information. This call is only meaningful after a call to
* {@link #prevalidate(ValidationContext)}.
*
* @return field information (or null if none)
*/
public IClassItem getField() {
return m_propertyAttrs.getField();
}
/**
* Set field name.
*
* @param field field name (or null if none)
*/
public void setFieldName(String field) {
m_propertyAttrs.setFieldName(field);
}
/**
* Get test method name.
*
* @return test method name (or null if none)
*/
public String getTestName() {
return m_propertyAttrs.getTestName();
}
/**
* Get test method information. This call is only meaningful after a call to
* {@link #prevalidate(ValidationContext)}.
*
* @return test method information (or null if none)
*/
public IClassItem getTest() {
return m_propertyAttrs.getTest();
}
/**
* Set test method name.
*
* @param test test method name (or null if none)
*/
public void setTestName(String test) {
m_propertyAttrs.setTestName(test);
}
/**
* Get get method name.
*
* @return get method name (or null if none)
*/
public String getGetName() {
return m_propertyAttrs.getGetName();
}
/**
* Get get method information. This call is only meaningful after a call to
* {@link #prevalidate(ValidationContext)}.
*
* @return get method information (or null if none)
*/
public IClassItem getGet() {
return m_propertyAttrs.getGet();
}
/**
* Get type for value loaded to stack. This call is only meaningful after a
* call to {@link #prevalidate(ValidationContext)}.
*
* @return get value type (or null if none)
*/
public IClass getGetType() {
return m_propertyAttrs.getGetType();
}
/**
* Set get method name.
*
* @param get get method name (or null if none)
*/
public void setGetName(String get) {
m_propertyAttrs.setGetName(get);
}
/**
* Get set method name.
*
* @return set method name (or null if none)
*/
public String getSetName() {
return m_propertyAttrs.getSetName();
}
/**
* Get set method information. This call is only meaningful after a call to
* {@link #prevalidate(ValidationContext)}.
*
* @return set method information (or null if none)
*/
public IClassItem getSet() {
return m_propertyAttrs.getSet();
}
/**
* Get type for value stored from stack. This call is only meaningful after
* a call to {@link #prevalidate(ValidationContext)}.
*
* @return set value type (or null if none)
*/
public IClass getSetType() {
return m_propertyAttrs.getSetType();
}
/**
* Set set method name.
*
* @param set set method name (or null if none)
*/
public void setSetName(String set) {
m_propertyAttrs.setSetName(set);
}
/**
* Check if nillable object.
*
* @return nillable flag
*/
public boolean isNillable() {
return m_isNillable;
}
/**
* Set nillable flag.
*
* @param nillable flag
*/
public void setNillable(boolean nillable) {
m_isNillable = nillable;
}
/**
* Check if this value implicitly uses the containing object. This call
* is only meaningful after a call to
* {@link #prevalidate(ValidationContext)}.
*
* @return true if using the containing object,
* false if own value
*/
public boolean isImplicit() {
return m_propertyAttrs.isImplicit();
}
//
// String attribute delegate methods
/**
* Get default value text.
*
* @return default value text
*/
public String getDefaultText() {
return m_stringAttrs.getDefaultText();
}
/**
* Get default value. This call is only meaningful after validation.
*
* @return default value object
*/
public Object getDefault() {
return m_stringAttrs.getDefault();
}
/**
* Set default value text.
*
* @param value default value text
*/
public void setDefaultText(String value) {
m_stringAttrs.setDefaultText(value);
}
/**
* Get enum value method information. This method is only usable after a
* call to {@link #validate(ValidationContext)}.
*
* @return enum value method information (or null if none)
*/
public IClassItem getEnumValue() {
return m_stringAttrs.getEnumValue();
}
/**
* Get enum value method name.
*
* @return enum value method name (or null if none)
*/
public String getEnumValueName() {
return m_stringAttrs.getEnumValueName();
}
/**
* Set enum value method name.
*
* @param name enum value method name (null if none)
*/
public void setEnumValueName(String name) {
m_stringAttrs.setEnumValueName(name);
}
/**
* Get base format name.
*
* @return referenced base format
*/
public String getFormatName() {
return m_stringAttrs.getFormatName();
}
/**
* Set base format name.
*
* @param name referenced base format
*/
public void setFormatName(String name) {
m_stringAttrs.setFormatName(name);
}
/**
* Get format qualified name.
*
* @return format qualified name (null if none)
*/
public QName getFormatQName() {
return m_stringAttrs.getFormatQName();
}
/**
* Set format qualified name. This method changes the label value to match
* the qualified name.
*
* @return format qualified name (null if none)
*/
public void setFormatQName(QName qname) {
m_stringAttrs.setFormatQName(qname);
}
/**
* Get serializer name.
*
* @return fully qualified class and method name for serializer (or
* null if none)
*/
public String getSerializerName() {
return m_stringAttrs.getSerializerName();
}
/**
* Get serializer method information. This call is only meaningful after
* validation.
*
* @return serializer information (or null if none)
*/
public IClassItem getSerializer() {
return m_stringAttrs.getSerializer();
}
/**
* Set serializer method name.
*
* @param fully qualified class and method name for serializer
*/
public void setSerializerName(String name) {
m_stringAttrs.setSerializerName(name);
}
/**
* Get deserializer name.
*
* @return fully qualified class and method name for deserializer (or
* null if none)
*/
public String getDeserializerName() {
return m_stringAttrs.getDeserializerName();
}
/**
* Get deserializer method information. This call is only meaningful after
* validation.
*
* @return deserializer information (or null if none)
*/
public IClassItem getDeserializer() {
return m_stringAttrs.getDeserializer();
}
/**
* Set deserializer method name.
*
* @param fully qualified class and method name for deserializer
*/
public void setDeserializerName(String name) {
m_stringAttrs.setDeserializerName(name);
}
//
// IComponent implementation methods (also delegated name methods)
/* (non-Javadoc)
* @see org.jibx.binding.model.IComponent#hasAttribute()
*/
public boolean hasAttribute() {
return m_styleIndex == NestingAttributes.ATTRIBUTE_STYLE;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IComponent#hasContent()
*/
public boolean hasContent() {
return m_styleIndex != NestingAttributes.ATTRIBUTE_STYLE;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IComponent#isOptional()
*/
public boolean isOptional() {
return m_propertyAttrs.getUsage() == PropertyAttributes.OPTIONAL_USAGE;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IComponent#hasName()
*/
public boolean hasName() {
return m_nameAttrs.getName() != null;
}
/* (non-Javadoc)
* @see org.jibx.binding.model.IComponent#getType()
*/
public IClass getType() {
return m_propertyAttrs.getType();
}
//
// Validation methods
/**
* Make sure all attributes are defined.
*
* @param uctx unmarshalling context
* @exception JiBXException on unmarshalling error
*/
private void preSet(IUnmarshallingContext uctx) throws JiBXException {
validateAttributes(uctx, s_allowedAttributes);
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ElementBase#prevalidate(org.jibx.binding.model.ValidationContext)
*/
public void prevalidate(ValidationContext vctx) {
// set the style value
if (m_styleName != null) {
m_styleIndex = s_styleEnum.getValue(m_styleName);
if (m_styleIndex < 0) {
vctx.addError("Value \"" + m_styleName +
"\" is not a valid choice for style");
}
} else {
m_styleIndex = vctx.getParentElement().getDefaultStyle();
}
// validate ID classification
m_identIndex = s_identEnum.getValue(m_identName);
if (m_identIndex < 0) {
vctx.addError("Value \"" + m_identName +
" is not a valid choice for ident");
}
// validate basic attribute groups
m_propertyAttrs.prevalidate(vctx);
m_nameAttrs.setIsAttribute
(m_styleIndex == NestingAttributes.ATTRIBUTE_STYLE);
m_nameAttrs.prevalidate(vctx);
if (m_styleIndex == CDATA_STYLE || m_styleIndex == TEXT_STYLE) {
if (m_nameAttrs.getName() != null) {
vctx.addFatal("Values with \"text\" or \"cdata\" style " +
"cannot have names");
}
} else {
if (m_nameAttrs.getName() == null) {
vctx.addFatal
("Missing required name for element or attribute value");
}
}
// make sure value is not constant
if (m_constantValue == null) {
// make sure nillable only for optional element with object
if (m_isNillable) {
if (m_styleIndex != NestingAttributes.ELEMENT_STYLE) {
vctx.addFatal("nillable can only be used with element style");
}
}
// process ID classification
if (m_identIndex == DEF_IDENT/* || m_identIndex == AUTO_IDENT*/) {
boolean valid = false;
IClass gclas = m_propertyAttrs.getGetType();
if (gclas != null) {
String gtype = gclas.getName();
if (gtype.equals("java.lang.String")) {
vctx.getContextObject().setIdChild(this, vctx);
valid = true;
}
}
if (!valid) {
vctx.addError("ID property must supply a " +
"java.lang.String value");
}
}
// check string attributes only if valid to this point
if (!vctx.isSkipped(this)) {
// handle string attributes based on identity type
if (m_identIndex == REF_IDENT) {
if (m_propertyAttrs.isImplicit()) {
vctx.addFatal
("No property value - ID reference can only " +
"be used with a property of the appropriate type");
}
if (m_stringAttrs.getDeserializerName() != null ||
m_stringAttrs.getSerializerName() != null ||
m_stringAttrs.getFormatName() != null ||
m_stringAttrs.getDefaultText() != null) {
vctx.addWarning("String attributes serializer, " +
"deserializer, format, and default are " +
"prohibited with ID references");
}
} else {
m_stringAttrs.setType(m_propertyAttrs.getType());
m_stringAttrs.prevalidate(vctx);
}
super.prevalidate(vctx);
}
} else {
// check prohibited attributes with constant value
if (m_identIndex != NONE_IDENT) {
vctx.addFatal("ident value must be \"none\" for constant");
} else if (m_propertyAttrs.hasProperty() ||
m_propertyAttrs.getDeclaredType() != null) {
vctx.addFatal
("Property attributes cannot be used with constant");
} else if (m_stringAttrs.getDefaultText() != null ||
m_stringAttrs.getDeserializerName() != null ||
m_stringAttrs.getSerializerName() != null ||
m_stringAttrs.getFormatName() != null) {
vctx.addFatal("String attributes cannot be used with constant");
} else if (m_isNillable) {
vctx.addFatal("nillable cannot be used with constant");
}
}
}
/* (non-Javadoc)
* @see org.jibx.binding.model.ElementBase#validate(org.jibx.binding.model.ValidationContext)
*/
public void validate(ValidationContext vctx) {
// validate basic attributes
m_nameAttrs.validate(vctx);
m_propertyAttrs.validate(vctx);
if (!vctx.isSkipped(this)) {
// check identity references for compatible objects
if (m_identIndex == REF_IDENT) {
String type = m_propertyAttrs.getType().getName();
if (!vctx.getBindingRoot().isIdClass(type)) {
vctx.addError("No ID definitions for compatible type");
}
}
super.validate(vctx);
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/model/binding.xml 0000644 0001750 0001750 00000024112 10752421640 024362 0 ustar moeller moeller
libjibx-java-1.1.6a/build/src/org/jibx/binding/util/ 0000755 0001750 0001750 00000000000 11023035622 022074 5 ustar moeller moeller libjibx-java-1.1.6a/build/src/org/jibx/binding/util/ArrayMap.java 0000644 0001750 0001750 00000007442 10524407520 024467 0 ustar moeller moeller /*
Copyright (c) 2003-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.util;
import java.util.ArrayList;
import java.util.HashMap;
/**
* Array with reverse mapping from values to indices. This operates as the
* combination of an array with ordinary int indices and a hashmap from values
* back to the corresponding index position. Values are assured to be unique.
*
* @author Dennis M. Sosnoski
*/
public class ArrayMap
{
/** Array of values. */
private ArrayList m_array;
/** Map from values to indices. */
private HashMap m_map;
/**
* Default constructor.
*/
public ArrayMap() {
m_array = new ArrayList();
m_map = new HashMap();
}
/**
* Constructor with initial capacity supplied.
*
* @param size initial capacity for array map
*/
public ArrayMap(int size) {
m_array = new ArrayList(size);
m_map = new HashMap(size);
}
/**
* Get value for index. The index must be within the valid range (from 0 to
* one less than the number of values present).
*
* @param index number to be looked up
* @return value at that index position
*/
public Object get(int index) {
return m_array.get(index);
}
/**
* Find existing object. If the supplied value object is present in the
* array map its index position is returned.
*
* @param obj value to be found
* @return index number assigned to value, or -1 if not found
*/
public int find(Object obj) {
Integer index = (Integer)m_map.get(obj);
if (index == null) {
return -1;
} else {
return index.intValue();
}
}
/**
* Add object. If the supplied value object is already present in the array
* map the existing index position is returned.
*
* @param obj value to be added
* @return index number assigned to value
*/
public int findOrAdd(Object obj) {
Integer index = (Integer)m_map.get(obj);
if (index == null) {
index = IntegerCache.getInteger(m_array.size());
m_map.put(obj, index);
m_array.add(obj);
}
return index.intValue();
}
/**
* Get count of values present.
*
* @return number of values in array map
*/
public int size() {
return m_array.size();
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/util/IntegerCache.java 0000644 0001750 0001750 00000006356 10210703674 025300 0 ustar moeller moeller /*
Copyright (c) 2003-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.util;
/**
* Cache of Integer values. This is designed on the assumption that
* clients will start with zero and work their way up from there. By holding
* created instances in an array it allows for full reuse.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public abstract class IntegerCache
{
/** Initial set of index values supported. */
private static Integer[] s_integers =
{
new Integer(0), new Integer(1), new Integer(2), new Integer(3),
new Integer(4), new Integer(5), new Integer(6), new Integer(7)
};
/**
* Get Integer for value.
*
* @param value non-negative integer value
* @return corresponding Integer value
*/
public static Integer getInteger(int value) {
if (value >= s_integers.length) {
// Note that in multithreaded operation there's a chance of two
// threads getting in a race condition here, but the worst that
// can happen is that the array gets extended more than it needs
// to be. Threads just using the array are safe - though if they
// get an old version they may again extend the array
// unnecessarily.
synchronized(IntegerCache.class) {
int size = s_integers.length * 3 / 2;
if (size <= value) {
size = value + 1;
}
Integer[] ints = new Integer[size];
System.arraycopy(s_integers, 0, ints, 0, s_integers.length);
for (int i = 0; i < size; i++) {
ints[i] = new Integer(i);
}
s_integers = ints;
}
}
return s_integers[value];
}
}
libjibx-java-1.1.6a/build/src/org/jibx/binding/util/MultipleValueMap.java 0000644 0001750 0001750 00000021672 10673571654 026221 0 ustar moeller moeller /*
Copyright (c) 2006-2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.util;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.NoSuchElementException;
import java.util.Set;
import org.jibx.binding.model.EmptyList;
/**
* Map supporting multiple values for a single key. The multiple value concept
* doesn't really fit with the standard collections idea of a map, so this
* provides its own variation of a map interface rather than extend the standard
* one.
*
* @author Dennis M. Sosnoski
*/
public class MultipleValueMap
{
/** Backing map from key to value or array of values. */
private final HashMap m_backingMap;
/** Actual number of values (not keys) present in map. */
private int m_valueCount;
/** Last lookup key (null if none, or if value changed). */
private Object m_lastKey;
/** Last lookup value (null if none, or if value changed). */
private Object m_lastValue;
/**
* Constructor.
*/
public MultipleValueMap() {
super();
m_backingMap = new HashMap();
}
/**
* Internal cached lookup.
*
* @param key
* @return value
*/
private Object getMapped(Object key) {
if (key != m_lastKey) {
m_lastKey = key;
m_lastValue = m_backingMap.get(key);
}
return m_lastValue;
}
/**
* Clear all entries.
*/
public void clear() {
m_backingMap.clear();
m_valueCount = 0;
}
/**
* Get number of values present for key.
*
* @param key
* @return value count
*/
public int getCount(Object key) {
Object obj = getMapped(key);
if (obj instanceof MultipleValueList) {
return ((MultipleValueList)obj).size();
} else if (obj == null) {
return 0;
} else {
return 1;
}
}
/**
* Get indexed value for key.
*
* @param key
* @param index
* @return value
*/
public Object get(Object key, int index) {
Object obj = getMapped(key);
if (obj instanceof MultipleValueList) {
return ((MultipleValueList)obj).get(index);
} else if (obj == null) {
throw new IndexOutOfBoundsException("No value present for key");
} else if (index == 0) {
return obj;
} else {
throw new IndexOutOfBoundsException("Only one value present for key");
}
}
/**
* Add value for key.
*
* @param key
* @param value
*/
public void add(Object key, Object value) {
// first force caching of current value
getMapped(key);
// update value as appropriate
if (m_lastValue == null) {
m_backingMap.put(key, value);
m_lastValue = value;
} else if (m_lastValue instanceof MultipleValueList) {
((MultipleValueList)m_lastValue).add(value);
} else {
MultipleValueList list = new MultipleValueList();
list.add(m_lastValue);
list.add(value);
m_backingMap.put(key, list);
m_lastValue = list;
}
m_valueCount++;
}
/**
* Get all values for key. This returns the value(s) from the map and
* returns them in the form of a list.
*
* @param key
* @return list of values
*/
public ArrayList get(Object key) {
Object obj = m_backingMap.get(key);
if (obj instanceof MultipleValueList) {
return (MultipleValueList)obj;
} else if (obj == null) {
return EmptyList.INSTANCE;
} else {
MultipleValueList list = new MultipleValueList();
list.add(obj);
return list;
}
}
/**
* Extract all values for key. This removes the value(s) from the map and
* returns them in the form of a list.
*
* @param key
* @return prior list of values
*/
public ArrayList extract(Object key) {
ArrayList result = get(key);
m_backingMap.remove(key);
return result;
}
/**
* Get number of keys.
*
* @return key count
*/
public int keySize() {
return m_backingMap.size();
}
/**
* Get number of values.
*
* @return value count
*/
public int valueSize() {
return m_valueCount;
}
/**
* Get iterator over only the multiple-valued keys present in the map.
*
* @return iterator
*/
public Iterator multipleIterator() {
return new MultipleIterator();
}
//
// Delegated methods
/**
* Check key present in map.
*
* @param key
* @return key present flag
*/
public boolean containsKey(Object key) {
return m_backingMap.containsKey(key);
}
/**
* Check if map is empty.
*
* @return empty flag
*/
public boolean isEmpty() {
return m_backingMap.isEmpty();
}
/**
* Get key set.
*
* @return set of keys
*/
public Set keySet() {
return m_backingMap.keySet();
}
/**
* List used for multiple values. This is just a marker, so that the actual
* values can be anything at all (including lists).
*/
private static class MultipleValueList extends ArrayList {
public MultipleValueList() {}
}
/**
* Iterator for only the multiple-valued keys in the map.
*/
public class MultipleIterator implements Iterator
{
/** Current key value has been consumed flag. */
private boolean m_isConsumed;
/** Current key, null if past end. */
private Object m_currentKey;
/** Iterator through keys present in map. */
private Iterator m_keyIterator;
/**
* Constructor. This initializes the key iterator and next key values.
*/
protected MultipleIterator() {
m_keyIterator = keySet().iterator();
m_isConsumed = true;
}
/**
* Advance to next multiple-valued key in map.
*/
private void advance() {
if (m_isConsumed) {
m_isConsumed = false;
m_currentKey = null;
while (m_keyIterator.hasNext()) {
Object key = m_keyIterator.next();
if (getCount(key) > 1) {
m_currentKey = key;
break;
}
}
}
}
/**
* Check for another multiple-valued key present.
*
* @return true if present, false if not
*/
public boolean hasNext() {
advance();
return m_currentKey != null;
}
/**
* Get the next multiple-valued key in map. This returns the current
* next key, advancing to the next next key.
*
* @return next multiple-valued key
*/
public Object next() {
advance();
if (m_currentKey == null) {
throw new NoSuchElementException("Past end of list");
} else {
m_isConsumed = true;
return m_currentKey;
}
}
/**
* Remove current multiple-valued key.
*/
public void remove() {
m_keyIterator.remove();
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/util/NameUtilities.java 0000644 0001750 0001750 00000005142 10752422106 025522 0 ustar moeller moeller /*
* Copyright (c) 2008, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.util;
/**
* Support methods for name conversions.
*/
public class NameUtilities
{
/**
* Convert potentially plural name to singular form. TODO: internationalization?
*
* @param name base name
* @return singularized name
*/
public static String depluralize(String name) {
if (name.endsWith("ies")) {
return name.substring(0, name.length() - 3) + 'y';
} else if (name.endsWith("sses")) {
return name.substring(0, name.length() - 2);
} else if (name.endsWith("s")) {
return name.substring(0, name.length() - 1);
} else {
return name;
}
}
/**
* Convert singular name to plural form. TODO: internationalization?
*
* @param name base name
* @return plural name
*/
public static String pluralize(String name) {
if (name.endsWith("y")) {
return name.substring(0, name.length() - 1) + "ies";
} else if (name.endsWith("ss")) {
return name + "es";
} else {
return name + 's';
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/util/ObjectStack.java 0000644 0001750 0001750 00000023727 10524427624 025162 0 ustar moeller moeller /*
Copyright (c) 2000-2006, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.util;
import java.lang.reflect.Array;
/**
* Growable Object stack with type specific access methods. This
* implementation is unsynchronized in order to provide the best possible
* performance for typical usage scenarios, so explicit synchronization must
* be implemented by a wrapper class or directly by the application in cases
* where instances are modified in a multithreaded environment.
*
* @author Dennis M. Sosnoski
*/
public class ObjectStack
{
/** Default initial array size. */
public static final int DEFAULT_SIZE = 8;
/** Size of the current array. */
protected int m_countLimit;
/** The number of values currently present in the stack. */
protected int m_countPresent;
/** Maximum size increment for growing array. */
protected int m_maximumGrowth;
/** The underlying array used for storing the data. */
protected Object[] m_baseArray;
/**
* Constructor with full specification.
*
* @param size number of Object values initially allowed in
* stack
* @param growth maximum size increment for growing stack
*/
public ObjectStack(int size, int growth) {
m_countLimit = size;
m_maximumGrowth = growth;
m_baseArray = new Object[size];
}
/**
* Constructor with initial size specified.
*
* @param size number of Object values initially allowed in
* stack
*/
public ObjectStack(int size) {
this(size, Integer.MAX_VALUE);
}
/**
* Default constructor.
*/
public ObjectStack() {
this(DEFAULT_SIZE);
}
/**
* Copy (clone) constructor.
*
* @param base instance being copied
*/
public ObjectStack(ObjectStack base) {
this(base.m_countLimit, base.m_maximumGrowth);
System.arraycopy(base.m_baseArray, 0, m_baseArray, 0,
base.m_countPresent);
m_countPresent = base.m_countPresent;
}
/**
* Constructor from array of strings.
*
* @param strings array of strings for initial contents
*/
public ObjectStack(Object[] strings) {
this(strings.length);
System.arraycopy(strings, 0, m_baseArray, 0, strings.length);
m_countPresent = strings.length;
}
/**
* Copy data after array resize. This just copies the entire contents of the
* old array to the start of the new array. It should be overridden in cases
* where data needs to be rearranged in the array after a resize.
*
* @param base original array containing data
* @param grown resized array for data
*/
private void resizeCopy(Object base, Object grown) {
System.arraycopy(base, 0, grown, 0, Array.getLength(base));
}
/**
* Discards values for a range of indices in the array. Checks if the
* values stored in the array are object references, and if so clears
* them. If the values are primitives, this method does nothing.
*
* @param from index of first value to be discarded
* @param to index past last value to be discarded
*/
private void discardValues(int from, int to) {
for (int i = from; i < to; i++) {
m_baseArray[i] = null;
}
}
/**
* Increase the size of the array to at least a specified size. The array
* will normally be at least doubled in size, but if a maximum size
* increment was specified in the constructor and the value is less than
* the current size of the array, the maximum increment will be used
* instead. If the requested size requires more than the default growth,
* the requested size overrides the normal growth and determines the size
* of the replacement array.
*
* @param required new minimum size required
*/
private void growArray(int required) {
int size = Math.max(required,
m_countLimit + Math.min(m_countLimit, m_maximumGrowth));
Object[] grown = new Object[size];
resizeCopy(m_baseArray, grown);
m_countLimit = size;
m_baseArray = grown;
}
/**
* Ensure that the array has the capacity for at least the specified
* number of values.
*
* @param min minimum capacity to be guaranteed
*/
public final void ensureCapacity(int min) {
if (min > m_countLimit) {
growArray(min);
}
}
/**
* Push a value on the stack.
*
* @param value value to be added
*/
public void push(Object value) {
int index = getAddIndex();
m_baseArray[index] = value;
}
/**
* Pop a value from the stack.
*
* @return value from top of stack
* @exception ArrayIndexOutOfBoundsException on attempt to pop empty stack
*/
public Object pop() {
if (m_countPresent > 0) {
Object value = m_baseArray[--m_countPresent];
m_baseArray[m_countPresent] = null;
return value;
} else {
throw new ArrayIndexOutOfBoundsException
("Attempt to pop empty stack");
}
}
/**
* Pop multiple values from the stack. The last value popped is the
* one returned.
*
* @param count number of values to pop from stack (must be strictly
* positive)
* @return value from top of stack
* @exception ArrayIndexOutOfBoundsException on attempt to pop past end of
* stack
*/
public Object pop(int count) {
if (count < 0) {
throw new IllegalArgumentException("Count must be greater than 0");
} else if (m_countPresent >= count) {
m_countPresent -= count;
Object value = m_baseArray[m_countPresent];
discardValues(m_countPresent, m_countPresent + count);
return value;
} else {
throw new ArrayIndexOutOfBoundsException
("Attempt to pop past end of stack");
}
}
/**
* Copy a value from the stack. This returns a value from within
* the stack without modifying the stack.
*
* @param depth depth of value to be returned
* @return value from stack
* @exception ArrayIndexOutOfBoundsException on attempt to peek past end of
* stack
*/
public Object peek(int depth) {
if (m_countPresent > depth) {
return m_baseArray[m_countPresent - depth - 1];
} else {
throw new ArrayIndexOutOfBoundsException
("Attempt to peek past end of stack");
}
}
/**
* Copy top value from the stack. This returns the top value without
* removing it from the stack.
*
* @return value at top of stack
* @exception ArrayIndexOutOfBoundsException on attempt to peek empty stack
*/
public Object peek() {
return peek(0);
}
/**
* Constructs and returns a simple array containing the same data as held
* in this stack. Note that the items will be in reverse pop order, with
* the last item to be popped from the stack as the first item in the
* array.
*
* @return array containing a copy of the data
*/
public Object[] toArray() {
Object[] copy = new Object[m_countPresent];
System.arraycopy(m_baseArray, 0, copy, 0, m_countPresent);
return copy;
}
/**
* Duplicates the object with the generic call.
*
* @return a copy of the object
*/
public Object clone() {
return new ObjectStack(this);
}
/**
* Gets the array offset for appending a value to those in the stack.
* If the underlying array is full, it is grown by the appropriate size
* increment so that the index value returned is always valid for the
* array in use by the time of the return.
*
* @return index position for added element
*/
private int getAddIndex() {
int index = m_countPresent++;
if (m_countPresent > m_countLimit) {
growArray(m_countPresent);
}
return index;
}
/**
* Get the number of values currently present in the stack.
*
* @return count of values present
*/
public int size() {
return m_countPresent;
}
/**
* Check if stack is empty.
*
* @return true if stack empty, false if not
*/
public boolean isEmpty() {
return m_countPresent == 0;
}
/**
* Set the stack to the empty state.
*/
public void clear() {
discardValues(0, m_countPresent);
m_countPresent = 0;
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/util/SparseStack.java 0000644 0001750 0001750 00000006756 10524427624 025214 0 ustar moeller moeller /*
Copyright (c) 2005-2006, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.util;
import org.jibx.runtime.IntStack;
/**
* Stack for values that depend on the level of nesting, where only some of the
* levels change the current value.
*
* @author Dennis M. Sosnoski
*/
public class SparseStack
{
/** Current item. */
private Object m_current;
/** Current nesting level. */
private int m_level;
/** Levels with different items (paired with m_items stack). */
private IntStack m_levels;
/** Stack of different items (paired with m_levels stack). */
private ObjectStack m_items;
/**
* Constructor with initial value.
*
* @param current initial value
*/
public SparseStack(Object current) {
// initialize so peek always works
m_levels = new IntStack();
m_levels.push(-1);
m_items = new ObjectStack();
m_items.push(current);
m_current = current;
}
/**
* Constructor with no initial value.
*/
public SparseStack() {
this(null);
}
/**
* Get current object.
*
* @return current
*/
public Object getCurrent() {
return m_current;
}
/**
* Set current object.
*
* @param obj set the current object
*/
public void setCurrent(Object obj) {
m_current = obj;
}
/**
* Enter a level of nesting.
*/
public void enter() {
if (m_current != m_items.peek()) {
m_levels.push(m_level);
m_items.push(m_current);
}
m_level++;
}
/**
* Exit a level of nesting with changed item returned.
*
* @return item that was active until this exit, or null if
* same item still active
*/
public Object exit() {
m_level--;
if (m_level == m_levels.peek()) {
Object obj = m_current;
m_levels.pop();
m_current = m_items.pop();
return obj;
} else {
return null;
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/util/StringArray.java 0000644 0001750 0001750 00000014732 10524427624 025227 0 ustar moeller moeller package org.jibx.binding.util;
/**
* Wrapper for arrays of ordered strings. This verifies the arrays and supports
* efficient lookups.
*
* @author Dennis M. Sosnoski
*/
public class StringArray
{
/** Ordered array of strings. */
private final String[] m_list;
/**
* Constructor from array of values. This checks the array values to make
* sure they're ordered and unique, and if they're not throws an exception.
* Once the array has been passed to this constructor it must not be
* modified by outside code.
*
* @param list array of values
*/
public StringArray(String[] list) {
validateArray(list);
m_list = list;
}
/**
* Constructor from array of values to be added to base instance. This
* merges the array values, making sure they're ordered and unique, and if
* they're not throws an exception.
*
* @param list array of values
* @param base base instance
*/
public StringArray(String[] list, StringArray base) {
validateArray(list);
m_list = mergeArrays(list, base.m_list);
}
/**
* Constructor from pair of base instances. This merges the values, making
* sure they're unique, and if they're not throws an exception.
*
* @param array1 first base array
* @param array2 second base array
*/
public StringArray(StringArray array1, StringArray array2) {
m_list = mergeArrays(array1.m_list, array2.m_list);
}
/**
* Constructor from array of values to be added to pair of base instances.
* This merges the array values, making sure they're ordered and unique, and
* if they're not throws an exception.
*
* @param list array of values
* @param array1 first base array
* @param array2 second base array
*/
public StringArray(String[] list, StringArray array1, StringArray array2) {
validateArray(list);
m_list = mergeArrays(list, mergeArrays(array1.m_list, array2.m_list));
}
/**
* Constructor from array of values to be added to three base instances.
* This merges the array values, making sure they're ordered and unique, and
* if they're not throws an exception.
*
* @param list array of values
* @param array1 first base array
* @param array2 second base array
* @param array3 third base array
*/
public StringArray(String[] list, StringArray array1, StringArray array2,
StringArray array3) {
validateArray(list);
m_list = mergeArrays(list, mergeArrays(array1.m_list,
mergeArrays(array2.m_list, array3.m_list)));
}
/**
* Constructor from array of values to be added to four base instances.
* This merges the array values, making sure they're ordered and unique, and
* if they're not throws an exception.
*
* @param list array of values
* @param array1 first base array
* @param array2 second base array
* @param array3 third base array
* @param array4 fourth base array
*/
public StringArray(String[] list, StringArray array1, StringArray array2,
StringArray array3, StringArray array4) {
validateArray(list);
m_list = mergeArrays(list, mergeArrays(array1.m_list,
mergeArrays(array2.m_list,
mergeArrays(array3.m_list, array4.m_list))));
}
/**
* Merge a pair of ordered arrays into a single array. The two source arrays
* must not contain any values in common.
*
* @param list1 first ordered array
* @param list2 second ordered array
* @return merged array
*/
private String[] mergeArrays(String[] list1, String[] list2) {
String[] merge = new String[list1.length + list2.length];
int fill = 0;
int i = 0;
int j = 0;
while (i < list1.length && j < list2.length) {
int diff = list2[j].compareTo(list1[i]);
if (diff > 0) {
merge[fill++] = list1[i++];
} else if (diff < 0) {
merge[fill++] = list2[j++];
} else {
throw new IllegalArgumentException
("Repeated value not allowed: \"" + list1[i] + '"');
}
}
if (i < list1.length) {
System.arraycopy(list1, i, merge, fill, list1.length-i);
}
if (j < list2.length) {
System.arraycopy(list2, j, merge, fill, list2.length-j);
}
return merge;
}
/**
* Make sure passed-in array contains values that are in order and without
* duplicate values.
*
* @param list
*/
private void validateArray(String[] list) {
if (list.length > 0) {
String last = list[0];
int index = 0;
while (++index < list.length) {
String comp = list[index];
int diff = last.compareTo(comp);
if (diff > 0) {
throw new IllegalArgumentException
("Array values are not ordered");
} else if (diff < 0) {
last = comp;
} else {
throw new IllegalArgumentException
("Duplicate values in array");
}
}
}
}
/**
* Get string at a particular index in the list.
*
* @param index list index to be returned
* @return string at that index position
*/
public String get(int index) {
return m_list[index];
}
/**
* Find index of a particular string in the array. This does
* a binary search through the array values, using a pair of
* index bounds to track the subarray of possible matches at
* each iteration.
*
* @param value string to be found in list
* @return index of string in array, or -1 if
* not present
*/
public int indexOf(String value) {
int base = 0;
int limit = m_list.length - 1;
while (base <= limit) {
int cur = (base + limit) >> 1;
int diff = value.compareTo(m_list[cur]);
if (diff < 0) {
limit = cur - 1;
} else if (diff > 0) {
base = cur + 1;
} else {
return cur;
}
}
return -1;
}
/**
* Get number of values in array
*
* @return number of values in array
*/
public int size() {
return m_list.length;
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/util/StringStack.java 0000644 0001750 0001750 00000023757 10524427624 025225 0 ustar moeller moeller /*
Copyright (c) 2000-2006, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.util;
import java.lang.reflect.Array;
/**
* Growable String stack with type specific access methods. This
* implementation is unsynchronized in order to provide the best possible
* performance for typical usage scenarios, so explicit synchronization must
* be implemented by a wrapper class or directly by the application in cases
* where instances are modified in a multithreaded environment.
*
* @author Dennis M. Sosnoski
*/
public class StringStack
{
/** Default initial array size. */
public static final int DEFAULT_SIZE = 8;
/** Size of the current array. */
private int m_countLimit;
/** The number of values currently present in the stack. */
private int m_countPresent;
/** Maximum size increment for growing array. */
private int m_maximumGrowth;
/** The underlying array used for storing the data. */
private String[] m_baseArray;
/**
* Constructor with full specification.
*
* @param size number of String values initially allowed in
* stack
* @param growth maximum size increment for growing stack
*/
public StringStack(int size, int growth) {
String[] array = new String[size];
m_countLimit = size;
m_maximumGrowth = growth;
m_baseArray = array;
}
/**
* Constructor with initial size specified.
*
* @param size number of String values initially allowed in
* stack
*/
public StringStack(int size) {
this(size, Integer.MAX_VALUE);
}
/**
* Default constructor.
*/
public StringStack() {
this(DEFAULT_SIZE);
}
/**
* Copy (clone) constructor.
*
* @param base instance being copied
*/
public StringStack(StringStack base) {
this(base.m_countLimit, base.m_maximumGrowth);
System.arraycopy(base.m_baseArray, 0, m_baseArray, 0,
base.m_countPresent);
m_countPresent = base.m_countPresent;
}
/**
* Constructor from array of strings.
*
* @param strings array of strings for initial contents
*/
public StringStack(String[] strings) {
this(strings.length);
System.arraycopy(strings, 0, m_baseArray, 0, strings.length);
m_countPresent = strings.length;
}
/**
* Copy data after array resize. This just copies the entire contents of the
* old array to the start of the new array. It should be overridden in cases
* where data needs to be rearranged in the array after a resize.
*
* @param base original array containing data
* @param grown resized array for data
*/
private void resizeCopy(Object base, Object grown) {
System.arraycopy(base, 0, grown, 0, Array.getLength(base));
}
/**
* Discards values for a range of indices in the array. Checks if the
* values stored in the array are object references, and if so clears
* them. If the values are primitives, this method does nothing.
*
* @param from index of first value to be discarded
* @param to index past last value to be discarded
*/
private void discardValues(int from, int to) {
for (int i = from; i < to; i++) {
m_baseArray[i] = null;
}
}
/**
* Increase the size of the array to at least a specified size. The array
* will normally be at least doubled in size, but if a maximum size
* increment was specified in the constructor and the value is less than
* the current size of the array, the maximum increment will be used
* instead. If the requested size requires more than the default growth,
* the requested size overrides the normal growth and determines the size
* of the replacement array.
*
* @param required new minimum size required
*/
private void growArray(int required) {
int size = Math.max(required,
m_countLimit + Math.min(m_countLimit, m_maximumGrowth));
String[] grown = new String[size];
resizeCopy(m_baseArray, grown);
m_countLimit = size;
m_baseArray = grown;
}
/**
* Ensure that the array has the capacity for at least the specified
* number of values.
*
* @param min minimum capacity to be guaranteed
*/
public final void ensureCapacity(int min) {
if (min > m_countLimit) {
growArray(min);
}
}
/**
* Push a value on the stack.
*
* @param value value to be added
*/
public void push(String value) {
int index = getAddIndex();
m_baseArray[index] = value;
}
/**
* Pop a value from the stack.
*
* @return value from top of stack
* @exception ArrayIndexOutOfBoundsException on attempt to pop empty stack
*/
public String pop() {
if (m_countPresent > 0) {
String value = m_baseArray[--m_countPresent];
m_baseArray[m_countPresent] = null;
return value;
} else {
throw new ArrayIndexOutOfBoundsException
("Attempt to pop empty stack");
}
}
/**
* Pop multiple values from the stack. The last value popped is the
* one returned.
*
* @param count number of values to pop from stack (must be strictly
* positive)
* @return value from top of stack
* @exception ArrayIndexOutOfBoundsException on attempt to pop past end of
* stack
*/
public String pop(int count) {
if (count < 0) {
throw new IllegalArgumentException("Count must be greater than 0");
} else if (m_countPresent >= count) {
m_countPresent -= count;
String value = m_baseArray[m_countPresent];
discardValues(m_countPresent, m_countPresent + count);
return value;
} else {
throw new ArrayIndexOutOfBoundsException
("Attempt to pop past end of stack");
}
}
/**
* Copy a value from the stack. This returns a value from within
* the stack without modifying the stack.
*
* @param depth depth of value to be returned
* @return value from stack
* @exception ArrayIndexOutOfBoundsException on attempt to peek past end of
* stack
*/
public String peek(int depth) {
if (m_countPresent > depth) {
return m_baseArray[m_countPresent - depth - 1];
} else {
throw new ArrayIndexOutOfBoundsException
("Attempt to peek past end of stack");
}
}
/**
* Copy top value from the stack. This returns the top value without
* removing it from the stack.
*
* @return value at top of stack
* @exception ArrayIndexOutOfBoundsException on attempt to peek empty stack
*/
public String peek() {
return peek(0);
}
/**
* Constructs and returns a simple array containing the same data as held
* in this stack. Note that the items will be in reverse pop order, with
* the last item to be popped from the stack as the first item in the
* array.
*
* @return array containing a copy of the data
*/
public String[] toArray() {
String[] copy = new String[m_countPresent];
System.arraycopy(m_baseArray, 0, copy, 0, m_countPresent);
return copy;
}
/**
* Duplicates the object with the generic call.
*
* @return a copy of the object
*/
public Object clone() {
return new StringStack(this);
}
/**
* Gets the array offset for appending a value to those in the stack.
* If the underlying array is full, it is grown by the appropriate size
* increment so that the index value returned is always valid for the
* array in use by the time of the return.
*
* @return index position for added element
*/
private int getAddIndex() {
int index = m_countPresent++;
if (m_countPresent > m_countLimit) {
growArray(m_countPresent);
}
return index;
}
/**
* Get the number of values currently present in the stack.
*
* @return count of values present
*/
public int size() {
return m_countPresent;
}
/**
* Check if stack is empty.
*
* @return true if stack empty, false if not
*/
public boolean isEmpty() {
return m_countPresent == 0;
}
/**
* Set the stack to the empty state.
*/
public void clear() {
discardValues(0, m_countPresent);
m_countPresent = 0;
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/BindingGenerator.java 0000644 0001750 0001750 00000140220 11005500336 025201 0 ustar moeller moeller /*
Copyright (c) 2004-2008, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.PrintStream;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import org.apache.bcel.classfile.Field;
import org.apache.bcel.classfile.JavaClass;
import org.jibx.binding.classes.ClassCache;
import org.jibx.binding.classes.ClassFile;
import org.jibx.binding.classes.ClassItem;
import org.jibx.binding.model.BindingElement;
import org.jibx.binding.model.CollectionElement;
import org.jibx.binding.model.ContainerElementBase;
import org.jibx.binding.model.MappingElement;
import org.jibx.binding.model.NamespaceElement;
import org.jibx.binding.model.StructureElement;
import org.jibx.binding.model.StructureElementBase;
import org.jibx.binding.model.ValueElement;
import org.jibx.binding.util.ObjectStack;
import org.jibx.runtime.BindingDirectory;
import org.jibx.runtime.IBindingFactory;
import org.jibx.runtime.IMarshallingContext;
import org.jibx.runtime.JiBXException;
/**
* Binding generator. This loads the specified input classes and processes them
* to generate a default binding definition.
*
* @author Dennis M. Sosnoski
*/
public class BindingGenerator
{
/** Generator version. */
private static String CURRENT_VERSION = "0.4";
/** Set of objects treated as primitives. */
private static HashSet s_objectPrimitiveSet = new HashSet();
static {
s_objectPrimitiveSet.add("java.lang.Boolean");
s_objectPrimitiveSet.add("java.lang.Byte");
s_objectPrimitiveSet.add("java.lang.Char");
s_objectPrimitiveSet.add("java.lang.Double");
s_objectPrimitiveSet.add("java.lang.Float");
s_objectPrimitiveSet.add("java.lang.Integer");
s_objectPrimitiveSet.add("java.lang.Long");
s_objectPrimitiveSet.add("java.lang.Short");
s_objectPrimitiveSet.add("java.math.BigDecimal");
s_objectPrimitiveSet.add("java.math.BigInteger");
//#!j2me{
s_objectPrimitiveSet.add("java.sql.Date");
s_objectPrimitiveSet.add("java.sql.Time");
s_objectPrimitiveSet.add("java.sql.Timestamp");
//#j2me}
s_objectPrimitiveSet.add("java.util.Date");
}
/** Show verbose output flag. */
private boolean m_verbose;
/** Use camel case for XML names flag. */
private boolean m_mixedCase;
/** Namespace URI for elements. */
private String m_namespaceUri;
/** Class names to mapped element names map. */
private HashMap m_mappedNames;
/** Class names to properties list map. */
private HashMap m_beanNames;
/** Class names to deserializers map for typesafe enumerations. */
private HashMap m_enumerationNames;
/** Stack of structure definitions in progress (used to detect cycles). */
private ObjectStack m_structureStack;
/** Class names bound as nested structures. */
private HashSet m_structureNames;
/** Class names to be treated like interfaces (not mapped directly). */
private HashSet m_ignoreNames;
/**
* Default constructor. This just initializes all options disabled.
*/
public BindingGenerator() {
m_mappedNames = new HashMap();
m_structureStack = new ObjectStack();
m_structureNames = new HashSet();
m_ignoreNames = new HashSet();
}
/**
* Constructor with settings specified.
*
* @param verbose report binding details and results
* @param mixed use camel case in element names
* @param uri namespace URI for element bindings
*/
public BindingGenerator(boolean verbose, boolean mixed, String uri) {
this();
m_verbose = verbose;
m_mixedCase = mixed;
m_namespaceUri = uri;
}
/**
* Set control flag for verbose processing reports.
*
* @param verbose report verbose information in processing bindings flag
*/
public void setVerbose(boolean verbose) {
m_verbose = verbose;
}
/**
* Set control flag for camel case element naming.
*
* @param camel use camel case element naming flag
*/
public void setCamelCase(boolean camel) {
m_mixedCase = camel;
}
/**
* Indent to proper depth for current item.
*
* @param pw output print stream to be indented
*/
private void nestingIndent(PrintStream pw) {
for (int i = 0; i < m_structureStack.size(); i++) {
pw.print(' ');
}
}
/**
* Convert class or unprefixed field name to element or attribute name.
*
* @param base class or simple field name to be converted
* @return element or attribute name
*/
private String convertName(String base) {
StringBuffer name = new StringBuffer();
name.append(Character.toLowerCase(base.charAt(0)));
if (m_mixedCase) {
name.append(base.substring(1));
} else {
boolean ignore = true;
for (int i = 1; i < base.length(); i++) {
char chr = base.charAt(i);
if (Character.isUpperCase(chr)) {
chr = Character.toLowerCase(chr);
if (ignore) {
int next = i + 1;
ignore = next >= base.length() ||
Character.isUpperCase(base.charAt(next));
}
if (ignore) {
name.append(chr);
} else {
name.append('-');
name.append(chr);
ignore = true;
}
} else {
name.append(chr);
ignore = false;
}
}
}
return name.toString();
}
/**
* Generate structure element name from class name using set conversions.
*
* @param cname class name to be converted
* @return element name for instances of class
*/
public String elementName(String cname) {
int split = cname.lastIndexOf('.');
if (split >= 0) {
cname = cname.substring(split+1);
}
while ((split = cname.indexOf('$')) >= 0) {
cname = cname.substring(0, split) + cname.substring(split+1);
}
return convertName(cname);
}
/**
* Generate structure element name from class name using set conversions.
*
* @param fname field name to be converted
* @return element name for instances of class
*/
private String valueName(String fname) {
String base = fname;
if (base.startsWith("m_")) {
base = base.substring(2);
} else if (base.startsWith("_")) {
base = base.substring(1);
} else if (base.startsWith("f") && base.length() > 1) {
if (Character.isUpperCase(base.charAt(1))) {
base = base.substring(1);
}
}
return convertName(base);
}
/**
* Construct the list of child binding components that define the binding
* structure for fields of a particular class. This binds all
* non-final/non-static/non-transient fields of the class, if necessary
* creating nested structure elements for unmapped classes referenced by the
* fields.
*
* @param cf class information
* @param contain binding structure container element
* @throws JiBXException on error in binding generation
*/
private void defineFields(ClassFile cf, ContainerElementBase contain)
throws JiBXException {
// process all non-final/non-static/non-transient fields of class
JavaClass clas = cf.getRawClass();
Field[] fields = clas.getFields();
for (int i = 0; i < fields.length; i++) {
Field field = fields[i];
if (!field.isFinal() && !field.isStatic() && !field.isTransient()) {
// find type of handling needed for field type
boolean simple = false;
boolean object = true;
boolean attribute = true;
String fname = field.getName();
String tname = field.getType().toString();
if (ClassItem.isPrimitive(tname)) {
simple = true;
object = false;
} else if (s_objectPrimitiveSet.contains(tname)) {
simple = true;
} else if (tname.equals("byte[]")) {
simple = true;
attribute = false;
} else if (tname.startsWith("java.")) {
// check for standard library classes we can handle
ClassFile pcf = ClassCache.getClassFile(tname);
ClassItem init = pcf.getInitializerMethod
("(Ljava/lang/String;)");
if (init != null) {
simple = pcf.getMethod("toString",
"()Ljava/lang/String;") != null;
attribute = false;
}
}
// check type of handling to use for value
if (m_enumerationNames.get(tname) != null) {
// define a value using deserializer method
String mname = (String)m_enumerationNames.get(tname);
int split = mname.lastIndexOf('.');
ClassFile dcf =
ClassCache.getClassFile(mname.substring(0, split));
ClassItem dser =
dcf.getStaticMethod(mname.substring(split+1),
"(Ljava/lang/String;)");
if (dser == null || !tname.equals(dser.getTypeName())) {
throw new JiBXException("Deserializer method not " +
"found for enumeration class " + tname);
}
ValueElement value = new ValueElement();
value.setFieldName(fname);
value.setName(valueName(fname));
value.setUsageName("optional");
value.setStyleName("element");
value.setDeserializerName(mname);
contain.addChild(value);
} else if (m_mappedNames.get(tname) != null) {
// use mapping definition for class
StructureElement structure = new StructureElement();
structure.setUsageName("optional");
structure.setFieldName(fname);
if (((String)m_mappedNames.get(tname)).length() == 0) {
// add a name for reference to abstract mapping
structure.setName(elementName(tname));
}
contain.addChild(structure);
if (m_verbose) {
nestingIndent(System.out);
System.out.println("referenced existing binding for " +
tname);
}
} else if (simple) {
// define a simple value
ValueElement value = new ValueElement();
value.setFieldName(fname);
value.setName(valueName(fname));
if (object) {
value.setUsageName("optional");
}
if (!attribute) {
value.setStyleName("element");
}
contain.addChild(value);
} else if (tname.endsWith("[]")) {
// array, check if item type has a mapping
String bname = tname.substring(0, tname.length()-2);
if (m_mappedNames.get(bname) == null) {
// no mapping, use collection with inline structure
// TODO: fill it in
throw new JiBXException("Base element type " + bname +
" must be mapped");
} else {
// mapping for type, use simple collection
CollectionElement collection = new CollectionElement();
collection.setUsageName("optional");
collection.setFieldName(fname);
contain.addChild(collection);
}
} else {
// no defined handling, check for collection vs. structure
ClassFile pcf = ClassCache.getClassFile(tname);
StructureElementBase element;
if (pcf.isImplements("Ljava/util/List;")) {
// create a collection for list subclass
System.err.println("Warning: field " + fname +
" requires mapped implementation of item classes");
element = new CollectionElement();
element.setComment(" add details of collection items " +
"to complete binding definition ");
element.setFieldName(fname);
// specify factory method if just typed as interface
if ("java.util.List".equals(tname)) {
element.setFactoryName
("org.jibx.runtime.Utility.arrayListFactory");
}
} else if (pcf.isInterface() ||
m_ignoreNames.contains(tname)) {
// create mapping reference with warning for interface
nestingIndent(System.err);
System.err.println("Warning: reference to interface " +
"or abstract class " + tname +
" requires mapped implementation");
element = new StructureElement();
element.setFieldName(fname);
} else {
// handle other types of structures directly
element = createStructure(pcf, fname);
}
// finish with common handling
element.setUsageName("optional");
contain.addChild(element);
}
}
}
}
/**
* Construct the list of child binding components that define the binding
* structure corresponding to properties of a particular class. This binds
* the specified properties of the class, using get/set methods, if
* necessary creating nested structure elements for unmapped classes
* referenced by the properties.
*
* @param cf class information
* @param props list of properties specified for class
* @param internal allow private get/set methods flag
* @param contain binding structure container element
* @throws JiBXException on error in binding generation
*/
private void defineProperties(ClassFile cf, ArrayList props,
boolean internal, ContainerElementBase contain) throws JiBXException {
// process all properties of class
for (int i = 0; i < props.size(); i++) {
String pname = (String)props.get(i);
String base = Character.toUpperCase(pname.charAt(0)) +
pname.substring(1);
String gname = "get" + base;
ClassItem gmeth = cf.getMethod(gname, "()");
if (gmeth == null) {
throw new JiBXException("No method " + gname +
"() found for property " + base + " in class " +
cf.getName());
} else {
String tname = gmeth.getTypeName();
String sname = "set" + base;
String sig = "(" + gmeth.getSignature().substring(2) + ")V";
ClassItem smeth = cf.getMethod(sname, sig);
if (smeth == null) {
throw new JiBXException("No method " + sname + "(" + tname +
") found for property " + base + " in class " +
cf.getName());
} else {
// find type of handling needed for field type
boolean simple = false;
boolean object = true;
boolean attribute = true;
if (ClassItem.isPrimitive(tname)) {
simple = true;
object = false;
} else if (s_objectPrimitiveSet.contains(tname)) {
simple = true;
} else if (tname.equals("byte[]")) {
simple = true;
attribute = false;
} else if (tname.startsWith("java.")) {
// check for standard library classes we can handle
ClassFile pcf = ClassCache.getClassFile(tname);
if (pcf.getInitializerMethod("()") != null) {
simple = pcf.getMethod("toString",
"()Ljava/lang/String;") != null;
attribute = false;
}
}
if (simple) {
// define a simple value
ValueElement value = new ValueElement();
value.setGetName(gname);
value.setSetName(sname);
value.setName(valueName(pname));
if (object) {
value.setUsageName("optional");
}
if (!attribute) {
value.setStyleName("element");
}
contain.addChild(value);
} else if (m_enumerationNames.get(tname) != null) {
// define a value using deserializer method
String mname = (String)m_enumerationNames.get(tname);
int split = mname.lastIndexOf('.');
ClassFile dcf =
ClassCache.getClassFile(mname.substring(0, split));
ClassItem dser =
dcf.getStaticMethod(mname.substring(split+1),
"(Ljava/lang/String;)");
if (dser == null || !tname.equals(dser.getTypeName())) {
throw new JiBXException("Deserializer method not " +
"found for enumeration class " + tname);
}
ValueElement value = new ValueElement();
value.setGetName(gname);
value.setSetName(sname);
value.setName(valueName(pname));
value.setUsageName("optional");
value.setStyleName("element");
value.setDeserializerName(mname);
contain.addChild(value);
} else if (m_mappedNames.get(tname) != null) {
// use mapping definition for class
StructureElement structure = new StructureElement();
structure.setUsageName("optional");
structure.setGetName(gname);
structure.setSetName(sname);
if (((String)m_mappedNames.get(tname)).length() == 0) {
// add a name for reference to abstract mapping
structure.setName(elementName(tname));
}
contain.addChild(structure);
if (m_verbose) {
nestingIndent(System.out);
System.out.println
("referenced existing binding for " + tname);
}
} else if (tname.endsWith("[]")) {
// array, only supported for mapped base type
String bname = tname.substring(0, tname.length()-2);
if (m_mappedNames.get(bname) == null) {
throw new JiBXException("Base element type " +
bname + " must be mapped");
} else {
StructureElement structure = new StructureElement();
structure.setUsageName("optional");
structure.setGetName(gname);
structure.setSetName(sname);
structure.setMarshallerName
("org.jibx.extras.TypedArrayMapper");
structure.setUnmarshallerName
("org.jibx.extras.TypedArrayMapper");
contain.addChild(structure);
}
} else {
// no defined handling, check collection vs. structure
ClassFile pcf = ClassCache.getClassFile(tname);
StructureElementBase element;
if (pcf.isImplements("Ljava/util/List;")) {
// create a collection for list subclass
System.err.println("Warning: property " + pname +
" requires mapped implementation of item " +
"classes");
element = new CollectionElement();
element.setComment(" add details of collection " +
"items to complete binding definition ");
element.setGetName(gname);
element.setSetName(sname);
// specify factory method if just typed as interface
if ("java.util.List".equals(tname)) {
element.setFactoryName("org.jibx.runtime." +
"Utility.arrayListFactory");
}
} else if (pcf.isInterface() ||
m_ignoreNames.contains(tname)) {
// mapping reference with warning for interface
nestingIndent(System.err);
System.err.println("Warning: reference to " +
"interface or abstract class " + tname +
" requires mapped implementation");
element = new StructureElement();
element.setGetName(gname);
element.setSetName(sname);
} else {
// handle other types of structures directly
element = createStructure(pcf, pname);
}
// finish with common handling
element.setUsageName("optional");
contain.addChild(element);
}
}
}
}
}
/**
* Construct the list of child binding components that define the binding
* structure corresponding to a particular class. This binds all
* non-final/non-static/non-transient fields of the class, if necessary
* creating nested structure elements for unmapped classes referenced by the
* fields.
*
* @param cf class information
* @param contain binding structure container element
* @throws JiBXException on error in binding generation
*/
private void defineStructure(ClassFile cf, ContainerElementBase contain)
throws JiBXException {
// process basic fields or property list
Object props = m_beanNames.get(cf.getName());
if (props == null) {
defineFields(cf, contain);
} else {
defineProperties(cf, (ArrayList)props, true, contain);
}
// check if superclass may have data for binding
ClassFile sf = cf.getSuperFile();
String sname = sf.getName();
if (!"java.lang.Object".equals(sname) &&
!m_ignoreNames.contains(sname)) {
if (m_mappedNames.get(sname) != null) {
StructureElement structure = new StructureElement();
structure.setMapAsName(sname);
structure.setName(elementName(sname));
contain.addChild(structure);
} else if (m_beanNames.get(sname) != null) {
defineProperties(sf, (ArrayList)m_beanNames.get(sname),
false, contain);
} else if (sf.getRawClass().getFields().length > 0) {
nestingIndent(System.err);
System.err.println("Warning: fields from base class " + sname +
" of class " + cf.getName() + " not handled by generated " +
"binding; use mapping or specify property list");
contain.setComment(" missing information for base class " +
sname + " ");
}
}
}
/**
* Create the structure element for a particular class. This maps all
* non-final/non-static/non-transient fields of the class, if necessary
* creating nested structures.
*
* @param cf class information
* @param fname name of field supplying reference
* @throws JiBXException on error in binding generation
*/
private StructureElement createStructure(ClassFile cf, String fname)
throws JiBXException {
JavaClass clas = cf.getRawClass();
if (m_verbose) {
nestingIndent(System.out);
System.out.println("creating nested structure definition for " +
clas.getClassName());
}
String cname = clas.getClassName();
for (int i = 0; i < m_structureStack.size(); i++) {
if (cname.equals(m_structureStack.peek(i))) {
StringBuffer buff =
new StringBuffer("Error: recursive use of ");
buff.append(cname);
buff.append(" requires :\n ");
while (i >= 0) {
buff.append(m_structureStack.peek(i--));
buff.append(" -> ");
}
buff.append(cname);
throw new JiBXException(buff.toString());
}
}
if (cname.startsWith("java.")) {
nestingIndent(System.err);
System.err.println("Warning: trying to create structure for " +
cname);
} else if (m_structureNames.contains(cname)) {
nestingIndent(System.err);
System.err.println("Warning: repeated usage of class " +
cname + "; consider adding to mapping list");
} else {
m_structureNames.add(cname);
}
m_structureStack.push(cname);
StructureElement element = new StructureElement();
element.setFieldName(fname);
element.setName(valueName(fname));
defineStructure(cf, element);
if (element.children().isEmpty()) {
throw new JiBXException("No content found for class " + cname);
}
m_structureStack.pop();
if (m_verbose) {
nestingIndent(System.out);
System.out.println("completed nested structure definition for " +
clas.getClassName());
}
return element;
}
/**
* Create the mapping element for a particular class. This maps all
* non-final/non-static/non-transient fields of the class, if necessary
* creating nested structures.
*
* @param cf class information
* @param abstr force abstract mapping flag
* @throws JiBXException on error in binding generation
*/
private MappingElement createMapping(ClassFile cf, boolean abstr)
throws JiBXException {
JavaClass clas = cf.getRawClass();
if (m_verbose) {
System.out.println("\nBuilding mapping definition for " +
clas.getClassName());
}
MappingElement element = new MappingElement();
element.setAbstract(abstr || clas.isAbstract() || clas.isInterface());
String name = clas.getClassName();
element.setClassName(name);
if (abstr) {
element.setAbstract(true);
} else {
element.setName((String)m_mappedNames.get(name));
}
m_structureStack.push(name);
defineStructure(cf, element);
m_structureStack.pop();
return element;
}
private static boolean isMappable(String cname) {
if ("java.lang.String".equals(cname)) {
return false;
} else if ("java.lang.Object".equals(cname)) {
return false;
} else if (ClassItem.isPrimitive(cname)) {
return false;
} else {
return !s_objectPrimitiveSet.contains(cname);
}
}
/**
* Get the set of data classes passed to or returned by a list of methods
* within a class. The classes returned exclude primitive types, wrappers,
* java.lang.String, and java.lang.Object.
* Exception classes thrown by the methods are also optionally accumulated.
*
* @param cname target class name
* @param mnames method names to be checked
* @param dataset set for accumulation of data classes (optional, data
* classes not recorded if null)
* @param exceptset set for accumulation of exception classes (optional,
* data classes not recorded if null)
* @throws JiBXException on error in loading class information
*/
public static void findClassesUsed(String cname, ArrayList mnames,
HashSet dataset, HashSet exceptset) throws JiBXException {
ClassFile cf = ClassCache.getClassFile(cname);
if (cf != null) {
for (int i = 0; i < mnames.size(); i++) {
String mname = (String)mnames.get(i);
ClassItem mitem = cf.getMethod(mname, "");
if (mitem == null) {
System.err.println("Method " + mname +
" not found in class " + cname);
} else {
if (dataset != null) {
String type = mitem.getTypeName();
if (type != null && isMappable(type)) {
dataset.add(type);
}
String[] args = mitem.getArgumentTypes();
for (int j = 0; j < args.length; j++) {
type = args[j];
if (isMappable(type)) {
dataset.add(args[j]);
}
}
}
if (exceptset != null) {
String[] excepts = mitem.getExceptions();
for (int j = 0; j < excepts.length; j++) {
exceptset.add(excepts[j]);
}
}
}
}
}
}
/**
* Generate a set of bindings using supplied classpaths and class names.
*
* @param names list of class names to be included in binding
* @param abstracts set of classes to be handled with abstract mappings in
* binding
* @param customs map of customized class names to marshaller/unmarshaller
* class names
* @param beans map of class names to supplied lists of properties
* @param enums map of typesafe enumeration classes to deserializer methods
* @param ignores list of non-interface classes to be treated as interfaces
* (no mapping, but mapped subclasses are used at runtime)
* @exception JiBXException if error in generating the binding definition
*/
public BindingElement generate(ArrayList names, HashSet abstracts,
HashMap customs, HashMap beans, HashMap enums, ArrayList ignores)
throws JiBXException {
// print current version information
System.out.println("Running binding generator version " +
CURRENT_VERSION);
// add all classes with mappings to tracking map
m_mappedNames.clear();
for (int i = 0; i < names.size(); i++) {
// make sure class can potentially be handled automatically
boolean drop = false;
String name = (String)names.get(i);
ClassFile cf = ClassCache.getClassFile(name);
if (cf.isImplements("Ljava/util/List;") ||
cf.isImplements("Ljava/util/Map;")) {
System.err.println("Warning: referenced class " + name +
" is a collection class that cannot be mapped " +
"automatically; dropped from mapped list in binding");
drop = true;
} else if (cf.isInterface()) {
System.err.println("Warning: interface " + name +
" is being handled as abstract mapping");
abstracts.add(name);
drop = true;
} else if (cf.isAbstract()) {
System.err.println("Warning: mapping abstract class " + name +
"; make sure actual subclasses are mapped as extending " +
"this abstract mapping");
abstracts.add(name);
drop = true;
}
if (drop) {
names.remove(i--);
} else {
m_mappedNames.put(name, elementName(name));
}
}
for (Iterator iter = abstracts.iterator(); iter.hasNext();) {
m_mappedNames.put((String)iter.next(), "");
}
for (Iterator iter = customs.keySet().iterator(); iter.hasNext();) {
String name = (String)iter.next();
m_mappedNames.put(name, elementName(name));
}
// create set for ignores
m_ignoreNames.clear();
m_ignoreNames.addAll(ignores);
// create binding with optional namespace
BindingElement binding = new BindingElement();
binding.setStyleName("attribute");
if (m_namespaceUri != null) {
NamespaceElement namespace = new NamespaceElement();
namespace.setComment(" namespace for all elements of binding ");
namespace.setDefaultName("elements");
namespace.setUri(m_namespaceUri);
binding.addTopChild(namespace);
}
// add mapping for each specified class
m_structureStack.clear();
m_structureNames.clear();
m_beanNames = beans;
m_enumerationNames = enums;
for (int i = 0; i < names.size(); i++) {
String cname = (String)names.get(i);
if (!abstracts.contains(cname)) {
ClassFile cf = ClassCache.getClassFile(cname);
MappingElement mapping = createMapping(cf, false);
mapping.setComment(" generated mapping for class " + cname);
binding.addTopChild(mapping);
}
}
for (Iterator iter = abstracts.iterator(); iter.hasNext();) {
String cname = (String)iter.next();
ClassFile cf = ClassCache.getClassFile(cname);
MappingElement mapping = createMapping(cf, true);
mapping.setComment(" generate abstract mapping for class " + cname);
binding.addTopChild(mapping);
}
// finish with custom mapping definitions
for (Iterator iter = customs.keySet().iterator(); iter.hasNext();) {
String cname = (String)iter.next();
String mname = (String)customs.get(cname);
MappingElement mapping = new MappingElement();
mapping.setComment(" specified mapping for class " + cname);
mapping.setClassName(cname);
mapping.setName((String)m_mappedNames.get(cname));
mapping.setMarshallerName(mname);
mapping.setUnmarshallerName(mname);
binding.addTopChild(mapping);
}
// list classes handled if verbose
if (m_verbose) {
for (int i = 0; i < names.size(); i++) {
m_structureNames.add(names.get(i));
}
m_structureNames.addAll(customs.keySet());
String[] classes = (String[])m_structureNames.
toArray(new String[m_structureNames.size()]);
Arrays.sort(classes);
System.out.println("\nClasses included in binding:");
for (int i = 0; i < classes.length; i++) {
System.out.println(" " + classes[i]);
}
}
return binding;
}
/**
* Main method for running compiler as application.
*
* @param args command line arguments
*/
public static void main(String[] args) {
if (args.length > 0) {
try {
// check for various flags set
boolean mixed = false;
boolean verbose = false;
String uri = null;
String fname = "binding.xml";
ArrayList paths = new ArrayList();
HashMap enums = new HashMap();
HashSet abstracts = new HashSet();
ArrayList ignores = new ArrayList();
HashMap customs = new HashMap();
HashMap beans = new HashMap();
int offset = 0;
for (; offset < args.length; offset++) {
String arg = args[offset];
if ("-v".equalsIgnoreCase(arg)) {
verbose = true;
} else if ("-b".equalsIgnoreCase(arg)) {
String plist = args[++offset];
int split = plist.indexOf("=");
String bname = plist.substring(0, split);
ArrayList props = new ArrayList();
int base = ++split;
while ((split = plist.indexOf(',', split)) >= 0) {
props.add(plist.substring(base, split));
base = ++split;
}
props.add(plist.substring(base));
beans.put(bname, props);
} else if ("-c".equalsIgnoreCase(arg)) {
String custom = args[++offset];
int split = custom.indexOf('=');
if (split > 0) {
customs.put(custom.substring(0, split),
custom.substring(split+1));
} else {
System.err.println
("Unable to interpret customization " + custom);
}
} else if ("-e".equalsIgnoreCase(arg)) {
String cname;
String mname;
String enumf = args[++offset];
int split = enumf.indexOf('=');
if (split > 0) {
cname = enumf.substring(0, split);
mname = enumf.substring(split+1);
if (mname.indexOf('.') < 0) {
mname = cname + '.' + mname;
}
} else {
cname = enumf;
split = cname.lastIndexOf('.');
if (split >= 0) {
mname = cname + '.' + "get" +
cname.substring(split+1);
} else {
mname = cname + '.' + "get" + cname;
}
}
enums.put(cname, mname);
} else if ("-i".equalsIgnoreCase(arg)) {
ignores.add(args[++offset]);
} else if ("-m".equalsIgnoreCase(arg)) {
mixed = true;
} else if ("-f".equalsIgnoreCase(arg)) {
fname = args[++offset];
} else if ("-n".equalsIgnoreCase(arg)) {
uri = args[++offset];
} else if ("-p".equalsIgnoreCase(arg)) {
paths.add(args[++offset]);
} else if ("-a".equalsIgnoreCase(arg)) {
abstracts.add(args[++offset]);
} else {
break;
}
}
// set up path and binding lists
String[] vmpaths = Utility.getClassPaths();
for (int i = 0; i < vmpaths.length; i++) {
paths.add(vmpaths[i]);
}
ArrayList names = new ArrayList();
for (int i = offset; i < args.length; i++) {
if (!abstracts.contains(args[i])) {
names.add(args[i]);
}
}
// report on the configuration
if (verbose) {
System.out.println("Using paths:");
for (int i = 0; i < paths.size(); i++) {
System.out.println(" " + paths.get(i));
}
System.out.println("Using class names:");
for (int i = 0; i < names.size(); i++) {
System.out.println(" " + names.get(i));
}
if (abstracts.size() > 0) {
System.out.println("Using abstract class names:");
for (Iterator iter = abstracts.iterator();
iter.hasNext();) {
System.out.println(" " + iter.next());
}
}
if (customs.size() > 0) {
System.out.println
("Using custom marshaller/unmarshallers:");
Iterator iter = customs.keySet().iterator();
while (iter.hasNext()) {
String key = (String)iter.next();
System.out.println(" " + customs.get(key) +
" for " + key);
}
}
if (beans.size() > 0) {
System.out.println("Using bean property lists:");
Iterator iter = beans.keySet().iterator();
while (iter.hasNext()) {
String key = (String)iter.next();
System.out.print(" " + key + " with properties:");
ArrayList props = (ArrayList)beans.get(key);
for (int i = 0; i < props.size(); i++) {
System.out.print(i > 0 ? ", " : " ");
System.out.print(props.get(i));
}
}
}
if (enums.size() > 0) {
System.out.println("Using enumeration classes:");
Iterator iter = enums.keySet().iterator();
while (iter.hasNext()) {
String key = (String)iter.next();
System.out.println(" " + key +
" with deserializer " + enums.get(key));
}
}
}
// set paths to be used for loading referenced classes
String[] parray =
(String[])paths.toArray(new String[paths.size()]);
ClassCache.setPaths(parray);
ClassFile.setPaths(parray);
// generate the binding
BindingGenerator generate =
new BindingGenerator(verbose, mixed, uri);
BindingElement binding = generate.generate(names, abstracts,
customs, beans, enums, ignores);
// marshal binding out to file
IBindingFactory bfact =
BindingDirectory.getFactory(BindingElement.class);
IMarshallingContext mctx = bfact.createMarshallingContext();
mctx.setIndent(2);
mctx.marshalDocument(binding, "UTF-8", null,
new FileOutputStream(fname));
} catch (JiBXException ex) {
ex.printStackTrace(System.out);
System.exit(1);
} catch (FileNotFoundException e) {
e.printStackTrace(System.out);
System.exit(2);
}
} else {
System.out.println
("\nUsage: java org.jibx.binding.BindingGenerator [options] " +
"class1 class2 ...\nwhere options are:\n -a abstract class\n" +
" -b bean property class,\n -c custom mapped class,\n" +
" -e enumeration class,\n -f binding file name,\n" +
" -i ignore class,\n -m use mixed case XML names (instead " +
"of hyphenated),\n -n namespace URI,\n -p class " +
"loading path component,\n -v turns on verbose output\n" +
"The class# files are different classes to be included in " +
"binding (references from\nthese classes will also be " +
"included).\n");
System.exit(1);
}
}
}
libjibx-java-1.1.6a/build/src/org/jibx/binding/Compile.java 0000644 0001750 0001750 00000040030 10525417720 023360 0 ustar moeller moeller /*
Copyright (c) 2003-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.net.URLClassLoader;
import org.apache.bcel.classfile.Method;
import org.apache.bcel.verifier.VerificationResult;
import org.apache.bcel.verifier.Verifier;
import org.apache.bcel.verifier.VerifierFactory;
import org.jibx.binding.classes.BoundClass;
import org.jibx.binding.classes.BranchWrapper;
import org.jibx.binding.classes.ClassCache;
import org.jibx.binding.classes.ClassFile;
import org.jibx.binding.classes.MungedClass;
import org.jibx.binding.def.BindingDefinition;
import org.jibx.runtime.JiBXException;
/**
* Binding compiler. This version checks the modified and generated classes
* by loading them and listing method information.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class Compile
{
private boolean m_verbose;
private boolean m_load;
private boolean m_verify;
private boolean m_trackBranches;
private boolean m_errorOverride;
private boolean m_skipValidate;
/**
* Default constructor. This just initializes all options disabled.
*/
public Compile() {}
/**
* Constructor with settings specified.
*
* @param verbose report binding details and results
* @param load test load modified classes to validate
* @param verify use BCEL validation of modified classes
* @param track keep tracking information for source of branch generation
* @param over override code generation error handling
*/
public Compile(boolean verbose, boolean load, boolean verify,
boolean track, boolean over) {
m_verbose = verbose;
m_load = load;
m_verify = verify;
m_trackBranches = track;
m_errorOverride = over;
}
/**
* Verify generated and modified files using BCEL verifier. This provides a
* more comprehensive listing of errors than just loading a class in the
* JVM.
*
* @param file information for class to be verified
* @return true if successfully verified, false if
* problem found (automatically reported)
*/
private boolean verifyBCEL(ClassFile file) {
try {
// construct verifier for class file
Verifier verifier = VerifierFactory.getVerifier(file.getName());
// run validation in stages with error handling for each stage
boolean verified = false;
VerificationResult vr = verifier.doPass1();
if (vr.getStatus() == VerificationResult.VERIFIED_OK) {
vr = verifier.doPass2();
if (vr.getStatus() == VerificationResult.VERIFIED_OK) {
Method[] methods = file.getRawClass().getMethods();
for (int j = 0; j < methods.length; j++) {
vr = verifier.doPass3a(j);
if (vr.getStatus() == VerificationResult.VERIFIED_OK) {
vr = verifier.doPass3b(j);
}
if (vr.getStatus() == VerificationResult.VERIFIED_OK) {
verified = true;
} else {
System.out.println
("Verification failure on method " +
methods[j].getName() + " of class " +
file.getName() + ":");
System.out.println(" " + vr.toString());
}
}
} else {
System.out.println("Verification failure on class " +
file.getName() + ":");
System.out.println(" " + vr.toString());
}
} else {
System.out.println("Verification failure on class " +
file.getName() + ":");
System.out.println(" " + vr.toString());
}
return verified;
} catch (Exception ex) { // catch BCEL errors
System.out.println("BCEL failure:");
ex.printStackTrace();
return false;
}
}
/**
* Output all generated and modified class files. Writes the actual files,
* and optionally verifies and/or reports the changes.
*
* @param paths array of paths used for loading files
* @exception JiBXException if error in processing the binding definition
* @exception IOException if path cannot be accessed
*/
private void handleOutput(String[] paths)
throws JiBXException, IOException {
// output the modified class files
ClassFile[][] lists = MungedClass.fixChanges(true);
// report modified file results to user
ClassFile[] files = lists[0];
if (m_verbose) {
System.out.println("\nWrote " + files.length + " files");
}
if (m_verbose || m_load) {
// generate class paths as URLs if needed for test loading
URL[] urls = null;
if (m_load) {
urls = new URL[paths.length];
for (int i = 0; i < urls.length; i++) {
urls[i] = new File(paths[i]).toURL();
}
}
for (int i = 0; i < files.length; i++) {
// write class file to bytes
ClassFile file = files[i];
ByteArrayOutputStream bos = new ByteArrayOutputStream();
file.writeFile(bos);
byte[] bytes = bos.toByteArray();
if(m_verbose){
System.out.println("\n " + file.getName() +
" output file size is " + bytes.length + " bytes");
}
// verify using BCEL verifier
if (m_verify) {
verifyBCEL(file);
}
// load to JVM and list method information from class
if (m_load) {
DirectLoader cloader = new DirectLoader(urls);
Class clas = cloader.load(file.getName(), bytes);
if (m_verbose) {
java.lang.reflect.Method[] methods =
clas.getDeclaredMethods();
System.out.println(" Found " + methods.length +
" methods:");
for (int j = 0; j < methods.length; j++) {
java.lang.reflect.Method method = methods[j];
System.out.println(" " +
method.getReturnType().getName() + " " +
method.getName());
}
}
}
}
}
// report summary information for files unchanged or deleted
if (m_verbose) {
files = lists[1];
System.out.println("\nKept " + files.length + " files unchanged:");
for (int i = 0; i < files.length; i++) {
System.out.println(" " + files[i].getName());
}
files = lists[2];
System.out.println("\nDeleted " + files.length + " files:");
for (int i = 0; i < files.length; i++) {
System.out.println(" " + files[i].getName());
}
}
}
/**
* Set control flag for test loading generated/modified classes.
*
* @param load test load generated/modified classes flag
*/
public void setLoad(boolean load) {
m_load = load;
}
/**
* Set control flag for verbose processing reports.
*
* @param verbose report verbose information in processing bindings flag
*/
public void setVerbose(boolean verbose) {
m_verbose = verbose;
}
/**
* Set control flag for verifying generated/modified classes with BCEL.
*
* @param verify use BCEL verification for generated/modified classes flag
*/
public void setVerify(boolean verify) {
m_verify = verify;
}
/**
* Set control flag for skipping binding validation. This flag is intended
* only for use while processing the binding model components within JiBX.
* Otherwise it'd be impossible to correct errors in the binding validation.
*
* @param skip test load generated/modified classes flag
*/
public void setSkipValidate(boolean skip) {
m_skipValidate = skip;
}
/**
* Compile a set of bindings using supplied classpaths.
*
* @param paths list of paths for loading classes
* @param files list of binding definition files
* @exception JiBXException if error in processing the binding definition
*/
public void compile(String[] paths, String[] files) throws JiBXException {
try {
// include current version information in verbose output
if (m_verbose) {
System.out.println("Running binding compiler version " +
BindingDefinition.CURRENT_VERSION_NAME);
}
// set paths to be used for loading referenced classes
ClassCache.setPaths(paths);
ClassFile.setPaths(paths);
// reset static information accumulation for binding
BoundClass.reset();
MungedClass.reset();
BindingDefinition.reset();
BranchWrapper.setTracking(m_trackBranches);
BranchWrapper.setErrorOverride(m_errorOverride);
// load all supplied bindings
BindingDefinition[] defs = new BindingDefinition[files.length];
for (int i = 0; i < files.length; i++) {
defs[i] = Utility.loadFileBinding(files[i], !m_skipValidate);
if (m_verbose) {
defs[i].print();
}
}
// modify the class files with JiBX hooks
for (int i = 0; i < defs.length; i++) {
try {
defs[i].generateCode(m_verbose);
} catch (RuntimeException e) {
throw new JiBXException
("\n*** Error during code generation for file '" +
files[i] + "' - please enter a bug report for this " +
"error in Jira if the problem is not listed as fixed " +
"on the online status page ***\n", e);
}
}
// handle file and reporting output
handleOutput(paths);
} catch (IOException ex) {
throw new JiBXException("IOException in compile", ex);
} catch (ExceptionInInitializerError ex) {
throw new JiBXException("Error during initialization;" +
" is jibx-run.jar in load classpath?", ex.getException());
} catch (Throwable ex) {
throw new JiBXException("Error running binding compiler", ex);
}
}
/**
* Main method for running compiler as application.
*
* @param args command line arguments
*/
public static void main(String[] args) {
if (args.length > 0) {
try {
// check for various flags set
boolean verbose = false;
boolean load = false;
boolean verify = false;
boolean track = false;
boolean over = false;
boolean skip = false;
int offset = 0;
for (; offset < 5 && offset < args.length; offset++) {
String arg = args[offset];
if ("-v".equalsIgnoreCase(arg)) {
verbose = true;
} else if ("-l".equalsIgnoreCase(arg)) {
load = true;
} else if ("-b".equalsIgnoreCase(arg)) {
verify = true;
} else if ("-o".equalsIgnoreCase(arg)) {
over = true;
} else if ("-s".equalsIgnoreCase(arg)) {
skip = true;
} else if ("-t".equalsIgnoreCase(arg)) {
track = true;
} else {
break;
}
}
// set up path and binding lists
String[] clsspths = Utility.getClassPaths();
String[] bindings = new String[args.length - offset];
System.arraycopy(args, offset, bindings, 0, bindings.length);
// report on the configuration
if (verbose) {
System.out.println("Using paths:");
for (int i = 0; i < clsspths.length; i++) {
System.out.println(" " + clsspths[i]);
}
System.out.println("Using bindings:");
for (int i = 0; i < bindings.length; i++) {
System.out.println(" " + bindings[i]);
}
}
// compile the bindings
Compile compiler =
new Compile(verbose, load, verify, track, over);
compiler.setSkipValidate(skip);
compiler.compile(clsspths, bindings);
} catch (JiBXException ex) {
ex.printStackTrace(System.out);
System.exit(1);
}
} else {
System.out.println
("\nUsage: java org.jibx.binding.Compile [-b] [-l] [-v] " +
"binding1 binding2 ...\nwhere:\n -b turns on BCEL " +
"verification (debug option),\n -l turns on test loading of " +
"modified or generated classes for validation, and\n" +
" -v turns on verbose output\nThe bindingn files are " +
"different bindings to be compiled.\n");
System.exit(1);
}
}
/**
* Direct class loader. This is optionally used for test loading the
* modified class files to make sure they're still valid.
*/
private static class DirectLoader extends URLClassLoader
{
protected DirectLoader(URL[] urls) {
super(urls, DirectLoader.class.getClassLoader());
}
protected Class load(String name, byte[] data) {
return defineClass(name, data, 0, data.length);
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/Loader.java 0000644 0001750 0001750 00000032275 10447002710 023202 0 ustar moeller moeller /*
Copyright (c) 2003-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.ArrayList;
import java.util.HashMap;
import org.jibx.binding.classes.BoundClass;
import org.jibx.binding.classes.ClassCache;
import org.jibx.binding.classes.ClassFile;
import org.jibx.binding.classes.MungedClass;
import org.jibx.binding.def.BindingDefinition;
import org.jibx.runtime.JiBXException;
/**
* Binding classloader. This is intended to substitute for the System
* classloader (i.e., the one used for loading user classes). It first processes
* one or more binding definitions, caching the binary classes modified by the
* bindings. It then uses these modified forms of the classes when they're
* requested for loading.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class Loader extends URLClassLoader
{
/** Binding definitions used by loader. */
private ArrayList m_bindings;
/** Flag for bindings compiled into class code. */
private boolean m_isBound;
/** Map of classes modified by binding. */
private HashMap m_classMap;
/**
* Constructor with classpath URLs and parent classloader supplied. Sets up
* the paths for both actual classloading and finding classes to be bound.
*
* @param paths array of classpath URLs
* @param parent classloader used for delegation loading
*/
public Loader(URL[] paths, ClassLoader parent) {
// configure the base class
super(paths, parent);
m_bindings = new ArrayList();
m_classMap = new HashMap();
// find all the file URLs in path
ArrayList fpaths = new ArrayList(paths.length);
for (int i = 0; i < paths.length; i++) {
URL path = paths[i];
if ("file".equals(path.getProtocol())) {
fpaths.add(path.getPath());
}
}
// set paths to be used for loading referenced classes
String[] dirs = (String[])fpaths.toArray(new String[0]);
ClassCache.setPaths(dirs);
ClassFile.setPaths(dirs);
// reset static information accumulation for binding
BoundClass.reset();
MungedClass.reset();
BindingDefinition.reset();
}
/**
* Constructor with classpath URLs supplied. This uses the supplied
* classpaths, delegating directly to the parent classloader of the normal
* System classloader.
*
* @param paths array of classpath URLs
*/
public Loader(URL[] paths) {
this(paths, ClassLoader.getSystemClassLoader().getParent());
}
/**
* Default constructor. This reads the standard class path and uses it for
* locating classes used by the binding, delegating directly to the parent
* classloader of the normal System classloader.
*
* @exception MalformedURLException on error in classpath URLs
*/
public Loader() throws MalformedURLException {
this(getClassPaths());
}
/**
* Reset loader information. This discards all prior bindings and clears the
* internal state in preparation for loading a different set of bindings. It
* is not possible to clear the loaded classes, though, so any new bindings
* must refer to different classes from those previously loaded.
*/
public void reset() {
m_bindings.clear();
m_classMap.clear();
m_isBound = false;
BoundClass.reset();
MungedClass.reset();
BindingDefinition.reset();
}
/**
* Method builds an array of URL for items in the class path.
*
* @return array of classpath URLs
*/
public static URL[] getClassPaths() throws MalformedURLException {
String[] paths = Utility.getClassPaths();
URL[] urls = new URL[paths.length];
for (int i = 0; i < urls.length; i++) {
urls[i] = new File(paths[i]).toURL();
}
return urls;
}
/**
* Load binding definition. This may be called multiple times to load
* multiple bindings, but only prior to the bindings being compiled. The
* reader form of the call is generally preferred, since the document
* encoding may not be properly interpreted from a stream.
*
* @param fname binding definition full name
* @param sname short form of name to use as the default name of the binding
* @param is input stream for binding definition document
* @param url URL for binding definition (null if not
* available)
* @exception IllegalStateException if called after bindings have been
* compiled
* @exception IOException if error reading the binding
* @exception JiBXException if error in processing the binding definition
*/
public void loadBinding(String fname, String sname, InputStream is, URL url)
throws JiBXException, IOException {
// error if called after bindings have been compiled
if (m_isBound) {
throw new IllegalStateException
("Call not allowed after bindings compiled");
} else {
m_bindings.add(Utility.loadBinding(fname, sname, is, url, true));
}
}
/**
* Load binding definition from file path. This may be called multiple times
* to load multiple bindings, but only prior to the bindings being compiled.
*
* @param path binding definition file path
* @exception IllegalStateException if called after bindings have been
* compiled
* @exception IOException if error reading the file
* @exception JiBXException if error in processing the binding definition
*/
public void loadFileBinding(String path) throws JiBXException, IOException {
// error if called after bindings have been compiled
if (m_isBound) {
throw new IllegalStateException
("Call not allowed after bindings compiled");
} else {
m_bindings.add(Utility.loadFileBinding(path, true));
}
}
/**
* Load binding definition from file path. This may be called multiple times
* to load multiple bindings, but only prior to the bindings being compiled.
*
* @param path binding definition file path
* @exception IllegalStateException if called after bindings have been
* compiled
* @exception IOException if error reading the file
* @exception JiBXException if error in processing the binding definition
*/
public void loadResourceBinding(String path)
throws JiBXException, IOException {
// error if called after bindings have been compiled
if (m_isBound) {
throw new IllegalStateException
("Call not allowed after bindings compiled");
} else {
String fname = path;
int split = fname.lastIndexOf('/');
if (split >= 0) {
fname = fname.substring(split+1);
}
String sname = fname;
split = sname.lastIndexOf('.');
if (split >= 0) {
sname = sname.substring(0, split);
}
sname = Utility.convertName(sname);
InputStream is = getResourceAsStream(path);
if (is == null) {
throw new IOException("Resource " + path + " not found");
} else {
loadBinding(fname, sname, is, null);
}
}
}
/**
* Process the binding definitions. This compiles the bindings into the
* classes, saving the modified classes for loading when needed.
*
* @exception JiBXException if error in processing the binding definition
*/
public void processBindings() throws JiBXException {
if (!m_isBound) {
// handle code generation from bindings
int count = m_bindings.size();
for (int i = 0; i < count; i++) {
BindingDefinition binding =
(BindingDefinition)m_bindings.get(i);
binding.generateCode(false);
}
// build hashmap of modified classes
ClassFile[][] lists = MungedClass.fixChanges(false);
count = lists[0].length;
for (int i = 0; i < count; i++) {
ClassFile clas = lists[0][i];
m_classMap.put(clas.getName(), clas);
}
// finish by setting flag for binding done
m_isBound = true;
}
}
/**
* Check if a class has been modified by a binding. If bindings haven't been
* compiled prior to this call they will be compiled automatically when this
* method is called.
*
* @param name fully qualified package and class name to be found
* @return true if class modified by binding,
* false if not
*/
protected boolean isBoundClass(String name) {
// first complete binding processing if not already done
if (!m_isBound) {
try {
processBindings();
} catch (JiBXException e) {
e.printStackTrace();
}
}
return m_classMap.containsKey(name);
}
/**
* Find and load class by name. If the named class has been modified by a
* binding this loads the modified binary class; otherwise, it just uses the
* base class implementation to do the loading. If bindings haven't been
* compiled prior to this call they will be compiled automatically when this
* method is called.
* @see java.lang.ClassLoader#findClass(java.lang.String)
*
* @param name fully qualified package and class name to be found
* @return the loaded class
* @throws ClassNotFoundException if the class cannot be found
*/
protected Class findClass(String name) throws ClassNotFoundException {
// check if class has been modified by binding
if (isBoundClass(name)) {
try {
// convert class information to byte array
ClassFile clas = (ClassFile)m_classMap.get(name);
ByteArrayOutputStream bos = new ByteArrayOutputStream();
clas.writeFile(bos);
byte[] bytes = bos.toByteArray();
return defineClass(name, bytes, 0, bytes.length);
} catch (IOException e) {
throw new ClassNotFoundException
("Unable to load modified class " + name);
}
} else {
// just use base class handling
return super.findClass(name);
}
}
/**
* Version of bind-on-demand loader which will not delegate handling of
* classes included in the binding definition. Somewhat dangerous to use,
* since it may result in loading multiple versions of the same class
* (with and without binding).
*/
public static class NondelegatingLoader extends Loader
{
/**
* @throws MalformedURLException
*/
public NondelegatingLoader() throws MalformedURLException {
super(getClassPaths(), ClassLoader.getSystemClassLoader());
}
/* (non-Javadoc)
* @see java.lang.ClassLoader#loadClass(java.lang.String, boolean)
*/
protected synchronized Class loadClass(String name, boolean resolve) throws ClassNotFoundException {
if (isBoundClass(name)) {
Class clas = findLoadedClass(name);
if (clas == null) {
clas = findClass(name);
}
return clas;
} else {
return super.loadClass(name, resolve);
}
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/Run.java 0000644 0001750 0001750 00000022232 10347114742 022540 0 ustar moeller moeller /*
Copyright (c) 2003-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding;
import java.io.BufferedReader;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.ArrayList;
import org.jibx.runtime.JiBXException;
/**
* Bind-on-load class runner. This uses a binding loader to compile a binding,
* then loads and calls the main execution class for an application substituting
* the classes modified by the binding.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class Run
{
private static final String BINDING_LIST_RESOURCE = "jibx_bindings.txt";
private static final String DEFAULT_BINDING_RESOURCE = "jibx_binding.xml";
private Run() {}
/**
* Accumulate list of bindings from stream.
*
* @param is stream to be read for list of bindings (one per line)
* @param bindings accumulated collection of bindings
*/
private static void addBindings(InputStream is, ArrayList bindings)
throws IOException {
BufferedReader rdr = new BufferedReader(new InputStreamReader(is));
String line;
while ((line = rdr.readLine()) != null) {
if (line.length() > 0) {
bindings.add(line);
}
}
}
/**
* Main method for bind-on-load handling.
*
* @param args command line arguments
*/
public static void main(String[] args) {
if (args.length >= 1) {
try {
// first get binding definitions and target class information
ArrayList files = new ArrayList();
ArrayList resources = new ArrayList();
int index = 0;
String target = null;
while (index < args.length) {
String arg = args[index++];
if ("-b".equals(arg)) {
if (index < args.length) {
files.add(args[index++]);
} else {
System.err.println("Missing binding file and " +
"target class following '-b'");
}
} else if ("-l".equals(arg)) {
if (index < args.length) {
FileInputStream is =
new FileInputStream(args[index++]);
addBindings(is, files);
is.close();
} else {
System.err.println("Missing binding list file " +
"and target class following '-l'");
}
} else if ("-r".equals(arg)) {
if (index < args.length) {
resources.add(args[index++]);
} else {
System.err.println("Missing binding resource and " +
"target class following '-r'");
}
} else {
target = arg;
break;
}
}
// make sure we have a target class name
if (target != null) {
// save class name and create loader
Loader loader = new Loader();
// check binding resources if no specified bindings
if (files.size() == 0 && resources.size() == 0) {
InputStream is =
loader.getResourceAsStream(BINDING_LIST_RESOURCE);
if (is == null) {
String name = target.replace('.', '/') + "_" +
BINDING_LIST_RESOURCE;
is = loader.getResourceAsStream(name);
}
if (is != null) {
addBindings(is, resources);
is.close();
} else {
String name = DEFAULT_BINDING_RESOURCE;
is = loader.getResourceAsStream(name);
if (is == null) {
name = target.replace('.', '/') + "_" +
DEFAULT_BINDING_RESOURCE;
is = loader.getResourceAsStream(name);
}
if (is != null) {
resources.add(name);
is.close();
}
}
}
// make sure at least one binding has been specified
if (files.size() == 0 && resources.size() == 0) {
System.err.println("No bindings found");
} else {
// compile all bindings
for (int i = 0; i < files.size(); i++) {
loader.loadFileBinding((String)files.get(i));
}
for (int i = 0; i < resources.size(); i++) {
String path = (String)resources.get(i);
String fname = Utility.fileName(path);
String bname = fname;
int split = bname.indexOf('.');
if (split >= 0) {
bname = bname.substring(0, split);
}
InputStream is = loader.getResourceAsStream(path);
if (is == null) {
throw new IOException("Resource " + path +
" not found on classpath");
}
loader.loadBinding(fname,
Utility.convertName(bname), is, null);
}
loader.processBindings();
// load the target class using custom class loader
Class clas = loader.loadClass(target);
// invoke the "main" method of the application class
Class[] ptypes = new Class[] { args.getClass() };
Method main = clas.getDeclaredMethod("main", ptypes);
String[] pargs = new String[args.length-index];
System.arraycopy(args, index, pargs, 0, pargs.length);
Thread.currentThread().setContextClassLoader(loader);
main.invoke(null, new Object[] { pargs });
}
}
} catch (ClassNotFoundException e) {
e.printStackTrace();
} catch (NoSuchMethodException e) {
e.printStackTrace();
} catch (IllegalArgumentException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
} catch (InvocationTargetException e) {
e.printStackTrace();
} catch (JiBXException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
} else {
System.out.println
("Usage: org.jibx.binding.Run [-b binding-file][-l list-file]" +
"[-r binding-resource] main-class args...");
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/binding/SchemaGenerator.java 0000644 0001750 0001750 00000120276 11005500414 025035 0 ustar moeller moeller /*
Copyright (c) 2004-2008, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.FactoryConfigurationError;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.Result;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.TransformerFactoryConfigurationError;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import org.jibx.binding.classes.ClassCache;
import org.jibx.binding.classes.ClassFile;
import org.jibx.binding.model.BindingElement;
import org.jibx.binding.model.ClassWrapper;
import org.jibx.binding.model.CollectionElement;
import org.jibx.binding.model.ContainerElementBase;
import org.jibx.binding.model.DefinitionContext;
import org.jibx.binding.model.ElementBase;
import org.jibx.binding.model.IClass;
import org.jibx.binding.model.IClassLocator;
import org.jibx.binding.model.MappingElement;
import org.jibx.binding.model.NestingAttributes;
import org.jibx.binding.model.NestingElementBase;
import org.jibx.binding.model.StructureElement;
import org.jibx.binding.model.StructureElementBase;
import org.jibx.binding.model.TemplateElementBase;
import org.jibx.binding.model.ValidationContext;
import org.jibx.binding.model.ValidationProblem;
import org.jibx.binding.model.ValueElement;
import org.jibx.binding.util.ObjectStack;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.ValidationException;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
/**
* Binding generator. This loads the specified input classes and processes them
* to generate a default binding definition.
*
* @author Dennis M. Sosnoski
*/
public class SchemaGenerator
{
/** Generator version. */
private static String CURRENT_VERSION = "0.4";
/** Schema namespace URI. */
private static final String XSD_URI = "http://www.w3.org/2001/XMLSchema";
/** Fixed XML namespace. */
public static final String XML_URI = "http://www.w3.org/XML/1998/namespace";
/** Fixed XML namespace namespace. */
public static final String XMLNS_URI = "http://www.w3.org/2000/xmlns/";
/** Set of object types mapped to schema types. */
private static HashMap s_objectTypeMap = new HashMap();
static {
s_objectTypeMap.put("java.lang.Boolean", "xsd:boolean");
s_objectTypeMap.put("java.lang.Byte", "xsd:byte");
s_objectTypeMap.put("java.lang.Char", "xsd:unsignedInt");
s_objectTypeMap.put("java.lang.Double", "xsd:double");
s_objectTypeMap.put("java.lang.Float", "xsd:float");
s_objectTypeMap.put("java.lang.Integer", "xsd:int");
s_objectTypeMap.put("java.lang.Long", "xsd:long");
s_objectTypeMap.put("java.lang.Short", "xsd:short");
s_objectTypeMap.put("java.math.BigDecimal", "xsd:decimal");
s_objectTypeMap.put("java.math.BigInteger", "xsd:integer");
//#!j2me{
s_objectTypeMap.put("java.sql.Date", "xsd:date");
s_objectTypeMap.put("java.sql.Time", "xsd:time");
s_objectTypeMap.put("java.sql.Timestamp", "xsd:dateTime");
//#j2me}
s_objectTypeMap.put("java.util.Date", "xsd:dateTime");
s_objectTypeMap.put("byte[]", "xsd:base64");
}
/** Set of primitive types mapped to schema types. */
private static HashMap s_primitiveTypeMap = new HashMap();
static {
s_primitiveTypeMap.put("boolean", "xsd:boolean");
s_primitiveTypeMap.put("byte", "xsd:byte");
s_primitiveTypeMap.put("char", "xsd:unsignedInt");
s_primitiveTypeMap.put("double", "xsd:double");
s_primitiveTypeMap.put("float", "xsd:float");
s_primitiveTypeMap.put("int", "xsd:int");
s_primitiveTypeMap.put("long", "xsd:long");
s_primitiveTypeMap.put("short", "xsd:short");
}
/** Show verbose output flag. */
private boolean m_verbose;
/** Use qualified elements default in schema flag. */
private boolean m_isElementQualified;
/** Use qualified attributes default in schema flag. */
private boolean m_isAttributeQualified;
/** Indentation sequence per level of nesting. */
private String m_indentSequence;
/** Map from namespaces to schemas. */
private HashMap m_schemaMap;
/** Locator for finding classes referenced by binding. */
private IClassLocator m_classLocator;
/** Document used for all schema definitions. */
private Document m_document;
/** Stack of structure definitions in progress (used to detect cycles). */
private ObjectStack m_structureStack;
/**
* Constructor with only paths supplied. This just initializes all other
* options disabled.
*
* @param paths class paths to be checked for classes referenced by bindings
*/
public SchemaGenerator(ArrayList paths) {
m_structureStack = new ObjectStack();
m_schemaMap = new HashMap();
// set paths to be used for loading referenced classes
String[] parray = (String[])paths.toArray(new String[paths.size()]);
ClassCache.setPaths(parray);
ClassFile.setPaths(parray);
// set class locator
m_classLocator = new IClassLocator() {
public IClass getClassInfo(String name) {
try {
return new ClassWrapper(this, ClassCache.getClassFile(name));
} catch (JiBXException e) {
throw new IllegalStateException("Class not found " + name);
}
}
};
try {
// create the document used for all schemas
DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
dbf.setNamespaceAware(true);
m_document = dbf.newDocumentBuilder().newDocument();
} catch (ParserConfigurationException e) {
throw new IllegalStateException("Parser configuration error " +
e.getMessage());
} catch (FactoryConfigurationError e) {
throw new IllegalStateException("Factory configuration error " +
e.getMessage());
}
}
/**
* Constructor with settings specified.
*
* @param verbose report binding details and results
* @param equal use element form default qualified flag
* @param aqual use attribute form default qualified flag
* @param paths class paths to be checked for classes referenced by bindings
*/
public SchemaGenerator(boolean verbose, boolean equal, boolean aqual,
ArrayList paths) {
this(paths);
m_verbose = verbose;
m_isElementQualified = equal;
m_isAttributeQualified = aqual;
m_indentSequence = " ";
}
/**
* Set control flag for verbose processing reports.
*
* @param verbose report verbose information in processing bindings flag
*/
public void setVerbose(boolean verbose) {
m_verbose = verbose;
}
/**
* Set control flag for element qualified default schema.
*
* @param qual element qualified default schemas flag
*/
public void setElementQualified(boolean qual) {
m_isElementQualified = qual;
}
/**
* Set control flag for attribute qualified default schema.
*
* @param qual attribute qualified default schemas flag
*/
public void setAttributeQualified(boolean qual) {
m_isAttributeQualified = qual;
}
/**
* Get array of generated schemas.
*
* @return array of schema elements
*/
public Element[] getSchemas() {
Element[] schemas = new Element[m_schemaMap.size()];
int fill = 0;
for (Iterator iter = m_schemaMap.values().iterator(); iter.hasNext();) {
schemas[fill++] = (Element)iter.next();
}
return schemas;
}
/**
* Generate indentation to proper depth for current item. This creates the
* indentation text and appends it to the supplied parent. The generated
* indentation is appropriate for the close tag of the parent element; if
* a child element is to be added following this indentation it needs to
* use an additional leading indent.
*
* @param parent element to contain indented child item
*/
private void indentForClose(Element parent) {
StringBuffer buff = new StringBuffer(20);
buff.append('\n');
Element ancestor = parent;
boolean count = false;
while (ancestor != null) {
if (count) {
buff.append(m_indentSequence);
}
ancestor = (Element)ancestor.getParentNode();
count = true;
}
parent.appendChild(m_document.createTextNode(buff.toString()));
}
/**
* Add comment with appropriate indentation.
*
* @param parent element to contain indented child item
* @param text comment text
*/
private void addComment(Element parent, String text) {
if (parent.getChildNodes().getLength() == 0) {
indentForClose(parent);
}
parent.appendChild(m_document.createTextNode(m_indentSequence));
parent.appendChild(m_document.createComment(text));
indentForClose(parent);
}
/**
* Add child element with appropriate indentation. This generates and
* returns the child element after adding it to the supplied parent,
* allowing further modification of the new child element.
*
* @param parent element to contain indented child item
* @param name child element name
*/
private Element addChildElement(Element parent, String name) {
if (parent.getChildNodes().getLength() == 0) {
indentForClose(parent);
}
parent.appendChild(m_document.createTextNode(m_indentSequence));
Element element = m_document.createElementNS(XSD_URI, name);
element.setPrefix(parent.getPrefix());
parent.appendChild(element);
indentForClose(parent);
return element;
}
/**
* Get innermost containing definition context.
*
* @return innermost definition context containing this element
*/
public DefinitionContext getDefinitions() {
int index = 0;
while (index < m_structureStack.size()) {
NestingElementBase nest =
(NestingElementBase)m_structureStack.peek(index++);
if (nest.getDefinitions() != null) {
return nest.getDefinitions();
}
}
throw new IllegalStateException
("Internal error: no definition context");
}
/**
* Process a structure component (structure or collection element) with no
* name and no child components. This adds the appropriate type of element
* or any definition to the container schema element.
*
* @param comp structure component to be processed
* @param egroup schema element to contain element definitions
* @param agroup schema element to contain attribute definitions
*/
private void defineEmptyStructureComponent(StructureElementBase comp,
Element egroup, Element agroup) {
NestingElementBase parent =
(NestingElementBase)m_structureStack.peek(0);
boolean only = parent.children().size() == 1;
if (comp.type() == ElementBase.COLLECTION_ELEMENT) {
// collection may define type or not
CollectionElement collection = (CollectionElement)comp;
String itype = collection.getItemTypeClass().getName();
DefinitionContext dctx = getDefinitions();
TemplateElementBase templ = dctx.getSpecificTemplate(itype);
Element element = null;
if (! (templ instanceof MappingElement)) {
if (only) {
addComment(egroup, " Replace \"any\" with details of " +
"content to complete schema ");
element = addChildElement(egroup, "any");
} else {
addComment(egroup,
" No mapping for items of collection at " +
ValidationException.describe(collection) + " ");
addComment(egroup,
" Fill in details of content to complete schema ");
}
} else {
element = addChildElement(egroup, "element");
String name = ((MappingElement)templ).getName();
if (element.getPrefix() == null) {
name = "tns:" + name;
}
element.setAttribute("ref", name);
}
if (element != null) {
element.setAttribute("minOccurs", "0");
element.setAttribute("maxOccurs", "unbounded");
}
} else {
// check for reference to a mapped class
StructureElement structure = (StructureElement)comp;
TemplateElementBase templ = structure.getEffectiveMapping();
if (! (templ instanceof MappingElement)) {
// unknown content, leave it to user to fill in details
if (only) {
addComment(egroup, " Replace \"any\" with details of " +
"content to complete schema ");
addChildElement(egroup, "any");
} else {
addComment(egroup, " No mapping for structure at " +
ValidationException.describe(structure) + " ");
addComment(egroup,
" Fill in details of content here to complete schema ");
}
} else {
MappingElement mapping = (MappingElement)templ;
if (mapping.isAbstract()) {
// check name to be used for instance of type
String ename = structure.getName();
if (ename == null) {
ename = mapping.getName();
}
if (ename == null) {
// no schema equivalent, embed definition directly
addComment(egroup, "No schema representation for " +
"directly-embedded type, inlining definition");
addComment(egroup, "Add element name to structure at " +
ValidationException.describe(structure) +
" to avoid inlining");
defineList(mapping.children(), egroup, agroup, false);
} else {
// handle abstract mapping element as reference to type
Element element = addChildElement(egroup, "element");
String tname = simpleClassName(mapping.getClassName());
if (element.getPrefix() == null) {
tname = "tns:" + tname;
}
element.setAttribute("type", tname);
String name = structure.getName();
if (name == null) {
name = mapping.getName();
}
element.setAttribute("name", name);
if (structure.isOptional()) {
element.setAttribute("minOccurs", "0");
}
}
} else {
// concrete mapping, check for name overridden
String sname = structure.getName();
String mname = mapping.getName();
if (sname != null && !sname.equals(mname)) {
// inline definition for overridden name
addComment(egroup, "No schema representation for " +
"element reference with different name, inlining " +
"definition");
addComment(egroup,
"Remove name on mapping reference at " +
ValidationException.describe(structure) +
" to avoid inlining");
defineList(mapping.children(), egroup, agroup, false);
} else {
// use element reference for concrete mapping
Element element = addChildElement(egroup, "element");
String tname = simpleClassName(mapping.getClassName());
if (element.getPrefix() == null) {
tname = "tns:" + tname;
}
element.setAttribute("ref", tname);
if (structure.isOptional()) {
element.setAttribute("minOccurs", "0");
}
}
}
}
}
}
/**
* Process a structure component (structure or collection element) within a
* list of child components. This adds the appropriate type of element or
* any definition to the container, if necessary calling other methods for
* recursive handling of nested child components.
*
* @param comp structure component to be processed
* @param egroup schema element to contain element definitions
* @param agroup schema element to contain attribute definitions
* @param mult allow any number of occurrences of components flag
*/
private void defineStructureComponent(StructureElementBase comp,
Element egroup, Element agroup, boolean mult) {
// check for element defined by binding component
if (comp.getName() != null) {
// create basic element definition for name
Element element = addChildElement(egroup, "element");
element.setAttribute("name", comp.getName());
if (mult) {
element.setAttribute("minOccurs", "0");
element.setAttribute("maxOccurs", "unbounded");
} else if (comp.isOptional()) {
element.setAttribute("minOccurs", "0");
}
// check for children present
if (comp.children().size() > 0) {
defineNestedStructure(comp, element);
} else {
// nest complex type definition for actual content
Element type = addChildElement(element, "complexType");
Element seq = addChildElement(type, "sequence");
// process the content description
defineEmptyStructureComponent(comp, seq, type);
}
} else if (comp.children().size() > 0) {
// handle child components with recursive call
boolean coll = comp.type() == ElementBase.COLLECTION_ELEMENT;
m_structureStack.push(comp);
defineList(comp.children(), egroup, agroup, coll);
m_structureStack.pop();
} else {
// handle empty structure definition inline
defineEmptyStructureComponent(comp, egroup, agroup);
}
}
/**
* Create the schema definition list for a binding component list. This
* builds the sequence of elements and attributes defined by the binding
* components, including nested complex types for elements with structure.
*
* @param comps binding component list
* @param egroup schema element to contain element definitions
* @param agroup schema element to contain attribute definitions
* @param mult allow any number of occurrences of components flag
*/
private void defineList(ArrayList comps, Element egroup, Element agroup,
boolean mult) {
// handle all nested elements of container
for (int i = 0; i < comps.size(); i++) {
ElementBase child = (ElementBase)comps.get(i);
switch (child.type()) {
case ElementBase.COLLECTION_ELEMENT:
case ElementBase.STRUCTURE_ELEMENT:
{
defineStructureComponent((StructureElementBase)child,
egroup, agroup, mult);
break;
}
case ElementBase.MAPPING_ELEMENT:
{
// nested mapping definitions not handled
System.err.println("Error: nested mapping not supported " +
"(class " + ((MappingElement)child).getClassName() +
")");
break;
}
case ElementBase.TEMPLATE_ELEMENT:
{
// templates to be added once usable in binding
System.err.println
("Error: template component not yet supported");
break;
}
case ElementBase.VALUE_ELEMENT:
{
// get type information for value
ValueElement value = (ValueElement)child;
String tname = value.getType().getName();
String stype = (String)s_primitiveTypeMap.get(tname);
if (stype == null) {
stype = (String)s_objectTypeMap.get(tname);
if (stype == null) {
stype = "xsd:string";
}
}
// build schema element or attribute for value
Element element;
int style = value.getStyle();
if (style == NestingAttributes.ATTRIBUTE_STYLE) {
// append attribute as child of type
element = addChildElement(agroup, "attribute");
if (!value.isOptional()) {
element.setAttribute("use", "required");
}
} else if (style == NestingAttributes.ELEMENT_STYLE) {
// append simple element as child of grouping
element = addChildElement(egroup, "element");
if (mult) {
element.setAttribute("minOccurs", "0");
element.setAttribute("maxOccurs", "unbounded");
} else if (value.isOptional()) {
element.setAttribute("minOccurs", "0");
}
} else {
// other types are not currently handled
System.err.println("Error: value type " +
value.getEffectiveStyleName() + " not supported");
break;
}
// set common attributes on definition
element.setAttribute("name", value.getName());
element.setAttribute("type", stype);
break;
}
}
}
}
/**
* Create the schema definition for a nested structure. This defines a
* complex type, if necessary calling itself recursively for elements which
* are themselves complex types. In the special case where the container
* element is a mapping which extends an abstract base class this generates
* the complex type as an extension of the base class complex type.
*
* @param container binding definition element containing nested structure
* @param parent schema element to hold the definition
* @return constructed complex type
*/
private Element defineNestedStructure(ContainerElementBase container,
Element parent) {
// create complex type as holder for definition
Element type = addChildElement(parent, "complexType");
// check whether ordered or unordered container
Element group;
ArrayList childs = container.children();
if (container.isOrdered()) {
// define content list as sequence
group = addChildElement(type, "sequence");
// check for mapping which extends another mapping
/* if (container instanceof MappingElement) {
MappingElement mapping = (MappingElement)container;
MappingElement extended = mapping.getExtendsMapping();
if (extended != null) {
// now see if the mapping can extend base complex type
boolean extend = false;
for (int i = 0; i < childs.size(); i++) {
ElementBase child = (ElementBase)childs.get(i);
if (child instanceof StructureElement) {
StructureElement struct = (StructureElement)child;
if (struct.getMapAsMapping() == extended) {
if (struct.getName() == null) {
extend = true;
}
}
}
if (child instanceof IComponent) {
}
}
}
} */
} else {
group = addChildElement(type, "all");
}
// handle all nested elements of container
m_structureStack.push(container);
defineList(childs, group, type,
container.type() == ElementBase.COLLECTION_ELEMENT);
m_structureStack.pop();
return type;
}
/**
* Generate a schema from a binding using supplied classpaths. If the schema
* for the binding namespace (or default namespace) already exists the
* definitions from this binding are added to the existing schema; otherwise
* a new schema is created and added to the collection defined.
*
* @param binding root element of binding
*/
private void generateSchema(BindingElement binding) {
// process each mapping definition for binding
m_structureStack.push(binding);
ArrayList tops = binding.topChildren();
for (int i = 0; i < tops.size(); i++) {
ElementBase top = (ElementBase)tops.get(i);
if (top.type() == ElementBase.MAPPING_ELEMENT) {
// find or create schema for mapped class
MappingElement mapping = (MappingElement)top;
String uri = mapping.getNamespace().getUri();
Element schema = (Element)m_schemaMap.get(uri);
if (schema == null) {
// build new schema element for this namespace
schema = m_document.createElementNS(XSD_URI, "schema");
m_schemaMap.put(uri, schema);
// set qualification attributes if needed
if (m_isElementQualified) {
schema.setAttribute("elementFormDefault", "qualified");
}
if (m_isAttributeQualified) {
schema.setAttribute("attributeFormDefault",
"qualified");
}
// add namespace declarations to element
if (uri == null) {
schema.setPrefix("xsd");
} else {
schema.setAttribute("targetNamespace", uri);
schema.setAttributeNS(XMLNS_URI, "xmlns:tns", uri);
schema.setAttributeNS(XMLNS_URI, "xmlns", XSD_URI);
}
schema.setAttributeNS(XMLNS_URI, "xmlns:xsd", XSD_URI);
// add spacing for first child node
indentForClose(schema);
}
// add spacer and comment before actual definition
indentForClose(schema);
String cname = mapping.getClassName();
addComment(schema, " Created from mapping for class " +
cname + " ");
if (mapping.isAbstract()) {
// add mapping as global type in binding
Element type = defineNestedStructure(mapping, schema);
type.setAttribute("name", simpleClassName(cname));
} else {
// add mapping as global element in binding
Element element = addChildElement(schema, "element");
element.setAttribute("name", mapping.getName());
// check type of mapping definition
if (mapping.getMarshaller() != null ||
mapping.getUnmarshaller() != null) {
// use "any" for custom marshaller/unmarshaller
Element type = addChildElement(element, "complexType");
Element seq = addChildElement(type, "sequence");
addComment(seq, " Replace \"any\" with details of " +
"content to complete schema ");
addChildElement(seq, "any");
} else {
// use complex type for embedded definition
defineNestedStructure(mapping, element);
}
}
}
}
m_structureStack.pop();
}
/**
* Process a binding definition for schema generation. This first validates
* the binding definition, and if it is valid then handles schema generation
* from the binding.
*
* @param binding root element of binding
* @exception JiBXException if error in generating the schema
*/
public void generate(BindingElement binding) throws JiBXException {
// validate the binding definition
ValidationContext vctx = new ValidationContext(m_classLocator);
binding.runValidation(vctx);
boolean usable = true;
if (vctx.getProblems().size() > 0) {
// report problems found
System.err.println("Problems found in binding " +
binding.getName());
ArrayList probs = vctx.getProblems();
for (int i = 0; i < probs.size(); i++) {
ValidationProblem prob = (ValidationProblem)probs.get(i);
System.err.println(prob.getDescription());
if (prob.getSeverity() > ValidationProblem.WARNING_LEVEL) {
usable = false;
}
}
}
// check if binding usable for schema generation
if (usable) {
generateSchema(binding);
} else {
System.err.println
("Binding validation errors prevent schema generation");
System.exit(1);
}
}
/**
* Get simple class name.
*
* @param cname class name with full package specification
* @return class name only
*/
private String simpleClassName(String cname) {
int split = cname.lastIndexOf('.');
if (split >= 0) {
cname = cname.substring(split+1);
}
return cname;
}
/**
* Main method for running compiler as application.
*
* @param args command line arguments
*/
public static void main(String[] args) {
if (args.length > 0) {
try {
// check for various flags set
boolean verbose = false;
boolean edflt = true;
boolean adflt = false;
ArrayList paths = new ArrayList();
int offset = 0;
for (; offset < args.length; offset++) {
String arg = args[offset];
if ("-v".equalsIgnoreCase(arg)) {
verbose = true;
} else if ("-e".equalsIgnoreCase(arg)) {
edflt = false;
} else if ("-a".equalsIgnoreCase(arg)) {
adflt = true;
} else if ("-p".equalsIgnoreCase(arg)) {
paths.add(args[++offset]);
} else {
break;
}
}
// set up path and binding lists
String[] vmpaths = Utility.getClassPaths();
for (int i = 0; i < vmpaths.length; i++) {
paths.add(vmpaths[i]);
}
ArrayList bindings = new ArrayList();
for (int i = offset; i < args.length; i++) {
bindings.add(args[i]);
}
// report on the configuration
System.out.println("Running schema generator version " +
CURRENT_VERSION);
if (verbose) {
System.out.println("Using paths:");
for (int i = 0; i < paths.size(); i++) {
System.out.println(" " + paths.get(i));
}
System.out.println("Using input bindings:");
for (int i = 0; i < bindings.size(); i++) {
System.out.println(" " + bindings.get(i));
}
}
// process all specified binding files
SchemaGenerator schemagen = new SchemaGenerator(verbose, edflt,
adflt, paths);
for (int i = 0; i < bindings.size(); i++) {
// read binding from file
String bpath = (String)bindings.get(i);
String name = Utility.fileName(bpath);
File file = new File(bpath);
BindingElement binding = Utility.validateBinding(name,
new URL("file://" + file.getAbsolutePath()),
new FileInputStream(file));
// convert the binding to a schema
if (binding != null) {
schemagen.generate(binding);
}
}
// output each schema to separate file
Element[] schemas = schemagen.getSchemas();
for (int i = 0; i < schemas.length; i++) {
// get base name for output file from last part of namespace
Element schema = schemas[i];
String tns = schema.getAttribute("targetNamespace");
String name = tns;
if (name.length() == 0) {
// fix this to relate back to binding
name = (String)bindings.get(0);
int split = name.lastIndexOf('.');
if (split >= 0) {
name = name.substring(0, split);
}
} else {
int split = name.lastIndexOf('/');
if (split >= 0) {
name = name.substring(split+1);
}
}
try {
// write schema to output file
name += ".xsd";
FileOutputStream out = new FileOutputStream(name);
Transformer transformer =
TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty("indent", "no");
DOMSource source = new DOMSource(schema);
Result result = new StreamResult(out);
transformer.transform(source, result);
out.close();
System.out.print("Wrote schema " + name);
if (tns.length() == 0) {
System.out.println(" for default namespace");
} else {
System.out.println(" for namespace " + tns);
}
} catch (TransformerConfigurationException e) {
e.printStackTrace();
} catch (TransformerFactoryConfigurationError e) {
e.printStackTrace();
} catch (TransformerException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
} catch (JiBXException ex) {
ex.printStackTrace();
System.exit(1);
} catch (FileNotFoundException e) {
e.printStackTrace();
System.exit(2);
} catch (MalformedURLException e) {
e.printStackTrace();
System.exit(3);
}
} else {
System.out.println
("\nUsage: java org.jibx.binding.SchemaGenerator [-v] [-e]" +
" [-a] [-p path]* binding1 binding2 ...\nwhere:" +
"\n -v turns on verbose output," +
"\n -e sets elementFormDefault=\"false\" for the schemas," +
"\n -a sets attributeFormDefault=\"true\" for the schemas, " +
"and\n -p gives a path component for looking up the classes " +
"referenced in the binding\nThe binding# files are " +
"different bindings to be used for schema generation.\n");
System.exit(1);
}
}
}
libjibx-java-1.1.6a/build/src/org/jibx/binding/Utility.java 0000644 0001750 0001750 00000037406 11013374540 023443 0 ustar moeller moeller /*
Copyright (c) 2003-2008, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.ArrayList;
import java.util.jar.Attributes;
import java.util.jar.JarFile;
import java.util.jar.Manifest;
import org.jibx.binding.classes.BoundClass;
import org.jibx.binding.classes.ClassFile;
import org.jibx.binding.def.BindingBuilder;
import org.jibx.binding.def.BindingDefinition;
import org.jibx.binding.def.MappingBase;
import org.jibx.binding.model.BindingElement;
import org.jibx.binding.model.IncludeElement;
import org.jibx.binding.model.MappingElement;
import org.jibx.binding.model.ValidationContext;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.impl.UnmarshallingContext;
/**
* Binding compiler support class. Supplies common methods for use in compiling
* binding definitions.
*
* @author Dennis M. Sosnoski
*/
public class Utility
{
// buffer size for copying stream input
private static final int COPY_BUFFER_SIZE = 1024;
// private constructor to prevent any instance creation
private Utility() {}
/**
* Read contents of stream into byte array.
*
* @param is input stream to be read
* @return array of bytes containing all data from stream
* @throws IOException on stream access error
*/
private static byte[] getStreamData(InputStream is) throws IOException {
byte[] buff = new byte[COPY_BUFFER_SIZE];
ByteArrayOutputStream os = new ByteArrayOutputStream();
int count;
while ((count = is.read(buff)) >= 0) {
os.write(buff, 0, count);
}
return os.toByteArray();
}
/**
* Recurse through jar file path component, adding all jars referenced from
* the original jar to the path collection. Silently ignores problems
* loading jar files.
*
* @param path jar path component
* @param paths set of paths processed (added to by call)
*/
private static void recursePathJars(String path, ArrayList paths) {
try {
// check class path information in jar file
JarFile jfile = new JarFile(path, false);
Manifest mfst = jfile.getManifest();
if (mfst != null) {
// look for class path information from manifest
Attributes attrs = mfst.getMainAttributes();
String cpath = (String)attrs.get(Attributes.Name.CLASS_PATH);
if (cpath != null) {
// set base path for all relative references
int split = path.lastIndexOf(File.separatorChar);
String base = (split >= 0) ?
path.substring(0, split+1) : "";
// process all references in jar class path
while (cpath != null) {
split = cpath.indexOf(' ');
String item;
if (split >= 0) {
item = cpath.substring(0, split);
cpath = cpath.substring(split+1).trim();
} else {
item = cpath;
cpath = null;
}
String ipath = base + item;
if (!paths.contains(ipath)) {
paths.add(ipath);
split = ipath.lastIndexOf('.');
if (split >= 0 && "jar".equalsIgnoreCase
(ipath.substring(split+1))) {
recursePathJars(ipath, paths);
}
}
}
}
}
} catch (IOException ex) { /* silently ignore problems in loading */ }
}
/**
* Method builds a string array of items in the class path.
*
* @return array of classpath components
*/
public static String[] getClassPaths() {
// get all class path components
String path = System.getProperty("java.class.path");
ArrayList paths = new ArrayList();
int start = 0;
int mark;
while (path != null) {
mark = path.indexOf(File.pathSeparatorChar, start);
String item;
if (mark >= 0) {
item = path.substring(start, mark);
} else {
item = path.substring(start);
path = null;
}
if (!paths.contains(item)) {
paths.add(item);
int split = item.lastIndexOf('.');
if (split >= 0 &&
"jar".equalsIgnoreCase(item.substring(split+1))) {
recursePathJars(item, paths);
}
}
start = mark + 1;
}
paths.add(".");
String[] clsspths = new String[paths.size()];
paths.toArray(clsspths);
return clsspths;
}
/**
* Generate binding name. This takes a base name (such as a file name with
* extension stripped off) and converts it to legal form by substituting '_'
* characters for illegal characters in the base name.
*
* @param name base binding name
* @return converted binding name
*/
public static String convertName(String name) {
// convert name to use only legal characters
StringBuffer buff = new StringBuffer(name);
for (int i = 0; i < buff.length(); i++) {
if (!Character.isJavaIdentifierPart(buff.charAt(i))) {
buff.setCharAt(i, '_');
}
}
return buff.toString();
}
/**
* Extract base file name from a full path.
*
* @param path full file path
* @return file name component from path
*/
public static String fileName(String path) {
int split = path.lastIndexOf(File.separatorChar);
return path.substring(split+1);
}
/**
* Validate binding definition. If issues are found in the binding the
* issues are printed directly to the console.
*
* @param name identifier for binding definition
* @param url URL for binding definition (null if not
* available)
* @param is input stream for reading binding definition
* @return root element of binding model if binding is valid,
* null if one or more errors in binding
*/
public static BindingElement validateBinding(String name, URL url,
InputStream is) {
try {
ValidationContext vctx = BindingElement.newValidationContext();
BindingElement root =
BindingElement.validateBinding(name, url, is, vctx);
if (vctx.getErrorCount() == 0 && vctx.getFatalCount() == 0) {
return root;
}
} catch (JiBXException ex) {
System.err.println("Unable to process binding " + name);
ex.printStackTrace();
}
return null;
}
/**
* Load validated binding definition. This first reads the input stream into
* a memory buffer, then parses the data once for validation and a second
* time for the actual binding definition construction. If any errors are
* found in the binding definition validation the construction is skipped
* and an exception is thrown.
*
* @param fname binding definition full name
* @param sname short form of name to use as the default name of the binding
* @param istrm input stream for binding definition document
* @param url URL for binding definition (null if not
* available)
* @param test validate binding flag
* @return constructed binding definition
* @exception FileNotFoundException if path cannot be accessed
* @exception JiBXException if error in processing the binding definition
*/
public static BindingDefinition loadBinding(String fname, String sname,
InputStream istrm, URL url, boolean test)
throws JiBXException, IOException {
// read stream into memory buffer
byte[] data = getStreamData(istrm);
// validate using binding object model
boolean valid = true;
ClassFile cf = null;
String tpack = null;
if (test) {
BindingElement root = validateBinding(fname, url,
new ByteArrayInputStream(data));
if (root == null) {
valid = false;
} else {
// find package of first mapping to use for added classes
cf = findMappedClass(root);
tpack = root.getTargetPackage();
if (tpack == null && cf != null) {
tpack = cf.getPackage();
}
}
}
if (valid) {
try {
// construct the binding definition code generator
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new ByteArrayInputStream(data), fname, null);
if (cf != null) {
// set target root and package for created classes
BoundClass.setModify(cf.getRoot(), tpack);
}
BindingDefinition bdef =
BindingBuilder.unmarshalBindingDefinition(uctx, sname, url);
// set package and class if not validated
if (!test) {
// a kludge, but needed to support skipping validation
ArrayList maps = bdef.getDefinitionContext().getMappings();
if (maps != null) {
// set up package information from mapped class
for (int i = 0; i < maps.size(); i++) {
Object child = maps.get(i);
if (child instanceof MappingBase) {
// end scan if a real mapping is found
MappingBase mapbase = (MappingBase)child;
cf = mapbase.getBoundClass().getMungedFile();
if (mapbase.getBoundClass().isDirectAccess()) {
break;
}
}
}
}
}
// set up binding root based on first mapping
if (cf == null) {
throw new JiBXException("One or more elements " +
"for modifiable classes must be defined in ");
} else {
// get package to be used for binding classes
if (tpack == null) {
tpack = bdef.getDefaultPackage();
if (tpack == null) {
tpack = cf.getPackage();
}
}
bdef.setFactoryLocation(tpack, cf.getRoot());
return bdef;
}
} catch (JiBXException e) {
throw new JiBXException
("\n*** Error during code generation for file '" + fname +
"' - please enter a bug report for this error in Jira if " +
"the problem is not listed as fixed on the online status " +
"page ***\n", e);
}
} else {
throw new JiBXException("Binding " + fname +
" is unusable because of validation errors");
}
}
/**
* Recursively search through binding definitions for a modifiable mapped
* class. This is used to determine the default package for code generation.
*
* @param childs
* @return
*/
private static ClassFile findMappedClass(BindingElement root) {
ArrayList childs = root.topChildren();
if (childs != null) {
// recursively search for modifiable mapped class
for (int i = childs.size() - 1; i >= 0 ; i--) {
Object child = childs.get(i);
if (child instanceof MappingElement) {
// end scan if a real mapping is found
MappingElement map = (MappingElement)child;
ClassFile cf = map.getHandledClass().getClassFile();
if (!cf.isInterface() && cf.isModifiable()) {
return cf;
}
} else if (child instanceof IncludeElement) {
// recurse on included binding
BindingElement bind = ((IncludeElement)child).getBinding();
if (bind != null) {
ClassFile cf = findMappedClass(bind);
if (cf != null) {
return cf;
}
}
}
}
}
return null;
}
/**
* Load binding definition from file.
*
* @param path file path for binding definition
* @param valid validate binding flag
* @return constructed binding definition
* @exception IOException if error accessing file
* @exception JiBXException if error in processing the binding definition
*/
public static BindingDefinition loadFileBinding(String path, boolean valid)
throws JiBXException, IOException {
// extract basic name of binding file from path
String fname = fileName(path);
String sname = fname;
int split = sname.indexOf('.');
if (split > 0) {
sname = sname.substring(0, split);
}
sname = convertName(sname);
// construct and return the binding definition
File file = new File(path);
return loadBinding(fname, sname, new FileInputStream(file),
file.toURL(), valid);
}
} libjibx-java-1.1.6a/build/src/org/jibx/custom/ 0000755 0001750 0001750 00000000000 11023035620 021015 5 ustar moeller moeller libjibx-java-1.1.6a/build/src/org/jibx/custom/CustomUtils.java 0000644 0001750 0001750 00000010113 10752422242 024157 0 ustar moeller moeller /*
* Copyright (c) 2007, Dennis M. Sosnoski All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.custom;
import java.io.File;
import java.util.HashSet;
import java.util.Set;
/**
* Support methods used by customization code.
*
* @author Dennis M. Sosnoski
*/
public class CustomUtils
{
/**
* Utility method to add an array of names to a set, ignoring case. All the supplied names are converted to lower
* case before they are added to the set.
*
* @param names (null if none)
* @param set base set of names (null if none)
* @return name set (null if none)
*/
public static Set addNoCaseSet(String[] names, Set set) {
if (names == null) {
return set;
} else {
if (set == null) {
set = new HashSet();
}
for (int i = 0; i < names.length; i++) {
set.add(names[i].toLowerCase());
}
return set;
}
}
/**
* Utility method to build a set from an array of names, ignoring case. All the supplied names are converted to
* lower case before they are added to the set.
*
* @param names (null if none)
* @return name set (null if name array also null, otherwise non-null)
*/
public static Set noCaseNameSet(String[] names) {
if (names == null) {
return null;
} else {
HashSet set = new HashSet();
for (int i = 0; i < names.length; i++) {
set.add(names[i].toLowerCase());
}
return set;
}
}
/**
* Utility method to build a set from an array of names.
*
* @param names (null if none)
* @return name set (null if name array also null, otherwise non-null)
*/
public static Set nameSet(String[] names) {
if (names == null) {
return null;
} else {
HashSet set = new HashSet();
for (int i = 0; i < names.length; i++) {
set.add(names[i]);
}
return set;
}
}
/**
* Clean directory by recursively deleting children.
*
* @param dir directory to be cleaned
*/
public static void clean(File dir) {
if (dir.isDirectory()) {
File[] files = dir.listFiles();
for (int i = 0; i < files.length; i++) {
File file = files[i];
if (file.isDirectory()) {
clean(file);
}
file.delete();
}
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/custom/CustomizationCommandLineBase.java 0000644 0001750 0001750 00000044130 10701164576 027453 0 ustar moeller moeller /*
* Copyright (c) 2007, Dennis M. Sosnoski. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of
* JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.custom;
import java.io.File;
import java.io.IOException;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
/**
* Command line processor for all types of customizable tools. This just provides the basic handling of a customizations
* file, target directory, and overrides of values in the customizations root object.
*
* @author Dennis M. Sosnoski
*/
public abstract class CustomizationCommandLineBase
{
/** Array of method parameter classes for single String parameter. */
public static final Class[] STRING_PARAMETER_ARRAY = new Class[] { String.class };
/** Array of classes for String and unmarshaller parameters. */
public static final Class[] STRING_UNMARSHALLER_PARAMETER_ARRAY =
new Class[] { String.class, IUnmarshallingContext.class };
/** Ordered array of usage lines. */
protected static final String[] COMMON_USAGE_LINES =
new String[] { " -c clean target generation directory (ignored if current directory)",
" -f path input customizations file",
" -t path target directory for generated output (default is current directory)",
" -v verbose output flag" };
/** List of specified classes or files. */
protected List m_extraArgs;
/** Target directory for output. */
protected File m_generateDirectory;
/**
* Process command line arguments array.
*
* @param args
* @return true if valid, false if not
* @throws JiBXException
* @throws IOException
*/
public boolean processArgs(String[] args) throws JiBXException, IOException {
boolean clean = false;
boolean verbose = false;
String custom = null;
String genpath = null;
Map overrides = new HashMap();
ArgList alist = new ArgList(args);
m_extraArgs = new ArrayList();
while (alist.hasNext()) {
String arg = alist.next();
if ("-c".equalsIgnoreCase(arg)) {
clean = true;
} else if ("-f".equalsIgnoreCase(arg)) {
custom = alist.next();
} else if ("-t".equalsIgnoreCase(arg)) {
genpath = alist.next();
} else if ("-v".equalsIgnoreCase(arg)) {
verbose = true;
} else if (arg.startsWith("--") && arg.length() > 2 && Character.isLetter(arg.charAt(2))) {
if (!putKeyValue(arg.substring(2), overrides)) {
alist.setValid(false);
}
} else if (!checkParameter(alist)) {
if (arg.startsWith("-")) {
System.err.println("Unknown option flag '" + arg + '\'');
alist.setValid(false);
} else {
m_extraArgs.add(alist.current());
break;
}
}
}
// collect the extra arguments at end
while (alist.hasNext()) {
String arg = alist.next();
if (arg.startsWith("-")) {
System.err.println("Command line options must precede all other arguments: error on '" + arg + '\'');
alist.setValid(false);
break;
} else {
m_extraArgs.add(arg);
}
}
// check for valid command line arguments
if (alist.isValid()) {
// set output directory
if (genpath == null) {
m_generateDirectory = new File(".");
clean = false;
} else {
m_generateDirectory = new File(genpath);
}
if (!m_generateDirectory.exists()) {
m_generateDirectory.mkdirs();
clean = false;
}
if (!m_generateDirectory.canWrite()) {
System.err.println("Target directory " + m_generateDirectory.getPath() + " is not writable");
alist.setValid(false);
} else {
// finish the command line processing
finishParameters(alist);
// report on the configuration
if (verbose) {
verboseDetails();
System.out.println("Output to directory " + m_generateDirectory);
}
// clean generate directory if requested
if (clean) {
CustomUtils.clean(m_generateDirectory);
}
// load customizations and check for errors
if (!loadCustomizations(custom)) {
alist.setValid(false);
} else {
// apply command line overrides to customizations
Map unknowns = applyOverrides(overrides);
if (!unknowns.isEmpty()) {
for (Iterator iter = unknowns.keySet().iterator(); iter.hasNext();) {
String key = (String)iter.next();
System.err.println("Unknown override key '" + key + '\'');
}
alist.setValid(false);
}
}
}
} else {
printUsage();
}
return alist.isValid();
}
/**
* Apply a key/value map to a customization object instance. This uses reflection to match the keys to either set
* methods (with names of the form setZZZText, or setZZZ, taking a single String parameter) or String fields (named
* m_ZZZ). The ZZZ in the names is based on the key name, with hyphenation converted to camel case (leading upper
* camel case, for the method names).
*
* @param map
* @param obj
* @return map for key/values not found in the supplied object
*/
public static Map applyKeyValueMap(Map map, Object obj) {
Map missmap = new HashMap();
for (Iterator iter = map.keySet().iterator(); iter.hasNext();) {
String key = (String)iter.next();
String value = (String)map.get(key);
boolean fail = true;
Throwable t = null;
try {
StringBuffer buff = new StringBuffer(key);
for (int i = 0; i < buff.length(); i++) {
char chr = buff.charAt(i);
if (chr == '-') {
buff.deleteCharAt(i);
buff.setCharAt(i, Character.toUpperCase(buff.charAt(i)));
}
}
String fname = "m_" + buff.toString();
buff.setCharAt(0, Character.toUpperCase(buff.charAt(0)));
String mname = "set" + buff.toString();
Method method = null;
Class clas = obj.getClass();
int argcnt = 1;
while (!clas.getName().equals("java.lang.Object")) {
try {
method = clas.getDeclaredMethod(mname + "Text", STRING_UNMARSHALLER_PARAMETER_ARRAY);
argcnt = 2;
break;
} catch (NoSuchMethodException e) {
try {
method = clas.getDeclaredMethod(mname, STRING_PARAMETER_ARRAY);
break;
} catch (NoSuchMethodException e1) {
clas = clas.getSuperclass();
}
}
}
if (method == null) {
clas = obj.getClass();
while (!clas.getName().equals("java.lang.Object")) {
try {
Field field = clas.getDeclaredField(fname);
try {
field.setAccessible(true);
} catch (SecurityException e) { /* deliberately empty */
}
String type = field.getType().getName();
if ("java.lang.String".equals(type)) {
field.set(obj, value);
fail = false;
} else if ("boolean".equals(type) || "java.lang.Boolean".equals(type)) {
Boolean bval = null;
if ("true".equals(value) || "1".equals(value)) {
bval = Boolean.TRUE;
} else if ("false".equals(value) || "0".equals(value)) {
bval = Boolean.FALSE;
}
if (bval == null) {
throw new IllegalArgumentException("Unknown value '" + value
+ "' for boolean parameter " + key);
}
field.set(obj, bval);
fail = false;
} else if ("[Ljava.lang.String;".equals(type)) {
try {
field.set(obj, org.jibx.runtime.Utility.deserializeTokenList(value));
fail = false;
} catch (JiBXException e) {
throw new IllegalArgumentException("Error processing list value + '" + value +
"': " + e.getMessage());
}
} else {
throw new IllegalArgumentException("Cannot handle field of type " + type);
}
break;
} catch (NoSuchFieldException e) {
clas = clas.getSuperclass();
}
}
} else {
try {
method.setAccessible(true);
} catch (SecurityException e) { /* deliberately empty */
}
Object[] args = new Object[argcnt];
args[0] = value;
method.invoke(obj, args);
fail = false;
}
} catch (IllegalAccessException e) {
t = e;
} catch (SecurityException e) {
t = e;
} catch (IllegalArgumentException e) {
t = e;
} catch (InvocationTargetException e) {
t = e;
} finally {
if (t != null) {
t.printStackTrace();
System.exit(1);
}
}
if (fail) {
missmap.put(key, value);
}
}
return missmap;
}
/**
* Get generate directory.
*
* @return directory
*/
public File getGeneratePath() {
return m_generateDirectory;
}
/**
* Get extra arguments from command line. These extra arguments must follow all parameter flags.
*
* @return args
*/
public List getExtraArgs() {
return m_extraArgs;
}
/**
* Set a key=value definition in a map. This is a command line processing assist method that prints an error message
* directly if the expected format is not found.
*
* @param def
* @param map
* @return true if successful, false if error
*/
public static boolean putKeyValue(String def, Map map) {
int split = def.indexOf('=');
if (split >= 0) {
String key = def.substring(0, split);
if (map.containsKey(key)) {
System.err.println("Repeated key item: '" + def + '\'');
return false;
} else {
map.put(key, def.substring(split + 1));
return true;
}
} else {
System.err.println("Missing '=' in expected key=value item: '" + def + '\'');
return false;
}
}
/**
* Merge two arrays of strings, returning an ordered array containing all the strings from both provided arrays.
*
* @param base
* @param adds
* @return ordered merged
*/
protected String[] mergeUsageLines(String[] base, String[] adds) {
if (adds.length == 0) {
return base;
} else {
String fulls[] = new String[base.length + adds.length];
System.arraycopy(base, 0, fulls, 0, base.length);
System.arraycopy(adds, 0, fulls, base.length, adds.length);
Arrays.sort(fulls);
return fulls;
}
}
/**
* Check extension parameter. This method may be overridden by subclasses to process parameters beyond those known
* to this base class.
*
* @param alist argument list
* @return true if parameter processed, false if unknown
*/
protected boolean checkParameter(ArgList alist) {
return false;
}
/**
* Finish processing of command line parameters. This method may be overridden by subclasses to implement any added
* processing after all the command line parameters have been handled.
*
* @param alist
*/
protected void finishParameters(ArgList alist) {}
/**
* Print any extension details. This method may be overridden by subclasses to print extension parameter values for
* verbose output.
*/
protected void verboseDetails() {}
/**
* Load the customizations file. This method must load the specified customizations file, or create a default
* customizations instance, of the appropriate type.
*
* @param path customization file path, null if none
* @return true if successful, false if an error
* @throws JiBXException
* @throws IOException
*/
protected abstract boolean loadCustomizations(String path) throws JiBXException, IOException;
/**
* Apply map of override values to customizations read from file or created as default.
*
* @param overmap override key-value map
* @return map for key/values not recognized
*/
protected abstract Map applyOverrides(Map overmap);
/**
* Print usage information.
*/
public abstract void printUsage();
/**
* Wrapper class for command line argument list.
*/
protected static class ArgList
{
private int m_offset;
private final String[] m_args;
private boolean m_valid;
/**
* Constructor.
*
* @param args
*/
protected ArgList(String[] args) {
m_offset = -1;
m_args = args;
m_valid = true;
}
/**
* Check if another argument value is present.
*
* @return true if argument present, false if all processed
*/
public boolean hasNext() {
return m_args.length - m_offset > 1;
}
/**
* Get current argument value.
*
* @return argument, or null if none
*/
public String current() {
return (m_offset >= 0 && m_offset < m_args.length) ? m_args[m_offset] : null;
}
/**
* Get next argument value. If this is called with no argument value available it sets the argument list
* invalid.
*
* @return argument, or null if none
*/
public String next() {
if (++m_offset < m_args.length) {
return m_args[m_offset];
} else {
m_valid = false;
return null;
}
}
/**
* Set valid state.
*
* @param valid
*/
public void setValid(boolean valid) {
m_valid = valid;
}
/**
* Check if argument list valid.
*
* @return true if valid, false if not
*/
public boolean isValid() {
return m_valid;
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/ 0000755 0001750 0001750 00000000000 11023035626 021174 5 ustar moeller moeller libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/ 0000755 0001750 0001750 00000000000 11023035620 022127 5 ustar moeller moeller libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/ArrayRangeIterator.java 0000644 0001750 0001750 00000007405 10257171674 026567 0 ustar moeller moeller /*
Copyright (c) 2000-2005, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime.impl;
import java.util.Iterator;
import java.util.NoSuchElementException;
/**
* Iterator class for values contained in an array range. This type of iterator
* can be used for any contiguous range of items in an object array.
*
* @author Dennis M. Sosnoski
* @version 1.1
*/
public class ArrayRangeIterator implements Iterator
{
/** Empty iterator used whenever possible. */
public static final ArrayRangeIterator EMPTY_ITERATOR =
new ArrayRangeIterator(null, 0, 0);
/** Array supplying values for iteration. */
protected Object[] m_array;
/** Offset of next iteration value. */
protected int m_offset;
/** Ending offset for values. */
protected int m_limit;
/**
* Internal constructor.
*
* @param array array containing values to be iterated
* @param start starting offset in array
* @param limit offset past end of values
*/
private ArrayRangeIterator(Object[] array, int start, int limit) {
m_array = array;
m_offset = start;
m_limit = limit;
}
/**
* Check for iteration element available.
*
* @return true if element available, false if
* not
*/
public boolean hasNext() {
return m_offset < m_limit;
}
/**
* Get next iteration element.
*
* @return next iteration element
* @exception NoSuchElementException if past end of iteration
*/
public Object next() {
if (m_offset < m_limit) {
return m_array[m_offset++];
} else {
throw new NoSuchElementException();
}
}
/**
* Remove element from iteration. This optional operation is not supported
* and always throws an exception.
*
* @exception UnsupportedOperationException for unsupported operation
*/
public void remove() {
throw new UnsupportedOperationException();
}
/**
* Build iterator.
*
* @param array array containing values to be iterated (may be
* null)
* @param start starting offset in array
* @param limit offset past end of values
* @return constructed iterator
*/
public static Iterator buildIterator(Object[] array, int start, int limit) {
if (array == null || start >= limit) {
return EMPTY_ITERATOR;
} else {
return new ArrayRangeIterator(array, start, limit);
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/BackFillArray.java 0000644 0001750 0001750 00000005044 10270431330 025444 0 ustar moeller moeller /*
Copyright (c) 2002,2003, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime.impl;
/**
* Backfill reference item, used for filling in forward references as
* members of arrays. Each item holds both the array containing the
* reference and the offset in the array.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class BackFillArray implements BackFillReference
{
/** Array containing reference. */
private Object[] m_array;
/** Reference offset within array. */
private int m_index;
/**
* Constructor. Saves the information for filling the reference
* once the associated object is defined.
*
* @param index reference offset within array
* @param array array containing the reference
*/
public BackFillArray(int index, Object[] array) {
m_index = index;
m_array = array;
}
/**
* Define referenced object. This method is called by the framework
* when the forward-referenced item is defined.
*
* @param obj referenced object
*/
public void backfill(Object obj) {
m_array[m_index] = obj;
}
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/BackFillHolder.java 0000644 0001750 0001750 00000006202 10071714370 025607 0 ustar moeller moeller /*
Copyright (c) 2002,2003, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime.impl;
import java.util.ArrayList;
/**
* Holder used to collect forward references to a particular object. The
* references are processed when the object is defined.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class BackFillHolder
{
/** Expected class name of tracked object. */
private String m_class;
/** List of references to this object. */
private ArrayList m_list;
/**
* Constructor. Just creates the backing list.
*
* @param name expected class name of tracked object
*/
public BackFillHolder(String name) {
m_class = name;
m_list = new ArrayList();
}
/**
* Add forward reference to tracked object. This method is called by
* the framework when a reference item is created for the object
* associated with this holder.
*
* @param ref backfill reference item
*/
public void addBackFill(BackFillReference ref){
m_list.add(ref);
}
/**
* Define referenced object. This method is called by the framework
* when the forward-referenced object is defined, and in turn calls each
* reference to fill in the reference.
*
* @param obj referenced object
*/
public void defineValue(Object obj) {
for (int i = 0; i < m_list.size(); i++) {
BackFillReference ref = (BackFillReference)m_list.get(i);
ref.backfill(obj);
}
}
/**
* Get expected class name of referenced object.
*
* @return expected class name of referenced object
*/
public String getExpectedClass() {
return m_class;
}
}
libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/BackFillReference.java 0000644 0001750 0001750 00000004233 10071714370 026272 0 ustar moeller moeller /*
Copyright (c) 2002,2003, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime.impl;
/**
* Backfill reference item, used for filling in forward references to
* objects. Each reference to an item must define a class implementing
* this interface, to be used when a referenced item is not yet defined.
* The references for a particular object are collected by a BackFillHolder
* instance, and are processed when the object is defined.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public interface BackFillReference
{
/**
* Define referenced object. This method is called by the framework
* when the forward-referenced item is defined.
*
* @param obj referenced object
*/
public void backfill(Object obj);
}
libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/GenericXMLWriter.java 0000644 0001750 0001750 00000025321 10652101062 026130 0 ustar moeller moeller /*
Copyright (c) 2004-2007, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime.impl;
import java.io.IOException;
import java.io.Writer;
import org.jibx.runtime.ICharacterEscaper;
import org.jibx.runtime.IXMLWriter;
/**
* Generic handler for marshalling text document to a writer. This is the
* most general output handler since it can be used with any character encoding
* and and output writer.
*
* @author Dennis M. Sosnoski
*/
public class GenericXMLWriter extends XMLWriterBase
{
/** Writer for text output. */
private Writer m_writer;
/** Escaper for character data content output. */
private ICharacterEscaper m_escaper;
/** Indent tags for pretty-printed text. */
private boolean m_indent;
/** Base number of characters in indent sequence (end of line only). */
private int m_indentBase;
/** Number of extra characters in indent sequence per level of nesting. */
private int m_indentPerLevel;
/** Raw text for indentation sequences. */
private char[] m_indentSequence;
/**
* Constructor.
*
* @param uris ordered array of URIs for namespaces used in document (must
* be constant; the value in position 0 must always be the empty string "",
* and the value in position 1 must always be the XML namespace
* "http://www.w3.org/XML/1998/namespace")
*/
public GenericXMLWriter(String[] uris) {
super(uris);
}
/**
* Copy constructor. This takes the writer from a supplied instance, while
* setting a new array of namespace URIs. It's intended for use when
* invoking one binding from within another binding.
*
* @param base instance to be used as base for writer
* @param uris ordered array of URIs for namespaces used in document
* (see {@link #GenericXMLWriter(String[])})
*/
public GenericXMLWriter(GenericXMLWriter base, String[] uris) {
super(base, uris);
setOutput(base.m_writer, base.m_escaper);
m_indent = base.m_indent;
m_indentBase = base.m_indentBase;
m_indentPerLevel = base.m_indentPerLevel;
m_indentSequence = base.m_indentSequence;
}
/**
* Set output writer and escaper. If an output writer is currently open when
* this is called the existing writer is flushed and closed, with any
* errors ignored.
*
* @param outw writer for document data output
* @param escaper character escaper for chosen encoding
*/
public void setOutput(Writer outw, ICharacterEscaper escaper) {
try {
close();
} catch (IOException e) { /* deliberately empty */ }
m_writer = outw;
m_escaper = escaper;
reset();
}
/**
* Set nesting indentation. This is advisory only, and implementations of
* this interface are free to ignore it. The intent is to indicate that the
* generated output should use indenting to illustrate element nesting.
*
* @param count number of character to indent per level, or disable
* indentation if negative (zero means new line only)
* @param newline sequence of characters used for a line ending
* (null means use the single character '\n')
* @param indent whitespace character used for indentation
*/
public void setIndentSpaces(int count, String newline, char indent) {
if (count >= 0) {
if (newline == null) {
newline = "\n";
}
m_indent = true;
m_indentBase = newline.length();
m_indentPerLevel = count;
int length = newline.length() + count * 10;
m_indentSequence = new char[length];
for (int i = 0; i < length; i++) {
if (i < newline.length()) {
m_indentSequence[i] = newline.charAt(i);
} else {
m_indentSequence[i] = indent;
}
}
} else {
m_indent = false;
}
}
/**
* Write markup text to output. Markup text can be written directly to the
* output without the need for any escaping.
*
* @param text markup text to be written
* @throws IOException if error writing to document
*/
protected void writeMarkup(String text) throws IOException {
m_writer.write(text);
}
/**
* Write markup character to output. Markup text can be written directly to
* the output without the need for any escaping.
*
* @param chr markup character to be written
* @throws IOException if error writing to document
*/
protected void writeMarkup(char chr) throws IOException {
m_writer.write(chr);
}
/**
* Report that namespace has been defined.
*
* @param index namespace URI index number
* @param prefix prefix used for namespace
*/
protected void defineNamespace(int index, String prefix) {}
/**
* Report that namespace has been undefined.
*
* @param index namespace URI index number
*/
protected void undefineNamespace(int index) {}
/**
* Write namespace prefix to output. This internal method is used to throw
* an exception when an undeclared prefix is used.
*
* @param index namespace URI index number
* @throws IOException if error writing to document
*/
protected void writePrefix(int index) throws IOException {
try {
String text = getNamespacePrefix(index);
if (text.length() > 0) {
m_writer.write(text);
m_writer.write(':');
}
} catch (NullPointerException ex) {
throw new IOException("Namespace URI has not been declared.");
}
}
/**
* Write attribute text to output. This needs to write the text with any
* appropriate escaping.
*
* @param text attribute value text to be written
* @throws IOException if error writing to document
*/
protected void writeAttributeText(String text) throws IOException {
m_escaper.writeAttribute(text, m_writer);
}
/**
* Write ordinary character data text content to document. This needs to
* write the text with any appropriate escaping.
*
* @param text content value text
* @throws IOException on error writing to document
*/
public void writeTextContent(String text) throws IOException {
flagTextContent();
m_escaper.writeContent(text, m_writer);
}
/**
* Write CDATA text to document. This needs to write the text with any
* appropriate escaping.
*
* @param text content value text
* @throws IOException on error writing to document
*/
public void writeCData(String text) throws IOException {
flagTextContent();
m_escaper.writeCData(text, m_writer);
}
/**
* Request output indent. Output the line end sequence followed by the
* appropriate number of indent characters.
*
* @param bias indent depth difference (positive or negative) from current
* element nesting depth
* @throws IOException on error writing to document
*/
public void indent(int bias) throws IOException {
if (m_indent) {
int length = m_indentBase +
(getNestingDepth() + bias) * m_indentPerLevel;
if (length > m_indentSequence.length) {
int use = Math.max(length,
m_indentSequence.length*2 - m_indentBase);
char[] grow = new char[use];
System.arraycopy(m_indentSequence, 0, grow, 0,
m_indentSequence.length);
for (int i = m_indentSequence.length; i < use; i++) {
grow[i] = grow[m_indentBase];
}
m_indentSequence = grow;
}
m_writer.write(m_indentSequence, 0, length);
}
}
/**
* Request output indent. Output the line end sequence followed by the
* appropriate number of indent characters for the current nesting level.
*
* @throws IOException on error writing to document
*/
public void indent() throws IOException {
indent(0);
}
/**
* Flush document output. Forces out all output generated to this point.
*
* @throws IOException on error writing to document
*/
public void flush() throws IOException {
// internal flush only, do not pass through to writer
flagContent();
}
/**
* Close document output. Completes writing of document output, including
* closing the output medium.
*
* @throws IOException on error writing to document
*/
public void close() throws IOException {
flush();
if (m_writer != null) {
m_writer.close();
m_writer = null;
}
}
/**
* Create a child writer instance to be used for a separate binding. The
* child writer inherits the stream and encoding from this writer, while
* using the supplied namespace URIs.
*
* @param uris ordered array of URIs for namespaces used in document
* (see {@link #GenericXMLWriter(String[])})
* @return child writer
*/
public IXMLWriter createChildWriter(String[] uris) {
return new GenericXMLWriter(this, uris);
}
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/IChunkedOutput.java 0000644 0001750 0001750 00000005545 10705471646 025740 0 ustar moeller moeller /*
Copyright (c) 2007, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime.impl;
import java.io.IOException;
/**
* Interface used to enhance an output stream with a separate method for writing
* the last chunk of data in a message. This is useful when working with a
* chunking transport layer, so that the output stream knows which particular
* write operation is the last one in the sequence.
*
* @author Dennis M. Sosnoski
*/
public interface IChunkedOutput
{
/**
* Normal write from byte array. This method is included only to make it
* clear that the {@link #writeFinal(byte[], int, int)} is an alternative to
* the normal write.
*
* @param b byte array
* @param off starting offset
* @param len number of bytes to write
* @throws IOException on write error
*/
void write(byte[] b, int off, int len) throws IOException;
/**
* Write last data chunk from byte array. This method finishes output. It is
* an error if any further write operations (using either the {@link
* #write(byte[], int, int)} method defined in this interface, or any of the
* other java.io.OutputStream methods) are executed after the
* call to this method.
*
* @param b byte array
* @param off starting offset
* @param len number of bytes to write
* @throws IOException on write error
*/
void writeFinal(byte[] b, int off, int len) throws IOException;
}
libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/ISO88591Escaper.java 0000644 0001750 0001750 00000017361 10071714376 025374 0 ustar moeller moeller /*
Copyright (c) 2004, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime.impl;
import java.io.IOException;
import java.io.Writer;
import org.jibx.runtime.ICharacterEscaper;
/**
* Handler for writing ASCII output stream. This code is specifically for XML
* 1.0 and would require changes for XML 1.1 (to handle the added legal
* characters, rather than throwing an exception).
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class ISO88591Escaper implements ICharacterEscaper
{
/** Singleton instance of class. */
private static final ISO88591Escaper s_instance = new ISO88591Escaper();
/**
* Private constructor to prevent external creation.
*/
private ISO88591Escaper() {}
/**
* Write attribute value with character entity substitutions. This assumes
* that attributes use the regular quote ('"') delimitor.
*
* @param text attribute value text
* @param writer sink for output text
* @throws IOException on error writing to document
*/
public void writeAttribute(String text, Writer writer) throws IOException {
int mark = 0;
for (int i = 0; i < text.length(); i++) {
char chr = text.charAt(i);
if (chr == '"') {
writer.write(text, mark, i-mark);
mark = i+1;
writer.write(""");
} else if (chr == '&') {
writer.write(text, mark, i-mark);
mark = i+1;
writer.write("&");
} else if (chr == '<') {
writer.write(text, mark, i-mark);
mark = i+1;
writer.write("<");
} else if (chr == '>' && i > 2 && text.charAt(i-1) == ']' &&
text.charAt(i-2) == ']') {
writer.write(text, mark, i-mark-2);
mark = i+1;
writer.write("]]>");
} else if (chr < 0x20) {
if (chr != 0x9 && chr != 0xA && chr != 0xD) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) + " in attribute value text");
}
} else if (chr >= 0x80) {
if (chr < 0xA0 || chr > 0xFF) {
writer.write(text, mark, i-mark);
mark = i+1;
if (chr > 0xD7FF && (chr < 0xE000 || chr == 0xFFFE ||
chr == 0xFFF || chr > 0x10FFFF)) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) +
" in attribute value text");
}
writer.write("&#x");
writer.write(Integer.toHexString(chr));
writer.write(';');
}
}
}
writer.write(text, mark, text.length()-mark);
}
/**
* Write content value with character entity substitutions.
*
* @param text content value text
* @param writer sink for output text
* @throws IOException on error writing to document
*/
public void writeContent(String text, Writer writer) throws IOException {
int mark = 0;
for (int i = 0; i < text.length(); i++) {
char chr = text.charAt(i);
if (chr == '&') {
writer.write(text, mark, i-mark);
mark = i+1;
writer.write("&");
} else if (chr == '<') {
writer.write(text, mark, i-mark);
mark = i+1;
writer.write("<");
} else if (chr == '>' && i > 2 && text.charAt(i-1) == ']' &&
text.charAt(i-2) == ']') {
writer.write(text, mark, i-mark-2);
mark = i+1;
writer.write("]]>");
} else if (chr < 0x20) {
if (chr != 0x9 && chr != 0xA && chr != 0xD) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) + " in content text");
}
} else if (chr >= 0x80) {
if (chr < 0xA0 || chr > 0xFF) {
writer.write(text, mark, i-mark);
mark = i+1;
if (chr > 0xD7FF && (chr < 0xE000 || chr == 0xFFFE ||
chr == 0xFFF || chr > 0x10FFFF)) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) + " in content text");
}
writer.write("&#x");
writer.write(Integer.toHexString(chr));
writer.write(';');
}
}
}
writer.write(text, mark, text.length()-mark);
}
/**
* Write CDATA to document. This writes the beginning and ending sequences
* for a CDATA section as well as the actual text, verifying that only
* characters allowed by the encoding are included in the text.
*
* @param text content value text
* @param writer sink for output text
* @throws IOException on error writing to document
*/
public void writeCData(String text, Writer writer) throws IOException {
writer.write("' && i > 2 && text.charAt(i-1) == ']' &&
text.charAt(i-2) == ']') {
throw new IOException("Sequence \"]]>\" is not allowed " +
"within CDATA section text");
} else if (chr < 0x20) {
if (chr != 0x9 && chr != 0xA && chr != 0xD) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) + " in CDATA section");
}
} else if (chr >= 0x80 && (chr < 0xA0 || chr > 0xFF)) {
throw new IOException("Character code 0x" +
Integer.toHexString(chr) +
" not supported by encoding in CDATA section");
}
}
writer.write(text);
writer.write("]]>");
}
/**
* Get instance of escaper.
*
* @return escaper instance
*/
public static ICharacterEscaper getInstance() {
return s_instance;
}
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/ISO88591StreamWriter.java 0000644 0001750 0001750 00000033073 11003053060 026416 0 ustar moeller moeller /*
Copyright (c) 2004-2008, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime.impl;
import java.io.IOException;
import org.jibx.runtime.IXMLWriter;
/**
* Handler for marshalling text document to a UTF-8 output stream.
*
* @author Dennis M. Sosnoski
*/
public class ISO88591StreamWriter extends StreamWriterBase
{
/**
* Constructor with supplied buffer.
*
* @param uris ordered array of URIs for namespaces used in document (must
* be constant; the value in position 0 must always be the empty string "",
* and the value in position 1 must always be the XML namespace
* "http://www.w3.org/XML/1998/namespace")
* @param buffer output data buffer
*/
public ISO88591StreamWriter(String[] uris, byte[] buffer) {
super("ISO-8859-1", uris, buffer);
try {
defineNamespace(0, "");
defineNamespace(1, "xml");
} catch (IOException e) {
throw new RuntimeException(e.getMessage());
}
}
/**
* Constructor using default buffer size.
*
* @param uris ordered array of URIs for namespaces used in document (must
* be constant; the value in position 0 must always be the empty string "",
* and the value in position 1 must always be the XML namespace
* "http://www.w3.org/XML/1998/namespace")
*/
public ISO88591StreamWriter(String[] uris) {
this(uris, new byte[DEFAULT_BUFFER_SIZE]);
}
/**
* Copy constructor. This uses the stream and actual buffer from a supplied
* instance, while setting a new array of namespace URIs. It's intended for
* use when invoking one binding from within another binding.
*
* @param base instance to be used as base for writer
* @param uris ordered array of URIs for namespaces used in document
* (see {@link #ISO88591StreamWriter(String[])})
*/
public ISO88591StreamWriter(ISO88591StreamWriter base, String[] uris) {
super(base, uris);
m_prefixBytes = new byte[uris.length][];
try {
defineNamespace(0, "");
defineNamespace(1, "xml");
} catch (IOException e) {
throw new RuntimeException(e.getMessage());
}
}
/**
* Write markup text to output. Markup text can be written directly to the
* output without the need for any escaping, but still needs to be properly
* encoded.
*
* @param text markup text to be written
* @throws IOException if error writing to document
*/
protected void writeMarkup(String text) throws IOException {
int length = text.length();
makeSpace(length);
int fill = m_fillOffset;
for (int i = 0; i < length; i++) {
char chr = text.charAt(i);
if (chr > 0xFF) {
throw new IOException("Unable to write character code 0x" +
Integer.toHexString(chr) + " in encoding ISO-8859-1");
} else {
m_buffer[fill++] = (byte)chr;
}
}
m_fillOffset = fill;
}
/**
* Write markup character to output. Markup text can be written directly to
* the output without the need for any escaping, but still needs to be
* properly encoded.
*
* @param chr markup character to be written
* @throws IOException if error writing to document
*/
protected void writeMarkup(char chr) throws IOException {
makeSpace(1);
if (chr > 0xFF) {
throw new IOException("Unable to write character code 0x" +
Integer.toHexString(chr) + " in encoding ISO-8859-1");
} else {
m_buffer[m_fillOffset++] = (byte)chr;
}
}
/**
* Report that namespace has been defined.
*
* @param index namespace URI index number
* @param prefix prefix used for namespace
* @throws IOException if error writing to document
*/
protected void defineNamespace(int index, String prefix)
throws IOException {
byte[] buff;
if (prefix.length() > 0) {
buff = new byte[prefix.length()+1];
for (int i = 0; i < buff.length-1; i++) {
char chr = prefix.charAt(i);
if (chr > 0xFF) {
throw new IOException("Unable to write character code 0x" +
Integer.toHexString(chr) + " in encoding ISO-8859-1");
} else {
buff[i] = (byte)chr;
}
}
buff[buff.length-1] = ':';
} else {
buff = new byte[0];
}
if (index < m_prefixBytes.length) {
m_prefixBytes[index] = buff;
} else if (m_extensionBytes != null) {
index -= m_prefixBytes.length;
for (int i = 0; i < m_extensionBytes.length; i++) {
int length = m_extensionBytes[i].length;
if (index < length) {
m_extensionBytes[i][index] = buff;
} else {
index -= length;
}
}
} else {
throw new IllegalArgumentException("Index out of range");
}
}
/**
* Write attribute text to output. This needs to write the text with any
* appropriate escaping.
*
* @param text attribute value text to be written
* @throws IOException if error writing to document
*/
protected void writeAttributeText(String text) throws IOException {
int length = text.length();
makeSpace(length * 6);
int fill = m_fillOffset;
for (int i = 0; i < length; i++) {
char chr = text.charAt(i);
if (chr == '"') {
fill = writeEntity(QUOT_ENTITY, fill);
} else if (chr == '&') {
fill = writeEntity(AMP_ENTITY, fill);
} else if (chr == '<') {
fill = writeEntity(LT_ENTITY, fill);
} else if (chr == '>' && i > 2 && text.charAt(i-1) == ']' &&
text.charAt(i-2) == ']') {
m_buffer[fill++] = (byte)']';
m_buffer[fill++] = (byte)']';
fill = writeEntity(GT_ENTITY, fill);
} else if (chr < 0x20) {
if (chr != 0x9 && chr != 0xA && chr != 0xD) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) + " in attribute value text");
} else {
m_buffer[fill++] = (byte)chr;
}
} else {
if (chr > 0xFF) {
if (chr > 0xD7FF && (chr < 0xE000 || chr == 0xFFFE ||
chr == 0xFFFF || chr > 0x10FFFF)) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) +
" in attribute value text");
} else {
m_fillOffset = fill;
makeSpace(length - i + 8);
fill = m_fillOffset;
m_buffer[fill++] = (byte)'&';
m_buffer[fill++] = (byte)'#';
m_buffer[fill++] = (byte)'x';
for (int j = 12; j >= 0; j -= 4) {
int nib = (chr >> j) & 0xF;
if (nib < 10) {
m_buffer[fill++] = (byte)('0' + nib);
} else {
m_buffer[fill++] = (byte)('A' + nib);
}
}
m_buffer[fill++] = (byte)';';
}
} else {
m_buffer[fill++] = (byte)chr;
}
}
}
m_fillOffset = fill;
}
/**
* Write ordinary character data text content to document.
*
* @param text content value text
* @throws IOException on error writing to document
*/
public void writeTextContent(String text) throws IOException {
flagTextContent();
int length = text.length();
makeSpace(length * 5);
int fill = m_fillOffset;
for (int i = 0; i < length; i++) {
char chr = text.charAt(i);
if (chr == '&') {
fill = writeEntity(AMP_ENTITY, fill);
} else if (chr == '<') {
fill = writeEntity(LT_ENTITY, fill);
} else if (chr == '>' && i > 2 && text.charAt(i-1) == ']' &&
text.charAt(i-2) == ']') {
fill = writeEntity(GT_ENTITY, fill);
} else if (chr < 0x20) {
if (chr != 0x9 && chr != 0xA && chr != 0xD) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) + " in content text");
} else {
m_buffer[fill++] = (byte)chr;
}
} else {
if (chr > 0xFF) {
if (chr > 0xD7FF && (chr < 0xE000 || chr == 0xFFFE ||
chr == 0xFFFF || chr > 0x10FFFF)) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) +
" in character data text");
} else {
m_fillOffset = fill;
makeSpace(length - i + 8);
fill = m_fillOffset;
m_buffer[fill++] = (byte)'&';
m_buffer[fill++] = (byte)'#';
m_buffer[fill++] = (byte)'x';
for (int j = 12; j >= 0; j -= 4) {
int nib = (chr >> j) & 0xF;
if (nib < 10) {
m_buffer[fill++] = (byte)('0' + nib);
} else {
m_buffer[fill++] = (byte)('A' + nib);
}
}
m_buffer[fill++] = (byte)';';
}
} else {
m_buffer[fill++] = (byte)chr;
}
}
}
m_fillOffset = fill;
}
/**
* Write CDATA text to document.
*
* @param text content value text
* @throws IOException on error writing to document
*/
public void writeCData(String text) throws IOException {
flagTextContent();
int length = text.length();
makeSpace(length + 12);
int fill = m_fillOffset;
fill = writeEntity(LT_CDATASTART, fill);
for (int i = 0; i < length; i++) {
char chr = text.charAt(i);
if (chr == '>' && i > 2 && text.charAt(i-1) == ']' &&
text.charAt(i-2) == ']') {
throw new IOException("Sequence \"]]>\" is not allowed " +
"within CDATA section text");
} else if (chr < 0x20) {
if (chr != 0x9 && chr != 0xA && chr != 0xD) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) + " in content text");
} else {
m_buffer[fill++] = (byte)chr;
}
} else {
if (chr > 0xFF) {
throw new IOException("Character code 0x" +
Integer.toHexString(chr) +
" not allowed by encoding in CDATA section text");
} else {
m_buffer[fill++] = (byte)chr;
}
}
}
m_fillOffset = writeEntity(LT_CDATAEND, fill);
}
/**
* Create a child writer instance to be used for a separate binding. The
* child writer inherits the stream and encoding from this writer, while
* using the supplied namespace URIs.
*
* @param uris ordered array of URIs for namespaces used in document
* (see {@link #ISO88591StreamWriter(String[])})
* @return child writer
* @throws IOException
*/
public IXMLWriter createChildWriter(String[] uris) throws IOException {
flagContent();
return new ISO88591StreamWriter(this, uris);
}
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/ITrackSourceImpl.java 0000644 0001750 0001750 00000004416 10071714376 026175 0 ustar moeller moeller /*
Copyright (c) 2004, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime.impl;
import org.jibx.runtime.ITrackSource;
/**
* Unmarshalling source tracking implementation interface. This interface is
* added to bound classes when requested by the binding definition. It defines
* the method used by JiBX to add unmarshal source tracking information to an
* instance of a bound class.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public interface ITrackSourceImpl extends ITrackSource
{
/**
* Set source document information.
*
* @param name of source document, or null if none
* @param line source document line number, or -1 if unknown
* @param column source document column position, or -1 if
* unknown
*/
public void jibx_setSource(String name, int line, int column);
}
libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/IXMLReaderFactory.java 0000644 0001750 0001750 00000010505 10434260716 026232 0 ustar moeller moeller /*
Copyright (c) 2005, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime.impl;
import java.io.InputStream;
import java.io.Reader;
import org.jibx.runtime.IXMLReader;
import org.jibx.runtime.JiBXException;
/**
* Interface for factories used to create XML reader instances. Instances of
* this interface must be assumed to be single threaded.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public interface IXMLReaderFactory
{
/**
* Get new XML reader instance for document from input stream.
*
* @param is document input stream
* @param name document name (null if unknown)
* @param enc document character encoding (null if unknown)
* @param nsf namespaces enabled flag
* @return new reader instance for document
* @throws JiBXException on parser configuration error
*/
public IXMLReader createReader(InputStream is, String name, String enc,
boolean nsf) throws JiBXException;
/**
* Get new XML reader instance for document from reader.
*
* @param rdr document reader
* @param name document name (null if unknown)
* @param nsf namespaces enabled flag
* @return new reader instance for document
* @throws JiBXException on parser configuration error
*/
public IXMLReader createReader(Reader rdr, String name, boolean nsf)
throws JiBXException;
/**
* Recycle XML reader instance for new document from input stream. If the
* supplied reader can be reused it will be configured for the new document
* and returned; otherwise, a new reader will be created for the document.
* The namespace enabled state of the returned reader is always the same as
* that of the supplied reader.
*
* @param old reader instance to be recycled
* @param is document input stream
* @param name document name (null if unknown)
* @param enc document character encoding (null if unknown)
* @return new reader instance for document
* @throws JiBXException on parser configuration error
*/
public IXMLReader recycleReader(IXMLReader old, InputStream is, String name,
String enc) throws JiBXException;
/**
* Recycle XML reader instance for document from reader. If the supplied
* reader can be reused it will be configured for the new document and
* returned; otherwise, a new reader will be created for the document. The
* namespace enabled state of the returned reader is always the same as that
* of the supplied reader.
*
* @param old reader instance to be recycled
* @param rdr document reader
* @param name document name (null if unknown)
* @return new reader instance for document
* @throws JiBXException on parser configuration error
*/
public IXMLReader recycleReader(IXMLReader old, Reader rdr, String name)
throws JiBXException;
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/InputStreamWrapper.java 0000644 0001750 0001750 00000056612 10732007636 026634 0 ustar moeller moeller /*
Copyright (c) 2004-2007, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime.impl;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
/**
* Wrapper for input stream that supports multiple character encodings. This is
* needed because the XPP3 pull parser does not support detecting the character
* encoding for a document based on the content of the document. If used with a
* common encoding this performs the conversion to characters using an inner
* reader class; otherwise, this creates the appropriate reader type
*
* @author Dennis M. Sosnoski
*/
public class InputStreamWrapper
{
/** Default input buffer size. */
public static final int DEFAULT_BUFFER_SIZE = 4096;
/** Name of encoding to be used for stream. */
private String m_encodingName;
/** Stream for byte input. */
private InputStream m_stream;
/** Flag for end of stream reached. */
private boolean m_isEnd;
/** Buffer for input bytes. */
private byte[] m_buffer;
/** Offset past end of bytes in buffer. */
private int m_endOffset;
/** Current offset for generating character from buffer. */
private int m_emptyOffset;
/** Scan position offset used for lookahead in buffer. */
private int m_scanOffset;
/**
* Constructor.
*/
public InputStreamWrapper(int size) {
m_buffer = new byte[size];
}
/**
* Constructor using default buffer size.
*/
public InputStreamWrapper() {
this(DEFAULT_BUFFER_SIZE);
}
/**
* Set input stream with encoding to be defined later. If an input stream is
* currently open when this is called the existing stream is closed, with
* any errors ignored.
*
* @param ins stream for document data input
*/
public void setInput(InputStream ins) {
try {
close();
} catch (IOException e) { /* deliberately empty */ }
reset();
m_stream = ins;
}
/**
* Set input stream with specified encoding. If an input stream is currently
* open when this is called the existing stream is closed, with any errors
* ignored.
*
* @param ins stream for document data input
* @param enc character encoding used for input from stream
* (null if to be determined from XML input)
* @throws IOException
*/
public void setInput(InputStream ins, String enc) throws IOException {
setInput(ins);
setEncoding(enc);
}
/**
* Set encoding for stream. This call is only valid if the encoding has not
* been set previously, and if the encoding is a recognized type.
*
* @param enc character encoding used for input from stream
* (null if to be determined from XML input)
* @throws IOException if unknown encoding, or encoding already set
*/
public void setEncoding(String enc) throws IOException {
if (m_encodingName == null) {
m_encodingName = enc;
} else {
throw new IOException("Encoding has already been set for stream");
}
}
/**
* Reads data into the buffer. Any retained data is first copied down to the
* start of the buffer array. Next, data is read from the wrapped stream
* into the available space in the buffer. The actual number of characters
* read by a call to this method is normally between one and the space
* available in the buffer array.
*
* @return true if data has been read into buffer,
* false if not
* @throws IOException on error reading from wrapped stream
*/
private boolean fillBuffer() throws IOException {
if (m_isEnd) {
return false;
} else {
// move remaining data in buffer down to start
int rem = m_endOffset - m_emptyOffset;
if (rem > 0) {
System.arraycopy(m_buffer, m_emptyOffset, m_buffer, 0, rem);
}
m_emptyOffset = 0;
// read to maximum capacity of buffer
int max = m_buffer.length - rem;
int actual = m_stream.read(m_buffer, rem, max);
if (actual >= 0) {
m_endOffset = rem + actual;
return true;
} else {
m_endOffset = rem;
m_isEnd = true;
return false;
}
}
}
/**
* Reads data into the buffer to at least a minimum number of bytes. Any
* retained data is first copied down to the start of the buffer array.
* Next, data is read from the wrapped stream into the available space in
* the buffer until the end of the input stream is reached or at least the
* requested number of bytes are present in the buffer.
*
* @param min number of bytes required
* @return true if buffer contains at least the required byte
* count on return, false if not
* @throws IOException on error reading from wrapped stream
*/
private boolean require(int min) throws IOException {
while (m_endOffset - m_emptyOffset < min) {
if (!fillBuffer()) {
return false;
}
}
return true;
}
/**
* Check if a character is XML whitespace.
*
* @param chr
* @return true if whitespace, false if not
*/
private boolean isWhite(int chr) {
return chr == ' ' || chr == 0x09 || chr == 0x0A || chr == 0x0D;
}
/**
* Reads a space or equals ('=') delimited token from the scan position in
* the buffer. This treats bytes in the buffer as equivalent to characters.
* Besides ending a token on a delimitor, it also ends a token after adding
* a greater-than ('>') character.
*
* @return token read from buffer
* @throws IOException on error reading from wrapped stream
*/
private String scanToken() throws IOException {
boolean skipping = true;
StringBuffer buff = new StringBuffer();
while (require(m_scanOffset+1)) {
char chr = (char)m_buffer[m_scanOffset++];
if (skipping) {
if (!isWhite(chr)) {
skipping = false;
buff.append(chr);
if (chr == '=') {
return buff.toString();
}
}
} else if (isWhite(chr) || chr == '=') {
m_scanOffset--;
return buff.toString();
} else {
buff.append(chr);
if (chr == '>') {
return buff.toString();
}
}
}
return null;
}
/**
* Reads a quote delimited token from the scan position in the buffer. This
* treats bytes in the buffer as equivalent to characters, and skips past
* any leading whitespace.
*
* @return token read from buffer
* @throws IOException on error reading from wrapped stream
*/
private String scanQuoted() throws IOException {
boolean skipping = true;
int quot = 0;
StringBuffer buff = new StringBuffer();
while (require(m_scanOffset+1)) {
char chr = (char)m_buffer[m_scanOffset++];
if (skipping) {
if (!isWhite(chr)) {
if (chr == '"' || chr == '\'') {
skipping = false;
quot = chr;
} else {
break;
}
}
} else if (chr == quot) {
return buff.toString();
} else {
buff.append(chr);
}
}
return null;
}
/**
* Get reader for wrapped input stream. This creates and returns a reader
* using the appropriate encoding, if necessary reading and examining the
* first part of the stream (including the XML declaration, if present) to
* determine the encoding.
*
* @return reader
* @throws IOException if error reading from document or creating a reader
* for the encoding found
*/
public Reader getReader() throws IOException {
// check if we need to determine an encoding
if (m_encodingName == null) {
// try to get enough input to decide if anything other than default
m_encodingName = "UTF-8";
if (require(4)) {
// get first four bytes for initial determination
int bom = (((m_buffer[0] << 8) + (m_buffer[1] & 0xFF) << 8) +
(m_buffer[2] & 0xFF) << 8) + (m_buffer[3] & 0xFF);
if (bom == 0x3C3F786D) {
// read encoding declaration with single byte characters
m_scanOffset = 2;
String token = scanToken();
if ("xml".equals(token)) {
while ((token = scanToken()) != null &&
!"?>".equals(token)) {
if ("encoding".equals(token)) {
if ("=".equals(scanToken())) {
token = scanQuoted();
if (token != null) {
m_encodingName = token;
break;
}
}
} else if ("=".equals(token)) {
scanQuoted();
}
}
}
} else if (bom == 0x0000FEFF || bom == 0xFFFE0000 ||
bom == 0x0000FFFE || bom == 0xFEFF0000) {
// just use generic UCS-4 and let the libaries figure it out
m_encodingName = "UCS-4";
} else if ((bom & 0xFFFFFF00) == 0xEFBBBF00) {
// UTF-8 as specified by byte order mark
m_encodingName = "UTF-8";
} else {
int upper = bom & 0xFFFF0000;
if (upper == 0xFEFF0000 || bom == 0x003C003F) {
// assume UTF-16BE for 16-bit BE
m_encodingName = "UTF-16BE";
} else if (upper == 0xFFFE0000 || bom == 0x3C003F00) {
// assume UTF-16LE for 16-bit LE
m_encodingName = "UTF-16LE";
} else if (bom == 0x4C6FA794){
// just because we can, even though nobody should
m_encodingName = "EBCDIC";
}
}
}
}
if (m_encodingName.equalsIgnoreCase("UTF-8")) {
return new WrappedStreamUTF8Reader();
} else if (m_encodingName.equalsIgnoreCase("ISO-8859-1") ||
m_encodingName.equalsIgnoreCase("ASCII")) {
return new WrappedStreamISO88591Reader();
} else {
return new InputStreamReader(new WrappedStream(), m_encodingName);
}
}
/**
* Get encoding for input document. This call may not return an accurate
* result until after {@link #getReader} is called.
*
* @return character encoding for input document
*/
public String getEncoding() {
return m_encodingName;
}
/**
* Close document input. Completes reading of document input, including
* closing the input medium.
*
* @throws IOException on error closing document
*/
public void close() throws IOException {
if (m_stream != null) {
m_stream.close();
m_stream = null;
}
reset();
}
/**
* Reset to initial state for reuse.
*/
public void reset() {
m_isEnd = false;
m_endOffset = 0;
m_emptyOffset = 0;
m_encodingName = null;
m_stream = null;
}
/**
* Stream that just uses the enclosing class to buffer input from the
* wrapped stream.
*/
private class WrappedStream extends InputStream
{
/* (non-Javadoc)
* @see java.io.InputStream#available()
*/
public int available() throws IOException {
return m_endOffset - m_emptyOffset + m_stream.available();
}
/* (non-Javadoc)
* @see java.io.InputStream#close()
*/
public void close() throws IOException {
InputStreamWrapper.this.close();
}
/* (non-Javadoc)
* @see java.io.InputStream#read(byte[], int, int)
*/
public int read(byte[] b, int off, int len) throws IOException {
int avail;
int actual = 0;
while (len > (avail = m_endOffset - m_emptyOffset)) {
System.arraycopy(m_buffer, m_emptyOffset, b, off, avail);
off += avail;
len -= avail;
actual += avail;
m_emptyOffset = m_endOffset = 0;
if (!fillBuffer()) {
return actual == 0 ? -1 : actual;
}
}
System.arraycopy(m_buffer, m_emptyOffset, b, off, len);
m_emptyOffset += len;
return actual + len;
}
/* (non-Javadoc)
* @see java.io.InputStream#read(byte[])
*/
public int read(byte[] b) throws IOException {
return read(b, 0, b.length);
}
/* (non-Javadoc)
* @see java.io.InputStream#skip(long)
*/
public long skip(long n) throws IOException {
int avail = m_endOffset - m_emptyOffset;
if (n >= (long)avail) {
return avail + m_stream.skip(n - avail);
} else {
m_emptyOffset += (int)n;
return n;
}
}
/* (non-Javadoc)
* @see java.io.InputStream#read()
*/
public int read() throws IOException {
if (m_emptyOffset >= m_endOffset && !fillBuffer()) {
return -1;
} else {
return m_buffer[m_emptyOffset++];
}
}
}
/**
* Reader for input stream using UTF-8 encoding. This uses the enclosing
* class to buffer input from the stream, interpreting it as characters on
* demand.
*/
private class WrappedStreamUTF8Reader extends Reader
{
/* (non-Javadoc)
* @see java.io.Reader#close()
*/
public void close() throws IOException {
InputStreamWrapper.this.close();
}
/* (non-Javadoc)
* @see java.io.Reader#read(char[], int, int)
*/
public int read(char[] b, int off, int len) throws IOException {
// load up local variables for conversion loop
int end = off + len;
int empty = m_emptyOffset;
byte[] buff = m_buffer;
while (off < end) {
// fill buffer if less than maximum byte count in character
if (empty + 3 > m_endOffset) {
m_emptyOffset = empty;
fillBuffer();
empty = m_emptyOffset;
if (empty == m_endOffset) {
int actual = len + off - end;
return actual > 0 ? actual : -1;
}
}
// check for single-byte vs multi-byte character next
int byt = buff[empty++];
if (byt >= 0) {
// single-byte character, just store to output array
b[off++] = (char)byt;
if (byt == 0) {
System.err.println("Wrote null");
}
} else if ((byt & 0xE0) == 0xC0) {
// double-byte character, check bytes available and store
if (empty < m_endOffset) {
b[off++] = (char)(((byt & 0x1F) << 6) +
(buff[empty++] & 0x3F));
if (b[off-1] == 0) {
System.err.println("Wrote null");
}
} else {
throw new IOException("UTF-8 conversion error");
}
} else {
// three-byte character, check bytes available and store
if (empty + 1 < m_endOffset) {
int byt2 = buff[empty++] & 0x3F;
b[off++] = (char)((((byt & 0x0F) << 6) +
byt2 << 6) + (buff[empty++] & 0x3F));
if (b[off-1] == 0) {
System.err.println("Wrote null");
}
} else {
throw new IOException("UTF-8 conversion error");
}
}
}
m_emptyOffset = empty;
return len;
}
/* (non-Javadoc)
* @see java.io.Reader#read(char[])
*/
public int read(char[] b) throws IOException {
return read(b, 0, b.length);
}
/* (non-Javadoc)
* @see java.io.Reader#read()
*/
public int read() throws IOException {
// fill buffer if less than maximum byte count in character
if (m_emptyOffset + 3 > m_endOffset) {
fillBuffer();
if (m_emptyOffset == m_endOffset) {
return -1;
}
}
// check for single-byte vs multi-byte character next
int byt = m_buffer[m_emptyOffset++];
if (byt >= 0) {
// single-byte character, just store to output array
return byt & 0xFF;
} else if ((byt & 0xE0) == 0xC0) {
// double-byte character, check bytes available and store
if (m_emptyOffset < m_endOffset) {
return ((byt & 0x1F) << 6) +
(m_buffer[m_emptyOffset++] & 0x3F);
} else {
throw new IOException("UTF-8 conversion error");
}
} else {
// three-byte character, check bytes available and store
if (m_emptyOffset + 1 < m_endOffset) {
int byt2 = m_buffer[m_emptyOffset++] & 0xFF;
return (((byt & 0x0F) << 6) +
byt2 << 6) + (m_buffer[m_emptyOffset++] & 0x3F);
} else {
throw new IOException("UTF-8 conversion error");
}
}
}
/* (non-Javadoc)
* @see java.io.Reader#ready()
*/
public boolean ready() throws IOException {
return m_emptyOffset + 2 < m_endOffset;
}
}
/**
* Reader for input stream using ISO8859-1 encoding. This uses the enclosing
* class to buffer input from the stream, interpreting it as characters on
* demand.
*/
private class WrappedStreamISO88591Reader extends Reader
{
/* (non-Javadoc)
* @see java.io.Reader#close()
*/
public void close() throws IOException {
InputStreamWrapper.this.close();
}
/* (non-Javadoc)
* @see java.io.Reader#read(char[], int, int)
*/
public int read(char[] b, int off, int len) throws IOException {
// load up local variables for conversion loop
int end = off + len;
int empty = m_emptyOffset;
byte[] buff = m_buffer;
while (off < end) {
// make sure there's data in buffer
int avail = m_endOffset - empty;
if (avail == 0) {
m_emptyOffset = empty;
if (fillBuffer()) {
empty = m_emptyOffset;
avail = m_endOffset - empty;
} else {
int actual = len + off - end;
return actual > 0 ? actual : -1;
}
}
// find count of bytes to convert to characters
int use = end - off;
if (use > avail) {
use = avail;
}
// convert bytes directly to characters
int limit = empty + use;
while (empty < limit) {
b[off++] = (char)(buff[empty++] & 0xFF);
}
}
m_emptyOffset = empty;
return len;
}
/* (non-Javadoc)
* @see java.io.Reader#read(char[])
*/
public int read(char[] b) throws IOException {
return read(b, 0, b.length);
}
/* (non-Javadoc)
* @see java.io.Reader#read()
*/
public int read() throws IOException {
if (m_emptyOffset >= m_endOffset && !fillBuffer()) {
return -1;
} else {
return m_buffer[m_emptyOffset++] & 0xFF;
}
}
/* (non-Javadoc)
* @see java.io.Reader#ready()
*/
public boolean ready() throws IOException {
return m_emptyOffset < m_endOffset;
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/MarshallingContext.java 0000644 0001750 0001750 00000133520 10736011440 026610 0 ustar moeller moeller /*
Copyright (c) 2002-2007, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime.impl;
import java.io.*;
import java.util.*;
import org.jibx.runtime.*;
import org.jibx.runtime.ICharacterEscaper;
import org.jibx.runtime.IMarshallable;
import org.jibx.runtime.IMarshaller;
import org.jibx.runtime.IMarshallingContext;
import org.jibx.runtime.JiBXException;
/**
* JiBX serializer supplying convenience methods for marshalling. Most of these
* methods are designed for use in code generated by the binding generator.
*
* @author Dennis M. Sosnoski
*/
public class MarshallingContext implements IMarshallingContext
{
/** Fixed XML namespace. */
public static final String XML_NAMESPACE =
"http://www.w3.org/XML/1998/namespace";
/** Starting size for object stack. */
private static final int INITIAL_STACK_SIZE = 20;
/** Binding factory used to create this unmarshaller. */
private IBindingFactory m_factory;
/** Names of classes included in mapping definition. */
private String[] m_classes;
/** Number of classes with global marshallers. */
private int m_globalCount;
/** Marshaller classes for mapping definition (null for
mappings out of context). */
private String[] m_marshallerClasses;
/** Marshallers for classes in mapping definition (lazy create of actual
marshaller instances) */
private IMarshaller[] m_marshallers;
/** URIs for namespaces used in binding. */
private String[] m_uris;
/** Current marshalling stack depth. */
private int m_stackDepth;
/** Stack of objects being marshalled. */
private Object[] m_objectStack;
/** Indent character count per level. */
private int m_indentCount;
/** Character sequence for end of line. */
private String m_newLine;
/** Character used for indenting. */
private char m_indentChar;
/** Shared map from IDs to objects. This is not used directly by the
marshalling code, but is available for user extensions (lazy create). */
private HashMap m_idMap;
/** Output document handler. */
private IXMLWriter m_writer;
/** User context object (not used by JiBX, only for user convenience). */
protected Object m_userContext;
/**
* Constructor.
*
* @param classes ordered array of class names included in mapping
* definition (reference kept, must be constant)
* @param mcs names of marshaller classes for indexes with fixed marshallers
* (as opposed to mapping slots, which may be overridden; reference kept,
* must be constant)
* @param uris ordered array of URIs for namespaces used in binding (must
* be constant; the value in position 0 must always be the empty string "",
* and the value in position 1 must always be the XML namespace
* "http://www.w3.org/XML/1998/namespace")
* @param ifact binding factory creating this unmarshaller
*/
public MarshallingContext(String[] classes, String[] mcs, String[] uris,
IBindingFactory ifact) {
m_classes = classes;
m_globalCount = mcs.length;
m_marshallers = new IMarshaller[classes.length];
m_marshallerClasses = new String[classes.length];
System.arraycopy(mcs, 0, m_marshallerClasses, 0, mcs.length);
m_uris = uris;
m_objectStack = new Object[INITIAL_STACK_SIZE];
m_indentCount = -1;
m_indentChar = ' ';
m_newLine = "\n";
m_factory = ifact;
}
/**
* Create character escaper for encoding.
*
* @param enc document output encoding, or null for default
* @return character escaper for encoding
* @throws JiBXException if error creating setting output
*/
private ICharacterEscaper createEscaper(String enc) throws JiBXException {
if (enc.equalsIgnoreCase("UTF-8") || enc.equalsIgnoreCase("UTF-16") ||
enc.equalsIgnoreCase("UTF-16BE") ||
enc.equalsIgnoreCase("UTF-16LE")) {
return UTF8Escaper.getInstance();
} else if (enc.equalsIgnoreCase("ISO-8859-1")) {
return ISO88591Escaper.getInstance();
} else if (enc.equalsIgnoreCase("US-ASCII")) {
return USASCIIEscaper.getInstance();
} else {
throw new JiBXException
("No character escaper defined for encoding " + enc);
}
}
/**
* Set output stream with encoding and escaper. This forces handling of the
* output stream to use the Java character encoding support with the
* supplied escaper.
*
* @param outs stream for document data output
* @param enc document output encoding, or null uses UTF-8
* default
* @param esc escaper for writing characters to stream
* @throws JiBXException if error setting output
*/
public void setOutput(OutputStream outs, String enc, ICharacterEscaper esc)
throws JiBXException {
try {
if (enc == null) {
enc = "UTF-8";
}
// handle any other encodings using library support
if (!(m_writer instanceof GenericXMLWriter)) {
m_writer = new GenericXMLWriter(m_uris);
m_writer.setIndentSpaces(m_indentCount, m_newLine,
m_indentChar);
}
Writer writer = new BufferedWriter
(new OutputStreamWriter(outs, enc));
((GenericXMLWriter)m_writer).setOutput(writer, esc);
reset();
} catch (IOException ex) {
throw new JiBXException("Error setting output", ex);
}
}
/**
* Set output stream and encoding.
*
* @param outs stream for document data output
* @param enc document output encoding, or null for default
* @throws JiBXException if error creating setting output
*/
public void setOutput(OutputStream outs, String enc) throws JiBXException {
if (enc == null) {
enc = "UTF-8";
}
if ("UTF-8".equalsIgnoreCase(enc)) {
// handle UTF-8 output to stream directly
if (!(m_writer instanceof UTF8StreamWriter)) {
m_writer = new UTF8StreamWriter(m_uris);
m_writer.setIndentSpaces(m_indentCount, m_newLine,
m_indentChar);
}
((UTF8StreamWriter)m_writer).setOutput(outs);
reset();
} else if ("ISO-8859-1".equalsIgnoreCase(enc)) {
// handle ISO-8859-1 output to stream directly
if (!(m_writer instanceof ISO88591StreamWriter)) {
m_writer = new ISO88591StreamWriter(m_uris);
m_writer.setIndentSpaces(m_indentCount, m_newLine,
m_indentChar);
}
((ISO88591StreamWriter)m_writer).setOutput(outs);
reset();
} else {
setOutput(outs, enc, createEscaper(enc));
}
}
/**
* Set output writer and escaper.
*
* @param outw writer for document data output
* @param esc escaper for writing characters
*/
public void setOutput(Writer outw, ICharacterEscaper esc) {
if (!(m_writer instanceof GenericXMLWriter)) {
m_writer = new GenericXMLWriter(m_uris);
m_writer.setIndentSpaces(m_indentCount, m_newLine,
m_indentChar);
}
((GenericXMLWriter)m_writer).setOutput(outw, esc);
reset();
}
/**
* Set output writer.
*
* @param outw writer for document data output
*/
public void setOutput(Writer outw) {
setOutput(outw, UTF8Escaper.getInstance());
}
/**
* Get the writer being used for output.
*
* @return XML writer used for output
*/
public IXMLWriter getXmlWriter() {
return m_writer;
}
/**
* Set the writer being used for output.
*
* @param xwrite XML writer used for output
*/
public void setXmlWriter(IXMLWriter xwrite) {
m_writer = xwrite;
}
/**
* Get current nesting indent spaces. This returns the number of spaces used
* to show indenting, if used.
*
* @return number of spaces indented per level, or negative if indentation
* disabled
*/
public int getIndent() {
return m_indentCount;
}
/**
* Set nesting indent spaces. This is advisory only, and implementations of
* this interface are free to ignore it. The intent is to indicate that the
* generated output should use indenting to illustrate element nesting.
*
* @param count number of spaces to indent per level, or disable
* indentation if negative
*/
public void setIndent(int count) {
if (m_writer != null) {
m_writer.setIndentSpaces(count, m_newLine, m_indentChar);
}
m_indentCount = count;
}
/**
* Set nesting indentation. This is advisory only, and implementations of
* this interface are free to ignore it. The intent is to indicate that the
* generated output should use indenting to illustrate element nesting.
*
* @param count number of character to indent per level, or disable
* indentation if negative (zero means new line only)
* @param newline sequence of characters used for a line ending
* (null means use the single character '\n')
* @param indent whitespace character used for indentation
*/
public void setIndent(int count, String newline, char indent) {
if (m_writer != null) {
m_writer.setIndentSpaces(count, newline, indent);
}
m_indentCount = count;
m_newLine = newline;
m_indentChar = indent;
}
/**
* Initializes the context to use the same marshalled text destination and
* parameters as another marshalling context. This method is designed for
* use when an initial context needs to create and invoke a secondary
* context (generally from a different binding) in the course of an
* marshalling operation. Note that once the secondary context has been used
* it's generally necessary to do a {@link XMLWriterBase#flush()} operation
* on the writer used by the that context before resuming output on the
* parent.
*
* @param parent context supplying target for marshalled document text
* @throws IOException on error writing output
*/
public void setFromContext(MarshallingContext parent) throws IOException {
reset();
m_indentCount = parent.m_indentCount;
m_newLine = parent.m_newLine;
m_indentChar = parent.m_indentChar;
if (parent.m_writer instanceof IExtensibleWriter) {
IExtensibleWriter base = (IExtensibleWriter)parent.m_writer;
base.flush();
m_writer = base.createChildWriter(m_uris);
} else if (parent.m_writer instanceof StAXWriter) {
m_writer = ((StAXWriter)parent.m_writer).createChildWriter(m_uris);
} else {
m_writer = parent.m_writer;
}
}
/**
* Reset to initial state for reuse. The context is serially reusable,
* as long as this method is called to clear any retained state information
* between uses. It is automatically called when output is set.
*/
public void reset() {
if (m_writer != null) {
m_writer.reset();
}
for (int i = m_globalCount; i < m_marshallers.length; i++) {
m_marshallers[i] = null;
}
for (int i = 0; i < m_objectStack.length; i++) {
m_objectStack[i] = null;
}
m_stackDepth = 0;
}
/**
* Return the binding factory used to create this unmarshaller.
*
* @return binding factory
*/
public IBindingFactory getFactory() {
return m_factory;
}
/**
* Get namespace URIs for mapping. This gets the full ordered array of
* namespaces known in the binding used for this marshalling, where the
* index number of each namespace URI is the namespace index used to lookup
* the prefix when marshalling a name in that namespace. The returned array
* must not be modified.
*
* @return array of namespaces
*/
public String[] getNamespaces() {
return m_uris;
}
/**
* Start document. This can only be validly called immediately following
* one of the set output methods; otherwise the output document will be
* corrupt.
*
* @param enc document encoding, null if not specified
* @param alone standalone document flag, null if not
* specified
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public void startDocument(String enc, Boolean alone) throws JiBXException {
try {
String atext = null;
if (alone != null) {
atext = alone.booleanValue() ? "yes" : "no";
}
m_writer.writeXMLDecl("1.0", enc, atext);
} catch (IOException ex) {
throw new JiBXException("Error writing marshalled document", ex);
}
}
/**
* Start document with output stream and encoding. The effect is the same
* as from first setting the output stream and encoding, then making the
* call to start document.
*
* @param enc document encoding, null if not specified
* @param alone standalone document flag, null if not
* specified
* @param outs stream for document data output
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public void startDocument(String enc, Boolean alone, OutputStream outs)
throws JiBXException {
setOutput(outs, enc);
startDocument(enc, alone);
}
/**
* Start document with writer. The effect is the same as from first
* setting the writer, then making the call to start document.
*
* @param enc document encoding, null if not specified
* @param alone standalone document flag, null if not
* specified
* @param outw writer for document data output
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public void startDocument(String enc, Boolean alone, Writer outw)
throws JiBXException {
setOutput(outw);
startDocument(enc, alone);
}
/**
* End document. Finishes all output and closes the document. Note that if
* this is called with an imcomplete marshalling the result will not be
* well-formed XML.
*
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public void endDocument() throws JiBXException {
try {
m_writer.close();
} catch (IOException ex) {
throw new JiBXException("Error writing marshalled document", ex);
}
}
/**
* Build name with optional namespace. Just returns the appropriate
* name format.
*
* @param index namespace URI index number
* @param name local name part of name
* @return formatted name string
*/
public String buildNameString(int index, String name) {
String ns = m_writer.getNamespaceUri(index);
if (ns == null || "".equals(ns)) {
return "\"" + name + "\"";
} else {
return "\"{" + ns + "}" + name + "\"";
}
}
/**
* Generate start tag for element without attributes.
*
* @param index namespace URI index number
* @param name element name
* @return this context (to allow chained calls)
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public MarshallingContext startTag(int index, String name)
throws JiBXException {
try {
m_writer.startTagClosed(index, name);
return this;
} catch (IOException ex) {
throw new JiBXException("Error writing marshalled document", ex);
}
}
/**
* Generate start tag for element with attributes. This only opens the start
* tag, allowing attributes to be added immediately following this call.
*
* @param index namespace URI index number
* @param name element name
* @return this context (to allow chained calls)
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public MarshallingContext startTagAttributes(int index, String name)
throws JiBXException {
try {
m_writer.startTagOpen(index, name);
return this;
} catch (IOException ex) {
throw new JiBXException("Error writing marshalled document", ex);
}
}
/**
* Generate text attribute. This can only be used following an open start
* tag with attributes.
*
* @param index namespace URI index number
* @param name attribute name
* @param value text value for attribute (cannot be null)
* @return this context (to allow chained calls)
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public MarshallingContext attribute(int index, String name, String value)
throws JiBXException {
try {
m_writer.addAttribute(index, name, value);
return this;
} catch (IOException ex) {
throw new JiBXException("Error writing marshalled document", ex);
} catch (Exception ex) {
String text = buildNameString(index, name);
if (value == null) {
throw new JiBXException("null value for attribute " +
text + " from object of type " +
getStackTop().getClass().getName());
} else {
throw new JiBXException
("Exception while marshalling attribute " + text, ex);
}
}
}
/**
* Generate integer attribute. This can only be used following an open start
* tag.
*
* @param index namespace URI index number
* @param name attribute name
* @param value integer value for attribute
* @return this context (to allow chained calls)
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public MarshallingContext attribute(int index, String name, int value)
throws JiBXException {
return attribute(index, name, Integer.toString(value));
}
/**
* Generate enumeration attribute. The actual text to be written is obtained
* by indexing into the supplied array of values. This can only be used
* following an open start tag.
*
* @param index namespace URI index number
* @param name attribute name
* @param value integer enumeration value (zero-based)
* @param table text values in enumeration
* @return this context (to allow chained calls)
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public MarshallingContext attribute(int index, String name, int value,
String[] table) throws JiBXException {
try {
return attribute(index, name, table[value]);
} catch (ArrayIndexOutOfBoundsException ex) {
throw new JiBXException("Enumeration value of " + value +
" is outside to allowed range of 0 to " + table.length);
}
}
/**
* Close start tag with content to follow.
*
* @return this context (to allow chained calls)
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public MarshallingContext closeStartContent() throws JiBXException {
try {
m_writer.closeStartTag();
return this;
} catch (IOException ex) {
throw new JiBXException("Error writing marshalled document", ex);
}
}
/**
* Close start tag with no content (empty tag).
*
* @return this context (to allow chained calls)
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public MarshallingContext closeStartEmpty() throws JiBXException {
try {
m_writer.closeEmptyTag();
return this;
} catch (IOException ex) {
throw new JiBXException("Error writing marshalled document", ex);
}
}
/**
* Add text content to current element.
*
* @param value text element content
* @return this context (to allow chained calls)
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public MarshallingContext content(String value) throws JiBXException {
try {
m_writer.writeTextContent(value);
return this;
} catch (IOException ex) {
throw new JiBXException("Error writing marshalled document", ex);
}
}
/**
* Add integer content to current element.
*
* @param value integer element content
* @return this context (to allow chained calls)
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public MarshallingContext content(int value) throws JiBXException {
content(Integer.toString(value));
return this;
}
/**
* Add enumeration content to current element. The actual text to be
* written is obtained by indexing into the supplied array of values.
*
* @param value integer enumeration value (zero-based)
* @param table text values in enumeration
* @return this context (to allow chained calls)
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public MarshallingContext content(int value, String[] table)
throws JiBXException {
try {
content(table[value]);
return this;
} catch (ArrayIndexOutOfBoundsException ex) {
throw new JiBXException("Enumeration value of " + value +
" is outside to allowed range of 0 to " + table.length);
}
}
/**
* Generate end tag for element.
*
* @param index namespace URI index number
* @param name element name
* @return this context (to allow chained calls)
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public MarshallingContext endTag(int index, String name)
throws JiBXException {
try {
m_writer.endTag(index, name);
return this;
} catch (IOException ex) {
throw new JiBXException("Error writing marshalled document", ex);
}
}
/**
* Generate complete element with text content.
*
* @param index namespace URI index number
* @param name element name
* @param value text element content
* @return this context (to allow chained calls)
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public MarshallingContext element(int index, String name, String value)
throws JiBXException {
try {
if (value.length() == 0) {
m_writer.startTagOpen(index, name);
m_writer.closeEmptyTag();
} else {
m_writer.startTagClosed(index, name);
m_writer.writeTextContent(value);
m_writer.endTag(index, name);
}
return this;
} catch (IOException ex) {
throw new JiBXException("Error writing marshalled document", ex);
} catch (Exception ex) {
String text = buildNameString(index, name);
if (value == null) {
throw new JiBXException("null value for element " +
text + " from object of type " +
getStackTop().getClass().getName());
} else {
throw new JiBXException
("Exception while marshalling element " + text, ex);
}
}
}
/**
* Generate complete element with integer content.
*
* @param index namespace URI index number
* @param name element name
* @param value integer element content
* @return this context (to allow chained calls)
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public MarshallingContext element(int index, String name, int value)
throws JiBXException {
return element(index, name, Integer.toString(value));
}
/**
* Generate complete element with enumeration content. The actual text to be
* written is obtained by indexing into the supplied array of values.
*
* @param index namespace URI index number
* @param name element name
* @param value integer enumeration value (zero-based)
* @param table text values in enumeration
* @return this context (to allow chained calls)
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public MarshallingContext element(int index, String name, int value,
String[] table) throws JiBXException {
try {
return element(index, name, table[value]);
} catch (ArrayIndexOutOfBoundsException ex) {
throw new JiBXException("Enumeration value of " + value +
" is outside to allowed range of 0 to " + table.length);
}
}
/**
* Write CDATA text to document.
*
* @param text content value text
* @return this context (to allow chained calls)
* @throws IOException on error writing to document
*/
public MarshallingContext writeCData(String text) throws IOException {
try {
m_writer.writeCData(text);
return this;
} catch (NullPointerException e) {
if (text == null) {
throw new IOException
("Null value writing CDATA from object of type " +
getStackTop().getClass().getName());
} else {
throw e;
}
}
}
/**
* Write content value with character entity substitutions.
*
* @param text content value text
* @return this context (to allow chained calls)
* @throws IOException on error writing to document
*/
public MarshallingContext writeContent(String text) throws IOException {
try {
m_writer.writeTextContent(text);
return this;
} catch (NullPointerException e) {
if (text == null) {
throw new IOException
("Null value writing text content from object " +
getStackTop().getClass().getName());
} else {
throw e;
}
}
}
/**
* Marshal all items in a collection. This variation is for generic
* collections.
*
* @param col collection of items to be marshalled
* @return this context (to allow chained calls)
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public MarshallingContext marshalCollection(Collection col)
throws JiBXException {
Iterator iter = col.iterator();
while (iter.hasNext()) {
Object obj = iter.next();
if (obj instanceof IMarshallable) {
((IMarshallable)obj).marshal(this);
} else {
throw new JiBXException
("Unmarshallable object of class " + obj.getClass() +
" found in marshalling");
}
}
return this;
}
/**
* Marshal all items in a collection. This variation is for ArrayList
* collections.
*
* @param col collection of items to be marshalled
* @return this context (to allow chained calls)
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public MarshallingContext marshalCollection(ArrayList col)
throws JiBXException {
for (int i = 0; i < col.size(); i++) {
Object obj = col.get(i);
if (obj instanceof IMarshallable) {
((IMarshallable)obj).marshal(this);
} else {
throw new JiBXException
("Unmarshallable object of class " +
obj.getClass().getName() + " found in marshalling");
}
}
return this;
}
/**
* Marshal all items in a collection. This variation is for Vector
* collections.
*
* @param col collection of items to be marshalled
* @return this context (to allow chained calls)
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public MarshallingContext marshalCollection(Vector col)
throws JiBXException {
for (int i = 0; i < col.size(); i++) {
Object obj = col.elementAt(i);
if (obj instanceof IMarshallable) {
((IMarshallable)obj).marshal(this);
} else {
throw new JiBXException
("Unmarshallable object of class " +
obj.getClass().getName() + " found in marshalling");
}
}
return this;
}
/**
* Define marshalling for class. Adds the marshalling definition using fixed
* indexes for each class, allowing direct lookup of the marshaller when
* multiple versions are defined.
*
* @param index class index for marshalling definition
* @param name marshaller class name handling
*/
public void addMarshalling(int index, String name) {
m_marshallerClasses[index] = name;
}
/**
* Undefine marshalling for element. Removes the marshalling
* definition for a particular class index.
*
* @param index class index for marshalling definition
*/
public void removeMarshalling(int index) {
m_marshallers[index] = null;
}
/**
* Generate start tag for element with namespaces. This creates the actual
* start tag, along with any necessary namespace declarations. Previously
* active namespace declarations are not duplicated. The tag is
* left incomplete, allowing other attributes to be added.
*
* TODO: Handle nested default namespaces declarations, prefixes for outers
*
* @param index namespace URI index number
* @param name element name
* @param nums array of namespace indexes defined by this element (must
* be constant, reference is kept until end of element)
* @param prefs array of namespace prefixes mapped by this element (no
* null values, use "" for default namespace declaration)
* @return this context (to allow chained calls)
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public MarshallingContext startTagNamespaces(int index, String name,
int[] nums, String[] prefs) throws JiBXException {
try {
m_writer.startTagNamespaces(index, name, nums, prefs);
return this;
} catch (IOException ex) {
throw new JiBXException("Error writing marshalled document", ex);
}
}
/**
* Find the marshaller for a particular class index
* in the current context.
* TODO: Eliminate the string passing, since it's not a common enough
* problem to be worth checking (and with abstract mappings can be really
* difficult to set properly)
*
* @param index class index for marshalling definition
* @param name fully qualified name of class to be marshalled (used only
* for validation)
* @return marshalling handler for class
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public IMarshaller getMarshaller(int index, String name)
throws JiBXException {
if (index >= m_classes.length || !name.equals(m_classes[index])) {
throw new JiBXException("Marshalling not defined for class " +
name);
}
if (m_marshallers[index] == null) {
// load the marshaller class and create an instance
String mname = m_marshallerClasses[index];
if (mname == null) {
throw new JiBXException("No marshaller defined for class " +
name);
}
try {
// first try loading class from binding factory class loader
Class clas = null;
ClassLoader factldr = null;
if (m_factory != null) {
factldr = m_factory.getClass().getClassLoader();
try {
clas = factldr.loadClass(mname);
} catch (ClassNotFoundException e) { /* fall through */ }
}
if (clas == null) {
// next try the context class loader, if set
ClassLoader ctxldr =
Thread.currentThread().getContextClassLoader();
if (ctxldr != null) {
try {
clas = ctxldr.loadClass(mname);
} catch (ClassNotFoundException e) { /* fall through */ }
}
if (clas == null) {
// not found, try the loader that loaded this class
ClassLoader thisldr =
MarshallingContext.class.getClassLoader();
if (thisldr != factldr && thisldr != ctxldr) {
try {
clas = thisldr.loadClass(mname);
} catch (ClassNotFoundException e)
{ /* fall through */ }
}
}
}
if (clas == null) {
throw new JiBXException("Unable to load marshaller class " +
mname);
}
// create an instance of marshaller class
IMarshaller m = (IMarshaller)clas.newInstance();
m_marshallers[index] = m;
} catch (JiBXException e) {
throw e;
} catch (Exception e) {
throw new JiBXException
("Unable to create marshaller of class " + mname + ":",
e);
}
}
return m_marshallers[index];
}
/**
* Marshal document from root object. This internal method just verifies
* that the object is marshallable, then calls the marshal method on the
* object itself.
*
* @param root object at root of structure to be marshalled, which must have
* a top-level mapping in the binding
* @throws JiBXException on any error (possibly wrapping other exception)
*/
protected void marshalRoot(Object root) throws JiBXException {
if (root instanceof IMarshallable) {
boolean valid = false;
IMarshallable mable = (IMarshallable)root;
int index = mable.JiBX_getIndex();
if (index < m_classes.length) {
String cname = m_classes[index];
Class mclass = mable.getClass();
while (!mclass.getName().equals("java.lang.Object")) {
if (mclass.getName().equals(cname)) {
valid = true;
break;
} else {
mclass = mclass.getSuperclass();
}
}
}
if (valid) {
mable.marshal(this);
} else {
throw new JiBXException("Supplied root object of class " +
root.getClass().getName() +
" is incompatible with the binding used for this context");
}
} else {
throw new JiBXException("Supplied root object of class " +
root.getClass().getName() +
" cannot be marshalled without top-level mapping");
}
}
/**
* Marshal document from root object without XML declaration. This can only
* be validly called immediately following one of the set output methods;
* otherwise the output document will be corrupt. The effect of this method
* is the same as the sequence of a call to marshal the root object using
* this context followed by a call to {@link #endDocument}.
*
* @param root object at root of structure to be marshalled, which must have
* a top-level mapping in the binding
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public void marshalDocument(Object root) throws JiBXException {
marshalRoot(root);
endDocument();
}
/**
* Marshal document from root object. This can only be validly called
* immediately following one of the set output methods; otherwise the output
* document will be corrupt. The effect of this method is the same as the
* sequence of a call to {@link #startDocument}, a call to marshal the root
* object using this context, and finally a call to {@link #endDocument}.
*
* @param root object at root of structure to be marshalled, which must have
* a top-level mapping in the binding
* @param enc document encoding, null if not specified
* @param alone standalone document flag, null if not
* specified
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public void marshalDocument(Object root, String enc, Boolean alone)
throws JiBXException {
startDocument(enc, alone);
marshalRoot(root);
endDocument();
}
/**
* Marshal document from root object to output stream with encoding. The
* effect of this method is the same as the sequence of a call to {@link
* #startDocument}, a call to marshal the root object using this context,
* and finally a call to {@link #endDocument}.
*
* @param root object at root of structure to be marshalled, which must have
* a top-level mapping in the binding
* @param enc document encoding, null if not specified
* @param alone standalone document flag, null if not
* specified
* @param outs stream for document data output
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public void marshalDocument(Object root, String enc, Boolean alone,
OutputStream outs) throws JiBXException {
startDocument(enc, alone, outs);
marshalRoot(root);
endDocument();
}
/**
* Marshal document from root object to writer. The effect of this method
* is the same as the sequence of a call to {@link #startDocument}, a call
* to marshal the root object using this context, and finally a call to
* {@link #endDocument}.
*
* @param root object at root of structure to be marshalled, which must have
* a top-level mapping in the binding
* @param enc document encoding, null if not specified
* @param alone standalone document flag, null if not
* specified
* @param outw writer for document data output
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public void marshalDocument(Object root, String enc, Boolean alone,
Writer outw) throws JiBXException {
startDocument(enc, alone, outw);
marshalRoot(root);
endDocument();
}
/**
* Get shared ID map. The ID map returned is not used directly by the
* marshalling code, but is provided to support user extensions.
*
* @return ID map
*/
public HashMap getIdMap() {
if (m_idMap == null) {
m_idMap = new HashMap();
}
return m_idMap;
}
/**
* 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 the {@link #reset()} method,
* so to make use of this you need to first call the appropriate version of
* the setOutput() method, then this method, and finally one of
* the marshalDocument methods which uses the previously-set
* output (not the ones which take a stream or writer as parameter, since
* they call setOutput() themselves).
*
* @param obj user context object, or null if clearing existing
* context object
* @see #getUserContext()
*/
public void setUserContext(Object obj) {
m_userContext = obj;
}
/**
* Get the user context object.
*
* @return user context object, or null if no context object
* set
* @see #setUserContext(Object)
*/
public Object getUserContext() {
return m_userContext;
}
/**
* Push created object to marshalling stack. This must be called before
* beginning the marshalling of the object. It is only called for objects
* with structure, not for those converted directly to and from text.
*
* @param obj object being marshalled
*/
public void pushObject(Object obj) {
int depth = m_stackDepth;
if (depth >= m_objectStack.length) {
Object[] stack = new Object[depth*2];
System.arraycopy(m_objectStack, 0, stack, 0, depth);
m_objectStack = stack;
}
m_objectStack[depth] = obj;
m_stackDepth++;
}
/**
* Pop marshalled object from stack.
*
* @throws JiBXException if no object on stack
*/
public void popObject() throws JiBXException {
if (m_stackDepth > 0) {
--m_stackDepth;
} else {
throw new JiBXException("No object on stack");
}
}
/**
* Get current marshalling object stack depth. This allows tracking
* nested calls to marshal one object while in the process of
* marshalling another object. The bottom item on the stack is always the
* root object being marshalled.
*
* @return number of objects in marshalling stack
*/
public int getStackDepth() {
return m_stackDepth;
}
/**
* Get object from marshalling stack. This stack allows tracking nested
* calls to marshal one object while in the process of marshalling
* another object. The bottom item on the stack is always the root object
* being marshalled.
*
* @param depth object depth in stack to be retrieved (must be in the range
* of zero to the current depth minus one).
* @return object from marshalling stack
*/
public Object getStackObject(int depth) {
return m_objectStack[m_stackDepth-depth-1];
}
/**
* Get top object on marshalling stack. This is safe to call even when no
* objects are on the stack.
*
* @return object from marshalling stack, or null if none
*/
public Object getStackTop() {
if (m_stackDepth > 0) {
return m_objectStack[m_stackDepth-1];
} else {
return null;
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/RuntimeSupport.java 0000644 0001750 0001750 00000012414 10732007524 026024 0 ustar moeller moeller /*
Copyright (c) 2007, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime.impl;
/**
* Support class providing methods used by generated code.
*
* @author Dennis M. Sosnoski
*/
public abstract class RuntimeSupport
{
/**
* Split concatenated class names string into an array of individual class
* names. This is used by the generated binding factory code, to reduce the
* size of the generated classes and methods. It takes as input a string
* consisting of compacted fully-qualified class names separated by '|'
* delimitor characters. If the compacted name starts with one or more '.'
* characters the corresponding number of package name levels are taken from
* the last class name. Empty names are left null in the array.
*
* @param count number of names
* @param blob compacted class names separated by '|' delimitors
* @return expanded class names
*/
public static String[] splitClassNames(int count, String blob) {
String[] names = new String[count];
String last = "";
int split = -1;
int index = 0;
StringBuffer buff = new StringBuffer();
while (split < blob.length()) {
int base = split + 1;
split = blob.indexOf('|', base);
if (split < 0) {
split = blob.length();
}
if (split > base) {
int mark = 0;
while (blob.charAt(base) == '.') {
mark = last.indexOf('.', mark) + 1;
base++;
}
buff.setLength(0);
if (mark > 0) {
buff.append(last.substring(0, mark));
}
buff.append(blob.substring(base, split));
names[index] = last = buff.toString().intern();
}
index++;
}
return names;
}
/**
* Expand names URI indexes into an array of individual names URIs. This is
* used by the generated binding factory code, to reduce the size of the
* generated classes and methods. It takes as input a string where each
* character is a namespace index, biased by +2 in order to avoid the use of
* null characters, along with a table of corresponding namespace URIs. The
* character value 1 is used as a marker for the case where no namespace is
* associated with an index.
*
* @param blob string of characters representing namespace indexes
* @param uris namespace URIs defined in binding
* @return expanded class names
*/
public static String[] expandNamespaces(String blob, String[] uris) {
String[] nameuris = new String[blob.length()];
for (int i = 0; i < blob.length(); i++) {
int index = blob.charAt(i) - 2;
if (index >= 0) {
nameuris[i] = uris[index];
}
}
return nameuris;
}
/**
* Split concatenated names string into an array of individual names. This
* is used by the generated binding factory code, to reduce the size of the
* generated classes and methods. It takes as input a string consisting of
* names separated by '|' delimitor characters.
*
* @param count number of names
* @param blob element names separated by '|' delimitors
* @return expanded class names
*/
public static String[] splitNames(int count, String blob) {
String[] names = new String[count];
int split = -1;
int index = 0;
while (split < blob.length()) {
int base = split + 1;
split = blob.indexOf('|', base);
if (split < 0) {
split = blob.length();
}
if (split > base) {
names[index] = blob.substring(base, split);
}
index++;
}
return names;
}
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/SparseArrayIterator.java 0000644 0001750 0001750 00000006712 10257171674 026770 0 ustar moeller moeller /*
* Copyright (c) 2000-2001 Sosnoski Software Solutions, Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
* IN THE SOFTWARE.
*/
package org.jibx.runtime.impl;
import java.util.Iterator;
import java.util.NoSuchElementException;
/**
* Iterator class for sparse values in an array. This type of iterator
* can be used for an object array which has references interspersed with
* nulls.
*
* @author Dennis M. Sosnoski
* @version 1.1
*/
public class SparseArrayIterator implements Iterator
{
/** Array supplying values for iteration. */
protected Object[] m_array;
/** Offset of next iteration value. */
protected int m_offset;
/**
* Internal constructor.
*
* @param array array containing values to be iterated
*/
private SparseArrayIterator(Object[] array) {
m_array = array;
m_offset = -1;
advance();
}
/**
* Advance to next iteration value. This advances the current position in
* the array to the next non-null value.
*
* @return true if element available, false if
* not
*/
protected boolean advance() {
while (++m_offset < m_array.length) {
if (m_array[m_offset] != null) {
return true;
}
}
return false;
}
/**
* Check for iteration element available.
*
* @return true if element available, false if
* not
*/
public boolean hasNext() {
return m_offset < m_array.length;
}
/**
* Get next iteration element.
*
* @return next iteration element
* @exception NoSuchElementException if past end of iteration
*/
public Object next() {
if (m_offset < m_array.length) {
Object result = m_array[m_offset];
advance();
return result;
} else {
throw new NoSuchElementException();
}
}
/**
* Remove element from iteration. This optional operation is not supported
* and always throws an exception.
*
* @exception UnsupportedOperationException for unsupported operation
*/
public void remove() {
throw new UnsupportedOperationException();
}
/**
* Build iterator.
*
* @param array array containing values to be iterated (may be
* null)
* @return constructed iterator
*/
public static Iterator buildIterator(Object[] array) {
if (array == null || array.length == 0) {
return ArrayRangeIterator.EMPTY_ITERATOR;
} else {
return new SparseArrayIterator(array);
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/StAXReaderFactory.java 0000644 0001750 0001750 00000014100 10611642106 026265 0 ustar moeller moeller /*
Copyright (c) 2005, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime.impl;
import java.io.InputStream;
import java.io.Reader;
import javax.xml.stream.FactoryConfigurationError;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import org.jibx.runtime.IXMLReader;
import org.jibx.runtime.JiBXException;
/**
* Factory for creating XMLPull parser instances.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class StAXReaderFactory implements IXMLReaderFactory
{
/** Singleton instance of class. */
private static final StAXReaderFactory s_instance = new StAXReaderFactory();
/** Factory used for constructing parser instances. */
private final XMLInputFactory m_factory;
/** Namespace processing state configured on factory. */
private boolean m_isNamespaceEnabled;
/**
* Internal constructor.
*/
private StAXReaderFactory() {
XMLInputFactory factory;
try {
factory = XMLInputFactory.newInstance();
} catch (FactoryConfigurationError e) {
Thread thread = Thread.currentThread();
ClassLoader cl = thread.getContextClassLoader();
thread.setContextClassLoader
(StAXReaderFactory.class.getClassLoader());
try {
factory = XMLInputFactory.newInstance();
} finally {
thread.setContextClassLoader(cl);
}
}
m_factory = factory;
m_isNamespaceEnabled = true;
}
/**
* Get instance of factory.
*
* @return factory instance
*/
public static StAXReaderFactory getInstance() {
return s_instance;
}
/**
* Create new parser instance. In order to avoid thread safety issues the
* caller must have a lock on the factory object.
*
* @param nsf enable namespace processing on parser flag
* @throws JiBXException on error creating parser
*/
private void setNamespacesState(boolean nsf) throws JiBXException {
if (nsf != m_isNamespaceEnabled) {
try {
m_factory.setProperty(XMLInputFactory.IS_NAMESPACE_AWARE,
nsf ? Boolean.TRUE : Boolean.FALSE);
m_isNamespaceEnabled = nsf;
} catch (IllegalArgumentException e) {
throw new JiBXException
("Unable to create parser with required namespace handling");
}
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.impl.IXMLReaderFactory#createReader(java.io.InputStream, java.lang.String, java.lang.String, boolean)
*/
public IXMLReader createReader(InputStream is, String name, String enc,
boolean nsf) throws JiBXException {
try {
synchronized (m_factory) {
setNamespacesState(nsf);
if (enc == null) {
XMLStreamReader rdr = m_factory.createXMLStreamReader(is);
return new StAXReaderWrapper(rdr, name, nsf);
} else {
XMLStreamReader rdr =
m_factory.createXMLStreamReader(is, enc);
return new StAXReaderWrapper(rdr, name, nsf);
}
}
} catch (XMLStreamException e) {
throw new JiBXException("Error creating parser", e);
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.impl.IXMLReaderFactory#createReader(java.io.Reader, java.lang.String, boolean)
*/
public IXMLReader createReader(Reader rdr, String name, boolean nsf)
throws JiBXException {
try {
synchronized (m_factory) {
setNamespacesState(nsf);
return new StAXReaderWrapper(m_factory.createXMLStreamReader(rdr),
name, nsf);
}
} catch (XMLStreamException e) {
throw new JiBXException("Error creating parser", e);
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.impl.IXMLReaderFactory#recycleReader(org.jibx.runtime.IXMLReader, java.io.InputStream, java.lang.String, java.lang.String)
*/
public IXMLReader recycleReader(IXMLReader old, InputStream is, String name,
String enc) throws JiBXException {
return createReader(is, name, enc, old.isNamespaceAware());
}
/* (non-Javadoc)
* @see org.jibx.runtime.impl.IXMLReaderFactory#recycleReader(org.jibx.runtime.IXMLReader, java.io.Reader, java.lang.String)
*/
public IXMLReader recycleReader(IXMLReader old, Reader rdr, String name)
throws JiBXException {
return createReader(rdr, name, old.isNamespaceAware());
}
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/StAXReaderWrapper.java 0000644 0001750 0001750 00000035347 10624255756 026335 0 ustar moeller moeller package org.jibx.runtime.impl;
import javax.xml.stream.Location;
import javax.xml.stream.XMLStreamConstants;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import org.jibx.runtime.IXMLReader;
import org.jibx.runtime.IntStack;
import org.jibx.runtime.JiBXException;
/**
* Wrapper for a StAX parser implementation. This delegates most calls
* more or less directly, only adding the required namespace functionality
* on top of the StAX API.
*/
public class StAXReaderWrapper implements IXMLReader
{
/** Event type code translation array. Indexed by the StAX event code, it
returns the corresponding XML reader event code. */
static final byte[] s_eventTranslations = new byte[256];
static {
s_eventTranslations[XMLStreamConstants.CDATA] = IXMLReader.CDSECT;
s_eventTranslations[XMLStreamConstants.CHARACTERS] = IXMLReader.TEXT;
s_eventTranslations[XMLStreamConstants.COMMENT] = IXMLReader.COMMENT;
s_eventTranslations[XMLStreamConstants.DTD] = IXMLReader.DOCDECL;
s_eventTranslations[XMLStreamConstants.END_DOCUMENT] =
IXMLReader.END_DOCUMENT;
s_eventTranslations[XMLStreamConstants.END_ELEMENT] =
IXMLReader.END_TAG;
s_eventTranslations[XMLStreamConstants.ENTITY_REFERENCE] =
IXMLReader.ENTITY_REF;
s_eventTranslations[XMLStreamConstants.PROCESSING_INSTRUCTION] =
IXMLReader.PROCESSING_INSTRUCTION;
s_eventTranslations[XMLStreamConstants.SPACE] =
IXMLReader.IGNORABLE_WHITESPACE;
s_eventTranslations[XMLStreamConstants.START_DOCUMENT] =
IXMLReader.START_DOCUMENT;
s_eventTranslations[XMLStreamConstants.START_ELEMENT] =
IXMLReader.START_TAG;
}
/** Actual parser. */
private final XMLStreamReader m_parser;
/** Parser processing namespaces flag. */
final boolean m_isNamespaceAware;
/** Document name. */
private final String m_docName;
/** Current element nesting depth. */
int m_nestingDepth;
/** Namespace definitions in scope at each nesting depth. */
private IntStack m_inScopeCounts;
/** Namespace URIs in scope. */
private StringArray m_inScopeUris;
/** Namespace prefixes in scope. */
private StringArray m_inScopePrefixes;
/** Accumulated text for return. */
private String m_accumulatedText;
/** Accumulated text is processing instruction flag (otherwise content) */
private boolean m_isProcessingInstruction;
/** Document encoding (apparently cannot be read after parse done). */
private String m_encoding;
/**
* Constructor used by factory.
*
* @param rdr event reader
* @param nsa namespace aware flag
*/
public StAXReaderWrapper(XMLStreamReader rdr, String name, boolean nsa) {
m_parser = rdr;
m_docName = name;
m_isNamespaceAware = nsa;
m_inScopeCounts = new IntStack();
m_inScopeCounts.push(0);
m_inScopeUris = new StringArray();
m_inScopePrefixes = new StringArray();
}
/**
* Build current parse input position description.
*
* @return text description of current parse position
*/
public String buildPositionString() {
Location location = m_parser.getLocation();
String base = "(line " + location.getLineNumber() + ", col " +
location.getColumnNumber();
if (m_docName != null) {
base += ", in " + m_docName;
}
return base + ')';
}
/**
* Handle start tag. This increments the nesting count, and records all
* namespaces associated with the start tag.
*/
private void startTag() {
if (m_nestingDepth == 0) {
m_encoding = m_parser.getEncoding();
if (m_encoding == null) {
m_encoding = m_parser.getCharacterEncodingScheme();
if (m_encoding == null) {
m_encoding = "UTF-8";
}
}
}
m_nestingDepth++;
int count = m_parser.getNamespaceCount();
for (int i = 0; i < count; i++) {
m_inScopeUris.add(m_parser.getNamespaceURI(i));
m_inScopePrefixes.add(m_parser.getNamespacePrefix(i));
}
m_inScopeCounts.push(m_inScopeUris.size());
}
/**
* Handle end tag. This decrements the nesting count, and deletes all
* namespaces associated with the start tag.
*/
private void endTag() {
m_nestingDepth--;
int count = m_inScopeCounts.pop() - m_inScopeCounts.peek();
if (count > 0) {
m_inScopeUris.remove(count);
m_inScopePrefixes.remove(count);
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#nextToken()
*/
public int nextToken() throws JiBXException {
if (m_accumulatedText == null) {
try {
int code;
loop: while (true) {
code = s_eventTranslations[m_parser.next()];
switch (code) {
case START_TAG:
startTag();
break loop;
case END_TAG:
endTag();
break loop;
case PROCESSING_INSTRUCTION:
m_accumulatedText = m_parser.getPITarget() + ' ' +
m_parser.getPIData();
m_isProcessingInstruction = true;
while (s_eventTranslations[m_parser.next()] == 0);
break loop;
case 0:
break;
default:
break loop;
}
}
return code;
} catch (XMLStreamException e) {
throw new JiBXException
("Error parsing document " + buildPositionString(), e);
}
} else {
m_accumulatedText = null;
m_isProcessingInstruction = false;
int code = s_eventTranslations[m_parser.getEventType()];
if (code == START_TAG) {
startTag();
} else if (code == END_TAG) {
endTag();
}
return code;
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#next()
*/
public int next() throws JiBXException {
String text = null;
StringBuffer buff = null;
try {
int type;
if (m_accumulatedText == null) {
m_parser.next();
} else {
m_accumulatedText = null;
m_isProcessingInstruction = false;
}
loop: while (true) {
type = s_eventTranslations[m_parser.getEventType()];
switch (type) {
case ENTITY_REF:
if (m_parser.getText() == null) {
throw new JiBXException
("Unexpanded entity reference in text at " +
buildPositionString());
}
// fall through into text accumulation
case CDSECT:
case TEXT:
if (text == null) {
text = m_parser.getText();
} else {
if (buff == null) {
buff = new StringBuffer(text);
}
buff.append(m_parser.getTextCharacters());
}
break;
case END_TAG:
if (text == null) {
endTag();
return type;
}
break loop;
case START_TAG:
if (text == null) {
startTag();
return type;
}
break loop;
case END_DOCUMENT:
if (text == null) {
return type;
}
break loop;
default:
break;
}
m_parser.next();
}
if (buff == null) {
m_accumulatedText = text;
} else {
m_accumulatedText = buff.toString();
}
return TEXT;
} catch (XMLStreamException e) {
throw new JiBXException
("Error parsing document " + buildPositionString(), e);
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getEventType()
*/
public int getEventType() throws JiBXException {
if (m_accumulatedText == null) {
return s_eventTranslations[m_parser.getEventType()];
} else if (m_isProcessingInstruction) {
return PROCESSING_INSTRUCTION;
} else {
return TEXT;
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getName()
*/
public String getName() {
return m_parser.getLocalName();
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getNamespace()
*/
public String getNamespace() {
String uri = m_parser.getNamespaceURI();
if (uri == null) {
return "";
} else {
return uri;
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getPrefix()
*/
public String getPrefix() {
String prefix = m_parser.getPrefix();
if (prefix != null && prefix.length() == 0) {
return null;
} else {
return prefix;
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getAttributeCount()
*/
public int getAttributeCount() {
return m_parser.getAttributeCount();
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getAttributeName(int)
*/
public String getAttributeName(int index) {
try {
return m_parser.getAttributeLocalName(index);
} catch (ArrayIndexOutOfBoundsException e) {
throw new IllegalStateException(e.getMessage());
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getAttributeNamespace(int)
*/
public String getAttributeNamespace(int index) {
try {
String uri = m_parser.getAttributeNamespace(index);
if (uri == null) {
return "";
} else {
return uri;
}
} catch (ArrayIndexOutOfBoundsException e) {
throw new IllegalStateException(e.getMessage());
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getAttributePrefix(int)
*/
public String getAttributePrefix(int index) {
try {
String prefix = m_parser.getAttributePrefix(index);
if (prefix != null && prefix.length() == 0) {
return null;
} else {
return prefix;
}
} catch (ArrayIndexOutOfBoundsException e) {
throw new IllegalStateException(e.getMessage());
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getAttributeValue(int)
*/
public String getAttributeValue(int index) {
try {
return m_parser.getAttributeValue(index);
} catch (ArrayIndexOutOfBoundsException e) {
throw new IllegalStateException(e.getMessage());
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getAttributeValue(java.lang.String, java.lang.String)
*/
public String getAttributeValue(String ns, String name) {
try {
return m_parser.getAttributeValue(ns, name);
} catch (ArrayIndexOutOfBoundsException e) {
throw new IllegalStateException(e.getMessage());
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getText()
*/
public String getText() {
if (m_accumulatedText == null) {
return m_parser.getText();
} else {
return m_accumulatedText;
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getNestingDepth()
*/
public int getNestingDepth() {
return m_nestingDepth;
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getNamespaceCount(int)
*/
public int getNamespaceCount(int depth) {
return m_inScopeCounts.peek(m_nestingDepth-depth);
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getNamespaceUri(int)
*/
public String getNamespaceUri(int index) {
return m_inScopeUris.get(index);
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getNamespacePrefix(int)
*/
public String getNamespacePrefix(int index) {
String prefix = m_inScopePrefixes.get(index);
if (prefix != null && prefix.length() == 0) {
return null;
} else {
return prefix;
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getDocumentName()
*/
public String getDocumentName() {
return m_docName;
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getLineNumber()
*/
public int getLineNumber() {
return m_parser.getLocation().getLineNumber();
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getColumnNumber()
*/
public int getColumnNumber() {
return m_parser.getLocation().getColumnNumber();
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getNamespace(java.lang.String)
*/
public String getNamespace(String prefix) {
int index = m_inScopePrefixes.size();
while (--index >= 0) {
String comp = m_inScopePrefixes.get(index);
if ((prefix == null && comp == null) ||
(prefix != null && prefix.equals(comp))) {
return m_inScopeUris.get(index);
}
}
return null;
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getInputEncoding()
*/
public String getInputEncoding() {
return m_encoding;
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#isNamespaceAware()
*/
public boolean isNamespaceAware() {
return m_isNamespaceAware;
}
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/StAXWriter.java 0000644 0001750 0001750 00000030437 10736011440 025021 0 ustar moeller moeller /*
Copyright (c) 2005-2007, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime.impl;
import java.io.IOException;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;
import org.jibx.runtime.IExtensibleWriter;
import org.jibx.runtime.IXMLWriter;
/**
* Writer generating StAX parse event stream output.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class StAXWriter extends XMLWriterNamespaceBase implements IExtensibleWriter
{
/** Target for parse event stream. */
private XMLStreamWriter m_writer;
/**
* Constructor.
*
* @param uris ordered array of URIs for namespaces used in document (must
* be constant; the value in position 0 must always be the empty string "",
* and the value in position 1 must always be the XML namespace
* "http://www.w3.org/XML/1998/namespace")
*/
public StAXWriter(String[] uris) {
super(uris);
}
/**
* Constructor with writer supplied.
*
* @param uris ordered array of URIs for namespaces used in document (must
* be constant; the value in position 0 must always be the empty string "",
* and the value in position 1 must always be the XML namespace
* "http://www.w3.org/XML/1998/namespace")
* @param wrtr StAX writer for parse event output
*/
public StAXWriter(String[] uris, XMLStreamWriter wrtr) {
this(uris);
m_writer = wrtr;
}
/**
* Copy constructor. This initializes the writer and extension namespace
* information from an existing instance.
*
* @param base existing instance
* @param uris ordered array of URIs for namespaces used in document
*/
public StAXWriter(StAXWriter base, String[] uris) {
super(base, uris);
m_writer = base.m_writer;
}
/**
* Set StAX writer.
*
* @param wrtr StAX writer for parse event output
*/
public void setWriter(XMLStreamWriter wrtr) {
m_writer = wrtr;
}
/* (non-Javadoc)
* @see org.jibx.runtime.impl.XMLWriterNamespaceBase#defineNamespace(int, java.lang.String)
*/
protected void defineNamespace(int index, String prefix)
throws IOException {
/* try {
// inform writer of new namespace usage
String uri = getNamespaceUri(index);
if (prefix.length() == 0) {
m_writer.setDefaultNamespace(uri);
} else {
m_writer.setPrefix(prefix, uri);
}
} catch (XMLStreamException e) {
throw new IOException("Error writing to stream: " + e.getMessage());
} */
}
/* (non-Javadoc)
* @see org.jibx.runtime.impl.XMLWriterNamespaceBase#undefineNamespace(int)
*/
protected void undefineNamespace(int index) {}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLWriter#setIndentSpaces(int, java.lang.String, char)
*/
public void setIndentSpaces(int count, String newline, char indent) {}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLWriter#writeXMLDecl(java.lang.String, java.lang.String, java.lang.String)
*/
public void writeXMLDecl(String version, String encoding, String standalone) throws IOException {
try {
m_writer.writeStartDocument(version, encoding);
} catch (XMLStreamException e) {
throw new IOException("Error writing to stream: " + e.getMessage());
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLWriter#startTagOpen(int, java.lang.String)
*/
public void startTagOpen(int index, String name) throws IOException {
try {
// write start element, without or with namespace
if (index == 0) {
m_writer.writeStartElement(name);
} else {
m_writer.writeStartElement(getNamespacePrefix(index), name,
getNamespaceUri(index));
}
// increment nesting for any possible content
incrementNesting();
} catch (XMLStreamException e) {
throw new IOException("Error writing to stream: " + e.getMessage());
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLWriter#startTagNamespaces(int, java.lang.String, int[], java.lang.String[])
*/
public void startTagNamespaces(int index, String name, int[] nums,
String[] prefs) throws IOException {
try {
// find the namespaces actually being declared
int[] deltas = openNamespaces(nums, prefs);
// open the start tag
startTagOpen(index, name);
// write the namespace declarations
for (int i = 0; i < deltas.length; i++) {
int slot = deltas[i];
String prefix = getNamespacePrefix(slot);
String uri = getNamespaceUri(slot);
if (prefix.length() > 0) {
m_writer.writeNamespace(prefix, uri);
} else {
m_writer.writeDefaultNamespace(uri);
}
}
} catch (XMLStreamException e) {
throw new IOException("Error writing to stream: " + e.getMessage());
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLWriter#addAttribute(int, java.lang.String, java.lang.String)
*/
public void addAttribute(int index, String name, String value)
throws IOException {
try {
if (index == 0) {
m_writer.writeAttribute(name, value);
} else {
m_writer.writeAttribute(getNamespacePrefix(index),
getNamespaceUri(index), name, value);
}
} catch (XMLStreamException e) {
throw new IOException("Error writing to stream: " + e.getMessage());
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLWriter#closeStartTag()
*/
public void closeStartTag() throws IOException {
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLWriter#closeEmptyTag()
*/
public void closeEmptyTag() throws IOException {
try {
m_writer.writeEndElement();
decrementNesting();
} catch (XMLStreamException e) {
throw new IOException("Error writing to stream: " + e.getMessage());
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLWriter#startTagClosed(int, java.lang.String)
*/
public void startTagClosed(int index, String name) throws IOException {
startTagOpen(index, name);
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLWriter#endTag(int, java.lang.String)
*/
public void endTag(int index, String name) throws IOException {
// not valid approach in general, but okay for StAX case
closeEmptyTag();
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLWriter#writeTextContent(java.lang.String)
*/
public void writeTextContent(String text) throws IOException {
try {
m_writer.writeCharacters(text);
} catch (XMLStreamException e) {
throw new IOException("Error writing to stream: " + e.getMessage());
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLWriter#writeCData(java.lang.String)
*/
public void writeCData(String text) throws IOException {
try {
m_writer.writeCData(text);
} catch (XMLStreamException e) {
throw new IOException("Error writing to stream: " + e.getMessage());
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLWriter#writeComment(java.lang.String)
*/
public void writeComment(String text) throws IOException {
try {
m_writer.writeComment(text);
} catch (XMLStreamException e) {
throw new IOException("Error writing to stream: " + e.getMessage());
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLWriter#writeEntityRef(java.lang.String)
*/
public void writeEntityRef(String name) throws IOException {
try {
m_writer.writeEntityRef(name);
} catch (XMLStreamException e) {
throw new IOException("Error writing to stream: " + e.getMessage());
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLWriter#writeDocType(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
*/
public void writeDocType(String name, String sys, String pub, String subset)
throws IOException {
try {
StringBuffer buff = new StringBuffer();
buff.append("');
m_writer.writeDTD(buff.toString());
} catch (XMLStreamException e) {
throw new IOException("Error writing to stream: " + e.getMessage());
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLWriter#writePI(java.lang.String, java.lang.String)
*/
public void writePI(String target, String data) throws IOException {
try {
m_writer.writeProcessingInstruction(target, data);
} catch (XMLStreamException e) {
throw new IOException("Error writing to stream: " + e.getMessage());
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLWriter#indent()
*/
public void indent() throws IOException {}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLWriter#flush()
*/
public void flush() throws IOException {
// internal flush only, do not pass through to writer
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLWriter#close()
*/
public void close() throws IOException {
try {
m_writer.close();
} catch (XMLStreamException e) {
throw new IOException("Error closing stream: " + e.getMessage());
}
}
/**
* Create a child writer instance to be used for a separate binding. The
* child writer inherits the output handling from this writer, while using
* the supplied namespace URIs.
*
* @param uris ordered array of URIs for namespaces used in document
* (see {@link #StAXWriter(String[])})
* @return child writer
*/
public IXMLWriter createChildWriter(String[] uris) {
return new StAXWriter(this, uris);
}
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/StreamWriterBase.java 0000644 0001750 0001750 00000041764 10737003370 026241 0 ustar moeller moeller /*
Copyright (c) 2004-2007, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime.impl;
import java.io.IOException;
import java.io.OutputStream;
import java.io.UnsupportedEncodingException;
/**
* Base handler for marshalling text document to an output stream. This is
* designed for use with character encodings that use standard one-byte values
* for Unicode characters in the 0x20-0x7F range, which includes the most
* widely used encodings for XML documents. It needs to be subclassed with
* implementation methods specific to the encoding used.
*
* @author Dennis M. Sosnoski
*/
public abstract class StreamWriterBase extends XMLWriterBase
{
//
// Defined entities and special sequences as bytes
protected static final byte[] QUOT_ENTITY =
{
(byte)'&', (byte)'q', (byte)'u', (byte)'o', (byte)'t', (byte)';'
};
protected static final byte[] AMP_ENTITY =
{
(byte)'&', (byte)'a', (byte)'m', (byte)'p', (byte)';'
};
protected static final byte[] GT_ENTITY =
{
(byte)'&', (byte)'g', (byte)'t', (byte)';'
};
protected static final byte[] LT_ENTITY =
{
(byte)'&', (byte)'l', (byte)'t', (byte)';'
};
protected static final byte[] LT_CDATASTART =
{
(byte)'<', (byte)'!', (byte)'[', (byte)'C', (byte)'D', (byte)'A',
(byte)'T', (byte)'A', (byte)'['
};
protected static final byte[] LT_CDATAEND =
{
(byte)']', (byte)']', (byte)'>'
};
/** Default output buffer size. */
public static final int DEFAULT_BUFFER_SIZE = 4096;
/** Name of encoding used for stream. */
private final String m_encodingName;
/** Original writer (only used when created using copy constructor, null otherwise). */
private final StreamWriterBase m_baseWriter;
/** Stream for text output. */
private OutputStream m_stream;
/** Buffer for accumulating output bytes. */
protected byte[] m_buffer;
/** Current offset in filling buffer. */
protected int m_fillOffset;
/** Byte sequences for prefixes of namespaces in scope. */
protected byte[][] m_prefixBytes;
/** Byte sequences for prefixes of extension namespaces in scope. */
protected byte[][][] m_extensionBytes;
/** Indent tags for pretty-printed text. */
private boolean m_indent;
/** Base number of characters in indent sequence (end of line only). */
private int m_indentBase;
/** Number of extra characters in indent sequence per level of nesting. */
private int m_indentPerLevel;
/** Raw text for indentation sequences. */
private byte[] m_indentSequence;
/**
* Constructor with supplied buffer.
*
* @param enc character encoding used for output to streams (upper case)
* @param uris ordered array of URIs for namespaces used in document (must
* be constant; the value in position 0 must always be the empty string "",
* and the value in position 1 must always be the XML namespace
* "http://www.w3.org/XML/1998/namespace")
* @param buffer output data buffer
*/
protected StreamWriterBase(String enc, String[] uris, byte[] buffer) {
super(uris);
m_encodingName = enc;
m_baseWriter = null;
m_prefixBytes = new byte[uris.length][];
m_buffer = buffer;
}
/**
* Constructor using default buffer size.
*
* @param enc character encoding used for output to streams (upper case)
* @param uris ordered array of URIs for namespaces used in document (must
* be constant; the value in position 0 must always be the empty string "",
* and the value in position 1 must always be the XML namespace
* "http://www.w3.org/XML/1998/namespace")
*/
public StreamWriterBase(String enc, String[] uris) {
this(enc, uris, new byte[DEFAULT_BUFFER_SIZE]);
}
/**
* Copy constructor. This takes the stream and encoding information from a
* supplied instance, while setting a new array of namespace URIs. It's
* intended for use when invoking one binding from within another binding.
*
* @param base instance to be used as base for writer
* @param uris ordered array of URIs for namespaces used in document
* (see {@link #StreamWriterBase(String, String[])})
*/
public StreamWriterBase(StreamWriterBase base, String[] uris) {
super(base, uris);
m_encodingName = base.m_encodingName;
m_baseWriter = base;
m_prefixBytes = new byte[uris.length][];
m_stream = base.m_stream;
m_buffer = base.m_buffer;
m_fillOffset = base.m_fillOffset;
m_indent = base.m_indent;
m_indentBase = base.m_indentBase;
m_indentPerLevel = base.m_indentPerLevel;
m_indentSequence = base.m_indentSequence;
byte[][][] extbytes = base.m_extensionBytes;
if (extbytes != null) {
m_extensionBytes = new byte[extbytes.length][][];
System.arraycopy(extbytes, 0, m_extensionBytes, 0,
m_extensionBytes.length);
}
}
/**
* Get the name of the character encoding used by this writer.
*
* @return encoding
*/
public String getEncodingName() {
return m_encodingName;
}
/**
* Set output stream. If an output stream is currently open when this is
* called the existing stream is flushed and closed, with any errors
* ignored.
*
* @param outs stream for document data output
*/
public void setOutput(OutputStream outs) {
try {
close();
} catch (IOException e) { /* deliberately empty */ }
m_stream = outs;
reset();
}
/**
* Set namespace URIs. This forces a reset of the writer, clearing any
* buffered output. It is intended to be used only for reconfiguring an
* existing writer for reuse.
*
* @param uris ordered array of URIs for namespaces used in document
* @throws IOException
*/
public void setNamespaceUris(String[] uris) throws IOException {
reset();
boolean diff = false;
String[] olds = getNamespaces();
if (olds.length == uris.length) {
for (int i = 0; i < uris.length; i++) {
if (!uris[i].equals(olds[i])) {
diff = true;
break;
}
}
} else {
diff = true;
}
if (diff) {
internalSetUris(uris);
m_prefixBytes = new byte[uris.length][];
defineNamespace(0, "");
defineNamespace(1, "xml");
}
}
/**
* Set nesting indentation. This is advisory only, and implementations of
* this interface are free to ignore it. The intent is to indicate that the
* generated output should use indenting to illustrate element nesting.
*
* @param count number of character to indent per level, or disable
* indentation if negative (zero means new line only)
* @param newline sequence of characters used for a line ending
* (null means use the single character '\n')
* @param indent whitespace character used for indentation
*/
public void setIndentSpaces(int count, String newline, char indent) {
if (count >= 0) {
try {
if (newline == null) {
newline = "\n";
}
m_indent = true;
byte[] base = newline.getBytes(m_encodingName);
m_indentBase = base.length;
byte[] per = new String(new char[]
{ indent }).getBytes(m_encodingName);
m_indentPerLevel = count * per.length;
int length = m_indentBase + m_indentPerLevel * 10;
m_indentSequence = new byte[length];
for (int i = 0; i < length; i++) {
if (i < newline.length()) {
m_indentSequence[i] = base[i];
} else {
int index = (i - m_indentBase) % per.length;
m_indentSequence[i] = per[index];
}
}
} catch (UnsupportedEncodingException e) {
throw new RuntimeException
("Encoding " + m_encodingName + " not recognized by JVM");
}
} else {
m_indent = false;
}
}
/**
* Make at least the requested number of bytes available in the output
* buffer. If necessary, the output buffer will be replaced by a larger
* buffer.
*
* @param length number of bytes space to be made available
* @throws IOException if error writing to document
*/
protected void makeSpace(int length) throws IOException {
if (m_fillOffset + length > m_buffer.length) {
m_stream.write(m_buffer, 0, m_fillOffset);
m_fillOffset = 0;
if (length > m_buffer.length) {
m_buffer = new byte[Math.max(length, m_buffer.length*2)];
}
}
}
/**
* Report that namespace has been undefined.
*
* @param index namespace URI index number
*/
protected void undefineNamespace(int index) {
if (index < m_prefixBytes.length) {
m_prefixBytes[index] = null;
} else if (m_extensionBytes != null) {
index -= m_prefixes.length;
for (int i = 0; i < m_extensionBytes.length; i++) {
int length = m_extensionBytes[i].length;
if (index < length) {
m_extensionBytes[i][index] = null;
break;
} else {
index -= length;
}
}
} else {
throw new IllegalArgumentException("Index out of range");
}
}
/**
* Write namespace prefix to output. This internal method is used to throw
* an exception when an undeclared prefix is used.
*
* @param index namespace URI index number
* @throws IOException if error writing to document
*/
protected void writePrefix(int index) throws IOException {
try {
byte[] bytes = null;
if (index < m_prefixBytes.length) {
bytes = m_prefixBytes[index];
} else if (m_extensionBytes != null) {
index -= m_prefixes.length;
for (int i = 0; i < m_extensionBytes.length; i++) {
int length = m_extensionBytes[i].length;
if (index < length) {
bytes = m_extensionBytes[i][index];
break;
} else {
index -= length;
}
}
}
if (bytes.length > 0) {
makeSpace(bytes.length);
System.arraycopy(bytes, 0, m_buffer, m_fillOffset, bytes.length);
m_fillOffset += bytes.length;
}
} catch (NullPointerException ex) {
throw new IOException("Namespace URI has not been declared.");
}
}
/**
* Write entity bytes to output.
*
* @param bytes actual bytes to be written
* @param offset starting offset in buffer
* @return offset for next data byte in buffer
*/
protected int writeEntity(byte[] bytes, int offset) {
System.arraycopy(bytes, 0, m_buffer, offset, bytes.length);
return offset + bytes.length;
}
/**
* Append extension namespace URIs to those in mapping.
*
* @param uris namespace URIs to extend those in mapping
*/
public void pushExtensionNamespaces(String[] uris) {
super.pushExtensionNamespaces(uris);
byte[][] items = new byte[uris.length][];
if (m_extensionBytes == null) {
m_extensionBytes = new byte[][][] { items };
} else {
int length = m_extensionBytes.length;
byte[][][] grow = new byte[length+1][][];
System.arraycopy(m_extensionBytes, 0, grow, 0, length);
grow[length] = items;
m_extensionBytes = grow;
}
}
/**
* Remove extension namespace URIs. This removes the last set of
* extension namespaces pushed using {@link #pushExtensionNamespaces}.
*/
public void popExtensionNamespaces() {
super.popExtensionNamespaces();
int length = m_extensionBytes.length;
if (length == 1) {
m_extensionBytes = null;
} else {
byte[][][] shrink = new byte[length-1][][];
System.arraycopy(m_extensionBytes, 0, shrink, 0, length-1);
m_extensionBytes = shrink;
}
}
/**
* Request output indent. Output the line end sequence followed by the
* appropriate number of indent characters.
*
* @param bias indent depth difference (positive or negative) from current
* element nesting depth
* @throws IOException on error writing to document
*/
public void indent(int bias) throws IOException {
if (m_indent) {
int length = m_indentBase +
(getNestingDepth() + bias) * m_indentPerLevel;
if (length > m_indentSequence.length) {
int use = Math.max(length,
m_indentSequence.length*2 - m_indentBase);
byte[] grow = new byte[use];
System.arraycopy(m_indentSequence, 0, grow, 0,
m_indentSequence.length);
for (int i = m_indentSequence.length; i < use; i++) {
grow[i] = grow[m_indentBase];
}
m_indentSequence = grow;
}
makeSpace(length);
System.arraycopy(m_indentSequence, 0, m_buffer, m_fillOffset,
length);
m_fillOffset += length;
}
}
/**
* Request output indent. Output the line end sequence followed by the
* appropriate number of indent characters for the current nesting level.
*
* @throws IOException on error writing to document
*/
public void indent() throws IOException {
indent(0);
}
/**
* Flush document output. Forces out all output generated to this point,
* unless using a chunking output mechanism.
*
* @throws IOException on error writing to document
*/
public void flush() throws IOException {
flagContent();
if (m_stream != null) {
if (m_baseWriter == null) {
if (!(m_stream instanceof IChunkedOutput)) {
m_stream.write(m_buffer, 0, m_fillOffset);
m_fillOffset = 0;
}
} else {
m_baseWriter.m_fillOffset = m_fillOffset;
}
}
}
/**
* Close document output. Completes writing of document output, including
* closing the output medium.
*
* @throws IOException on error writing to document
*/
public void close() throws IOException {
flush();
if (m_stream != null) {
try {
if (m_stream instanceof IChunkedOutput) {
((IChunkedOutput)m_stream).writeFinal(m_buffer, 0, m_fillOffset);
}
m_stream.close();
} finally {
m_fillOffset = 0;
m_stream = null;
}
}
}
/**
* Reset to initial state for reuse. This override of the base class
* method handles clearing the internal buffer when starting a new
* document.
*/
public void reset() {
super.reset();
m_fillOffset = 0;
}
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/StringArray.java 0000644 0001750 0001750 00000020472 10434260716 025257 0 ustar moeller moeller /*
Copyright (c) 2000-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime.impl;
import java.lang.reflect.Array;
/**
* Growable String array with type specific access methods. This
* implementation is unsynchronized in order to provide the best possible
* performance for typical usage scenarios, so explicit synchronization must
* be implemented by a wrapper class or directly by the application in cases
* where instances are modified in a multithreaded environment.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class StringArray
{
/** Default initial array size. */
public static final int DEFAULT_SIZE = 8;
/** Size of the current array. */
private int m_countLimit;
/** The number of values currently present in the array. */
private int m_countPresent;
/** Maximum size increment for growing array. */
private int m_maximumGrowth;
/** The underlying array used for storing the data. */
private String[] m_baseArray;
/**
* Constructor with full specification.
*
* @param size number of String values initially allowed in
* array
* @param growth maximum size increment for growing array
*/
public StringArray(int size, int growth) {
String[] array = new String[size];
m_countLimit = size;
m_maximumGrowth = growth;
m_baseArray = array;
}
/**
* Constructor with initial size specified.
*
* @param size number of String values initially allowed in
* array
*/
public StringArray(int size) {
this(size, Integer.MAX_VALUE);
}
/**
* Default constructor.
*/
public StringArray() {
this(DEFAULT_SIZE);
}
/**
* Copy (clone) constructor.
*
* @param base instance being copied
*/
public StringArray(StringArray base) {
this(base.m_countLimit, base.m_maximumGrowth);
System.arraycopy(base.m_baseArray, 0, m_baseArray, 0,
base.m_countPresent);
m_countPresent = base.m_countPresent;
}
/**
* Copy data after array resize. This just copies the entire contents of the
* old array to the start of the new array. It should be overridden in cases
* where data needs to be rearranged in the array after a resize.
*
* @param base original array containing data
* @param grown resized array for data
*/
private void resizeCopy(Object base, Object grown) {
System.arraycopy(base, 0, grown, 0, Array.getLength(base));
}
/**
* Discards values for a range of indices in the array. Clears references to
* removed values.
*
* @param from index of first value to be discarded
* @param to index past last value to be discarded
*/
private void discardValues(int from, int to) {
for (int i = from; i < to; i++) {
m_baseArray[i] = null;
}
}
/**
* Increase the size of the array to at least a specified size. The array
* will normally be at least doubled in size, but if a maximum size
* increment was specified in the constructor and the value is less than
* the current size of the array, the maximum increment will be used
* instead. If the requested size requires more than the default growth,
* the requested size overrides the normal growth and determines the size
* of the replacement array.
*
* @param required new minimum size required
*/
private void growArray(int required) {
int size = Math.max(required,
m_countLimit + Math.min(m_countLimit, m_maximumGrowth));
String[] grown = new String[size];
resizeCopy(m_baseArray, grown);
m_countLimit = size;
m_baseArray = grown;
}
/**
* Ensure that the array has the capacity for at least the specified
* number of values.
*
* @param min minimum capacity to be guaranteed
*/
public final void ensureCapacity(int min) {
if (min > m_countLimit) {
growArray(min);
}
}
/**
* Add a value at the end of the array.
*
* @param value value to be added
*/
public void add(String value) {
int index = getAddIndex();
m_baseArray[index] = value;
}
/**
* Remove some number of values from the end of the array.
*
* @param count number of values to be removed
* @exception ArrayIndexOutOfBoundsException on attempt to remove more than
* the count present
*/
public void remove(int count) {
int start = m_countPresent - count;
if (start >= 0) {
discardValues(start, m_countPresent);
m_countPresent = start;
} else {
throw new ArrayIndexOutOfBoundsException
("Attempt to remove too many values from array");
}
}
/**
* Get a value from the array.
*
* @param index index of value to be returned
* @return value from stack
* @exception ArrayIndexOutOfBoundsException on attempt to access outside
* valid range
*/
public String get(int index) {
if (m_countPresent > index) {
return m_baseArray[index];
} else {
throw new ArrayIndexOutOfBoundsException
("Attempt to access past end of array");
}
}
/**
* Constructs and returns a simple array containing the same data as held
* in this array.
*
* @return array containing a copy of the data
*/
public String[] toArray() {
String[] copy = new String[m_countPresent];
System.arraycopy(m_baseArray, 0, copy, 0, m_countPresent);
return copy;
}
/**
* Duplicates the object with the generic call.
*
* @return a copy of the object
*/
public Object clone() {
return new StringArray(this);
}
/**
* Gets the array offset for appending a value to those in the array. If the
* underlying array is full, it is grown by the appropriate size increment
* so that the index value returned is always valid for the array in use by
* the time of the return.
*
* @return index position for added element
*/
private int getAddIndex() {
int index = m_countPresent++;
if (m_countPresent > m_countLimit) {
growArray(m_countPresent);
}
return index;
}
/**
* Get the number of values currently present in the array.
*
* @return count of values present
*/
public int size() {
return m_countPresent;
}
/**
* Check if array is empty.
*
* @return true if array empty, false if not
*/
public boolean isEmpty() {
return m_countPresent == 0;
}
/**
* Set the array to the empty state.
*/
public void clear() {
discardValues(0, m_countPresent);
m_countPresent = 0;
}
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/StringIntHashMap.java 0000644 0001750 0001750 00000035727 10263166014 026202 0 ustar moeller moeller /*
* Copyright (c) 2000-2005, Dennis M. Sosnoski. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer. Redistributions in binary
* form must reproduce the above copyright notice, this list of conditions and
* the following disclaimer in the documentation and/or other materials provided
* with the distribution. Neither the name of JiBX nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime.impl;
/**
* Hash map using String values as keys mapped to primitive
* int values. This implementation is unsynchronized in order to
* provide the best possible performance for typical usage scenarios, so
* explicit synchronization must be implemented by a wrapper class or directly
* by the application in cases where instances are modified in a multithreaded
* environment. The map implementation is not very efficient when resizing, but
* works well when the size of the map is known in advance.
*
* @author Dennis M. Sosnoski
* @version 1.1
*/
public class StringIntHashMap
{
/** Default value returned when key not found in table. */
public static final int DEFAULT_NOT_FOUND = Integer.MIN_VALUE;
/** Default fill fraction allowed before growing table. */
protected static final double DEFAULT_FILL = 0.3d;
/** Minimum size used for hash table. */
protected static final int MINIMUM_SIZE = 31;
/** Fill fraction allowed for this hash table. */
protected final double m_fillFraction;
/** Number of entries present in table. */
protected int m_entryCount;
/** Entries allowed before growing table. */
protected int m_entryLimit;
/** Size of array used for keys. */
protected int m_arraySize;
/** Offset added (modulo table size) to slot number on collision. */
protected int m_hitOffset;
/** Array of key table slots. */
protected String[] m_keyTable;
/** Array of value table slots. */
protected int[] m_valueTable;
/** Value returned when key not found in table. */
protected int m_notFoundValue;
/**
* Constructor with full specification.
*
* @param count number of values to assume in initial sizing of table
* @param fill fraction full allowed for table before growing
* @param miss value returned when key not found in table
*/
public StringIntHashMap(int count, double fill, int miss) {
// check the passed in fill fraction
if (fill <= 0.0d || fill >= 1.0d) {
throw new IllegalArgumentException("fill value out of range");
}
m_fillFraction = fill;
// compute initial table size (ensuring odd)
m_arraySize = Math.max((int)(count / m_fillFraction), MINIMUM_SIZE);
m_arraySize += (m_arraySize + 1) % 2;
// initialize the table information
m_entryLimit = (int)(m_arraySize * m_fillFraction);
m_hitOffset = m_arraySize / 2;
m_keyTable = new String[m_arraySize];
m_valueTable = new int[m_arraySize];
m_notFoundValue = miss;
}
/**
* Constructor with size and fill fraction specified. Uses default hash
* technique and value returned when key not found in table.
*
* @param count number of values to assume in initial sizing of table
* @param fill fraction full allowed for table before growing
*/
public StringIntHashMap(int count, double fill) {
this(count, fill, DEFAULT_NOT_FOUND);
}
/**
* Constructor with only size supplied. Uses default hash technique and
* values for fill fraction and value returned when key not found in table.
*
* @param count number of values to assume in initial sizing of table
*/
public StringIntHashMap(int count) {
this(count, DEFAULT_FILL);
}
/**
* Default constructor.
*/
public StringIntHashMap() {
this(0, DEFAULT_FILL);
}
/**
* Copy (clone) constructor.
*
* @param base instance being copied
*/
public StringIntHashMap(StringIntHashMap base) {
// copy the basic occupancy information
m_fillFraction = base.m_fillFraction;
m_entryCount = base.m_entryCount;
m_entryLimit = base.m_entryLimit;
m_arraySize = base.m_arraySize;
m_hitOffset = base.m_hitOffset;
m_notFoundValue = base.m_notFoundValue;
// copy table of items
m_keyTable = new String[m_arraySize];
System.arraycopy(base.m_keyTable, 0, m_keyTable, 0, m_arraySize);
m_valueTable = new int[m_arraySize];
System.arraycopy(base.m_valueTable, 0, m_valueTable, 0, m_arraySize);
}
/**
* Step the slot number for an entry. Adds the collision offset (modulo
* the table size) to the slot number.
*
* @param slot slot number to be stepped
* @return stepped slot number
*/
private final int stepSlot(int slot) {
return (slot + m_hitOffset) % m_arraySize;
}
/**
* Find free slot number for entry. Starts at the slot based directly
* on the hashed key value. If this slot is already occupied, it adds
* the collision offset (modulo the table size) to the slot number and
* checks that slot, repeating until an unused slot is found.
*
* @param slot initial slot computed from key
* @return slot at which entry was added
*/
private final int freeSlot(int slot) {
while (m_keyTable[slot] != null) {
slot = stepSlot(slot);
}
return slot;
}
/**
* Standard base slot computation for a key.
*
* @param key key value to be computed
* @return base slot for key
*/
private final int standardSlot(Object key) {
return (key.hashCode() & Integer.MAX_VALUE) % m_arraySize;
}
/**
* Standard find key in table. This method may be used directly for key
* lookup using either the hashCode() method defined for the
* key objects or the System.identityHashCode() method, and
* either the equals() method defined for the key objects or
* the == operator, as selected by the hash technique
* constructor parameter. To implement a hash class based on some other
* methods of hashing and/or equality testing, define a separate method in
* the subclass with a different name and use that method instead. This
* avoids the overhead caused by overrides of a very heavily used method.
*
* @param key to be found in table
* @return index of matching key, or -index-1 of slot to be
* used for inserting key in table if not already present (always negative)
*/
private int standardFind(Object key) {
// find the starting point for searching table
int slot = standardSlot(key);
// scan through table to find target key
while (m_keyTable[slot] != null) {
// check if we have a match on target key
if (m_keyTable[slot].equals(key)) {
return slot;
} else {
slot = stepSlot(slot);
}
}
return -slot-1;
}
/**
* Reinsert an entry into the hash map. This is used when the table is being
* directly modified, and does not adjust the count present or check the
* table capacity.
*
* @param slot position of entry to be reinserted into hash map
* @return true if the slot number used by the entry has has
* changed, false if not
*/
private boolean reinsert(int slot) {
String key = m_keyTable[slot];
m_keyTable[slot] = null;
return assignSlot(key, m_valueTable[slot]) != slot;
}
/**
* Internal remove pair from the table. Removes the pair from the table
* by setting the key entry to null and adjusting the count
* present, then chains through the table to reinsert any other pairs
* which may have collided with the removed pair. If the associated value
* is an object reference, it should be set to null before
* this method is called.
*
* @param slot index number of pair to be removed
*/
protected void internalRemove(int slot) {
// delete pair from table
m_keyTable[slot] = null;
m_entryCount--;
while (m_keyTable[(slot = stepSlot(slot))] != null) {
// reinsert current entry in table to fill holes
reinsert(slot);
}
}
/**
* Restructure the table. This is used when the table is increasing or
* decreasing in size, and works directly with the old table representation
* arrays. It inserts pairs from the old arrays directly into the table
* without adjusting the count present or checking the table size.
*
* @param keys array of keys
* @param values array of values
*/
private void restructure(String[] keys, int[] values) {
for (int i = 0; i < keys.length; i++) {
if (keys[i] != null) {
assignSlot(keys[i], values[i]);
}
}
}
/**
* Assign slot for entry. Starts at the slot found by the hashed key value.
* If this slot is already occupied, it steps the slot number and checks the
* resulting slot, repeating until an unused slot is found. This method does
* not check for duplicate keys, so it should only be used for internal
* reordering of the tables.
*
* @param key to be added to table
* @param value associated value for key
* @return slot at which entry was added
*/
private int assignSlot(String key, int value) {
int offset = freeSlot(standardSlot(key));
m_keyTable[offset] = key;
m_valueTable[offset] = value;
return offset;
}
/**
* Add an entry to the table. If the key is already present in the table,
* this replaces the existing value associated with the key.
*
* @param key key to be added to table (non- null)
* @param value associated value for key
* @return value previously associated with key, or reserved not found value
* if key not previously present in table
*/
public int add(String key, int value) {
// first validate the parameters
if (key == null) {
throw new IllegalArgumentException("null key not supported");
} else if (value == m_notFoundValue) {
throw new IllegalArgumentException(
"value matching not found return not supported");
} else {
// check space available
int min = m_entryCount + 1;
if (min > m_entryLimit) {
// find the array size required
int size = m_arraySize;
int limit = m_entryLimit;
while (limit < min) {
size = size * 2 + 1;
limit = (int) (size * m_fillFraction);
}
// set parameters for new array size
m_arraySize = size;
m_entryLimit = limit;
m_hitOffset = size / 2;
// restructure for larger arrays
String[] keys = m_keyTable;
m_keyTable = new String[m_arraySize];
int[] values = m_valueTable;
m_valueTable = new int[m_arraySize];
restructure(keys, values);
}
// find slot of table
int offset = standardFind(key);
if (offset >= 0) {
// replace existing value for key
int prior = m_valueTable[offset];
m_valueTable[offset] = value;
return prior;
} else {
// add new pair to table
m_entryCount++;
offset = -offset - 1;
m_keyTable[offset] = key;
m_valueTable[offset] = value;
return m_notFoundValue;
}
}
}
/**
* Check if an entry is present in the table. This method is supplied to
* support the use of values matching the reserved not found value.
*
* @param key key for entry to be found
* @return true if key found in table, false
* if not
*/
public final boolean containsKey(String key) {
return standardFind(key) >= 0;
}
/**
* Find an entry in the table.
*
* @param key key for entry to be returned
* @return value for key, or reserved not found value if key not found
*/
public final int get(String key) {
int slot = standardFind(key);
if (slot >= 0) {
return m_valueTable[slot];
} else {
return m_notFoundValue;
}
}
/**
* Remove an entry from the table. If multiple entries are present with the
* same key value, only the first one found will be removed.
*
* @param key key to be removed from table
* @return value associated with removed key, or reserved not found value if
* key not found in table
*/
public int remove(String key) {
int slot = standardFind(key);
if (slot >= 0) {
int value = m_valueTable[slot];
internalRemove(slot);
return value;
} else {
return m_notFoundValue;
}
}
/**
* Construct a copy of the table.
*
* @return shallow copy of table
*/
public Object clone() {
return new StringIntHashMap(this);
}
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/USASCIIEscaper.java 0000644 0001750 0001750 00000016737 10071714404 025421 0 ustar moeller moeller /*
Copyright (c) 2004, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime.impl;
import java.io.IOException;
import java.io.Writer;
import org.jibx.runtime.ICharacterEscaper;
/**
* Handler for writing ASCII output stream. This code is specifically for XML
* 1.0 and would require changes for XML 1.1 (to handle the added legal
* characters, rather than throwing an exception).
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class USASCIIEscaper implements ICharacterEscaper
{
/** Singleton instance of class. */
private static final USASCIIEscaper s_instance = new USASCIIEscaper();
/**
* Private constructor to prevent external creation.
*/
private USASCIIEscaper() {}
/**
* Write attribute value with character entity substitutions. This assumes
* that attributes use the regular quote ('"') delimitor.
*
* @param text attribute value text
* @param writer sink for output text
* @throws IOException on error writing to document
*/
public void writeAttribute(String text, Writer writer) throws IOException {
int mark = 0;
for (int i = 0; i < text.length(); i++) {
char chr = text.charAt(i);
if (chr == '"') {
writer.write(text, mark, i-mark);
mark = i+1;
writer.write(""");
} else if (chr == '&') {
writer.write(text, mark, i-mark);
mark = i+1;
writer.write("&");
} else if (chr == '<') {
writer.write(text, mark, i-mark);
mark = i+1;
writer.write("<");
} else if (chr == '>' && i > 2 && text.charAt(i-1) == ']' &&
text.charAt(i-2) == ']') {
writer.write(text, mark, i-mark-2);
mark = i+1;
writer.write("]]>");
} else if (chr < 0x20) {
if (chr != 0x9 && chr != 0xA && chr != 0xD) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) + " in attribute value text");
}
} else if (chr > 0x7F) {
writer.write(text, mark, i-mark);
mark = i+1;
if (chr > 0xD7FF && (chr < 0xE000 || chr == 0xFFFE ||
chr == 0xFFFF || chr > 0x10FFFF)) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) + " in attribute value text");
}
writer.write("&#x");
writer.write(Integer.toHexString(chr));
writer.write(';');
}
}
writer.write(text, mark, text.length()-mark);
}
/**
* Write content value with character entity substitutions.
*
* @param text content value text
* @param writer sink for output text
* @throws IOException on error writing to document
*/
public void writeContent(String text, Writer writer) throws IOException {
int mark = 0;
for (int i = 0; i < text.length(); i++) {
char chr = text.charAt(i);
if (chr == '&') {
writer.write(text, mark, i-mark);
mark = i+1;
writer.write("&");
} else if (chr == '<') {
writer.write(text, mark, i-mark);
mark = i+1;
writer.write("<");
} else if (chr == '>' && i > 2 && text.charAt(i-1) == ']' &&
text.charAt(i-2) == ']') {
writer.write(text, mark, i-mark-2);
mark = i+1;
writer.write("]]>");
} else if (chr < 0x20) {
if (chr != 0x9 && chr != 0xA && chr != 0xD) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) + " in content text");
}
} else if (chr > 0x7F) {
writer.write(text, mark, i-mark);
mark = i+1;
if (chr > 0xD7FF && (chr < 0xE000 || chr == 0xFFFE ||
chr == 0xFFFF || chr > 0x10FFFF)) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) + " in content text");
}
writer.write("&#x");
writer.write(Integer.toHexString(chr));
writer.write(';');
}
}
writer.write(text, mark, text.length()-mark);
}
/**
* Write CDATA to document. This writes the beginning and ending sequences
* for a CDATA section as well as the actual text, verifying that only
* characters allowed by the encoding are included in the text.
*
* @param text content value text
* @param writer sink for output text
* @throws IOException on error writing to document
*/
public void writeCData(String text, Writer writer) throws IOException {
writer.write("' && i > 2 && text.charAt(i-1) == ']' &&
text.charAt(i-2) == ']') {
throw new IOException("Sequence \"]]>\" is not allowed " +
"within CDATA section text");
} else if (chr < 0x20) {
if (chr != 0x9 && chr != 0xA && chr != 0xD) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) + " in CDATA section");
}
} else if (chr >= 0x80) {
throw new IOException("Character code 0x" +
Integer.toHexString(chr) +
" not supported by encoding in CDATA section");
}
}
writer.write(text);
writer.write("]]>");
}
/**
* Get instance of escaper.
*
* @return escaper instance
*/
public static ICharacterEscaper getInstance() {
return s_instance;
}
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/UTF8Escaper.java 0000644 0001750 0001750 00000016004 10231200600 025014 0 ustar moeller moeller /*
Copyright (c) 2004-2005, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime.impl;
import java.io.IOException;
import java.io.Writer;
import org.jibx.runtime.ICharacterEscaper;
/**
* Handler for writing UTF output stream (for any form of UTF, despite the
* name). This code is specifically for XML 1.0 and would require changes for
* XML 1.1 (to handle the added legal characters, rather than throwing an
* exception).
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class UTF8Escaper implements ICharacterEscaper
{
/** Singleton instance of class. */
private static final UTF8Escaper s_instance = new UTF8Escaper();
/**
* Private constructor to prevent external creation.
*/
private UTF8Escaper() {}
/**
* Write attribute value with character entity substitutions. This assumes
* that attributes use the regular quote ('"') delimitor.
*
* @param text attribute value text
* @param writer sink for output text
* @throws IOException on error writing to document
*/
public void writeAttribute(String text, Writer writer) throws IOException {
int mark = 0;
for (int i = 0; i < text.length(); i++) {
char chr = text.charAt(i);
if (chr == '"') {
writer.write(text, mark, i-mark);
mark = i+1;
writer.write(""");
} else if (chr == '&') {
writer.write(text, mark, i-mark);
mark = i+1;
writer.write("&");
} else if (chr == '<') {
writer.write(text, mark, i-mark);
mark = i+1;
writer.write("<");
} else if (chr == '>' && i > 2 && text.charAt(i-1) == ']' &&
text.charAt(i-2) == ']') {
writer.write(text, mark, i-mark-2);
mark = i+1;
writer.write("]]>");
} else if (chr < 0x20) {
if (chr != 0x9 && chr != 0xA && chr != 0xD) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) + " in attribute value text");
}
} else if (chr > 0xD7FF && (chr < 0xE000 || chr == 0xFFFE ||
chr == 0xFFFF || chr > 0x10FFFF)) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) + " in attribute value text");
}
}
writer.write(text, mark, text.length()-mark);
}
/**
* Write content value with character entity substitutions.
*
* @param text content value text
* @param writer sink for output text
* @throws IOException on error writing to document
*/
public void writeContent(String text, Writer writer) throws IOException {
int mark = 0;
for (int i = 0; i < text.length(); i++) {
char chr = text.charAt(i);
if (chr == '&') {
writer.write(text, mark, i-mark);
mark = i+1;
writer.write("&");
} else if (chr == '<') {
writer.write(text, mark, i-mark);
mark = i+1;
writer.write("<");
} else if (chr == '>' && i > 2 && text.charAt(i-1) == ']' &&
text.charAt(i-2) == ']') {
writer.write(text, mark, i-mark-2);
mark = i+1;
writer.write("]]>");
} else if (chr < 0x20) {
if (chr != 0x9 && chr != 0xA && chr != 0xD) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) + " in content text");
}
} else if (chr > 0xD7FF && (chr < 0xE000 || chr == 0xFFFE ||
chr == 0xFFFF || chr > 0x10FFFF)) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) + " in content text");
}
}
writer.write(text, mark, text.length()-mark);
}
/**
* Write CDATA to document. This writes the beginning and ending sequences
* for a CDATA section as well as the actual text, verifying that only
* characters allowed by the encoding are included in the text.
*
* @param text content value text
* @param writer sink for output text
* @throws IOException on error writing to document
*/
public void writeCData(String text, Writer writer) throws IOException {
writer.write("' && i > 2 && text.charAt(i-1) == ']' &&
text.charAt(i-2) == ']') {
throw new IOException("Sequence \"]]>\" is not allowed " +
"within CDATA section text");
} else if (chr < 0x20) {
if (chr != 0x9 && chr != 0xA && chr != 0xD) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) + " in CDATA section");
}
} else if (chr > 0xD7FF &&
(chr < 0xE000 || chr == 0xFFFE || chr == 0xFFFF)) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) + " in CDATA section");
}
}
writer.write(text);
writer.write("]]>");
}
/**
* Get instance of escaper.
*
* @return escaper instance
*/
public static ICharacterEscaper getInstance() {
return s_instance;
}
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/UTF8StreamWriter.java 0000644 0001750 0001750 00000035012 10737003370 026102 0 ustar moeller moeller /*
Copyright (c) 2004-2007, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime.impl;
import java.io.IOException;
import org.jibx.runtime.IXMLWriter;
/**
* Handler for marshalling text document to a UTF-8 output stream.
*
* @author Dennis M. Sosnoski
*/
public class UTF8StreamWriter extends StreamWriterBase
{
/** Conversion buffer for prefixes; */
private byte[] m_converts;
/**
* Constructor with supplied buffer.
*
* @param uris ordered array of URIs for namespaces used in document (must
* be constant; the value in position 0 must always be the empty string "",
* and the value in position 1 must always be the XML namespace
* "http://www.w3.org/XML/1998/namespace")
* @param buffer output data buffer
*/
public UTF8StreamWriter(String[] uris, byte[] buffer) {
super("UTF-8", uris, buffer);
defineNamespace(0, "");
defineNamespace(1, "xml");
}
/**
* Constructor creating a buffer of the default size.
*
* @param uris ordered array of URIs for namespaces used in document (must
* be constant; the value in position 0 must always be the empty string "",
* and the value in position 1 must always be the XML namespace
* "http://www.w3.org/XML/1998/namespace")
*/
public UTF8StreamWriter(String[] uris) {
this(uris, new byte[DEFAULT_BUFFER_SIZE]);
}
/**
* Copy constructor. This takes the stream from a supplied instance, while
* setting a new array of namespace URIs. It's intended for use when
* invoking one binding from within another binding.
*
* @param base instance to be used as base for writer
* @param uris ordered array of URIs for namespaces used in document
* (see {@link #UTF8StreamWriter(String[])})
*/
public UTF8StreamWriter(UTF8StreamWriter base, String[] uris) {
super(base, uris);
defineNamespace(0, "");
defineNamespace(1, "xml");
}
/**
* Write markup text to output. Markup text can be written directly to the
* output without the need for any escaping, but still needs to be properly
* encoded.
*
* @param text markup text to be written
* @throws IOException if error writing to document
*/
protected void writeMarkup(String text) throws IOException {
int length = text.length();
makeSpace(length * 3);
int fill = m_fillOffset;
for (int i = 0; i < length; i++) {
char chr = text.charAt(i);
if (chr > 0x7F) {
if (chr > 0x7FF) {
m_buffer[fill++] = (byte)(0xE0 + (chr >> 12));
m_buffer[fill++] = (byte)(0x80 + ((chr >> 6) & 0x3F));
m_buffer[fill++] = (byte)(0x80 + (chr & 0x3F));
} else {
m_buffer[fill++] = (byte)(0xC0 + (chr >> 6));
m_buffer[fill++] = (byte)(0x80 + (chr & 0x3F));
}
} else {
m_buffer[fill++] = (byte)chr;
}
}
m_fillOffset = fill;
}
/**
* Write markup character to output. Markup text can be written directly to
* the output without the need for any escaping, but still needs to be
* properly encoded.
*
* @param chr markup character to be written
* @throws IOException if error writing to document
*/
protected void writeMarkup(char chr) throws IOException {
makeSpace(3);
if (chr > 0x7F) {
if (chr > 0x7FF) {
m_buffer[m_fillOffset++] = (byte)(0xE0 + (chr >> 12));
m_buffer[m_fillOffset++] = (byte)(0x80 + ((chr >> 6) & 0x3F));
m_buffer[m_fillOffset++] = (byte)(0x80 + (chr & 0x3F));
} else {
m_buffer[m_fillOffset++] = (byte)(0xC0 + (chr >> 6));
m_buffer[m_fillOffset++] = (byte)(0x80 + (chr & 0x3F));
}
} else {
m_buffer[m_fillOffset++] = (byte)chr;
}
}
/**
* Report that namespace has been defined.
*
* @param index namespace URI index number
* @param prefix prefix used for namespace
*/
protected void defineNamespace(int index, String prefix) {
int limit = prefix.length() * 3;
if (m_converts == null) {
m_converts = new byte[limit];
} else if (limit > m_converts.length) {
m_converts = new byte[limit];
}
int fill = 0;
for (int i = 0; i < prefix.length(); i++) {
char chr = prefix.charAt(i);
if (chr > 0x7F) {
if (chr > 0x7FF) {
m_converts[fill++] = (byte)(0xE0 + (chr >> 12));
m_converts[fill++] = (byte)(0x80 + ((chr >> 6) & 0x3F));
m_converts[fill++] = (byte)(0x80 + (chr & 0x3F));
} else {
m_converts[fill++] = (byte)(0xC0 + (chr >> 6));
m_converts[fill++] = (byte)(0x80 + (chr & 0x3F));
}
} else {
m_converts[fill++] = (byte)chr;
}
}
byte[] trim;
if (fill > 0) {
trim = new byte[fill+1];
System.arraycopy(m_converts, 0, trim, 0, fill);
trim[fill] = ':';
} else {
trim = new byte[0];
}
if (index < m_prefixBytes.length) {
m_prefixBytes[index] = trim;
} else if (m_extensionBytes != null) {
index -= m_prefixBytes.length;
for (int i = 0; i < m_extensionBytes.length; i++) {
int length = m_extensionBytes[i].length;
if (index < length) {
m_extensionBytes[i][index] = trim;
} else {
index -= length;
}
}
} else {
throw new IllegalArgumentException("Index out of range");
}
}
/**
* Write attribute text to output. This needs to write the text with any
* appropriate escaping.
*
* @param text attribute value text to be written
* @throws IOException if error writing to document
*/
protected void writeAttributeText(String text) throws IOException {
int length = text.length();
makeSpace(length * 6);
int fill = m_fillOffset;
for (int i = 0; i < length; i++) {
char chr = text.charAt(i);
if (chr == '"') {
fill = writeEntity(QUOT_ENTITY, fill);
} else if (chr == '&') {
fill = writeEntity(AMP_ENTITY, fill);
} else if (chr == '<') {
fill = writeEntity(LT_ENTITY, fill);
} else if (chr == '>' && i > 2 && text.charAt(i-1) == ']' &&
text.charAt(i-2) == ']') {
m_buffer[fill++] = (byte)']';
m_buffer[fill++] = (byte)']';
fill = writeEntity(GT_ENTITY, fill);
} else if (chr < 0x20) {
if (chr != 0x9 && chr != 0xA && chr != 0xD) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) + " in attribute value text");
} else {
m_buffer[fill++] = (byte)chr;
}
} else {
if (chr > 0x7F) {
if (chr > 0x7FF) {
if (chr > 0xD7FF && (chr < 0xE000 || chr == 0xFFFE ||
chr == 0xFFFF || chr > 0x10FFFF)) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) +
" in attribute value text");
} else {
m_buffer[fill++] = (byte)(0xE0 + (chr >> 12));
m_buffer[fill++] =
(byte)(0x80 + ((chr >> 6) & 0x3F));
m_buffer[fill++] = (byte)(0x80 + (chr & 0x3F));
}
} else {
m_buffer[fill++] = (byte)(0xC0 + (chr >> 6));
m_buffer[fill++] = (byte)(0x80 + (chr & 0x3F));
}
} else {
m_buffer[fill++] = (byte)chr;
}
}
}
m_fillOffset = fill;
}
/**
* Write ordinary character data text content to document.
*
* @param text content value text
* @throws IOException on error writing to document
*/
public void writeTextContent(String text) throws IOException {
flagTextContent();
int length = text.length();
makeSpace(length * 5);
int fill = m_fillOffset;
for (int i = 0; i < length; i++) {
char chr = text.charAt(i);
if (chr == '&') {
fill = writeEntity(AMP_ENTITY, fill);
} else if (chr == '<') {
fill = writeEntity(LT_ENTITY, fill);
} else if (chr == '>' && i > 2 && text.charAt(i-1) == ']' &&
text.charAt(i-2) == ']') {
fill = writeEntity(GT_ENTITY, fill);
} else if (chr < 0x20) {
if (chr != 0x9 && chr != 0xA && chr != 0xD) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) + " in content text");
} else {
m_buffer[fill++] = (byte)chr;
}
} else {
if (chr > 0x7F) {
if (chr > 0x7FF) {
if (chr > 0xD7FF && (chr < 0xE000 || chr == 0xFFFE ||
chr == 0xFFFF || chr > 0x10FFFF)) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) + " in content text");
} else {
m_buffer[fill++] = (byte)(0xE0 + (chr >> 12));
m_buffer[fill++] =
(byte)(0x80 + ((chr >> 6) & 0x3F));
m_buffer[fill++] = (byte)(0x80 + (chr & 0x3F));
}
} else {
m_buffer[fill++] = (byte)(0xC0 + (chr >> 6));
m_buffer[fill++] = (byte)(0x80 + (chr & 0x3F));
}
} else {
m_buffer[fill++] = (byte)chr;
}
}
}
m_fillOffset = fill;
}
/**
* Write CDATA text to document.
*
* @param text content value text
* @throws IOException on error writing to document
*/
public void writeCData(String text) throws IOException {
flagTextContent();
int length = text.length();
makeSpace(length * 3 + 12);
int fill = m_fillOffset;
fill = writeEntity(LT_CDATASTART, fill);
for (int i = 0; i < length; i++) {
char chr = text.charAt(i);
if (chr == '>' && i > 2 && text.charAt(i-1) == ']' &&
text.charAt(i-2) == ']') {
throw new IOException("Sequence \"]]>\" is not allowed " +
"within CDATA section text");
} else if (chr < 0x20) {
if (chr != 0x9 && chr != 0xA && chr != 0xD) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) + " in content text");
} else {
m_buffer[fill++] = (byte)chr;
}
} else {
if (chr > 0x7F) {
if (chr > 0x7FF) {
if (chr > 0xD7FF && (chr < 0xE000 || chr == 0xFFFE ||
chr == 0xFFFF || chr > 0x10FFFF)) {
throw new IOException("Illegal character code 0x" +
Integer.toHexString(chr) +
" in CDATA section text");
} else {
m_buffer[fill++] = (byte)(0xE0 + (chr >> 12));
m_buffer[fill++] =
(byte)(0x80 + ((chr >> 6) & 0x3F));
m_buffer[fill++] = (byte)(0x80 + (chr & 0x3F));
}
} else {
m_buffer[fill++] = (byte)(0xC0 + (chr >> 6));
m_buffer[fill++] = (byte)(0x80 + (chr & 0x3F));
}
} else {
m_buffer[fill++] = (byte)chr;
}
}
}
m_fillOffset = writeEntity(LT_CDATAEND, fill);
}
/**
* Create a child writer instance to be used for a separate binding. The
* child writer inherits the stream and encoding from this writer, while
* using the supplied namespace URIs.
*
* @param uris ordered array of URIs for namespaces used in document
* (see {@link #UTF8StreamWriter(String[])})
* @return child writer
* @throws IOException
*/
public IXMLWriter createChildWriter(String[] uris) throws IOException {
flagContent();
return new UTF8StreamWriter(this, uris);
}
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/UnmarshallingContext.java 0000644 0001750 0001750 00000366671 11003053146 027167 0 ustar moeller moeller /*
Copyright (c) 2002-2007, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime.impl;
import java.io.InputStream;
import java.io.Reader;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import org.jibx.runtime.IBindingFactory;
import org.jibx.runtime.IUnmarshaller;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.IXMLReader;
import org.jibx.runtime.JiBXConstrainedParseException;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.JiBXParseException;
import org.jibx.runtime.Utility;
/**
* 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
*/
public class UnmarshallingContext implements IUnmarshallingContext
{
/** Starting size for object stack. */
private static final int INITIAL_STACK_SIZE = 20;
/** Empty array of strings. */
private static final String[] EMPTY_STRING_ARRAY = new String[0];
/** Factory for creating XML readers. */
private static final IXMLReaderFactory s_readerFactory;
static {
String prop = null;
try {
System.getProperty("org.jibx.runtime.impl.parser");
} catch (SecurityException e) {
/* exception just means the value will be null */
}
if (prop == null) {
// try XMLPull parser factory first
IXMLReaderFactory fact = null;
try {
fact = createReaderFactory
("org.jibx.runtime.impl.XMLPullReaderFactory");
} catch (Throwable e) {
fact = createReaderFactory
("org.jibx.runtime.impl.StAXReaderFactory");
}
s_readerFactory = fact;
} else {
// try loading factory class specified by property
s_readerFactory = createReaderFactory(prop);
}
}
/** Binding factory used to create this unmarshaller. */
private IBindingFactory m_factory;
/** Parser in use. */
private IXMLReader m_reader;
//
// Structures organized by mapping index number. Each unmarshaller in the
// binding definition is assigned a unique index number by the binding
// compiler. This includes both generated unmarshallers (from non-abstract
// definitions) and user-defined unmarshallers. Instances of
// the unmarshaller classes are created as needed. The indexes for the
// unmarshallers corresponding to named mappings always precede those for
// internal mappings in the list.
/** Unmarshaller classes for mapping definition (null for
mappings out of context). */
protected String[] m_unmarshallerClasses;
/** Unmarshallers for classes in mapping definition (lazy create of actual
unmarshaller instances) */
protected IUnmarshaller[] m_unmarshallers;
//
// Structures organized by mapping
/** Namespaces for elements associated with class mappings. */
protected String[] m_namespaces;
/** Names for elements associated with class mappings. */
protected String[] m_names;
/** Number of classes with global unmarshallers. */
protected int m_globalCount;
/** ID maps for finding references. */
protected HashMap[] m_idMaps;
/** Class names of referenced types (null unless class-specific
IDs used). */
protected String[] m_idClasses;
/** Current unmarshalling stack depth. */
protected int m_stackDepth;
/** Stack of objects being unmarshalled. */
protected Object[] m_objectStack;
/** Mapping from element name to class index. If only a single namespace
is defined for a particular local name the value for that name in
this table is the Integer index of the associated class. If multiple
namespaces are defined using the same local name the value is an
ArrayList of Integer indexes. This is a high-overhead construct, so
lazy construction is used - it's built the first time needed, then kept
up to date thereafter. */
protected HashMap m_unmarshalMap;
/** Wrapped index values used with unmarshalling map. */
protected Integer[] m_indexes;
/** Last IDREF value parsed. */
protected String m_idref;
/** User context object (not used by JiBX, only for user convenience). */
protected Object m_userContext;
/**
* Parser factory class loader method. This is used during initialization to
* check that a particular factory class is usable.
*
* @param cname class name
* @return reader factory instance
* @throws RuntimeException on error creating class instance
*/
private static IXMLReaderFactory createReaderFactory(String cname) {
// try loading factory class from context loader
Class clas = null;
ClassLoader loader = Thread.currentThread().getContextClassLoader();
if (loader != null) {
try {
clas = loader.loadClass(cname);
} catch (ClassNotFoundException e) { /* deliberately empty */ }
}
if (clas == null) {
// next try the class loader that loaded the unmarshaller interface
try {
loader = IUnmarshallingContext.class.getClassLoader();
clas = loader.loadClass(cname);
} catch (ClassNotFoundException e) {
throw new RuntimeException
("Unable to specified parser factory class " + cname);
}
}
if (! (IXMLReaderFactory.class.isAssignableFrom(clas))) {
throw new RuntimeException("Specified parser factory class " +
cname + " does not implement IXMLReaderFactory interface");
}
// use static method to create parser factory class instance
try {
Method meth = clas.getMethod("getInstance", null);
return (IXMLReaderFactory)meth.invoke(null, null);
} catch (NoSuchMethodException e) {
throw new RuntimeException("Specified parser factory class " +
cname + " does not define static getInstance() method");
} catch (IllegalAccessException e) {
throw new RuntimeException("Error on parser factory class " +
cname + " getInstance() method call: " + e.getMessage());
} catch (InvocationTargetException e) {
throw new RuntimeException("Error on parser factory class " +
cname + " getInstance() method call: " + e.getMessage());
}
}
/**
* Constructor. Builds the actual parser and initializes internal data
* structures.
*
* @param nmap number of mapping definitions included
* @param umcs names of unmarshaller classes for indexes with fixed
* unmarshallers (as opposed to mapping slots, which may be overridden;
* reference kept, must be constant)
* @param nss namespaces for elements of classes with global definitions
* @param names names for elements of classes with global definitions
* @param idcs array of class names with IDs (null if no IDs or
* global IDs)
* @param ifact binding factory creating this unmarshaller
*/
public UnmarshallingContext(int nmap, String[] umcs, String[] nss,
String[] names, String[] idcs, IBindingFactory ifact) {
// initialize internal unmarshaller state
m_globalCount = nss.length;
m_unmarshallerClasses = new String[nmap];
System.arraycopy(umcs, 0, m_unmarshallerClasses, 0, umcs.length);
m_unmarshallers = new IUnmarshaller[nmap];
m_namespaces = new String[nmap];
System.arraycopy(nss, 0, m_namespaces, 0, nss.length);
m_names = new String[nmap];
System.arraycopy(names, 0, m_names, 0, names.length);
m_idClasses = idcs;
int size = idcs == null ? 1 : idcs.length;
m_idMaps = new HashMap[size];
m_objectStack = new Object[INITIAL_STACK_SIZE];
m_factory = ifact;
}
/**
* Default constructor. This can be used for creating a context outside of
* the generated code for special purposes.
*/
public UnmarshallingContext() {
this(0, EMPTY_STRING_ARRAY, EMPTY_STRING_ARRAY, EMPTY_STRING_ARRAY,
EMPTY_STRING_ARRAY, null);
}
/**
* Build name with optional namespace. Just returns the appropriate
* name format.
*
* @param ns namespace URI of name
* @param name local name part of name
* @return formatted name string
*/
public static String buildNameString(String ns, String name) {
if (ns == null || "".equals(ns)) {
return "\"" + name + "\"";
} else {
return "\"{" + ns + "}" + name + "\"";
}
}
/**
* Build current element name, with optional namespace.
*
* @return formatted name string
*/
public String currentNameString() {
return buildNameString(m_reader.getNamespace(), m_reader.getName());
}
/**
* Build current parse input position description.
*
* @return text description of current parse position
*/
public String buildPositionString() {
return m_reader.buildPositionString();
}
/**
* Throw exception for expected element start tag not found.
*
* @param ns namespace URI of name
* @param name local name part of name
* @exception JiBXException always thrown
*/
public void throwStartTagNameError(String ns, String name)
throws JiBXException {
throw new JiBXException("Expected " + buildNameString(ns, name) +
" start tag, found " + currentNameString() + " start tag " +
buildPositionString());
}
/**
* Throw exception for expected element end tag not found.
*
* @param ns namespace URI of name
* @param name local name part of name
* @exception JiBXException always thrown
*/
public void throwEndTagNameError(String ns, String name)
throws JiBXException {
throw new JiBXException("Expected " + buildNameString(ns, name) +
" end tag, found " + currentNameString() + " end tag " +
buildPositionString());
}
/**
* Throw exception including a name and position information.
*
* @param msg leading message text
* @param ns namespace URI of name
* @param name local name part of name
* @exception JiBXException always thrown
*/
public void throwNameException(String msg, String ns, String name)
throws JiBXException {
throw new JiBXException(msg + buildNameString(ns, name) +
buildPositionString());
}
/**
* Advance to next parse item. This wraps the base parser call in order to
* catch and handle exceptions.
*
* @exception JiBXException on any error (possibly wrapping other exception)
*/
private void advance() throws JiBXException {
m_reader.nextToken();
}
/**
* Verify namespace. This is a simple utility method that allows multiple
* representations for the empty namespace as a convenience for generated
* code.
*
* @param ns namespace URI expected (may be null
* or the empty string for the empty namespace)
* @return true if the current namespace matches that
* expected, false if not
*/
private boolean verifyNamespace(String ns) {
if (ns == null || "".equals(ns)) {
return m_reader.getNamespace().length() == 0;
} else {
return ns.equals(m_reader.getNamespace());
}
}
/**
* Get attribute value from parser.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @return attribute value text, or null if missing
*/
private String getAttributeValue(String ns, String name) {
return m_reader.getAttributeValue(ns, name);
}
/**
* 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.
*
* @param ins stream supplying document data
* @param name document name (null if unknown)
* @param enc document input encoding, or null if to be
* determined by parser
* @param nsa enable namespace processing for parser flag
* @throws JiBXException if error creating parser
*/
public void setDocument(InputStream ins, String name, String enc,
boolean nsa) throws JiBXException {
if (m_reader == null) {
m_reader = s_readerFactory.createReader(ins, name, enc, nsa);
} else {
m_reader = s_readerFactory.recycleReader(m_reader, ins, name, enc);
}
reset();
}
/**
* Set document to be parsed from stream.
*
* @param ins stream supplying document data
* @param enc document input encoding, or null if to be
* determined by parser
* @throws JiBXException if error creating parser
*/
public void setDocument(InputStream ins, String enc) throws JiBXException {
setDocument(ins, null, enc, true);
}
/**
* 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.
*
* @param rdr reader supplying document data
* @param name document name (null if unknown)
* @param nsa enable namespace processing for parser flag
* @throws JiBXException if error creating parser
*/
public void setDocument(Reader rdr, String name, boolean nsa)
throws JiBXException {
if (m_reader == null) {
m_reader = s_readerFactory.createReader(rdr, name, nsa);
} else {
m_reader = s_readerFactory.recycleReader(m_reader, rdr, name);
}
reset();
}
/**
* Set document to be parsed from reader.
*
* @param rdr reader supplying document data
* @throws JiBXException if error creating parser
*/
public void setDocument(Reader rdr) throws JiBXException {
setDocument(rdr, null, true);
}
/**
* Set named document to be parsed from stream.
*
* @param ins stream supplying document data
* @param name document name
* @param enc document input encoding, or null if to be
* determined by parser
* @throws JiBXException if error creating parser
*/
public void setDocument(InputStream ins, String name, String enc)
throws JiBXException {
setDocument(ins, name, enc, true);
}
/**
* Set named document to be parsed from reader.
*
* @param rdr reader supplying document data
* @param name document name
* @throws JiBXException if error creating parser
*/
public void setDocument(Reader rdr, String name) throws JiBXException {
setDocument(rdr, name, true);
}
/**
* Set input document parse source directly.
*
* @param rdr document parse event reader
*/
public void setDocument(IXMLReader rdr) {
m_reader = rdr;
}
/**
* 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.
*
* @param parent context supplying parser and document to be unmarshalled
*/
public void setFromContext(UnmarshallingContext parent) {
m_factory = parent.m_factory;
m_reader = parent.m_reader;
}
/**
* 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.
*/
public void reset() {
for (int i = 0; i < m_idMaps.length; i++) {
m_idMaps[i] = null;
}
for (int i = m_globalCount; i < m_unmarshallers.length; i++) {
m_namespaces[i] = null;
m_names[i] = null;
m_unmarshallers[i] = null;
}
m_unmarshalMap = null;
m_idref = null;
for (int i = 0; i < m_objectStack.length; i++) {
m_objectStack[i] = null;
}
m_stackDepth = 0;
m_userContext = null;
}
/**
* 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.
*
* @return element name of start tag found
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public String toStart() throws JiBXException {
if (m_reader.getEventType() == IXMLReader.START_TAG) {
return m_reader.getName();
}
while (true) {
m_reader.next();
switch (m_reader.getEventType()) {
case IXMLReader.START_TAG:
return m_reader.getName();
case IXMLReader.END_TAG:
throw new JiBXException("Expected start tag, " +
"found end tag " + currentNameString() +
" " + buildPositionString());
case IXMLReader.END_DOCUMENT:
throw new JiBXException("Expected start tag, " +
"found end of document " + buildPositionString());
}
}
}
/**
* 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.
*
* @return element name of end tag found
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public String toEnd() throws JiBXException {
if (m_reader.getEventType() == IXMLReader.END_TAG) {
return m_reader.getName();
}
while (true) {
m_reader.next();
switch (m_reader.getEventType()) {
case IXMLReader.START_TAG:
throw new JiBXException("Expected end tag, " +
"found start tag " + currentNameString() +
" " + buildPositionString());
case IXMLReader.END_TAG:
return m_reader.getName();
case IXMLReader.END_DOCUMENT:
throw new JiBXException("Expected end tag, " +
"found end of document " + buildPositionString());
}
}
}
/**
* 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.
*
* @return parser event type for start tag or end tag
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public int toTag() throws JiBXException {
int type = m_reader.getEventType();
while (type != IXMLReader.START_TAG &&
type != IXMLReader.END_TAG) {
type = m_reader.next();
}
return m_reader.getEventType();
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param name element name expected
* @return true if at start of element with supplied name,
* false if not
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public boolean isAt(String ns, String name) throws JiBXException {
int type = m_reader.getEventType();
while (type != IXMLReader.START_TAG &&
type != IXMLReader.END_TAG) {
type = m_reader.next();
}
return m_reader.getEventType() == IXMLReader.START_TAG &&
m_reader.getName().equals(name) && verifyNamespace(ns);
}
/**
* Check if attribute is present on current start tag. Throws an exception
* if not currently positioned on a start tag.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @return true if named attribute is present,
* false if not
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public boolean hasAttribute(String ns, String name) throws JiBXException {
if (m_reader.getEventType() == IXMLReader.START_TAG) {
return getAttributeValue(ns, name) != null;
} else {
throw new JiBXException("Error parsing document " +
buildPositionString());
}
}
/**
* Check if any of several attributes is present on current start tag.
* Throws an exception if not currently positioned on a start tag.
*
* @param nss namespace URIs for expected attributes (each may be
* null or the empty string for the empty namespace)
* @param names attribute names expected
* @return true if at least one of the named attributes is
* present, false if not
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public boolean hasAnyAttribute(String[] nss, String[] names)
throws JiBXException {
if (m_reader.getEventType() == IXMLReader.START_TAG) {
for (int i = 0; i < names.length; i++) {
if (getAttributeValue(nss[i], names[i]) != null) {
return true;
}
}
return false;
} else {
throw new JiBXException("Error parsing document " +
buildPositionString());
}
}
/**
* 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.
*
* @param nss namespace URIs for allowed attributes (each may be
* null or the empty string for the empty namespace)
* @param names alphabetical list of attribute names expected (duplicates
* names are ordered by namespace URI)
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public void checkAllowedAttributes(String[] nss, String[] names)
throws JiBXException {
if (m_reader.getEventType() == IXMLReader.START_TAG) {
int count = m_reader.getAttributeCount();
loop: for (int i = 0; i < count; i++) {
String name = m_reader.getAttributeName(i);
String ns = m_reader.getAttributeNamespace(i);
int base = 0;
int limit = names.length - 1;
while (base <= limit) {
int cur = (base + limit) >> 1;
int diff = name.compareTo(names[cur]);
if (diff == 0) {
String comp = nss[cur];
if (comp == null) {
diff = ns.compareTo("");
} else {
diff = ns.compareTo(comp);
}
if (diff == 0) {
continue loop;
}
}
if (diff < 0) {
limit = cur - 1;
} else if (diff > 0) {
base = cur + 1;
}
}
throwStartTagException("Illegal attribute " +
buildNameString(ns, name));
}
} else {
throw new JiBXException("Error parsing document " +
buildPositionString());
}
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param name element name expected
* @throws JiBXException on any error (possibly wrapping other exception)
*/
private void matchStart(String ns, String name) throws JiBXException {
if (toTag() == IXMLReader.START_TAG) {
if (!m_reader.getName().equals(name) || !verifyNamespace(ns)) {
throwStartTagNameError(ns, name);
}
} else {
throw new JiBXException("Expected " + buildNameString(ns, name)
+ " start tag, found " + currentNameString() + " end tag "
+ buildPositionString());
}
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param name element name expected
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public void parseToStartTag(String ns, String name) throws JiBXException {
matchStart(ns, name);
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param name element name expected
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public void parsePastStartTag(String ns, String name) throws JiBXException {
matchStart(ns, name);
advance();
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param name element name expected
* @return true if start tag found, false if not
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public boolean parseIfStartTag(String ns, String name)
throws JiBXException {
if (isAt(ns, name)) {
advance();
return true;
} else {
return false;
}
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param name element name expected
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public void parsePastCurrentEndTag(String ns, String name)
throws JiBXException {
// move parse to start or end tag
int event = toTag();
// check for match on expected end tag
if (event == IXMLReader.END_TAG) {
if (m_reader.getName().equals(name) && verifyNamespace(ns)) {
advance();
} else {
throwEndTagNameError(ns, name);
}
} else {
throw new JiBXException("Expected " + buildNameString(ns, name)
+ " end tag, found " + currentNameString() + " start tag "
+ buildPositionString());
}
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param name element name expected
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public void parsePastEndTag(String ns, String name) throws JiBXException {
// most past current tag if start
int event = m_reader.getEventType();
if (event == IXMLReader.START_TAG) {
advance();
}
// handle as current tag
parsePastCurrentEndTag(ns, name);
}
/**
* 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.
*
* @return true if at start of element, false if
* at end
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public boolean isStart() throws JiBXException {
int type = m_reader.getEventType();
while (type != IXMLReader.START_TAG &&
type != IXMLReader.END_TAG) {
type = m_reader.next();
}
return m_reader.getEventType() == IXMLReader.START_TAG;
}
/**
* 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.
*
* @return true if at end of element, false if
* at start
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public boolean isEnd() throws JiBXException {
int type = m_reader.getEventType();
while (type != IXMLReader.START_TAG &&
type != IXMLReader.END_TAG) {
type = m_reader.next();
}
return m_reader.getEventType() == IXMLReader.END_TAG;
}
/**
* 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.
*
* @return consolidated text string (empty string if no text components)
* @exception JiBXException on error in unmarshalling
*/
public String accumulateText() throws JiBXException {
String text = null;
StringBuffer buff = null;
loop: while (true) {
switch (m_reader.getEventType()) {
case IXMLReader.ENTITY_REF:
if (m_reader.getText() == null) {
throw new JiBXException
("Unexpanded entity reference in text at " +
buildPositionString());
}
// fall through into text accumulation
case IXMLReader.CDSECT:
case IXMLReader.TEXT:
if (text == null) {
text = m_reader.getText();
} else {
if (buff == null) {
buff = new StringBuffer(text);
}
buff.append(m_reader.getText());
}
break;
case IXMLReader.END_TAG:
case IXMLReader.START_TAG:
case IXMLReader.END_DOCUMENT:
break loop;
default:
break;
}
m_reader.nextToken();
}
if (buff == null) {
return (text == null) ? "" : text;
} else {
return buff.toString();
}
}
/**
* Parse required text content. Assumes the parse is already positioned at
* the text content, so just returns the text.
*
* @return content text found
* @throws JiBXException on any error (possible wrapping other exception)
*/
public String parseContentText() throws JiBXException {
return accumulateText();
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @return content text from element
* @throws JiBXException on any error (possible wrapping other exception)
*/
public String parseContentText(String ns, String tag)
throws JiBXException {
String text = accumulateText();
switch (m_reader.getEventType()) {
case IXMLReader.END_TAG:
if (m_reader.getName().equals(tag) &&
verifyNamespace(ns)) {
m_reader.nextToken();
return text;
} else {
throwEndTagNameError(ns, tag);
}
case IXMLReader.START_TAG:
throw new JiBXException("Expected " +
buildNameString(ns, tag) + " end tag, " +
"found " + currentNameString() + " start tag " +
buildPositionString());
case IXMLReader.END_DOCUMENT:
throw new JiBXException("Expected " +
buildNameString(ns, tag) + " end tag, " +
"found end of document " + buildPositionString());
}
return null;
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @return converted value from element text
* @throws JiBXException on any error (possible wrapping other exception)
*/
public int parseContentInt(String ns, String tag) throws JiBXException {
String text = parseContentText(ns, tag);
try {
return Utility.parseInt(text);
} catch (JiBXException ex) {
throw new JiBXParseException(ex.getMessage() + ' ' +
buildPositionString(), text, ns, tag, ex.getRootCause());
}
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @return content text from element
* @throws JiBXException on any error (possible wrapping other exception)
*/
public String parseElementText(String ns, String tag) throws JiBXException {
parsePastStartTag(ns, tag);
return parseContentText(ns, tag);
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @param dflt default text value
* @return content text from element
* @throws JiBXException on any error (possible wrapping other exception)
*/
public String parseElementText(String ns, String tag, String dflt)
throws JiBXException {
if (parseIfStartTag(ns, tag)) {
return parseContentText(ns, tag);
} else {
return dflt;
}
}
/**
* Get text value of attribute from current start tag.
* Throws an exception if the attribute value is not found in the start
* tag.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @return attribute value text
* @throws JiBXException if attribute not present
*/
public String attributeText(String ns, String name) throws JiBXException {
String value = getAttributeValue(ns, name);
if (value == null) {
throw new JiBXException("Missing required attribute " +
buildNameString(ns, name) + " " + buildPositionString());
} else {
return value;
}
}
/**
* Get text value of optional attribute from current start
* tag. If the attribute is not present the supplied default value is
* returned instead.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @param dflt value to be returned if attribute is not present
* @return attribute value text
*/
public String attributeText(String ns, String name, String dflt) {
String value = getAttributeValue(ns, name);
if (value == null) {
return dflt;
} else {
return value;
}
}
/**
* Find the object corresponding to an ID. This method just handles the
* lookup and checks the object type.
*
* @param id ID text
* @param index expected reference type index
* @return object corresponding to IDREF, or null if not
* yet defined
* @throws JiBXException on any error
*/
public Object findID(String id, int index) throws JiBXException {
HashMap map = m_idMaps[index];
if (map != null) {
Object obj = map.get(id);
if (obj == null || obj instanceof BackFillHolder) {
return null;
} else if (m_idClasses == null ||
m_idClasses[index].equals(obj.getClass().getName())) {
return obj;
} else {
throwStartTagException
("IDREF element content mapped to wrong type");
}
}
return null;
}
/**
* Find previously defined object corresponding to an ID. This does the
* lookup and checks that the referenced object has been defined.
*
* @param id ID text
* @param index expected reference type index
* @return object corresponding to IDREF
* @throws JiBXException on any error
*/
public Object findDefinedID(String id, int index) throws JiBXException {
Object obj = findID(id, index);
if (obj == null) {
throwStartTagException("ID " + id + " not defined");
}
return obj;
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag attribute name expected
* @param index expected reference type index
* @return object corresponding to IDREF, or null if not
* yet defined
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public Object parseElementForwardIDREF(String ns, String tag, int index)
throws JiBXException {
parsePastStartTag(ns, tag);
m_idref = parseContentText(ns, tag);
return findID(m_idref, index);
}
/**
* Get object (if defined yet) corresponding to IDREF attribute from
* current start tag.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @param index expected reference type index
* @return 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
*/
public Object attributeForwardIDREF(String ns, String name, int index)
throws JiBXException {
m_idref = attributeText(ns, name);
return findID(m_idref, index);
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag attribute name expected
* @param index expected reference type index
* @return object corresponding to IDREF
* @throws JiBXException if attribute not present, ID not defined, or
* mapped to a different type of object than expected
*/
public Object parseElementExistingIDREF(String ns, String tag, int index)
throws JiBXException {
parsePastStartTag(ns, tag);
m_idref = parseContentText(ns, tag);
return findDefinedID(m_idref, index);
}
/**
* Get previously defined object corresponding to IDREF attribute from
* current start tag.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @param index expected reference type index
* @return object corresponding to IDREF
* @throws JiBXException if attribute not present, ID not defined, or
* mapped to a different type of object than expected
*/
public Object attributeExistingIDREF(String ns, String name, int index)
throws JiBXException {
m_idref = attributeText(ns, name);
return findDefinedID(m_idref, index);
}
/**
* 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.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @return attribute integer value
* @throws JiBXException if attribute not present or not a valid integer
* value
*/
public int attributeInt(String ns, String name) throws JiBXException {
String text = attributeText(ns, name);
try {
return Utility.parseInt(text);
} catch (JiBXException ex) {
throw new JiBXParseException(ex.getMessage() + ' ' +
buildPositionString(), text, ns, name, ex.getRootCause());
}
}
/**
* Get integer value of optional attribute from current
* start tag. If the attribute is not present the supplied default value
* is returned instead.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @param dflt value to be returned if attribute is not present
* @return attribute integer value
* @throws JiBXException if attribute value is not a valid integer
*/
public int attributeInt(String ns, String name, int dflt)
throws JiBXException {
String value = getAttributeValue(ns, name);
if (value == null) {
return dflt;
} else {
try {
return Utility.parseInt(value);
} catch (JiBXException ex) {
throw new JiBXParseException(ex.getMessage() + ' ' +
buildPositionString(), value, ns, name, ex.getRootCause());
}
}
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @return content text from element
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public int parseElementInt(String ns, String tag) throws JiBXException {
parsePastStartTag(ns, tag);
return parseContentInt(ns, tag);
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @param dflt default value
* @return content text from element
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public int parseElementInt(String ns, String tag, int dflt)
throws JiBXException {
if (parseIfStartTag(ns, tag)) {
return parseContentInt(ns, tag);
} else {
return dflt;
}
}
/**
* Find required text value in enumeration. Looks up and returns the
* enumeration value corresponding to the target text.
*
* @param target text to be found in enumeration
* @param enums ordered array of texts included in enumeration
* @param vals array of values to be returned for corresponding text match
* positions (position returned directly if this is null)
* @return enumeration value for target text
* @throws JiBXException if target text not found in enumeration
*/
public int convertEnum(String target, String[] enums, int[] vals)
throws JiBXException {
if (target == null) {
throwStartTagException("Missing required enumeration value");
}
try {
return Utility.enumValue(target, enums, vals);
} catch (JiBXException ex) {
throw new JiBXConstrainedParseException(ex.getMessage() + ' ' +
buildPositionString(), target, enums);
}
}
/**
* 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 is null.
*
* @param target text to be found in enumeration (may be null)
* @param enums ordered array of texts included in enumeration
* @param vals array of values to be returned for corresponding text match
* positions (position returned directly if this is null)
* @param dflt default value returned if target text is null
* @return enumeration value for target text
* @throws JiBXException if target text not found in enumeration
*/
public int convertEnum(String target, String[] enums, int[] vals, int dflt)
throws JiBXException {
if (target == null) {
return dflt;
}
try {
return Utility.enumValue(target, enums, vals);
} catch (JiBXException ex) {
throw new JiBXConstrainedParseException(ex.getMessage() + ' ' +
buildPositionString(), target, enums);
}
}
/**
* 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.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @param enums ordered array of texts included in enumeration
* @param vals array of values to be returned for corresponding text match
* positions (position returned directly if this is null)
* @return enumeration value for target text
* @throws JiBXException if attribute not present or value not found in
* enumeration list
*/
public int attributeEnumeration(String ns, String name, String[] enums,
int[] vals) throws JiBXException {
try {
return convertEnum(getAttributeValue(ns, name), enums, vals);
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(name);
throw e;
}
}
/**
* 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.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @param enums ordered array of texts included in enumeration
* @param vals array of values to be returned for corresponding text match
* positions (position returned directly if this is null)
* @param dflt default value returned if attribute is not present
* @return enumeration value for target text
* @throws JiBXException if attribute not present or value not found in
* enumeration list
*/
public int attributeEnumeration(String ns, String name, String[] enums,
int[] vals, int dflt) throws JiBXException {
try {
return convertEnum(getAttributeValue(ns, name), enums, vals, dflt);
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(name);
throw e;
}
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @param enums ordered array of texts included in enumeration
* @param vals array of values to be returned for corresponding text match
* positions (position returned directly if this is null)
* @return enumeration value for element text
* @throws JiBXException on any error (possible wrapping other exception)
*/
public int parseContentEnumeration(String ns, String tag, String[] enums,
int[] vals) throws JiBXException {
try {
return convertEnum(parseContentText(ns, tag), enums, vals);
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(tag);
throw e;
}
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @param enums ordered array of texts included in enumeration
* @param vals array of values to be returned for corresponding text match
* positions (position returned directly if this is null)
* @param dflt default value
* @return enumeration value for element text
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public int parseElementEnumeration(String ns, String tag, String[] enums,
int[] vals, int dflt) throws JiBXException {
if (parseIfStartTag(ns, tag)) {
String text = parseContentText(ns, tag);
try {
return convertEnum(text, enums, vals, dflt);
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(tag);
throw e;
}
} else {
return dflt;
}
}
/**
* 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.
*
* @param text text for value to be converted
* @return converted byte value
* @throws JiBXException if not a valid byte value
*/
public byte convertByte(String text) throws JiBXException {
try {
return Utility.parseByte(text);
} catch (JiBXException ex) {
throw new JiBXParseException(ex.getMessage() + ' ' +
buildPositionString(), text, ex.getRootCause());
}
}
/**
* 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.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @return attribute byte value
* @throws JiBXException if attribute not present or not a valid byte value
*/
public byte attributeByte(String ns, String name) throws JiBXException {
try {
return convertByte(attributeText(ns, name));
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(name);
throw e;
}
}
/**
* Get byte value of optional attribute from current start tag. If the
* attribute is not present the supplied default value is returned instead.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @param dflt value to be returned if attribute is not present
* @return attribute byte value
* @throws JiBXException if attribute value is not a valid byte
*/
public byte attributeByte(String ns, String name, byte dflt)
throws JiBXException {
String text = getAttributeValue(ns, name);
if (text == null) {
return dflt;
} else {
try {
return convertByte(text);
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(name);
throw e;
}
}
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @return converted value from element text
* @throws JiBXException on any error (possible wrapping other exception)
*/
public byte parseContentByte(String ns, String tag) throws JiBXException {
try {
return convertByte(parseContentText(ns, tag));
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(tag);
throw e;
}
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @return content text from element
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public byte parseElementByte(String ns, String tag) throws JiBXException {
parsePastStartTag(ns, tag);
return parseContentByte(ns, tag);
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @param dflt default value
* @return content text from element
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public byte parseElementByte(String ns, String tag, byte dflt)
throws JiBXException {
if (parseIfStartTag(ns, tag)) {
try {
return convertByte(parseContentText(ns, tag));
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(tag);
throw e;
}
} else {
return dflt;
}
}
/**
* 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.
*
* @param text text for value to be converted
* @return converted short value
* @throws JiBXException if not a valid short value
*/
public short convertShort(String text) throws JiBXException {
try {
return Utility.parseShort(text);
} catch (JiBXException ex) {
throw new JiBXParseException(ex.getMessage() + ' ' +
buildPositionString(), text, ex.getRootCause());
}
}
/**
* 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.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @return attribute short value
* @throws JiBXException if attribute not present or not a valid short value
*/
public short attributeShort(String ns, String name) throws JiBXException {
try {
return convertShort(attributeText(ns, name));
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(name);
throw e;
}
}
/**
* Get short value of optional attribute from current start tag. If the
* attribute is not present the supplied default value is returned instead.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @param dflt value to be returned if attribute is not present
* @return attribute short value
* @throws JiBXException if attribute value is not a valid short
*/
public short attributeShort(String ns, String name, short dflt)
throws JiBXException {
String text = getAttributeValue(ns, name);
if (text == null) {
return dflt;
} else {
try {
return convertShort(text);
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(name);
throw e;
}
}
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @return converted value from element text
* @throws JiBXException on any error (possible wrapping other exception)
*/
public short parseContentShort(String ns, String tag) throws JiBXException {
try {
return convertShort(parseContentText(ns, tag));
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(tag);
throw e;
}
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @return content text from element
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public short parseElementShort(String ns, String tag) throws JiBXException {
parsePastStartTag(ns, tag);
try {
return parseContentShort(ns, tag);
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(tag);
throw e;
}
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @param dflt default value
* @return content text from element
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public short parseElementShort(String ns, String tag, short dflt)
throws JiBXException {
if (parseIfStartTag(ns, tag)) {
try {
return convertShort(parseContentText(ns, tag));
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(tag);
throw e;
}
} else {
return dflt;
}
}
/**
* 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.
*
* @param text text for value to be converted
* @return converted char value
* @throws JiBXException if not a valid char value
*/
public char convertChar(String text) throws JiBXException {
try {
return Utility.parseChar(text);
} catch (JiBXException ex) {
throw new JiBXParseException(ex.getMessage() + ' ' +
buildPositionString(), text, ex.getRootCause());
}
}
/**
* 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.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @return attribute char value
* @throws JiBXException if attribute not present or not a valid char value
*/
public char attributeChar(String ns, String name) throws JiBXException {
try {
return convertChar(attributeText(ns, name));
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(name);
throw e;
}
}
/**
* Get char value of optional attribute from current start tag. If the
* attribute is not present the supplied default value is returned instead.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @param dflt value to be returned if attribute is not present
* @return attribute char value
* @throws JiBXException if attribute value is not a valid char
*/
public char attributeChar(String ns, String name, char dflt)
throws JiBXException {
String text = getAttributeValue(ns, name);
if (text == null) {
return dflt;
} else {
try {
return convertChar(text);
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(name);
throw e;
}
}
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @return converted value from element text
* @throws JiBXException on any error (possible wrapping other exception)
*/
public char parseContentChar(String ns, String tag) throws JiBXException {
try {
return convertChar(parseContentText(ns, tag));
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(tag);
throw e;
}
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @return content text from element
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public char parseElementChar(String ns, String tag) throws JiBXException {
parsePastStartTag(ns, tag);
try {
return parseContentChar(ns, tag);
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(tag);
throw e;
}
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @param dflt default value
* @return content text from element
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public char parseElementChar(String ns, String tag, char dflt)
throws JiBXException {
if (parseIfStartTag(ns, tag)) {
try {
return convertChar(parseContentText(ns, tag));
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(tag);
throw e;
}
} else {
return dflt;
}
}
/**
* 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.
*
* @param text text for value to be converted
* @return converted long value
* @throws JiBXException if not a valid long value
*/
public long convertLong(String text) throws JiBXException {
try {
return Utility.parseLong(text);
} catch (JiBXException ex) {
throw new JiBXParseException(ex.getMessage() + ' ' +
buildPositionString(), text, ex.getRootCause());
}
}
/**
* 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.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @return attribute long value
* @throws JiBXException if attribute not present or not a valid long value
*/
public long attributeLong(String ns, String name) throws JiBXException {
try {
return convertLong(attributeText(ns, name));
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(name);
throw e;
}
}
/**
* Get long value of optional attribute from current start tag. If the
* attribute is not present the supplied default value is returned instead.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @param dflt value to be returned if attribute is not present
* @return attribute long value
* @throws JiBXException if attribute value is not a valid long
*/
public long attributeLong(String ns, String name, long dflt)
throws JiBXException {
String text = getAttributeValue(ns, name);
if (text == null) {
return dflt;
} else {
try {
return convertLong(text);
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(name);
throw e;
}
}
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @return converted value from element text
* @throws JiBXException on any error (possible wrapping other exception)
*/
public long parseElementLong(String ns, String tag) throws JiBXException {
parsePastStartTag(ns, tag);
try {
return convertLong(parseContentText(ns, tag));
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(tag);
throw e;
}
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @param dflt default value
* @return content text from element
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public long parseElementLong(String ns, String tag, long dflt)
throws JiBXException {
if (parseIfStartTag(ns, tag)) {
try {
return convertLong(parseContentText(ns, tag));
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(tag);
throw e;
}
} else {
return dflt;
}
}
/**
* 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.
*
* @param text text for value to be converted
* @return converted boolean value
* @throws JiBXException if not a valid boolean value
*/
public boolean convertBoolean(String text) throws JiBXException {
if ("true".equalsIgnoreCase(text) || "1".equals(text)) {
return true;
} else if ("false".equalsIgnoreCase(text) || "0".equals(text)) {
return false;
}
throw new JiBXParseException("Invalid boolean value " +
buildPositionString(), text);
}
/**
* 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.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @return attribute boolean value
* @throws JiBXException if attribute not present or not a valid boolean
* value
*/
public boolean attributeBoolean(String ns, String name)
throws JiBXException {
try {
return convertBoolean(attributeText(ns, name));
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(name);
throw e;
}
}
/**
* Get boolean value of optional attribute from current start tag. If the
* attribute is not present the supplied default value is returned instead.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @param dflt value to be returned if attribute is not present
* @return attribute boolean value
* @throws JiBXException if attribute value is not a valid boolean
*/
public boolean attributeBoolean(String ns, String name, boolean dflt)
throws JiBXException {
String text = getAttributeValue(ns, name);
if (text == null) {
return dflt;
} else {
try {
return convertBoolean(text);
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(name);
throw e;
}
}
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @return converted value from element text
* @throws JiBXException on any error (possible wrapping other exception)
*/
public boolean parseElementBoolean(String ns, String tag)
throws JiBXException {
parsePastStartTag(ns, tag);
try {
return convertBoolean(parseContentText(ns, tag));
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(tag);
throw e;
}
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @param dflt default value
* @return content text from element
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public boolean parseElementBoolean(String ns, String tag, boolean dflt)
throws JiBXException {
if (parseIfStartTag(ns, tag)) {
try {
return convertBoolean(parseContentText(ns, tag));
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(tag);
throw e;
}
} else {
return dflt;
}
}
/**
* 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.
*
* @param text text for value to be converted
* @return converted float value
* @throws JiBXException if not a valid float value
*/
public float convertFloat(String text) throws JiBXException {
try {
return Utility.parseFloat(text);
} catch (JiBXException ex) {
throw new JiBXParseException(ex.getMessage() + ' ' +
buildPositionString(), text, ex.getRootCause());
}
}
/**
* 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.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @return attribute float value
* @throws JiBXException if attribute not present or not a valid float value
*/
public float attributeFloat(String ns, String name) throws JiBXException {
try {
return convertFloat(attributeText(ns, name));
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(name);
throw e;
}
}
/**
* Get float value of optional attribute from current start tag. If the
* attribute is not present the supplied default value is returned instead.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @param dflt value to be returned if attribute is not present
* @return attribute float value
* @throws JiBXException if attribute value is not a valid float
*/
public float attributeFloat(String ns, String name, float dflt)
throws JiBXException {
String text = getAttributeValue(ns, name);
if (text == null) {
return dflt;
} else {
try {
return convertFloat(text);
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(name);
throw e;
}
}
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @return converted value from element text
* @throws JiBXException on any error (possible wrapping other exception)
*/
public float parseElementFloat(String ns, String tag) throws JiBXException {
parsePastStartTag(ns, tag);
try {
return convertFloat(parseContentText(ns, tag));
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(tag);
throw e;
}
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @param dflt default value
* @return content text from element
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public float parseElementFloat(String ns, String tag, float dflt)
throws JiBXException {
if (parseIfStartTag(ns, tag)) {
try {
return convertFloat(parseContentText(ns, tag));
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(tag);
throw e;
}
} else {
return dflt;
}
}
/**
* 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.
*
* @param text text for value to be converted
* @return converted double value
* @throws JiBXException if not a valid double value
*/
public double convertDouble(String text) throws JiBXException {
try {
return Utility.parseDouble(text);
} catch (JiBXException ex) {
throw new JiBXParseException(ex.getMessage() + ' ' +
buildPositionString(), text, ex.getRootCause());
}
}
/**
* 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.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @return attribute double value
* @throws JiBXException if attribute not present or not a valid double
* value
*/
public double attributeDouble(String ns, String name) throws JiBXException {
try {
return convertDouble(attributeText(ns, name));
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(name);
throw e;
}
}
/**
* Get double value of optional attribute from current start tag. If the
* attribute is not present the supplied default value is returned instead.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @param dflt value to be returned if attribute is not present
* @return attribute double value
* @throws JiBXException if attribute value is not a valid double
*/
public double attributeDouble(String ns, String name, double dflt)
throws JiBXException {
String text = getAttributeValue(ns, name);
if (text == null) {
return dflt;
} else {
try {
return convertDouble(text);
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(name);
throw e;
}
}
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @return converted value from element text
* @throws JiBXException on any error (possible wrapping other exception)
*/
public double parseElementDouble(String ns, String tag)
throws JiBXException {
parsePastStartTag(ns, tag);
try {
return convertDouble(parseContentText(ns, tag));
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(tag);
throw e;
}
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @param dflt default value
* @return content text from element
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public double parseElementDouble(String ns, String tag, double dflt)
throws JiBXException {
if (parseIfStartTag(ns, tag)) {
try {
return convertDouble(parseContentText(ns, tag));
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(tag);
throw e;
}
} else {
return dflt;
}
}
/**
* Convert 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.
*
* @param text text for value to be converted
* @return converted Date value
* @throws JiBXException if not a valid Date value
*/
public Date convertDate(String text) throws JiBXException {
try {
return new Date(Utility.parseDateTime(text));
} catch (JiBXException ex) {
throw new JiBXParseException(ex.getMessage() + ' ' +
buildPositionString(), text, ex.getRootCause());
}
}
/**
* Get 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.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @return attribute Date value
* @throws JiBXException if attribute not present or not a valid Date
* value
*/
public Date attributeDate(String ns, String name) throws JiBXException {
try {
return convertDate(attributeText(ns, name));
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(name);
throw e;
}
}
/**
* Get java.util.Date value of optional attribute from current
* start tag. If the attribute is not present the supplied default value is
* returned instead.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @param dflt value to be returned if attribute is not present
* @return attribute Date value
* @throws JiBXException if attribute value is not a valid Date
*/
public Date attributeDate(String ns, String name, Date dflt)
throws JiBXException {
String text = getAttributeValue(ns, name);
if (text == null) {
return dflt;
} else {
try {
return convertDate(text);
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(name);
throw e;
}
}
}
/**
* Parse past end of element, returning 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @return converted value from element text
* @throws JiBXException on any error (possible wrapping other exception)
*/
public Date parseElementDate(String ns, String tag) throws JiBXException {
parsePastStartTag(ns, tag);
try {
return convertDate(parseContentText(ns, tag));
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(tag);
throw e;
}
}
/**
* Parse entire element, returning 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @param dflt default value
* @return content text from element
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public Date parseElementDate(String ns, String tag, Date dflt)
throws JiBXException {
if (parseIfStartTag(ns, tag)) {
try {
return convertDate(parseContentText(ns, tag));
} catch (JiBXParseException e) {
e.setNamespace(ns);
e.setTagName(tag);
throw e;
}
} else {
return dflt;
}
}
/**
* 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.
*
* @param id target undefined ID value
* @param index target reference type index
* @param fill back fill item
* @throws JiBXException if attribute not present, or ID already defined
*/
public void registerBackFill(String id, int index, BackFillReference fill)
throws JiBXException {
HashMap map = m_idMaps[index];
if (map == null) {
m_idMaps[index] = map = new HashMap();
}
Object obj = map.get(id);
if (obj == null) {
String xclass = (m_idClasses == null) ? null : m_idClasses[index];
BackFillHolder holder = new BackFillHolder(xclass);
map.put(id, holder);
holder.addBackFill(fill);
} else if (obj instanceof BackFillHolder) {
((BackFillHolder)obj).addBackFill(fill);
} else {
throw new JiBXException
("Internal operation error (back fill error) " +
buildPositionString());
}
}
/**
* 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).
*
* @param index target reference type index
* @param fill back fill item
* @throws JiBXException if attribute not present, or ID already defined
*/
public void registerBackFill(int index, BackFillReference fill)
throws JiBXException {
registerBackFill(m_idref, index, fill);
}
/**
* 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.
*
* @param id text ID value
* @param index ID class index number
* @param obj object corresponding to element
* @throws JiBXException if duplicate ID or wrong class
*/
public void defineID(String id, int index, Object obj)
throws JiBXException {
HashMap map = m_idMaps[index];
if (map == null) {
m_idMaps[index] = map = new HashMap();
}
Object prior = map.put(id, obj);
if (prior instanceof BackFillHolder) {
BackFillHolder holder = (BackFillHolder)prior;
String xclass = holder.getExpectedClass();
if (xclass == null || xclass.equals(obj.getClass().getName())) {
holder.defineValue(obj);
} else {
throw new JiBXException("ID object has wrong type " +
buildPositionString());
}
} else if (prior != null) {
throw new JiBXException("Duplicate ID definition " +
buildPositionString());
}
}
/**
* Map unmarshalling for element. Adds the entry for a particular class
* index to the unmarshalling map.
*
* @param index class index for unmarshalling definition to be added
*/
protected void mapUnmarshalling(int index) {
Object value = m_unmarshalMap.get(m_names[index]);
if (value instanceof Integer) {
ArrayList list = new ArrayList();
list.add(value);
list.add(m_indexes[index]);
m_unmarshalMap.put(m_names[index], list);
} else if (value instanceof ArrayList) {
ArrayList list = (ArrayList)value;
list.add(m_indexes[index]);
} else {
m_unmarshalMap.put(m_names[index], m_indexes[index]);
}
}
/**
* Define unmarshalling for element. Enables the unmarshalling definition
* linking an element name (including namespace) with a handler. The
* unmarshalling definitions use fixed indexes for each class, allowing
* direct lookup of the unmarshaller when multiple versions are defined.
*
* @param index class index for unmarshalling definition
* @param ns namespace for element (may be null
* or the empty string for the empty namespace)
* @param name name for element
* @param cname name of class created by unmarshaller
*/
public void addUnmarshalling(int index, String ns, String name,
String cname) {
m_namespaces[index] = ns;
m_names[index] = name;
m_unmarshallerClasses[index] = cname;
if (m_unmarshalMap != null && name != null) {
mapUnmarshalling(index);
}
}
/**
* Undefine unmarshalling for element. Disables the unmarshalling
* definition for a particular class index.
*
* @param index class index for unmarshalling definition
*/
public void removeUnmarshalling(int index) {
if (m_unmarshalMap != null && m_names[index] != null) {
Object value = m_unmarshalMap.get(m_names[index]);
if (value instanceof Integer) {
m_unmarshalMap.remove(m_names[index]);
} else if (value instanceof ArrayList) {
ArrayList list = (ArrayList)value;
list.remove(list.indexOf(m_indexes[index]));
}
}
m_namespaces[index] = null;
m_names[index] = null;
m_unmarshallers[index] = null;
m_unmarshallerClasses[index] = null;
}
/**
* Find the unmarshaller for a particular class index in the current
* context.
*
* @param index class index for unmarshalling definition
* @return unmarshalling handler for class
* @throws JiBXException if unable to create unmarshaller
*/
public IUnmarshaller getUnmarshaller(int index) throws JiBXException {
if (m_unmarshallers[index] == null) {
// load the unmarshaller class and create an instance
String name = m_unmarshallerClasses[index];
if (name == null) {
throw new JiBXException
("No unmarshaller defined for class at index " + index);
}
try {
// first try loading class from binding factory class loader
Class clas = null;
ClassLoader factldr = null;
if (m_factory != null) {
factldr = m_factory.getClass().getClassLoader();
try {
clas = factldr.loadClass(name);
} catch (ClassNotFoundException e) { /* fall through */ }
}
if (clas == null) {
// next try the context class loader, if set
ClassLoader ctxldr =
Thread.currentThread().getContextClassLoader();
if (ctxldr != null) {
try {
clas = ctxldr.loadClass(name);
} catch (ClassNotFoundException e) { /* fall through */ }
}
if (clas == null) {
// not found, try the loader that loaded this class
ClassLoader thisldr =
UnmarshallingContext.class.getClassLoader();
if (thisldr != factldr && thisldr != ctxldr) {
try {
clas = thisldr.loadClass(name);
} catch (ClassNotFoundException e)
{ /* fall through */ }
}
}
}
if (clas == null) {
throw new JiBXException("Unable to load unmarshaller class " +
name);
}
// create an instance of unmarshaller class
IUnmarshaller um = (IUnmarshaller)clas.newInstance();
m_unmarshallers[index] = um;
} catch (JiBXException e) {
throw e;
} catch (Exception e) {
throw new JiBXException
("Unable to create unmarshaller of class " + name + ":", e);
}
}
return m_unmarshallers[index];
}
/**
* Find the unmarshaller for a particular element name (including
* namespace) in the current context.
*
* @param ns namespace for element (may be null
* or the empty string for the empty namespace)
* @param name name for element
* @return unmarshalling handler for element, or null if none
* found
* @throws JiBXException if unable to create unmarshaller
*/
public IUnmarshaller getUnmarshaller(String ns, String name)
throws JiBXException {
if (m_unmarshalMap == null) {
m_unmarshalMap = new HashMap(m_names.length);
m_indexes = new Integer[m_names.length];
for (int i = 0; i < m_names.length; i++) {
m_indexes[i] = new Integer(i);
if (m_names[i] != null) {
mapUnmarshalling(i);
}
}
}
Object value = m_unmarshalMap.get(name);
if (value instanceof Integer) {
int index = ((Integer)value).intValue();
String mns = m_namespaces[index];
if (ns == mns || (ns == null && mns.length() == 0) ||
(mns == null && ns.length() == 0) ||
(ns != null && ns.equals(mns))) {
return getUnmarshaller(index);
}
} else if (value instanceof ArrayList) {
ArrayList list = (ArrayList)value;
for (int i = 0; i < list.size(); i++) {
int index = ((Integer)list.get(i)).intValue();
String mns = m_namespaces[index];
if (ns == mns || (ns == null && mns.length() == 0) ||
(mns == null && ns.length() == 0) ||
(ns != null && ns.equals(mns))) {
return getUnmarshaller(index);
}
}
}
return null;
}
/**
* 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.
*
* @return unmarshalled object from element, or null if end tag
* rather than start tag seen
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public Object unmarshalOptionalElement() throws JiBXException {
int type = toTag();
if (type == IXMLReader.START_TAG) {
IUnmarshaller unmarshal =
getUnmarshaller(m_reader.getNamespace(), m_reader.getName());
if (unmarshal != null) {
return unmarshal.unmarshal(null, this);
}
}
return null;
}
/**
* 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.
*
* @param clas expected class of unmarshalled object
* @return unmarshalled object from element
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public Object unmarshalElement(Class clas) throws JiBXException {
String name = toStart();
IUnmarshaller unmarshal =
getUnmarshaller(m_reader.getNamespace(), name);
if (unmarshal == null) {
throw new JiBXException("No unmarshaller for element " +
currentNameString() + " " + buildPositionString());
} else {
Object obj = unmarshal.unmarshal(null, this);
if (!clas.isInstance(obj)) {
throw new JiBXException("Element " + name +
" not compatible with expected type " + clas.getName() +
" " + buildPositionString());
}
return obj;
}
}
/**
* 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.
*
* @return unmarshalled object from element
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public Object unmarshalElement() throws JiBXException {
String name = toStart();
IUnmarshaller unmarshal =
getUnmarshaller(m_reader.getNamespace(), name);
if (unmarshal == null) {
throw new JiBXException("No unmarshaller for element " +
currentNameString() + " " + buildPositionString());
} else {
return unmarshal.unmarshal(null, this);
}
}
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param tag element name expected
* @throws JiBXException on any error (possible wrapping other exception)
*/
public void parsePastElement(String ns, String tag) throws JiBXException {
parsePastStartTag(ns, tag);
int depth = 0;
while (true) {
switch (m_reader.getEventType()) {
case IXMLReader.END_TAG:
if (depth == 0) {
if (m_reader.getName().equals(tag) &&
verifyNamespace(ns)) {
m_reader.nextToken();
return;
} else {
throwEndTagNameError(ns, tag);
}
} else {
depth--;
}
break;
case IXMLReader.START_TAG:
depth++;
break;
default:
break;
}
m_reader.nextToken();
}
}
/**
* Returns current element name.
*
* @return local name part of name, or null if not at a start
* or end tag
* @throws JiBXException if error from parser
*/
public String getElementName() throws JiBXException {
int type = m_reader.getEventType();
if (type == IXMLReader.START_TAG ||
type == IXMLReader.END_TAG) {
return m_reader.getName();
} else {
return null;
}
}
/**
* Returns current element namespace URI.
*
* @return namespace URI of name, or null if not at a start
* or end tag
* @throws JiBXException if error from parser
*/
public String getElementNamespace() throws JiBXException {
int type = m_reader.getEventType();
if (type == IXMLReader.START_TAG ||
type == IXMLReader.END_TAG) {
return m_reader.getNamespace();
} else {
return null;
}
}
/**
* Throw exception with start tag and position information.
*
* @param msg exception message text
* @exception JiBXException always thrown
*/
public void throwStartTagException(String msg) throws JiBXException {
throw new JiBXException(msg + " at tag " + currentNameString() +
buildPositionString());
}
/**
* Throw exception with start tag, position information, and nested
* exception.
*
* @param msg exception message text
* @param ex nested exception
* @exception JiBXException always thrown
*/
public void throwStartTagException(String msg, Exception ex)
throws JiBXException {
throw new JiBXException(msg + " at tag " + currentNameString() +
buildPositionString(), ex);
}
/**
* Throw exception with position information.
*
* @param msg exception message text
* @exception JiBXException always thrown
*/
public void throwException(String msg) throws JiBXException {
throw new JiBXException(msg + " " + buildPositionString());
}
/**
* Throw exception with position information and nested exception.
*
* @param msg exception message text
* @param ex nested exception
* @exception JiBXException always thrown
*/
public void throwException(String msg, Exception ex) throws JiBXException {
throw new JiBXException(msg + " " + buildPositionString(), ex);
}
/**
* Unmarshal document from stream to object. The effect of this is the same
* as if {@link #setDocument} were called, followed by {@link
* #unmarshalElement}
*
* @param ins stream supplying document data
* @param enc document input encoding, or null if to be
* determined by parser
* @return unmarshalled object
* @throws JiBXException if error creating parser
*/
public Object unmarshalDocument(InputStream ins, String enc)
throws JiBXException {
setDocument(ins, enc);
return unmarshalElement();
}
/**
* Unmarshal document from reader to object. The effect of this is the same
* as if {@link #setDocument} were called, followed by {@link
* #unmarshalElement}
*
* @param rdr reader supplying document data
* @return unmarshalled object
* @throws JiBXException if error creating parser
*/
public Object unmarshalDocument(Reader rdr) throws JiBXException {
setDocument(rdr);
return unmarshalElement();
}
/**
* Unmarshal named document from stream to object. The effect of this is the
* same as if {@link #setDocument} were called, followed by {@link
* #unmarshalElement}
*
* @param ins stream supplying document data
* @param name document name
* @param enc document input encoding, or null if to be
* determined by parser
* @return unmarshalled object
* @throws JiBXException if error creating parser
*/
public Object unmarshalDocument(InputStream ins, String name, String enc)
throws JiBXException {
setDocument(ins, name, enc);
return unmarshalElement();
}
/**
* Unmarshal named document from reader to object. The effect of this is the
* same as if {@link #setDocument} were called, followed by {@link
* #unmarshalElement}
*
* @param rdr reader supplying document data
* @param name document name
* @return unmarshalled object
* @throws JiBXException if error creating parser
*/
public Object unmarshalDocument(Reader rdr, String name)
throws JiBXException {
setDocument(rdr, name);
return unmarshalElement();
}
/**
* Return the binding factory used to create this unmarshaller.
*
* @return binding factory
*/
public IBindingFactory getFactory() {
return m_factory;
}
/**
* Return the supplied document name.
*
* @return supplied document name (null if none)
*/
public String getDocumentName() {
return m_reader.getDocumentName();
}
/**
* Return the input encoding, if known. This is only valid after parsing of
* a document has been started.
*
* @return input encoding (null if unknown)
*/
public String getInputEncoding() {
return m_reader.getInputEncoding();
}
/**
* 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 the {@link #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
* {@link #unmarshalElement} method.
*
* @param obj user context object, or null if clearing existing
* context object
* @see #getUserContext()
*/
public void setUserContext(Object obj) {
m_userContext = obj;
}
/**
* Get the user context object.
*
* @return user context object, or null if no context object
* set
* @see #setUserContext(Object)
*/
public Object getUserContext() {
return m_userContext;
}
/**
* 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.
*
* @param obj object being unmarshalled
*/
public void pushObject(Object obj) {
int depth = m_stackDepth;
if (depth >= m_objectStack.length) {
Object[] stack = new Object[depth*2];
System.arraycopy(m_objectStack, 0, stack, 0, depth);
m_objectStack = stack;
}
m_objectStack[depth] = obj;
m_stackDepth++;
}
/**
* Set position tracking information for object, if supported.
*
* @param obj object being tracked
*/
public void trackObject(Object obj) {
if (obj instanceof ITrackSourceImpl) {
((ITrackSourceImpl)obj).jibx_setSource(m_reader.getDocumentName(),
m_reader.getLineNumber(), m_reader.getColumnNumber());
}
}
/**
* 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.
*
* @param obj object being unmarshalled
*/
public void pushTrackedObject(Object obj) {
pushObject(obj);
trackObject(obj);
}
/**
* Pop unmarshalled object from stack.
*
* @throws JiBXException if no object on stack
*/
public void popObject() throws JiBXException {
if (m_stackDepth > 0) {
--m_stackDepth;
} else {
throw new JiBXException("No object on stack");
}
}
/**
* 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.
*
* @return number of objects in unmarshalling stack
*/
public int getStackDepth() {
return m_stackDepth;
}
/**
* 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.
*
* @param depth object depth in stack to be retrieved (must be in the range
* of zero to the current depth minus one).
* @return object from unmarshalling stack
*/
public Object getStackObject(int depth) {
if (depth >= 0 && depth < m_stackDepth) {
return m_objectStack[m_stackDepth-depth-1];
} else {
throw new ArrayIndexOutOfBoundsException("Depth " + depth +
" is out of range");
}
}
/**
* Get top object on unmarshalling stack. This is safe to call even when no
* objects are on the stack.
*
* @return object from unmarshalling stack, or null if none
*/
public Object getStackTop() {
if (m_stackDepth > 0) {
return m_objectStack[m_stackDepth-1];
} else {
return null;
}
}
/**
* Get count of active namespaces.
*
* @return number of active namespaces in stack
*/
public int getActiveNamespaceCount() {
try {
return m_reader.getNamespaceCount(m_reader.getNestingDepth());
} catch (IllegalArgumentException e) {
throw new IllegalStateException("Internal error: " +
e.getMessage());
}
}
/**
* Get URI for an active namespace.
*
* @param index index number of namespace to be returned
* @return URI for namespace at position
* @throws IllegalArgumentException if invalid index
*/
public String getActiveNamespaceUri(int index) {
return m_reader.getNamespaceUri(index);
}
/**
* Get prefix for an active namespace.
*
* @param index stack position of namespace to be returned
* @return prefix for namespace at position
* @throws IllegalArgumentException if invalid index
*/
public String getActiveNamespacePrefix(int index) {
return m_reader.getNamespacePrefix(index);
}
/**
* Skip past current element.
*
* @exception JiBXException on any error (possibly wrapping other exception)
*/
public void skipElement() throws JiBXException {
// check positioned at start tag
if (!isEnd()) {
// skip past the start tag
next();
// loop until end tag reached
int depth = 1;
while (depth > 0) {
if (isEnd()) {
depth--;
} else {
depth++;
}
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.
*
* @return event type for next major parse event (START_TAG, TEXT, END_TAG,
* or END_DOCUMENT)
* @exception JiBXException on any error (possibly wrapping other exception)
*/
public int next() throws JiBXException {
return m_reader.next();
}
/**
* 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.
*
* @return event type for next parse event
* @exception JiBXException on any error (possibly wrapping other exception)
*/
public int nextToken() throws JiBXException {
return m_reader.nextToken();
}
/**
* 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.
*
* @return event type for current parse event
* @exception JiBXException on any error (possibly wrapping other exception)
*/
public int currentEvent() throws JiBXException {
return m_reader.getEventType();
}
/**
* Get name associated with current parse event.
*
* @return 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)
*/
public String getName() {
return m_reader.getName();
}
/**
* Get namespace associated with current parse event.
*
* @return 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)
*/
public String getNamespace() {
return m_reader.getNamespace();
}
/**
* Get namespace prefix associated with current parse event.
*
* @return 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)
*/
public String getPrefix() {
return m_reader.getPrefix();
}
/**
* Get number of attributes for current START_ELEMENT event. The results are
* undefined if called when not at a START_ELEMENT event.
*
* @return number of attributes, or -1 if not at START_ELEMENT
* @throws IllegalStateException if not at a start tag (optional)
*/
public int getAttributeCount() {
return m_reader.getAttributeCount();
}
/**
* Get attribute name for current START_ELEMENT event. The results are
* undefined if called when not at a START_ELEMENT event.
*
* @param index index number of attribute to be returned
* @return name of attribute at position
* @throws IllegalStateException if not at a start tag or invalid index
*/
public String getAttributeName(int index) {
return m_reader.getAttributeName(index);
}
/**
* Get attribute namespace for current START_ELEMENT event. The results are
* undefined if called when not at a START_ELEMENT event.
*
* @param index index number of attribute to be returned
* @return namespace URI of attribute at position, empty string if none
* @throws IllegalStateException if not at a start tag or invalid index
*/
public String getAttributeNamespace(int index) {
return m_reader.getAttributeNamespace(index);
}
/**
* Get attribute namespace prefix for current START_ELEMENT event. The
* results are undefined if called when not at a START_ELEMENT event.
*
* @param index index number of attribute to be returned
* @return prefix for namespace of attribute at position, null
* if none
* @throws IllegalStateException if not at a start tag or invalid index
*/
public String getAttributePrefix(int index) {
return m_reader.getAttributePrefix(index);
}
/**
* Get attribute value for current START_ELEMENT event. The results are
* undefined if called when not at a START_ELEMENT event.
*
* @param index index number of attribute to be returned
* @return value of attribute at position
* @throws IllegalStateException if not at a start tag or invalid index
*/
public String getAttributeValue(int index) {
return m_reader.getAttributeValue(index);
}
/**
* Get number of namespace declarations for current START_ELEMENT event. The
* results are undefined if called when not at a START_ELEMENT event.
*
* @return number of namespace declarations, or -1 if not at
* START_ELEMENT
*/
public int getNamespaceCount() {
try {
int level = m_reader.getNestingDepth();
return m_reader.getNamespaceCount(level)-
m_reader.getNamespaceCount(level-1);
} catch (IllegalArgumentException e) {
throw new IllegalStateException("Internal error: " +
e.getMessage());
}
}
/**
* Get namespace URI for namespace declaration on current START_ELEMENT
* event. The results are undefined if called when not at a START_ELEMENT
* event.
*
* @param index index number of declaration to be returned
* @return namespace URI for declaration at position
* @throws IllegalArgumentException if invalid index
*/
public String getNamespaceUri(int index) {
int base = m_reader.getNamespaceCount(m_reader.getNestingDepth()-1);
return m_reader.getNamespaceUri(base + index);
}
/**
* Get namespace prefix for namespace declaration on current START_ELEMENT
* event. The results are undefined if called when not at a START_ELEMENT
* event.
*
* @param index index number of declaration to be returned
* @return namespace prefix for declaration at position,
* @throws IllegalArgumentException if invalid index
*/
public String getNamespacePrefix(int index) {
int base = m_reader.getNamespaceCount(m_reader.getNestingDepth()-1);
return m_reader.getNamespacePrefix(base + index);
}
/**
* Get namespace URI matching prefix.
*
* @param prefix namespace prefix to be matched (null for
* default namespace)
* @return namespace URI for prefix
*/
public String getNamespaceUri(String prefix) {
return m_reader.getNamespace(prefix);
}
/**
* Get text value for current event.
*
* @return text value for event
*/
public String getText() {
return m_reader.getText();
}
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/XMLPullReaderFactory.java 0000644 0001750 0001750 00000041301 10720550514 026750 0 ustar moeller moeller /*
Copyright (c) 2005-2006, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime.impl;
import java.io.IOException;
import java.io.InputStream;
import java.io.Reader;
import org.jibx.runtime.IXMLReader;
import org.jibx.runtime.JiBXException;
import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.XmlPullParserException;
import org.xmlpull.v1.XmlPullParserFactory;
/**
* Factory for creating XMLPull parser instances.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class XMLPullReaderFactory implements IXMLReaderFactory
{
/** Default parser factory name when nothing else found. */
private static final String DEFAULT_PARSER_NAME =
"org.xmlpull.mxp1.MXParserFactory";
/** Singleton instance of class. */
private static final XMLPullReaderFactory s_instance;
static {
// first try getting factory defined by property value
XmlPullParserFactory factory = null;
ClassLoader loader = Thread.currentThread().getContextClassLoader();
if (loader == null) {
loader = XMLPullReaderFactory.class.getClassLoader();
}
try {
String name =
System.getProperty(XmlPullParserFactory.PROPERTY_NAME);
if (name != null && (name = name.trim()).length() > 0) {
factory = XmlPullParserFactory.newInstance(name,
loader.getClass());
}
} catch (Exception ex) { /* deliberately empty */ }
// if no luck that way, try getting it directly
if (factory == null) {
try {
factory = XmlPullParserFactory.newInstance();
} catch (Exception ex) { /* deliberately empty */ }
if (factory == null) {
throw new RuntimeException("Unable to create XMLPull parser");
}
}
s_instance = new XMLPullReaderFactory(factory);
}
/** Factory used for constructing parser instances. */
private final XmlPullParserFactory m_factory;
/**
* Internal constructor.
*
* @param factory
*/
private XMLPullReaderFactory(XmlPullParserFactory factory) {
m_factory = factory;
}
/**
* Get instance of factory.
*
* @return factory instance
*/
public static XMLPullReaderFactory getInstance() {
return s_instance;
}
/**
* Create new parser instance.
*
* @param nsf enable namespace processing on parser flag
* @return parser instance
* @throws XmlPullParserException on error creating parser
*/
private XmlPullParser createParser(boolean nsf)
throws XmlPullParserException {
XmlPullParser parser = m_factory.newPullParser();
if (nsf) {
parser.setFeature(XmlPullParser.FEATURE_PROCESS_NAMESPACES, true);
}
return parser;
}
/* (non-Javadoc)
* @see org.jibx.runtime.impl.IXMLReaderFactory#createReader(java.io.InputStream, java.lang.String, java.lang.String, boolean)
*/
public IXMLReader createReader(InputStream is, String name, String enc,
boolean nsf) throws JiBXException {
try {
return recycleReader(new XMLPullReader(createParser(nsf)), is,
name, enc);
} catch (XmlPullParserException e) {
throw new JiBXException("Error creating parser", e);
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.impl.IXMLReaderFactory#createReader(java.io.Reader, java.lang.String, boolean)
*/
public IXMLReader createReader(Reader rdr, String name, boolean nsf)
throws JiBXException {
try {
return recycleReader(new XMLPullReader(createParser(nsf)),
rdr, name);
} catch (XmlPullParserException e) {
throw new JiBXException("Error creating parser", e);
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.impl.IXMLReaderFactory#recycleReader(org.jibx.runtime.IXMLReader, java.io.InputStream, java.lang.String, java.lang.String)
*/
public IXMLReader recycleReader(IXMLReader old, InputStream is, String name,
String enc) throws JiBXException {
((XMLPullReader)old).setDocument(is, name, enc);
return old;
}
/* (non-Javadoc)
* @see org.jibx.runtime.impl.IXMLReaderFactory#recycleReader(org.jibx.runtime.IXMLReader, java.io.Reader, java.lang.String)
*/
public IXMLReader recycleReader(IXMLReader old, Reader rdr, String name)
throws JiBXException {
((XMLPullReader)old).setDocument(rdr, name);
return old;
}
/**
* Wrapper for an XMLPull parser implementation. Since the internal parser
* API was originally based on XMLPull, this basically just delegates all
* the calls with minimal processing.
*/
private static class XMLPullReader implements IXMLReader
{
/** Actual parser. */
private final XmlPullParser m_parser;
/** Document name. */
private String m_docName;
/** Wrapper for supplied input stream. */
private InputStreamWrapper m_streamWrapper;
/** Input document character encoding (null if unknown) */
private String m_encoding;
/**
* Constructor used by factory.
*
* @param parser
*/
private XMLPullReader(XmlPullParser parser) {
m_parser = parser;
}
/**
* Set document to be parsed from input stream.
*
* @param is document input stream
* @param name document name (null if unknown)
* @param enc document character encoding (null if unknown)
* @throws JiBXException on parser configuration error
*/
private void setDocument(InputStream is, String name, String enc)
throws JiBXException {
try {
if (enc == null) {
if (m_streamWrapper == null) {
m_streamWrapper = new InputStreamWrapper();
}
m_streamWrapper.setInput(is, enc);
setDocument(m_streamWrapper.getReader(), name);
m_encoding = m_streamWrapper.getEncoding();
} else {
m_docName = name;
m_encoding = enc;
m_parser.setInput(is, enc);
}
} catch (XmlPullParserException e) {
throw new JiBXException("Error initializing parser", e);
} catch (IOException e) {
throw new JiBXException("Error reading from stream", e);
}
}
/**
* Set document to be parsed from reader.
*
* @param rdr document reader
* @param name document name (null if unknown)
* @throws JiBXException on parser configuration error
*/
private void setDocument(Reader rdr, String name) throws JiBXException {
try {
m_docName = name;
m_encoding = null;
m_parser.setInput(rdr);
} catch (XmlPullParserException e) {
throw new JiBXException("Error initializing parser", e);
}
}
/**
* Format error message from exception.
*
* @param e root cause exception
*/
private String describeException(Exception e) {
return "Error parsing document " + buildPositionString() + ": " +
e.getMessage();
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#buildPositionString()
*/
public String buildPositionString() {
String base = "(line " + m_parser.getLineNumber() + ", col " +
m_parser.getColumnNumber();
if (m_docName != null) {
base += ", in " + m_docName;
}
return base + ')';
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#nextToken()
*/
public int nextToken() throws JiBXException {
try {
return m_parser.nextToken();
} catch (IOException e) {
throw new JiBXException("Error accessing document", e);
} catch (XmlPullParserException e) {
throw new JiBXException
("Error parsing document " + buildPositionString(), e);
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#next()
*/
public int next() throws JiBXException {
try {
return m_parser.next();
} catch (IOException e) {
throw new JiBXException("Error accessing document", e);
} catch (XmlPullParserException e) {
throw new JiBXException
("Error parsing document " + buildPositionString(), e);
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getEventType()
*/
public int getEventType() throws JiBXException {
try {
return m_parser.getEventType();
} catch (XmlPullParserException e) {
throw new JiBXException
("Error parsing document " + buildPositionString(), e);
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getName()
*/
public String getName() {
String name = m_parser.getName();
if (name == null) {
throw new IllegalStateException
("Internal state error: not at start or end tag");
} else {
return name;
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getNamespace()
*/
public String getNamespace() {
String uri = m_parser.getNamespace();
if (uri == null) {
throw new IllegalStateException
("Internal state error: not at start or end tag");
} else {
return uri;
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getPrefix()
*/
public String getPrefix() {
return m_parser.getPrefix();
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getAttributeCount()
*/
public int getAttributeCount() {
int count = m_parser.getAttributeCount();
if (count < 0) {
throw new IllegalStateException
("Internal state error: not at start tag");
} else {
return count;
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getAttributeName(int)
*/
public String getAttributeName(int index) {
try {
return m_parser.getAttributeName(index);
} catch (ArrayIndexOutOfBoundsException e) {
throw new IllegalStateException(describeException(e));
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getAttributeNamespace(int)
*/
public String getAttributeNamespace(int index) {
try {
return m_parser.getAttributeNamespace(index);
} catch (ArrayIndexOutOfBoundsException e) {
throw new IllegalStateException(describeException(e));
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getAttributePrefix(int)
*/
public String getAttributePrefix(int index) {
try {
return m_parser.getAttributePrefix(index);
} catch (ArrayIndexOutOfBoundsException e) {
throw new IllegalStateException(describeException(e));
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getAttributeValue(int)
*/
public String getAttributeValue(int index) {
try {
return m_parser.getAttributeValue(index);
} catch (ArrayIndexOutOfBoundsException e) {
throw new IllegalStateException(describeException(e));
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getAttributeValue(java.lang.String, java.lang.String)
*/
public String getAttributeValue(String ns, String name) {
try {
return m_parser.getAttributeValue(ns, name);
} catch (ArrayIndexOutOfBoundsException e) {
throw new IllegalStateException(describeException(e));
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getText()
*/
public String getText() {
return m_parser.getText();
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getNestingDepth()
*/
public int getNestingDepth() {
return m_parser.getDepth();
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getNamespaceCount(int)
*/
public int getNamespaceCount(int depth) {
try {
return m_parser.getNamespaceCount(depth);
} catch (XmlPullParserException e) {
throw new IllegalArgumentException(describeException(e));
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getNamespaceUri(int)
*/
public String getNamespaceUri(int index) {
try {
return m_parser.getNamespaceUri(index);
} catch (XmlPullParserException e) {
throw new IllegalArgumentException(describeException(e));
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getNamespacePrefix(int)
*/
public String getNamespacePrefix(int index) {
try {
return m_parser.getNamespacePrefix(index);
} catch (XmlPullParserException e) {
throw new IllegalArgumentException(describeException(e));
}
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getDocumentName()
*/
public String getDocumentName() {
return m_docName;
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getLineNumber()
*/
public int getLineNumber() {
return m_parser.getLineNumber();
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getColumnNumber()
*/
public int getColumnNumber() {
return m_parser.getColumnNumber();
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getNamespace(java.lang.String)
*/
public String getNamespace(String prefix) {
return m_parser.getNamespace(prefix);
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#getInputEncoding()
*/
public String getInputEncoding() {
return m_encoding;
}
/* (non-Javadoc)
* @see org.jibx.runtime.IXMLReader#isNamespaceAware()
*/
public boolean isNamespaceAware() {
return m_parser.getFeature
(XmlPullParser.FEATURE_PROCESS_NAMESPACES);
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/XMLWriterBase.java 0000644 0001750 0001750 00000036435 10767273760 025464 0 ustar moeller moeller /*
Copyright (c) 2004-2008, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime.impl;
import java.io.IOException;
import org.jibx.runtime.IExtensibleWriter;
/**
* Base implementation of XML writer interface. This provides common handling of
* indentation and formatting that can be used for all forms of text output.
*
* @author Dennis M. Sosnoski
*/
public abstract class XMLWriterBase extends XMLWriterNamespaceBase
implements IExtensibleWriter
{
/** Flag for current element has text content. */
private boolean m_textSeen;
/** Flag for current element has content. */
private boolean m_contentSeen;
/** Flag for first write done (used to skip indentation before first
element). */
private boolean m_afterFirst;
/**
* Constructor.
*
* @param uris ordered array of URIs for namespaces used in document (must
* be constant; the value in position 0 must always be the empty string "",
* and the value in position 1 must always be the XML namespace
* "http://www.w3.org/XML/1998/namespace")
*/
public XMLWriterBase(String[] uris) {
super(uris);
m_contentSeen = true;
}
/**
* Copy constructor. This initializes the extension namespace information
* from an existing instance.
*
* @param base existing instance
* @param uris ordered array of URIs for namespaces used in document
*/
public XMLWriterBase(XMLWriterBase base, String[] uris) {
super(base, uris);
m_contentSeen = true;
m_afterFirst = base.m_afterFirst;
}
/**
* Write markup text to output. Markup text can be written directly to the
* output without the need for any escaping, but still needs to be properly
* encoded.
*
* @param text markup text to be written
* @throws IOException if error writing to document
*/
protected abstract void writeMarkup(String text) throws IOException;
/**
* Write markup character to output. Markup text can be written directly to
* the output without the need for any escaping, but still needs to be
* properly encoded.
*
* @param chr markup character to be written
* @throws IOException if error writing to document
*/
protected abstract void writeMarkup(char chr) throws IOException;
/**
* Write namespace prefix to output. This internal method is used to throw
* an exception when an undeclared prefix is used.
*
* @param index namespace URI index number
* @throws IOException if error writing to document
*/
protected abstract void writePrefix(int index) throws IOException;
/**
* Write attribute text to output. This needs to write the text with any
* appropriate escaping.
*
* @param text attribute value text to be written
* @throws IOException if error writing to document
*/
protected abstract void writeAttributeText(String text) throws IOException;
/**
* Request output indent with bias from current element nesting level. This
* is used internally for proper indenting in special cases.
*
* @throws IOException on error writing to document
*/
protected abstract void indent(int bias) throws IOException;
/**
* Set up for writing any content to element. If the start tag for the
* element has not been closed, this will close it.
*
* @throws IOException on error writing to document
*/
protected final void flagContent() throws IOException {
if (!m_contentSeen) {
writeMarkup('>');
incrementNesting();
m_contentSeen = true;
}
}
/**
* Set up for writing text content to element. If the start tag for the
* element has not been closed, this will close it.
*
* @throws IOException on error writing to document
*/
protected final void flagTextContent() throws IOException {
flagContent();
m_textSeen = true;
}
/**
* Write XML declaration to document. This can only be called before any
* other methods in the interface are called.
*
* @param version XML version text
* @param encoding text for encoding attribute (unspecified if
* null)
* @param standalone text for standalone attribute (unspecified if
* null)
* @throws IOException on error writing to document
*/
public void writeXMLDecl(String version, String encoding, String standalone)
throws IOException {
if (m_afterFirst) {
throw new IllegalStateException
("XML declaration must be written before any other output");
} else {
writeMarkup("");
m_afterFirst = true;
}
}
/**
* Generate open start tag. This allows attributes to be added to the start
* tag, but must be followed by a {@link #closeStartTag} call.
*
* @param index namespace URI index number
* @param name unqualified element name
* @throws IOException on error writing to document
*/
public void startTagOpen(int index, String name) throws IOException {
flagContent();
indentAfterFirst();
writeMarkup('<');
writePrefix(index);
writeMarkup(name);
}
/**
* Generate start tag for element with namespaces. This creates the actual
* start tag, along with any necessary namespace declarations. Previously
* active namespace declarations are not duplicated. The tag is
* left incomplete, allowing other attributes to be added.
*
* @param index namespace URI index number
* @param name element name
* @param nums array of namespace indexes defined by this element (must
* be constant, reference is kept until end of element)
* @param prefs array of namespace prefixes mapped by this element (no
* null values, use "" for default namespace declaration)
* @throws IOException on error writing to document
*/
public void startTagNamespaces(int index, String name,
int[] nums, String[] prefs) throws IOException {
// find the namespaces actually being declared
flagContent();
int[] deltas = openNamespaces(nums, prefs);
// create the start tag for element
startTagOpen(index, name);
// add namespace declarations to open element
for (int i = 0; i < deltas.length; i++) {
int slot = deltas[i];
String prefix = getNamespacePrefix(slot);
if (prefix.length() > 0) {
writeMarkup(" xmlns:");
writeMarkup(prefix);
writeMarkup("=\"");
} else {
writeMarkup(" xmlns=\"");
}
writeAttributeText(getNamespaceUri(slot));
writeMarkup('"');
}
}
/**
* Add attribute to current open start tag. This is only valid after a call
* to {@link #startTagOpen} or {@link #startTagNamespaces} and before the
* corresponding call to {@link #closeStartTag}.
*
* @param index namespace URI index number
* @param name unqualified attribute name
* @param value text value for attribute
* @throws IOException on error writing to document
*/
public void addAttribute(int index, String name, String value)
throws IOException {
writeMarkup(' ');
writePrefix(index);
writeMarkup(name);
writeMarkup("=\"");
writeAttributeText(value);
writeMarkup('"');
}
/**
* Close the current open start tag. This is only valid after a call to
* {@link #startTagOpen}.
*
* @throws IOException on error writing to document
*/
public void closeStartTag() throws IOException {
m_textSeen = m_contentSeen = false;
}
/**
* Close the current open start tag as an empty element. This is only valid
* after a call to {@link #startTagOpen}.
*
* @throws IOException on error writing to document
*/
public void closeEmptyTag() throws IOException {
writeMarkup("/>");
incrementNesting();
decrementNesting();
m_contentSeen = true;
}
/**
* Conditionally indent output only if not the first write. This is used
* both to track the output state (useful to check that the XML declaration
* is only written at the start of the document) and to avoid an initial
* blank line in the case where an XML declaration is not written.
*
* @throws IOException on write error
*/
private void indentAfterFirst() throws IOException {
if (m_afterFirst) {
indent(0);
} else {
m_afterFirst = true;
}
}
/**
* Generate closed start tag. No attributes or namespaces can be added to a
* start tag written using this call.
*
* @param index namespace URI index number
* @param name unqualified element name
* @throws IOException on error writing to document
*/
public void startTagClosed(int index, String name) throws IOException {
flagContent();
indentAfterFirst();
writeMarkup('<');
writePrefix(index);
writeMarkup(name);
m_textSeen = m_contentSeen = false;
}
/**
* Generate end tag.
*
* @param index namespace URI index number
* @param name unqualified element name
* @throws IOException on error writing to document
*/
public void endTag(int index, String name) throws IOException {
// first adjust indentation
if (m_contentSeen && !m_textSeen) {
indent(-1);
}
// check for content written to element
if (m_contentSeen) {
// content was written, which means start tag closed and end needed
writeMarkup("');
} else {
// no content, just close start tag as empty tag
writeMarkup("/>");
incrementNesting();
}
// adjust flags for containing element
decrementNesting();
m_textSeen = false;
m_contentSeen = true;
}
/**
* Write comment to document.
*
* @param text comment text
* @throws IOException on error writing to document
*/
public void writeComment(String text) throws IOException {
flagContent();
writeMarkup("");
}
/**
* Write entity reference to document.
*
* @param name entity name
* @throws IOException on error writing to document
*/
public void writeEntityRef(String name) throws IOException {
flagContent();
writeMarkup('&');
writeMarkup(name);
writeMarkup(';');
}
/**
* Write DOCTYPE declaration to document.
*
* @param name root element name
* @param sys system ID (null if none, must be
* non-null for public ID to be used)
* @param pub public ID (null if none)
* @param subset internal subset (null if none)
* @throws IOException on error writing to document
*/
public void writeDocType(String name, String sys, String pub, String subset)
throws IOException {
indentAfterFirst();
writeMarkup("');
}
/**
* Write processing instruction to document.
*
* @param target processing instruction target name
* @param data processing instruction data
* @throws IOException on error writing to document
*/
public void writePI(String target, String data) throws IOException {
flagContent();
indentAfterFirst();
writeMarkup("");
}
/**
* Flush document output. Subclasses must implement this method to force all
* buffered output to be written. To assure proper handling of an open start
* tag they should first call {@link #flagContent()}.
*
* @throws IOException on error writing to document
*/
public abstract void flush() throws IOException;
/**
* Close document output. Completes writing of document output, including
* closing the output medium.
*
* @throws IOException on error writing to document
*/
public abstract void close() throws IOException;
/**
* Reset to initial state for reuse. The writer is serially reusable,
* as long as this method is called to clear any retained state information
* between uses. It is automatically called when output is set.
*/
public void reset() {
m_textSeen = false;
m_contentSeen = true;
m_afterFirst = false;
super.reset();
}
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/XMLWriterNamespaceBase.java 0000644 0001750 0001750 00000043432 10720550514 027254 0 ustar moeller moeller /*
Copyright (c) 2004-2005, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime.impl;
import java.io.IOException;
import java.util.Stack;
import org.jibx.runtime.IXMLWriter;
/**
* Base implementation of XML writer interface namespace handling. This tracks
* only the namespace declarations and the element nesting depth. It can be used
* as a base class for all forms of output.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public abstract class XMLWriterNamespaceBase implements IXMLWriter
{
/** Empty array for default return. */
private static final int[] EMPTY_INT_ARRAY = new int[0];
/** URIs for namespaces. */
protected String[] m_uris;
/** Prefixes currently defined for namespaces. */
protected String[] m_prefixes;
/** Depth of nested tags. */
private int m_nestingDepth;
/** Stack of information for namespace declarations. */
private Stack m_namespaceStack;
/** Depth of top namespace declaration level. */
private int m_namespaceDepth;
/** Extension namespace URIs (null if not in use). */
private String[][] m_extensionUris;
/** Extension namespace prefixes (null if not in use). */
private String[][] m_extensionPrefixes;
/**
* Constructor.
*
* @param uris ordered array of URIs for namespaces used in document (must
* be constant; the value in position 0 must always be the empty string "",
* and the value in position 1 must always be the XML namespace
* "http://www.w3.org/XML/1998/namespace")
*/
public XMLWriterNamespaceBase(String[] uris) {
m_uris = uris;
m_prefixes = new String[uris.length];
m_prefixes[0] = "";
m_prefixes[1] = "xml";
m_namespaceStack = new Stack();
m_namespaceDepth = -1;
}
/**
* Copy constructor. This initializes the extension namespace information
* from an existing instance.
*
* @param base existing instance
* @param uris ordered array of URIs for namespaces used in document
*/
public XMLWriterNamespaceBase(XMLWriterNamespaceBase base, String[] uris) {
this(uris);
m_extensionUris = base.m_extensionUris;
m_extensionPrefixes = base.m_extensionPrefixes;
m_nestingDepth = base.m_nestingDepth;
}
/**
* Report to subclass that namespace has been defined.
*
* @param index namespace URI index number
* @param prefix prefix used for namespace
* @throws IOException if error writing to document
*/
protected abstract void defineNamespace(int index, String prefix)
throws IOException;
/**
* Report to subclass that namespace has been undefined.
*
* @param index namespace URI index number
*/
protected abstract void undefineNamespace(int index);
/**
* Set namespace URIs. It is provided so that subclasses can implement easy
* reuse.
*
* @param uris ordered array of URIs for namespaces used in document
*/
protected void internalSetUris(String[] uris) {
m_uris = uris;
m_prefixes = new String[uris.length];
m_prefixes[0] = "";
m_prefixes[1] = "xml";
}
/**
* Set prefix for namespace.
*
* @param index namespace URI index number
* @param prefix
*/
private void setNamespacePrefix(int index, String prefix) {
if (index < m_prefixes.length) {
m_prefixes[index] = prefix;
} else if (m_extensionUris != null) {
index -= m_prefixes.length;
for (int i = 0; i < m_extensionUris.length; i++) {
int length = m_extensionUris[i].length;
if (index < length) {
m_extensionPrefixes[i][index] = prefix;
break;
} else {
index -= length;
}
}
}
}
/**
* Open the specified namespaces. Previously active namespace declarations
* are not duplicated.
*
* @param nums array of namespace indexes defined by this element (must
* be constant, reference is kept until end of element)
* @param prefs array of namespace prefixes mapped by this element (no
* null values, use "" for default namespace declaration)
* @return array of indexes for namespaces not previously active (the ones
* actually needing to be declared, in the case of text output)
* @throws IOException on error writing to document
*/
public int[] openNamespaces(int[] nums, String[] prefs) throws IOException {
// find the number of namespaces actually being declared
int count = 0;
for (int i = 0; i < nums.length; i++) {
// set prefix only if different and not changing prefix to default
String newpref = prefs[i];
String oldpref = getNamespacePrefix(nums[i]);
boolean use = false;
if (!newpref.equals(oldpref) &&
(!"".equals(newpref) || oldpref == null)) {
use = true;
for (int j = 0; j < i; j++) {
if (nums[i] == nums[j]) {
if (prefs[i] == null) {
nums[i] = -1;
} else {
use = false;
break;
}
}
}
}
if (use) {
count++;
} else {
nums[i] = -1;
}
}
// check if there's actually any change
int[] deltas = EMPTY_INT_ARRAY;
if (count > 0) {
// get the set of namespace indexes that are changing
String[] priors = new String[count];
if (count == nums.length) {
// replace the full set, tracking the prior values
deltas = nums;
for (int i = 0; i < count; i++) {
int slot = deltas[i];
priors[i] = getNamespacePrefix(slot);
setNamespacePrefix(slot, prefs[i]);
defineNamespace(slot, prefs[i]);
}
} else {
// replace only changed ones, tracking both indexes and priors
int fill = 0;
deltas = new int[count];
for (int i = 0; i < nums.length; i++) {
int slot = nums[i];
if (slot >= 0) {
deltas[fill] = slot;
priors[fill++] = getNamespacePrefix(slot);
setNamespacePrefix(slot, prefs[i]);
defineNamespace(slot, prefs[i]);
}
}
}
// set up for undeclaring namespaces on close of element
m_namespaceStack.push
(new DeclarationInfo(m_nestingDepth, deltas, priors));
m_namespaceDepth = m_nestingDepth;
}
return deltas;
}
/**
* Ends the current innermost set of nested namespace definitions. Reverts
* the namespaces involved to their previously-declared prefixes, and sets
* up for ending the new innermost set.
*/
private void closeNamespaces() {
// revert prefixes for namespaces included in last declaration
DeclarationInfo info = (DeclarationInfo)m_namespaceStack.pop();
int[] deltas = info.m_deltas;
String[] priors = info.m_priors;
for (int i = 0; i < deltas.length; i++) {
int index = deltas[i];
undefineNamespace(index);
if (index < m_prefixes.length) {
m_prefixes[index] = priors[i];
} else if (m_extensionUris != null) {
index -= m_prefixes.length;
for (int j = 0; j < m_extensionUris.length; j++) {
int length = m_extensionUris[j].length;
if (index < length) {
m_extensionPrefixes[j][index] = priors[i];
} else {
index -= length;
}
}
}
}
// set up for clearing next nested set
if (m_namespaceStack.empty()) {
m_namespaceDepth = -1;
} else {
m_namespaceDepth =
((DeclarationInfo)m_namespaceStack.peek()).m_depth;
}
}
/**
* Get the current element nesting depth. Elements are only counted in the
* depth returned when they're officially open - after the start tag has
* been output and before the end tag has been output.
*
* @return number of nested elements at current point in output
*/
public final int getNestingDepth() {
return m_nestingDepth;
}
/**
* Get the number of namespaces currently defined. This is equivalent to the
* index of the next extension namespace added.
*
* @return namespace count
*/
public final int getNamespaceCount() {
int count = m_uris.length;
if (m_extensionUris != null) {
for (int i = 0; i < m_extensionUris.length; i++) {
count += m_extensionUris[i].length;
}
}
return count;
}
/**
* Increment the current nesting depth. Subclasses need to call this method
* whenever an element start tag is written.
*/
protected void incrementNesting() {
m_nestingDepth++;
}
/**
* Decrement the current nesting depth. Subclasses need to call this method
* whenever an element end tag is written.
*/
protected void decrementNesting() {
--m_nestingDepth;
if (m_nestingDepth >= 0) {
while (m_nestingDepth == m_namespaceDepth) {
closeNamespaces();
}
}
}
/**
* Reset to initial state for reuse. Subclasses overriding this method need
* to call this base class implementation during their processing.
*/
public void reset() {
m_nestingDepth = 0;
m_namespaceDepth = -1;
m_namespaceStack.clear();
m_extensionUris = null;
m_extensionPrefixes = null;
}
/**
* Get namespace URIs for mapping. This gets the full ordered array of
* namespaces known in the binding used for this marshalling, where the
* index number of each namespace URI is the namespace index used to lookup
* the prefix when marshalling a name in that namespace. The returned array
* must not be modified.
*
* @return array of namespaces
*/
public final String[] getNamespaces() {
return m_uris;
}
/**
* Get URI for namespace.
*
* @param index namespace URI index number
* @return namespace URI text, or null if the namespace index
* is invalid
*/
public final String getNamespaceUri(int index) {
if (index < m_uris.length) {
return m_uris[index];
} else if (m_extensionUris != null) {
index -= m_uris.length;
for (int i = 0; i < m_extensionUris.length; i++) {
int length = m_extensionUris[i].length;
if (index < length) {
return m_extensionUris[i][index];
} else {
index -= length;
}
}
}
return null;
}
/**
* Get current prefix defined for namespace.
*
* @param index namespace URI index number
* @return current prefix text, or null if the namespace is not
* currently mapped
*/
public final String getNamespacePrefix(int index) {
if (index < m_prefixes.length) {
return m_prefixes[index];
} else if (m_extensionUris != null) {
index -= m_prefixes.length;
for (int i = 0; i < m_extensionUris.length; i++) {
int length = m_extensionUris[i].length;
if (index < length) {
return m_extensionPrefixes[i][index];
} else {
index -= length;
}
}
}
return null;
}
/**
* Get index of namespace mapped to prefix. This can be an expensive
* operation with time proportional to the number of namespaces defined, so
* it should be used with care.
*
* @param prefix text to match (non-null, use "" for default
* prefix)
* @return index namespace URI index number mapped to prefix
*/
public final int getPrefixIndex(String prefix) {
if (m_extensionPrefixes != null) {
for (int i = m_extensionPrefixes.length-1; i >= 0; i--) {
String[] prefixes = m_extensionPrefixes[i];
for (int j = prefixes.length-1; j >= 0; j--) {
if (prefix.equals(prefixes[j])) {
int index = j + m_prefixes.length;
for (int k = i-1; k >= 0; k--) {
index += m_extensionPrefixes[k].length;
}
return index;
}
}
}
}
for (int i = m_prefixes.length-1; i >= 0; i--) {
if (prefix.equals(m_prefixes[i])) {
return i;
}
}
return -1;
}
/**
* Grow array of array of strings.
*
* @param base array to be grown (null is treated as zero
* length)
* @param items array of strings to be added at end of base array
* @return array with added array of items
*/
protected static String[][] growArray(String[][] base, String[] items) {
if (base == null) {
return new String[][] { items };
} else {
int length = base.length;
String[][] grow = new String[length+1][];
System.arraycopy(base, 0, grow, 0, length);
grow[length] = items;
return grow;
}
}
/**
* Shrink array of array of strings.
*
* @param base array to be shrunk
* @return array with last set of items eliminated (null if
* empty)
*/
protected static String[][] shrinkArray(String[][] base) {
int length = base.length;
if (length == 1) {
return null;
} else {
String[][] shrink = new String[length-1][];
System.arraycopy(base, 0, shrink, 0, length-1);
return shrink;
}
}
/**
* Append extension namespace URIs to those in mapping.
*
* @param uris namespace URIs to extend those in mapping
*/
public void pushExtensionNamespaces(String[] uris) {
m_extensionUris = growArray(m_extensionUris, uris);
m_extensionPrefixes =
growArray(m_extensionPrefixes, new String[uris.length]);
}
/**
* Remove extension namespace URIs. This removes the last set of
* extension namespaces pushed using {@link #pushExtensionNamespaces}.
*/
public void popExtensionNamespaces() {
m_extensionUris = shrinkArray(m_extensionUris);
m_extensionPrefixes = shrinkArray(m_extensionPrefixes);
}
/**
* Get extension namespace URIs added to those in mapping. This gets the
* current set of extension definitions. The returned arrays must not be
* modified.
*
* @return array of arrays of extension namespaces (null if
* none)
*/
public final String[][] getExtensionNamespaces() {
return m_extensionUris;
}
/**
* Namespace declaration tracking information. This tracks all information
* associated with an element that declares namespaces.
*/
private static class DeclarationInfo
{
/** Depth of element making declaration. */
public final int m_depth;
/** Indexes of namespaces included in declarations. */
public final int[] m_deltas;
/** Prior prefixes for namespaces. */
public final String[] m_priors;
/** Simple constructor. */
public DeclarationInfo(int depth, int[] deltas, String[] priors) {
m_depth = depth;
m_deltas = deltas;
m_priors = priors;
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/impl/package.html 0000644 0001750 0001750 00000001113 10071714422 024412 0 ustar moeller moeller
JiBX data binding framework runtime implementation package. These classes are
designed for use in generated code by the binding generator portion of the framework.
They are not generally intended for direct use by end users, and are subject
to more change than the published external APIs.
The only circumstance in which an end user of the framework should need to work
with these classes is when writing a marshaller or unmarshaller for a class.
These replace generated code for the classes involved, and hence allow full
control over the operation of the framework.
libjibx-java-1.1.6a/build/src/org/jibx/runtime/BindingDirectory.java 0000644 0001750 0001750 00000030033 11002543054 025271 0 ustar moeller moeller /*
Copyright (c) 2002-2008, Sosnoski Software Solutions, Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
/**
* Abstract class with static methods to find the binding factory corresponding
* to a binding name.
*
* @author Dennis M. Sosnoski
*/
public abstract class BindingDirectory
{
/** Name of String[] field giving binding factory name list. */
public static final String BINDINGLIST_NAME = "JiBX_bindingList";
/** Prefix of binding factory name. */
public static final String BINDINGFACTORY_PREFIX = "JiBX_";
/** Suffix of binding factory name. */
public static final String BINDINGFACTORY_SUFFIX = "Factory";
/** Binding factory method to get instance of factory. */
public static final String FACTORY_INSTMETHOD = "getInstance";
/** Empty argument list. */
public static final Class[] EMPTY_ARGS = new Class[0];
/**
* Get list of bindings for class. This just accesses the static variable
* added to each class with a top-level mapping.
*
* @param clas class with top-level mapping in binding
* @return list of bindings defined for that class (as a text string)
* @throws JiBXException on error accessing binding information
*/
private static String getBindingList(Class clas)throws JiBXException {
try {
Field field = clas.getDeclaredField(BINDINGLIST_NAME);
try {
// should be able to access field anyway, but just in case
field.setAccessible(true);
} catch (Exception e) { /* deliberately left empty */ }
return (String)field.get(null);
} catch (NoSuchFieldException e) {
throw new JiBXException
("Unable to access binding information for class " +
clas.getName() +
"\nMake sure the binding has been compiled", e);
} catch (IllegalAccessException e) {
throw new JiBXException
("Error in added code for class " + clas.getName() +
"Please report this to the JiBX developers", e);
}
}
/**
* Get instance of factory. Loads the factory class using the classloader
* for the supplied class, then calls the get instance method of the
* factory class.
*
* @param name fully qualified name of factory class
* @param clas class providing factory
* @param loader class loader to be used for loading factory
* @return binding factory instance
* @throws JiBXException on error loading or accessing factory
*/
private static IBindingFactory getFactoryFromName(String name, Class clas,
ClassLoader loader)
throws JiBXException {
Throwable ex = null;
Object result = null;
IBindingFactory ifact = null;
try {
Class factory = loader.loadClass(name);
Method method = factory.getMethod(FACTORY_INSTMETHOD, EMPTY_ARGS);
result = method.invoke(null, (Object[])null);
} catch (SecurityException e) {
ex = e;
} catch (ClassNotFoundException e) {
ex = e;
} catch (NoSuchMethodException e) {
ex = e;
} catch (IllegalAccessException e) {
ex = e;
} catch (InvocationTargetException e) {
ex = e;
} finally {
if (ex == null) {
if (result instanceof IBindingFactory) {
ifact = (IBindingFactory)result;
int diff = ifact.getCompilerVersion() ^
IBindingFactory.CURRENT_VERSION_NUMBER;
if ((diff & IBindingFactory.COMPATIBLE_VERSION_MASK) != 0) {
throw new JiBXException
("Binding information for class " + clas.getName() +
" must be recompiled with current binding " +
"compiler (compiled with " +
ifact.getCompilerDistribution() + ", runtime is " +
IBindingFactory.CURRENT_VERSION_NAME + ")");
}
} else {
throw new JiBXException
("Binding information for class " + clas.getName() +
" must be regenerated with current binding " +
"compiler");
}
} else {
throw new JiBXException
("Unable to access binding information for class " +
clas.getName() + "\nMake sure classes generated by the " +
"binding compiler are available at runtime", ex);
}
}
return ifact;
}
/**
* Get instance of binding factory. Finds the binding factory for the
* named binding on the target class, then loads that factory and returns
* an instance.
*
* @param name binding name
* @param clas target class for binding
* @param loader class loader to be used for loading factory
* @return binding factory instance
* @throws JiBXException on any error in finding or accessing factory
*/
public static IBindingFactory getFactory(String name, Class clas,
ClassLoader loader) throws JiBXException {
String list = getBindingList(clas);
String match = BINDINGFACTORY_PREFIX + name +
BINDINGFACTORY_SUFFIX + '|';
int index = list.indexOf(match);
if (index >= 0) {
int mark = list.lastIndexOf('|', index);
String fname =
list.substring(mark+1, index + match.length() - 1);
mark = fname.indexOf('=');
if (mark >= 0) {
fname = fname.substring(0, mark);
}
return getFactoryFromName(fname, clas, loader);
} else {
throw new JiBXException("Binding '" + name +
"' not found for class " + clas.getName());
}
}
/**
* Get instance of binding factory. Finds the binding factory for the
* named binding on the target class, then loads that factory and returns
* an instance.
*
* @param name binding name
* @param clas target class for binding
* @return binding factory instance
* @throws JiBXException on any error in finding or accessing factory
*/
public static IBindingFactory getFactory(String name, Class clas)
throws JiBXException {
return getFactory(name, clas, clas.getClassLoader());
}
/**
* Get instance of binding factory. Finds the binding factory for the
* target class, then loads that factory and returns an instance. This
* method can only be used with target classes that are mapped in only
* one binding.
*
* @param clas target class for binding
* @return binding factory instance
* @throws JiBXException on any error in finding or accessing factory
*/
public static IBindingFactory getFactory(Class clas) throws JiBXException {
String list = getBindingList(clas);
if (list != null && list.length() > 2) {
String fact = list.substring(1, list.length()-1);
if (fact.indexOf('|') < 0) {
return getFactoryFromName(fact, clas, clas.getClassLoader());
}
}
throw new JiBXException("Multiple bindings defined for class " +
clas.getName());
}
/**
* Get instance of binding factory. Finds the binding factory for the
* named binding on the target class, then loads that factory and returns
* an instance.
*
* @param bname binding name
* @param pack target package for binding
* @param loader class loader to be used for loading factory
* @return binding factory instance
* @throws JiBXException on any error in finding or accessing factory
*/
public static IBindingFactory getFactory(String bname, String pack,
ClassLoader loader) throws JiBXException {
String cname = (pack == null ? "" : pack + '.') +
BINDINGFACTORY_PREFIX + bname + BINDINGFACTORY_SUFFIX;
Throwable ex = null;
Object result = null;
IBindingFactory ifact = null;
try {
Class factory = loader.loadClass(cname);
Method method = factory.getMethod(FACTORY_INSTMETHOD, EMPTY_ARGS);
result = method.invoke(null, (Object[])null);
} catch (SecurityException e) {
ex = e;
} catch (ClassNotFoundException e) {
ex = e;
} catch (NoSuchMethodException e) {
ex = e;
} catch (IllegalAccessException e) {
ex = e;
} catch (InvocationTargetException e) {
ex = e;
} finally {
if (ex == null) {
if (result instanceof IBindingFactory) {
ifact = (IBindingFactory)result;
int diff = ifact.getCompilerVersion() ^
IBindingFactory.CURRENT_VERSION_NUMBER;
if ((diff & IBindingFactory.COMPATIBLE_VERSION_MASK) != 0) {
throw new JiBXException
("Binding '" + bname +
"' must be recompiled with current binding " +
"compiler (compiled with " +
ifact.getCompilerDistribution() + ", runtime is " +
IBindingFactory.CURRENT_VERSION_NAME + ")");
}
} else {
throw new JiBXException
("Classloader conflict for binding '" + bname +
"' - factory does not implement required interface");
}
} else {
throw new JiBXException
("Unable to access binding '" + bname +
"'\nMake sure classes generated by the " +
"binding compiler are available at runtime", ex);
}
}
return ifact;
}
/**
* Get instance of binding factory. Finds the binding factory for the named
* binding compiled to the specified package, then loads that factory and
* returns an instance.
*
* @param bname binding name
* @param pack target package for binding
* @return binding factory instance
* @throws JiBXException on any error in finding or accessing factory
*/
public static IBindingFactory getFactory(String bname, String pack)
throws JiBXException {
return getFactory(bname, pack,
BindingDirectory.class.getClassLoader());
}
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/EnumSet.java 0000644 0001750 0001750 00000024026 10524403562 023426 0 ustar moeller moeller /*
Copyright (c) 2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime;
import java.util.Arrays;
import java.util.Comparator;
/**
* Named value set support class. This provides convenience methods to support
* working with a set of named static final int values, including
* translating them to and from String representations. It's
* intended for use with relatively small nonnegative int values.
*
* @author Dennis M. Sosnoski
*/
public class EnumSet
{
/** Maximum int value supported for enumerations. */
public static final int VALUE_LIMIT = 512;
/** Actual item definitions (used for extensions). */
private final EnumItem[] m_items;
/** Enumeration names in index number order. */
private final String[] m_indexedNames;
/** Enumeration names in sort order. */
private final String[] m_orderedNames;
/** Index values corresponding to sorted names. */
private final int[] m_orderedIndexes;
/**
* Constructor from array of enumeration items. The supplied items can be in
* any order, and the numeric values do not need to be contiguous (but must
* be unique, nonnegative, and should be fairly small). Note that this
* constructor will reorder the items in the supplied array as a side
* effect.
*
* @param items array of enumeration items (will be reordered)
*/
public EnumSet(EnumItem[] items) {
m_items = items;
if (items.length > 0) {
// first sort items in ascending name order
Arrays.sort(items, new Comparator() {
public int compare(Object a, Object b) {
return ((EnumItem)a).m_name.compareTo(((EnumItem)b).m_name);
}
});
// populate arrays for name lookup
m_orderedNames = new String[items.length];
m_orderedIndexes = new int[items.length];
int high = -1;
for (int i = 0; i < items.length; i++) {
EnumItem item = items[i];
if (item.m_value < 0) {
throw new IllegalArgumentException("Negative item value " +
item.m_value + " not allowed");
} else if (item.m_value > high) {
high = item.m_value;
if (high >= VALUE_LIMIT) {
throw new IllegalArgumentException
("Enumeration with value " +
high + " too large to be used.");
}
}
m_orderedNames[i] = item.m_name;
m_orderedIndexes[i] = item.m_value;
}
// populate array for indexed lookup of names
m_indexedNames = new String[high+1];
for (int i = 0; i < items.length; i++) {
EnumItem item = items[i];
if (m_indexedNames[item.m_value] == null) {
m_indexedNames[item.m_value] = item.m_name;
} else {
throw new IllegalArgumentException
("Duplicate index value " + item.m_value);
}
}
} else {
m_indexedNames = new String[0];
m_orderedNames = new String[0];
m_orderedIndexes = new int[0];
}
}
/**
* Constructor from array of names. The value associated with each name is
* just the position index in the array added to the start value.
*
* @param start item value for first added name
* @param names array of names (no null entries allowed)
*/
public EnumSet(int start, String[] names) {
this(buildItems(start, names));
}
/**
* Constructor from existing enumeration with added names. The value
* associated with each name is just the position index in the array added
* to the start value.
*
* @param base base enumeration to be extended
* @param start item value for first added name
* @param names array of names (no null entries allowed)
*/
public EnumSet(EnumSet base, int start, String[] names) {
this(mergeItems(base, start, names));
}
/**
* Generate array of enumeration items from array of names. The value
* associated with each name is just the position index in the array added
* to the start value.
*
* @param start item value for first added name
* @param names array of names (no null entries allowed)
*/
private static EnumItem[] buildItems(int start, String[] names) {
EnumItem[] items = new EnumItem[names.length];
for (int i = 0; i < items.length; i++) {
items[i] = new EnumItem(start+i, names[i]);
}
return items;
}
/**
* Generate array of enumeration items from base enumeration and array of
* names. The value associated with each name is just the position index in
* the array added to the start value.
*
* @param base base enumeration to be extended
* @param start item value for first added name
* @param names array of names (no null entries allowed)
*/
private static EnumItem[] mergeItems(EnumSet base, int start,
String[] names) {
int prior = base.m_items.length;
EnumItem[] merges = new EnumItem[prior + names.length];
System.arraycopy(base.m_items, 0, merges, 0, prior);
for (int i = 0; i < names.length; i++) {
merges[prior+i] = new EnumItem(start+i, names[i]);
}
return merges;
}
/**
* Get name for value if defined.
*
* @param value enumeration value
* @return name for value, or null if not defined
*/
public String getName(int value) {
if (value >= 0 && value < m_indexedNames.length) {
return m_indexedNames[value];
} else {
return null;
}
}
/**
* Get name for value. If the supplied value is not defined in the
* enumeration this throws an exception.
*
* @param value enumeration value
* @return name for value
*/
public String getNameChecked(int value) {
if (value >= 0 && value < m_indexedNames.length) {
String name = m_indexedNames[value];
if (name != null) {
return name;
}
}
throw new IllegalArgumentException("Value " + value + " not defined");
}
/**
* Get value for name if defined.
*
* @param name possible enumeration name
* @return value for name, or -1 if not found in enumeration
*/
public int getValue(String name) {
int base = 0;
int limit = m_orderedNames.length - 1;
while (base <= limit) {
int cur = (base + limit) >> 1;
int diff = name.compareTo(m_orderedNames[cur]);
if (diff < 0) {
limit = cur - 1;
} else if (diff > 0) {
base = cur + 1;
} else if (m_orderedIndexes != null) {
return m_orderedIndexes[cur];
} else {
return cur;
}
}
return -1;
}
/**
* Get value for name. If the supplied name is not present in the
* enumeration this throws an exception.
*
* @param name enumeration name
* @return value for name
*/
public int getValueChecked(String name) {
int index = getValue(name);
if (index >= 0) {
return index;
} else {
throw new IllegalArgumentException("Name " + name + " not defined");
}
}
/**
* Check value with exception. Throws an exception if the supplied value is
* not defined by this enumeration.
*
* @param value
*/
public void checkValue(int value) {
if (value < 0 || value >= m_indexedNames.length ||
m_indexedNames[value] == null) {
throw new IllegalArgumentException("Value " + value +
" not defined");
}
}
/**
* Get maximum index value in enumeration set.
*
* @return maximum
*/
public int maxIndex() {
return m_indexedNames.length - 1;
}
/**
* Enumeration pair information. This gives an int value along
* with the associated String representation.
*/
public static class EnumItem {
public final int m_value;
public final String m_name;
public EnumItem(int value, String name) {
m_value = value;
m_name = name;
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/IAbstractMarshaller.java 0000644 0001750 0001750 00000005316 10330637136 025737 0 ustar moeller moeller /*
Copyright (c) 2002,2003, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime;
/**
* Abstract base marshaller interface definition. This interface must be
* implemented by the handler for marshalling an object as an instance of a
* binding with extension mappings.
*
* This extension to the normal marshaller interface allows the base
* marshalling to determine the proper marshaller implementation to use at
* runtime. The code needs to check that the object to be marshalled has a
* marshaller that extends this base mapping.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public interface IAbstractMarshaller extends IMarshaller
{
/**
* Marshal instance of class with mapping extending this abstract mapping.
* This method call is responsible for all handling of the marshalling of an
* appropriate object to XML text. It is called at the point where the start
* tag for the associated element should be generated.
*
* @param obj object to be marshalled (may be null, in the case
* of a non-optional property with no value supplied)
* @param ctx XML text output context
* @throws JiBXException on error in marshalling process
*/
public void baseMarshal(Object obj, IMarshallingContext ctx)
throws JiBXException;
}
libjibx-java-1.1.6a/build/src/org/jibx/runtime/IAliasable.java 0000644 0001750 0001750 00000004735 10071714354 024042 0 ustar moeller moeller /*
Copyright (c) 2002-2004, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime;
/**
* Nameable extension interface definition. This interface must be implemented
* by a marshaller {@link org.jibx.runtime.IMarshaller} or unmarshaller {@link
* org.jibx.runtime.IUnmarshaller} that can use different top-level element
* names. Although it does not define any methods, it designates the marshaller
* or unmarshaller as being usable with a namespace and element name, and
* particular bound class name, defined within a binding.
*
* If this interface is implemented by a marshaller or unmarshaller class used
* with a specified element name in a binding the binding compiler will actually
* generate a subclass of the original class. The subclass uses a standard
* no-argument constructor, but calls a superclass constructor with the
* specified element name and bound class information. The superclass code can
* then make use of the specified name in marshalling and/or unmarshalling.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public interface IAliasable {}
libjibx-java-1.1.6a/build/src/org/jibx/runtime/IBindingFactory.java 0000644 0001750 0001750 00000013657 10435557336 025103 0 ustar moeller moeller /*
Copyright (c) 2002-2005, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime;
/**
* Binding factory interface definition. This interface is implemented by
* the binding factory class generated by each binding definition. All binding
* factory instances are guaranteed to be threadsafe and reusable.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public interface IBindingFactory
{
/** Current binary version number. This is a byte-ordered value, allowing
for two levels of major and two levels of minor version. */
public static final int CURRENT_VERSION_NUMBER = 0x00020000;
/** Current distribution file name. This is filled in by the Ant build
process to match the current distribution. */
public static final String CURRENT_VERSION_NAME = "@distrib@";
/** Mask for portions of version number that effect compatibility. */
public static final int COMPATIBLE_VERSION_MASK = 0xFFFF0000;
/**
* Create marshalling context instance.
*
* @return created marshalling context instance
* @throws JiBXException if error creating context
* @throws UnsupportedOperationException if marshalling not supported
* by binding
*/
public IMarshallingContext createMarshallingContext()
throws JiBXException;
/**
* Create unmarshalling context instance.
*
* @return created unmarshalling context instance
* @throws JiBXException if error creating context
* @throws UnsupportedOperationException if unmarshalling not supported
* by binding
*/
public IUnmarshallingContext createUnmarshallingContext()
throws JiBXException;
/**
* Get version number for binding compiler used.
*
* @return version number of code used to compile binding
*/
public int getCompilerVersion();
/**
* Get distribution name for binding compiler used.
*
* @return name of distribution for binding compiler
*/
public String getCompilerDistribution();
/**
* Get namespaces defined in mapping. The returned array is indexed by the
* namespace index number used when marshalling.
*
* @return array of namespaces defined in binding (null if not
* an output binding)
*/
public String[] getNamespaces();
/**
* Get initial prefixes for namespaces defined in mapping. The returned
* array is indexed by the namespace index number used when marshalling.
* Note that these are only the first prefixes associated with each
* namespace; it's possible to reuse the namespace in the binding with a
* different prefix.
*
* @return array of prefixes for namespaces defined in binding
* (null if not an output binding)
*/
public String[] getPrefixes();
/**
* Get mapped class names (or type names, in the case of abstract mappings).
* Returns array of fully-qualified class and/or type names, ordered by
* index number of the class.
*
* @return array of class names
*/
public String[] getMappedClasses();
/**
* Get namespaces of elements corresponding to mapped classes. The returned
* array uses the same ordering as the result of the {@link
* #getMappedClasses} call. Entries in the array are null if
* there is no element for a class or the element is in the default
* namespace.
*
* @return array of element namespaces
*/
public String[] getElementNamespaces();
/**
* Get names of elements corresponding to mapped classes. The returned array
* uses the same ordering as the result of the {@link #getMappedClasses}
* call. Entries in the array are null if there is no element
* for a class.
*
* @return array of element names
*/
public String[] getElementNames();
/**
* Get mapped class index from type name for abstract non-base mappings
* included in the binding. This is intended to allow identifying and using
* abstract mappings (basically type mappings) at runtime. The method is
* only returns a non-negative result if the "force-classes" option is used
* for the binding definition (since otherwise no marshaller/unmarshaller
* classes are created for abstract non-base mappings).
*
* @param type fully-qualified class or type name
* @return mapping index for type, or -1 if type is not an
* abstract non-base mapping
*/
public int getTypeIndex(String type);
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/ICharacterEscaper.java 0000644 0001750 0001750 00000005742 10071714354 025363 0 ustar moeller moeller /*
Copyright (c) 2004, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime;
import java.io.IOException;
import java.io.Writer;
/**
* Escaper for character data to be written to output document. This allows
* special character encodings to be handled appropriately on output. It's used
* by the generic output handler class during document marshalling.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public interface ICharacterEscaper
{
/**
* Write attribute value with character entity substitutions. This assumes
* that attributes use the regular quote ('"') delimitor.
*
* @param text attribute value text
* @param writer sink for output text
* @throws IOException on error writing to document
*/
public void writeAttribute(String text, Writer writer) throws IOException;
/**
* Write content value with character entity substitutions.
*
* @param text content value text
* @param writer sink for output text
* @throws IOException on error writing to document
*/
public void writeContent(String text, Writer writer) throws IOException;
/**
* Write CDATA to document. This writes the beginning and ending sequences
* for a CDATA section as well as the actual text, verifying that only
* characters allowed by the encoding are included in the text.
*
* @param text content value text
* @param writer sink for output text
* @throws IOException on error writing to document
*/
public void writeCData(String text, Writer writer) throws IOException;
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/IExtensibleWriter.java 0000644 0001750 0001750 00000004221 10737003370 025450 0 ustar moeller moeller /*
Copyright (c) 2007, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime;
import java.io.IOException;
/**
* Extensible version of standard XML writer interface. This allows the creation
* of child writer instances with added namespaces.
*
* @author Dennis M. Sosnoski
*/
public interface IExtensibleWriter extends IXMLWriter
{
/**
* Create a child writer instance to be used for a separate binding. The
* child writer inherits the output handling from this writer, while using
* the supplied namespace URIs.
*
* @param uris ordered array of URIs for namespaces used in document
* @return child writer
* @throws IOException
*/
IXMLWriter createChildWriter(String[] uris) throws IOException;
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/IListItemDeserializer.java 0000644 0001750 0001750 00000003703 10434260716 026255 0 ustar moeller moeller /*
Copyright (c) 2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime;
/**
* Schema list component deserializer interface. This is a convenience for
* defining list variations of basic types.
*
* @author Dennis M. Sosnoski
*/
public interface IListItemDeserializer
{
/**
* Deserializer method for list items.
*
* @param text value text
* @return created item class instance
* @exception JiBXException on error deserializing text
*/
public Object deserialize(String text) throws JiBXException;
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/IMarshallable.java 0000644 0001750 0001750 00000005302 10071714354 024543 0 ustar moeller moeller /*
Copyright (c) 2002,2003, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime;
/**
* Marshallable interface definition. This interface must be implemented by all
* classes which can be marshalled as independent units (not just as children of
* other objects). Classes implementing this interface may either marshal
* themselves directly (if there's only one marshalling format defined), or
* obtain an instance of the appropriate marshaller from the context and use
* that. This interface is automatically added by the binding compiler to all
* classes targeted by <mapping> elements in a binding.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public interface IMarshallable
{
/**
* Get class index. This returns the mapping index number for a class within
* the compiled bindings. It's intended primarily for internal use by the
* binding framework.
*
* @return mapping index number
*/
public int JiBX_getIndex();
/**
* Marshal self. This method call is responsible for all handling of the
* marshalling of an object to XML text.
*
* @param ctx marshalling context
* @throws JiBXException on error in marshalling process
*/
public void marshal(IMarshallingContext ctx) throws JiBXException;
}
libjibx-java-1.1.6a/build/src/org/jibx/runtime/IMarshaller.java 0000644 0001750 0001750 00000006636 10071714354 024261 0 ustar moeller moeller /*
Copyright (c) 2002,2003, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime;
/**
* Marshaller interface definition. This interface must be implemented
* by the handler for marshalling an object.
*
* Instances of classes implementing this interface must be serially
* reusable, meaning they can store state information while in the process
* of marshalling an object but must reset all state when called to
* marshal another object after the first one is done (even if the first
* object throws an exception during marshalling).
*
* The JiBX framework will only create one instance of a marshaller class
* for each mapped class using that marshaller. Generally the marshaller
* instance will not be called recursively, but this may happen in cases where
* the binding definition includes recursive mappings and the marshaller
* uses other marshallers (as opposed to handling all children directly).
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public interface IMarshaller
{
/**
* Check if marshaller represents an extension mapping. This is used by the
* framework in generated code to verify compatibility of objects being
* marshalled using an abstract mapping.
*
* @param index abstract mapping index to be checked
* @return true if this mapping is an extension of the abstract
* mapping, false if not
*/
public boolean isExtension(int index);
/**
* Marshal instance of handled class. This method call is responsible
* for all handling of the marshalling of an object to XML text. It is
* called at the point where the start tag for the associated element
* should be generated.
*
* @param obj object to be marshalled (may be null if property
* is not optional)
* @param ctx XML text output context
* @throws JiBXException on error in marshalling process
*/
public void marshal(Object obj, IMarshallingContext ctx)
throws JiBXException;
}
libjibx-java-1.1.6a/build/src/org/jibx/runtime/IMarshallingContext.java 0000644 0001750 0001750 00000032647 10434260716 025777 0 ustar moeller moeller /*
Copyright (c) 2002-2006, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime;
import java.io.OutputStream;
import java.io.Writer;
/**
* User interface for serializer to XML. This provides methods used to set up
* and control the marshalling process, as well as access to the marshalling
* object stack while marshalling.
*
* @author Dennis M. Sosnoski
*/
public interface IMarshallingContext
{
/**
* Set output stream with encoding and escaper. This forces handling of the
* output stream to use the Java character encoding support with the
* supplied escaper.
*
* @param outs stream for document data output
* @param enc document output encoding, or null uses UTF-8
* default
* @param esc escaper for writing characters to stream
* @throws JiBXException if error setting output
*/
void setOutput(OutputStream outs, String enc, ICharacterEscaper esc)
throws JiBXException;
/**
* Set output stream and encoding.
*
* @param outs stream for document data output
* @param enc document output encoding, or null uses UTF-8
* default
* @throws JiBXException if error setting output
*/
void setOutput(OutputStream outs, String enc) throws JiBXException;
/**
* Set output writer and escaper.
*
* @param outw writer for document data output
* @param esc escaper for writing characters
*/
void setOutput(Writer outw, ICharacterEscaper esc);
/**
* Set output writer. This assumes the standard UTF-8 encoding.
*
* @param outw writer for document data output
*/
void setOutput(Writer outw);
/**
* Get the writer being used for output.
*
* @return XML writer used for output
*/
IXMLWriter getXmlWriter();
/**
* Set the writer being used for output.
*
* @param xwrite XML writer used for output
*/
void setXmlWriter(IXMLWriter xwrite);
/**
* Get current nesting indent spaces. This returns the number of spaces used
* to show indenting, if used.
*
* @return number of spaces indented per level, or negative if indentation
* disabled
*/
int getIndent();
/**
* Set nesting indent spaces. This is advisory only, and implementations of
* this interface are free to ignore it. The intent is to indicate that the
* generated output should use indenting to illustrate element nesting.
*
* @param count number of spaces to indent per level, or disable
* indentation if negative
*/
void setIndent(int count);
/**
* Set nesting indentation. This is advisory only, and implementations of
* this interface are free to ignore it. The intent is to indicate that the
* generated output should use indenting to illustrate element nesting.
*
* @param count number of character to indent per level, or disable
* indentation if negative (zero means new line only)
* @param newline sequence of characters used for a line ending
* (null means use the single character '\n')
* @param indent whitespace character used for indentation
*/
public void setIndent(int count, String newline, char indent);
/**
* Reset to initial state for reuse. The context is serially reusable,
* as long as this method is called to clear any retained state information
* between uses. It is automatically called when output is set.
*/
void reset();
/**
* Start document, writing the XML declaration. This can only be validly
* called immediately following one of the set output methods; otherwise the
* output document will be corrupt.
*
* @param enc document encoding, null uses UTF-8 default
* @param alone standalone document flag, null if not
* specified
* @throws JiBXException on any error (possibly wrapping other exception)
*/
void startDocument(String enc, Boolean alone) throws JiBXException;
/**
* Start document with output stream and encoding. The effect is the same
* as from first setting the output stream and encoding, then making the
* call to start document.
*
* @param enc document encoding, null uses UTF-8 default
* @param alone standalone document flag, null if not
* specified
* @param outs stream for document data output
* @throws JiBXException on any error (possibly wrapping other exception)
*/
void startDocument(String enc, Boolean alone, OutputStream outs)
throws JiBXException;
/**
* Start document with writer. The effect is the same as from first
* setting the writer, then making the call to start document.
*
* @param enc document encoding, null uses UTF-8 default
* @param alone standalone document flag, null if not
* specified
* @param outw writer for document data output
* @throws JiBXException on any error (possibly wrapping other exception)
*/
void startDocument(String enc, Boolean alone, Writer outw)
throws JiBXException;
/**
* End document. Finishes all output and closes the document. Note that if
* this is called with an imcomplete marshalling the result will not be
* well-formed XML.
*
* @throws JiBXException on any error (possibly wrapping other exception)
*/
void endDocument() throws JiBXException;
/**
* Marshal document from root object without XML declaration. This can only
* be validly called immediately following one of the set output methods;
* otherwise the output document will be corrupt. The effect of this method
* is the same as the sequence of a call to marshal the root object using
* this context followed by a call to {@link #endDocument}.
*
* @param root object at root of structure to be marshalled, which must have
* a top-level mapping in the binding
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public void marshalDocument(Object root) throws JiBXException;
/**
* Marshal document from root object. This can only be validly called
* immediately following one of the set output methods; otherwise the output
* document will be corrupt. The effect of this method is the same as the
* sequence of a call to {@link #startDocument}, a call to marshal the root
* object using this context, and finally a call to {@link #endDocument}.
*
* @param root object at root of structure to be marshalled, which must have
* a top-level mapping in the binding
* @param enc document encoding, null uses UTF-8 default
* @param alone standalone document flag, null if not
* specified
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public void marshalDocument(Object root, String enc, Boolean alone)
throws JiBXException;
/**
* Marshal document from root object to output stream with encoding. The
* effect of this method is the same as the sequence of a call to {@link
* #startDocument}, a call to marshal the root object using this context,
* and finally a call to {@link #endDocument}.
*
* @param root object at root of structure to be marshalled, which must have
* a top-level mapping in the binding
* @param enc document encoding, null uses UTF-8 default
* @param alone standalone document flag, null if not
* specified
* @param outs stream for document data output
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public void marshalDocument(Object root, String enc, Boolean alone,
OutputStream outs) throws JiBXException;
/**
* Marshal document from root object to writer. The effect of this method
* is the same as the sequence of a call to {@link #startDocument}, a call
* to marshal the root object using this context, and finally a call to
* {@link #endDocument}.
*
* @param root object at root of structure to be marshalled, which must have
* a top-level mapping in the binding
* @param enc document encoding, null uses UTF-8 default
* @param alone standalone document flag, null if not
* specified
* @param outw writer for document data output
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public void marshalDocument(Object root, String enc, Boolean alone,
Writer outw) throws JiBXException;
/**
* 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 the {@link #reset()} method,
* so to make use of this you need to first call the appropriate version of
* the setOutput() method, then this method, and finally one of
* the marshalDocument methods which uses the previously-set
* output (not the ones which take a stream or writer as parameter, since
* they call setOutput() themselves).
*
* @param obj user context object, or null if clearing existing
* context object
* @see #getUserContext()
*/
public void setUserContext(Object obj);
/**
* Get the user context object.
*
* @return user context object, or null if no context object
* set
* @see #setUserContext(Object)
*/
public Object getUserContext();
/**
* Push created object to marshalling stack. This must be called before
* beginning the marshalling of the object. It is only called for objects
* with structure, not for those converted directly to and from text.
*
* @param obj object being marshalled
*/
public void pushObject(Object obj);
/**
* Pop marshalled object from stack.
*
* @throws JiBXException if no object on stack
*/
public void popObject() throws JiBXException;
/**
* Get current marshalling object stack depth. This allows tracking
* nested calls to marshal one object while in the process of marshalling
* another object. The bottom item on the stack is always the root object
* of the marshalling.
*
* @return number of objects in marshalling stack
*/
public int getStackDepth();
/**
* Get object from marshalling stack. This stack allows tracking nested
* calls to marshal one object while in the process of marshalling
* another object. The bottom item on the stack is always the root object
* of the marshalling.
*
* @param depth object depth in stack to be retrieved (must be in the range
* of zero to the current depth minus one).
* @return object from marshalling stack
*/
public Object getStackObject(int depth);
/**
* Get top object on marshalling stack. This is safe to call even when no
* objects are on the stack.
*
* @return object from marshalling stack, or null if none
*/
public Object getStackTop();
/**
* Find the marshaller for a particular class index
* in the current context.
*
* @param index class index for marshalling definition
* @param name fully qualified name of class to be marshalled (used only
* for validation)
* @return marshalling handler for class
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public IMarshaller getMarshaller(int index, String name)
throws JiBXException;
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/ITrackSource.java 0000644 0001750 0001750 00000004720 10071714354 024404 0 ustar moeller moeller /*
Copyright (c) 2004, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime;
/**
* Unmarshalling source tracking interface. This interface is added to bound
* classes when requested by the binding definition. It allows the user to
* retrieve information about the location in the input document corresponding
* to an unmarshalled object, if the parser used for unmarshalling supports
* reporting this information.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public interface ITrackSource
{
/**
* Get source document name.
*
* @return name given for source document, or null if none
*/
public String jibx_getDocumentName();
/**
* Get source document line number.
*
* @return line number in source document, or -1 if unknown
*/
public int jibx_getLineNumber();
/**
* Get source document column number.
*
* @return column number in source document, or -1 if unknown
*/
public int jibx_getColumnNumber();
}
libjibx-java-1.1.6a/build/src/org/jibx/runtime/IUnmarshallable.java 0000644 0001750 0001750 00000004473 10071714356 025120 0 ustar moeller moeller /*
Copyright (c) 2002,2003, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime;
/**
* Unmarshallable interface definition. This interface must be implemented by
* all classes which can be unmarshalled as independent units (not just as
* children of other objects). Classes implementing this interface may either
* unmarshal themselves directly (if there's only one unmarshalling format
* defined), or obtain an instance of the appropriate unmarshaller from the
* context and use that.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public interface IUnmarshallable
{
/**
* Unmarshal self. This method call is responsible for all handling of the
* unmarshalling of the object from XML text.
*
* @param ctx unmarshalling context
* @throws JiBXException on error in unmarshalling process
*/
public void unmarshal(IUnmarshallingContext ctx) throws JiBXException;
}
libjibx-java-1.1.6a/build/src/org/jibx/runtime/IUnmarshaller.java 0000644 0001750 0001750 00000007356 10071714356 024626 0 ustar moeller moeller /*
Copyright (c) 2002,2003, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime;
/**
* Unmarshaller interface definition. This interface must be implemented
* by the handler for unmarshalling an object.
*
* Instances of classes implementing this interface must be serially
* reusable, meaning they can store state information while in the process
* of unmarshalling an object but must reset all state when called to
* unmarshal another object after the first one is done (even if the first
* object throws an exception during unmarshalling).
*
* The JiBX framework will only create one instance of an unmarshaller class
* for each mapped class using that unmarshaller. Generally the unmarshaller
* instance will not be called recursively, but this may happen in cases where
* the binding definition includes recursive mappings and the unmarshaller
* uses other unmarshallers (as opposed to handling all children directly).
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public interface IUnmarshaller
{
/**
* Check if instance present in XML. This method can be called when the
* unmarshalling context is positioned at or just before the start of the
* data corresponding to an instance of this mapping. It verifies that the
* expected data is present.
*
* @param ctx unmarshalling context
* @return true if expected parse data found,
* false if not
* @throws JiBXException on error in unmarshalling process
*/
public boolean isPresent(IUnmarshallingContext ctx)
throws JiBXException;
/**
* Unmarshal instance of handled class. This method call is responsible
* for all handling of the unmarshalling of an object from XML text,
* including creating the instance of the handled class if an instance is
* not supplied. When it is called the unmarshalling context is always
* positioned at or just before the start tag corresponding to the start of
* the class data.
*
* @param obj object to be unmarshalled (may be null)
* @param ctx unmarshalling context
* @return unmarshalled object (may be null)
* @throws JiBXException on error in unmarshalling process
*/
public Object unmarshal(Object obj, IUnmarshallingContext ctx)
throws JiBXException;
}
libjibx-java-1.1.6a/build/src/org/jibx/runtime/IUnmarshallingContext.java 0000644 0001750 0001750 00000024444 10434260716 026336 0 ustar moeller moeller /*
Copyright (c) 2002-2006, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime;
import java.io.InputStream;
import java.io.Reader;
/**
* User interface for deserializer from XML. This provides methods used to set
* up and control the marshalling process, as well as access to the
* unmarshalling object stack while unmarshalling.
*
* @author Dennis M. Sosnoski
*/
public interface IUnmarshallingContext {
/**
* Set document to be parsed from stream.
*
* @param ins stream supplying document data
* @param enc document input encoding, or null if to be
* determined by parser
* @throws JiBXException if error creating parser
*/
void setDocument(InputStream ins, String enc) throws JiBXException;
/**
* Set document to be parsed from reader.
*
* @param rdr reader supplying document data
* @throws JiBXException if error creating parser
*/
void setDocument(Reader rdr) throws JiBXException;
/**
* Set named document to be parsed from stream.
*
* @param ins stream supplying document data
* @param name document name
* @param enc document input encoding, or null if to be
* determined by parser
* @throws JiBXException if error creating parser
*/
void setDocument(InputStream ins, String name, String enc)
throws JiBXException;
/**
* Set named document to be parsed from reader.
*
* @param rdr reader supplying document data
* @param name document name
* @throws JiBXException if error creating parser
*/
void setDocument(Reader rdr, String name) throws JiBXException;
/**
* 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.
*/
void reset();
/**
* Unmarshal the current element. If not currently positioned at a start
* or end tag this first advances the parse to the next start or end tag.
* There must be an unmarshalling defined for the current element, and this
* unmarshalling is used to build an object from that element.
*
* @return unmarshalled object from element
* @throws JiBXException on any error (possibly wrapping other exception)
*/
Object unmarshalElement() throws JiBXException;
/**
* Unmarshal document from stream to object. The effect of this is the same
* as if {@link #setDocument} were called, followed by {@link
* #unmarshalElement}
*
* @param ins stream supplying document data
* @param enc document input encoding, or null if to be
* determined by parser
* @return unmarshalled object
* @throws JiBXException if error creating parser
*/
Object unmarshalDocument(InputStream ins, String enc) throws JiBXException;
/**
* Unmarshal document from reader to object. The effect of this is the same
* as if {@link #setDocument} were called, followed by {@link
* #unmarshalElement}
*
* @param rdr reader supplying document data
* @return unmarshalled object
* @throws JiBXException if error creating parser
*/
Object unmarshalDocument(Reader rdr) throws JiBXException;
/**
* Unmarshal named document from stream to object. The effect of this is the
* same as if {@link #setDocument} were called, followed by {@link
* #unmarshalElement}
*
* @param ins stream supplying document data
* @param name document name
* @param enc document input encoding, or null if to be
* determined by parser
* @return unmarshalled object
* @throws JiBXException if error creating parser
*/
Object unmarshalDocument(InputStream ins, String name, String enc)
throws JiBXException;
/**
* Unmarshal named document from reader to object. The effect of this is the
* same as if {@link #setDocument} were called, followed by {@link
* #unmarshalElement}
*
* @param rdr reader supplying document data
* @param name document name
* @return unmarshalled object
* @throws JiBXException if error creating parser
*/
Object unmarshalDocument(Reader rdr, String name) throws JiBXException;
/**
* Return the supplied document name.
*
* @return supplied document name (null if none)
*/
public String getDocumentName();
/**
* 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.
*
* @param ns namespace URI for expected element (may be null
* or the empty string for the empty namespace)
* @param name element name expected
* @return true if at start of element with supplied name,
* false if not
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public boolean isAt(String ns, String name) throws JiBXException;
/**
* 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.
*
* @return true if at start of element, false if
* at end
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public boolean isStart() throws JiBXException;
/**
* 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.
*
* @return true if at end of element, false if
* at start
* @throws JiBXException on any error (possibly wrapping other exception)
*/
public boolean isEnd() throws JiBXException;
/**
* Find the unmarshaller for a particular class index in the current
* context.
*
* @param index class index for unmarshalling definition
* @return unmarshalling handler for class
* @throws JiBXException if unable to create unmarshaller
*/
public IUnmarshaller getUnmarshaller(int index) throws JiBXException;
/**
* 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 the {@link #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
* {@link #unmarshalElement} method.
*
* @param obj user context object, or null if clearing existing
* context object
* @see #getUserContext()
*/
public void setUserContext(Object obj);
/**
* Get the user context object.
*
* @return user context object, or null if no context object
* set
* @see #setUserContext(Object)
*/
public Object getUserContext();
/**
* 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.
*
* @param obj object being unmarshalled
*/
public void pushObject(Object obj);
/**
* Pop unmarshalled object from stack.
*
* @throws JiBXException if stack empty
*/
public void popObject() throws JiBXException;
/**
* 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.
*
* @return number of objects in unmarshalling stack
*/
public int getStackDepth();
/**
* 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.
*
* @param depth object depth in stack to be retrieved (must be in the range
* of zero to the current depth minus one).
* @return object from unmarshalling stack
*/
public Object getStackObject(int depth);
/**
* Get top object on unmarshalling stack. This is safe to call even when no
* objects are on the stack.
*
* @return object from unmarshalling stack, or null if none
*/
public Object getStackTop();
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/IXMLReader.java 0000644 0001750 0001750 00000021340 10434260716 023740 0 ustar moeller moeller /*
Copyright (c) 2005, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime;
/**
* XML reader interface used for input of unmarshalled document. This interface
* allows easy substitution of different parsers or other input sources.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public interface IXMLReader
{
//
// Event types reported by nextEvent() method
public static final int START_DOCUMENT = 0;
public static final int END_DOCUMENT = 1;
public static final int START_TAG = 2;
public static final int END_TAG = 3;
public static final int TEXT = 4;
public static final int CDSECT = 5;
public static final int ENTITY_REF = 6;
public static final int IGNORABLE_WHITESPACE = 7;
public static final int PROCESSING_INSTRUCTION = 8;
public static final int COMMENT = 9;
public static final int DOCDECL = 10;
/**
* Build current parse input position description.
*
* @return text description of current parse position
*/
public String buildPositionString();
/**
* Advance to next parse event of input document.
*
* @return parse event type code
* @throws JiBXException if error reading or parsing document
*/
public int nextToken() throws JiBXException;
/**
* Advance to next binding component of input document. This is a
* higher-level operation than {@link #nextToken()}, which consolidates text
* content and ignores parse events for components such as comments and PIs.
*
* @return parse event type code
* @throws JiBXException if error reading or parsing document
*/
public int next() throws JiBXException;
/**
* Gets the current parse event type, without changing the current parse
* state.
*
* @return parse event type code
* @throws JiBXException if error parsing document
*/
public int getEventType() throws JiBXException;
/**
* Get element name from the current start or end tag.
*
* @return local name if namespace handling enabled, full name if namespace
* handling disabled
* @throws IllegalStateException if not at a start or end tag (optional)
*/
public String getName();
/**
* Get element namespace from the current start or end tag.
*
* @return namespace URI if namespace handling enabled and element is in a
* namespace, empty string otherwise
* @throws IllegalStateException if not at a start or end tag (optional)
*/
public String getNamespace();
/**
* Get element prefix from the current start or end tag.
*
* @return prefix text (null if no prefix)
* @throws IllegalStateException if not at a start or end tag
*/
public String getPrefix();
/**
* Get the number of attributes of the current start tag.
*
* @return number of attributes
* @throws IllegalStateException if not at a start tag (optional)
*/
public int getAttributeCount();
/**
* Get an attribute name from the current start tag.
*
* @param index attribute index
* @return local name if namespace handling enabled, full name if namespace
* handling disabled
* @throws IllegalStateException if not at a start tag or invalid index
*/
public String getAttributeName(int index);
/**
* Get an attribute namespace from the current start tag.
*
* @param index attribute index
* @return namespace URI if namespace handling enabled and attribute is in a
* namespace, empty string otherwise
* @throws IllegalStateException if not at a start tag or invalid index
*/
public String getAttributeNamespace(int index);
/**
* Get an attribute prefix from the current start tag.
*
* @param index attribute index
* @return prefix for attribute (null if no prefix present)
* @throws IllegalStateException if not at a start tag or invalid index
*/
public String getAttributePrefix(int index);
/**
* Get an attribute value from the current start tag.
*
* @param index attribute index
* @return value text
* @throws IllegalStateException if not at a start tag or invalid index
*/
public String getAttributeValue(int index);
/**
* Get an attribute value from the current start tag.
*
* @param ns namespace URI for expected attribute (may be null
* or the empty string for the empty namespace)
* @param name attribute name expected
* @return attribute value text, or null if missing
* @throws IllegalStateException if not at a start tag
*/
public String getAttributeValue(String ns, String name);
/**
* Get current text. When positioned on a TEXT event this returns the actual
* text; for CDSECT it returns the text inside the CDATA section; for
* COMMENT, DOCDECL, or PROCESSING_INSTRUCTION it returns the text inside
* the structure.
*
* @return text for current event
*/
public String getText();
/**
* Get current element nesting depth. The returned depth always includes the
* current start or end tag (if positioned on a start or end tag).
*
* @return element nesting depth
*/
public int getNestingDepth();
/**
* Get number of namespace declarations active at depth.
*
* @param depth element nesting depth
* @return number of namespaces active at depth
* @throws IllegalArgumentException if invalid depth
*/
public int getNamespaceCount(int depth);
/**
* Get namespace URI.
*
* @param index declaration index
* @return namespace URI
* @throws IllegalArgumentException if invalid index
*/
public String getNamespaceUri(int index);
/**
* Get namespace prefix.
*
* @param index declaration index
* @return namespace prefix, null if a default namespace
* @throws IllegalArgumentException if invalid index
*/
public String getNamespacePrefix(int index);
/**
* Get document name.
*
* @return document name, null if not known
*/
public String getDocumentName();
/**
* Get current source line number.
*
* @return line number from source document, -1 if line number
* information not available
*/
public int getLineNumber();
/**
* Get current source column number.
*
* @return column number from source document, -1 if column
* number information not available
*/
public int getColumnNumber();
/**
* Get namespace URI associated with prefix.
*
* @param prefix to be found
* @return associated URI (null if prefix not defined)
*/
public String getNamespace(String prefix);
/**
* Return the input encoding, if known. This is only valid after parsing of
* a document has been started.
*
* @return input encoding (null if unknown)
*/
public String getInputEncoding();
/**
* Return namespace processing flag.
*
* @return namespace processing flag (true if namespaces are
* processed by reader, false if not)
*/
public boolean isNamespaceAware();
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/IXMLWriter.java 0000644 0001750 0001750 00000031447 10624255760 024027 0 ustar moeller moeller /*
Copyright (c) 2004-2007, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime;
import java.io.IOException;
/**
* XML writer interface used for output of marshalled document. This interface
* allows easy substitution of different output formats, including parse event
* stream equivalents. This makes heavy use of state information, so each
* method call defined is only valid in certain states.
*
* @author Dennis M. Sosnoski
*/
public interface IXMLWriter
{
/**
* Get the current element nesting depth. Elements are only counted in the
* depth returned when they're officially open - after the start tag has
* been output and before the end tag has been output.
*
* @return number of nested elements at current point in output
*/
public int getNestingDepth();
/**
* Get the number of namespaces currently defined. This is equivalent to the
* index of the next extension namespace added.
*
* @return namespace count
*/
public int getNamespaceCount();
/**
* Set nesting indentation. This is advisory only, and implementations of
* this interface are free to ignore it. The intent is to indicate that the
* generated output should use indenting to illustrate element nesting.
*
* @param count number of character to indent per level, or disable
* indentation if negative (zero means new line only)
* @param newline sequence of characters used for a line ending
* (null means use the single character '\n')
* @param indent whitespace character used for indentation
*/
public void setIndentSpaces(int count, String newline, char indent);
/**
* Write XML declaration to document. This can only be called before any
* other methods in the interface are called.
*
* @param version XML version text
* @param encoding text for encoding attribute (unspecified if
* null)
* @param standalone text for standalone attribute (unspecified if
* null)
* @throws IOException on error writing to document
*/
public void writeXMLDecl(String version, String encoding, String standalone)
throws IOException;
/**
* Generate open start tag. This allows attributes and/or namespace
* declarations to be added to the start tag, but must be followed by a
* {@link #closeStartTag} call.
*
* @param index namespace URI index number
* @param name unqualified element name
* @throws IOException on error writing to document
*/
public void startTagOpen(int index, String name) throws IOException;
/**
* Generate start tag for element with namespaces. This creates the actual
* start tag, along with any necessary namespace declarations. Previously
* active namespace declarations are not duplicated. The tag is
* left incomplete, allowing other attributes to be added.
*
* @param index namespace URI index number
* @param name element name
* @param nums array of namespace indexes defined by this element (must
* be constant, reference is kept until end of element)
* @param prefs array of namespace prefixes mapped by this element (no
* null values, use "" for default namespace declaration)
* @throws IOException on error writing to document
*/
public void startTagNamespaces(int index, String name,
int[] nums, String[] prefs) throws IOException;
/**
* Add attribute to current open start tag. This is only valid after a call
* to {@link #startTagOpen} and before the corresponding call to {@link
* #closeStartTag}.
*
* @param index namespace URI index number
* @param name unqualified attribute name
* @param value text value for attribute
* @throws IOException on error writing to document
*/
public void addAttribute(int index, String name, String value)
throws IOException;
/**
* Close the current open start tag. This is only valid after a call to
* {@link #startTagOpen}.
*
* @throws IOException on error writing to document
*/
public void closeStartTag() throws IOException;
/**
* Close the current open start tag as an empty element. This is only valid
* after a call to {@link #startTagOpen}.
*
* @throws IOException on error writing to document
*/
public void closeEmptyTag() throws IOException;
/**
* Generate closed start tag. No attributes or namespaces can be added to a
* start tag written using this call.
*
* @param index namespace URI index number
* @param name unqualified element name
* @throws IOException on error writing to document
*/
public void startTagClosed(int index, String name) throws IOException;
/**
* Generate end tag.
*
* @param index namespace URI index number
* @param name unqualified element name
* @throws IOException on error writing to document
*/
public void endTag(int index, String name) throws IOException;
/**
* Write ordinary character data text content to document.
*
* @param text content value text (must not be null)
* @throws IOException on error writing to document
*/
public void writeTextContent(String text) throws IOException;
/**
* Write CDATA text to document.
*
* @param text content value text (must not be null)
* @throws IOException on error writing to document
*/
public void writeCData(String text) throws IOException;
/**
* Write comment to document.
*
* @param text comment text (must not be null)
* @throws IOException on error writing to document
*/
public void writeComment(String text) throws IOException;
/**
* Write entity reference to document.
*
* @param name entity name (must not be null)
* @throws IOException on error writing to document
*/
public void writeEntityRef(String name) throws IOException;
/**
* Write DOCTYPE declaration to document.
*
* @param name root element name
* @param sys system ID (null if none, must be
* non-null for public ID to be used)
* @param pub public ID (null if none)
* @param subset internal subset (null if none)
* @throws IOException on error writing to document
*/
public void writeDocType(String name, String sys, String pub, String subset)
throws IOException;
/**
* Write processing instruction to document.
*
* @param target processing instruction target name (must not be
* null)
* @param data processing instruction data (must not be null)
* @throws IOException on error writing to document
*/
public void writePI(String target, String data) throws IOException;
/**
* Request output indent. The writer implementation should normally indent
* output as appropriate. This method can be used to request indenting of
* output that might otherwise not be indented. The normal effect when used
* with a text-oriented writer should be to output the appropriate line end
* sequence followed by the appropriate number of indent characters for the
* current nesting level.
*
* @throws IOException on error writing to document
*/
public void indent() throws IOException;
/**
* Flush document output. Writes any buffered data to the output medium.
* This does not flush the output medium itself, only any internal
* buffering within the writer.
*
* @throws IOException on error writing to document
*/
public void flush() throws IOException;
/**
* Close document output. Completes writing of document output, including
* flushing and closing the output medium.
*
* @throws IOException on error writing to document
*/
public void close() throws IOException;
/**
* Reset to initial state for reuse. The context is serially reusable,
* as long as this method is called to clear any retained state information
* between uses. It is automatically called when output is set.
*/
public void reset();
/**
* Get namespace URIs for mapping. This gets the full ordered array of
* namespaces known in the binding used for this marshalling, where the
* index number of each namespace URI is the namespace index used to lookup
* the prefix when marshalling a name in that namespace. The returned array
* must not be modified.
*
* @return array of namespaces
*/
public String[] getNamespaces();
/**
* Get URI for namespace.
*
* @param index namespace URI index number
* @return namespace URI text, or null if the namespace index
* is invalid
*/
public String getNamespaceUri(int index);
/**
* Get current prefix defined for namespace.
*
* @param index namespace URI index number
* @return current prefix text, or null if the namespace is not
* currently mapped
*/
public String getNamespacePrefix(int index);
/**
* Get index of namespace mapped to prefix. This can be an expensive
* operation with time proportional to the number of namespaces defined, so
* it should be used with care.
*
* @param prefix text to match (non-null, use "" for default
* prefix)
* @return index namespace URI index number mapped to prefix
*/
public int getPrefixIndex(String prefix);
/**
* Append extension namespace URIs to those in mapping.
*
* @param uris namespace URIs to extend those in mapping
*/
public void pushExtensionNamespaces(String[] uris);
/**
* Remove extension namespace URIs. This removes the last set of
* extension namespaces pushed using {@link #pushExtensionNamespaces}.
*/
public void popExtensionNamespaces();
/**
* Get extension namespace URIs added to those in mapping. This gets the
* current set of extension definitions. The returned arrays must not be
* modified.
*
* @return array of arrays of extension namespaces (null if
* none)
*/
public String[][] getExtensionNamespaces();
/**
* Open the specified namespaces for use. This method is normally only
* called internally, when namespace declarations are actually written to
* output. It is exposed as part of this interface to allow for special
* circumstances where namespaces are being written outside the usual
* processing. The namespaces will remain open for use until the current
* element is closed.
*
* @param nums array of namespace indexes defined by this element (must
* be constant, reference is kept until namespaces are closed)
* @param prefs array of namespace prefixes mapped by this element (no
* null values, use "" for default namespace declaration)
* @return array of indexes for namespaces not previously active (the ones
* actually needing to be declared, in the case of text output)
* @throws IOException on error writing to document
*/
public int[] openNamespaces(int[] nums, String[] prefs) throws IOException;
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/IntStack.java 0000644 0001750 0001750 00000023135 10434260716 023570 0 ustar moeller moeller /*
Copyright (c) 2000-2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime;
import java.lang.reflect.Array;
/**
* Growable int stack with type specific access methods. This
* implementation is unsynchronized in order to provide the best possible
* performance for typical usage scenarios, so explicit synchronization must
* be implemented by a wrapper class or directly by the application in cases
* where instances are modified in a multithreaded environment. See the base
* classes for other details of the implementation.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class IntStack
{
/** Default initial array size. */
public static final int DEFAULT_SIZE = 8;
/** Size of the current array. */
protected int m_countLimit;
/** The number of values currently present in the stack. */
protected int m_countPresent;
/** Maximum size increment for growing array. */
protected int m_maximumGrowth;
/** The underlying array used for storing the data. */
protected int[] m_baseArray;
/**
* Constructor with full specification.
*
* @param size number of int values initially allowed in
* stack
* @param growth maximum size increment for growing stack
*/
public IntStack(int size, int growth) {
m_countLimit = size;
m_maximumGrowth = growth;
m_baseArray = new int[size];
}
/**
* Constructor with initial size specified.
*
* @param size number of int values initially allowed in
* stack
*/
public IntStack(int size) {
this(size, Integer.MAX_VALUE);
}
/**
* Default constructor.
*/
public IntStack() {
this(DEFAULT_SIZE);
}
/**
* Copy (clone) constructor.
*
* @param base instance being copied
*/
public IntStack(IntStack base) {
this(base.m_countLimit, base.m_maximumGrowth);
System.arraycopy(base.m_baseArray, 0, m_baseArray, 0,
base.m_countPresent);
m_countPresent = base.m_countPresent;
}
/**
* Constructor from array of ints.
*
* @param ints array of ints for initial contents
*/
public IntStack(int[] ints) {
this(ints.length);
System.arraycopy(ints, 0, m_baseArray, 0, ints.length);
m_countPresent = ints.length;
}
/**
* Copy data after array resize. This just copies the entire contents of the
* old array to the start of the new array. It should be overridden in cases
* where data needs to be rearranged in the array after a resize.
*
* @param base original array containing data
* @param grown resized array for data
*/
private void resizeCopy(Object base, Object grown) {
System.arraycopy(base, 0, grown, 0, Array.getLength(base));
}
/**
* Increase the size of the array to at least a specified size. The array
* will normally be at least doubled in size, but if a maximum size
* increment was specified in the constructor and the value is less than
* the current size of the array, the maximum increment will be used
* instead. If the requested size requires more than the default growth,
* the requested size overrides the normal growth and determines the size
* of the replacement array.
*
* @param required new minimum size required
*/
private void growArray(int required) {
int size = Math.max(required,
m_countLimit + Math.min(m_countLimit, m_maximumGrowth));
int[] grown = new int[size];
resizeCopy(m_baseArray, grown);
m_countLimit = size;
m_baseArray = grown;
}
/**
* Ensure that the array has the capacity for at least the specified
* number of values.
*
* @param min minimum capacity to be guaranteed
*/
public final void ensureCapacity(int min) {
if (min > m_countLimit) {
growArray(min);
}
}
/**
* Push a value on the stack.
*
* @param value value to be added
*/
public void push(int value) {
int index = getAddIndex();
m_baseArray[index] = value;
}
/**
* Pop a value from the stack.
*
* @return value from top of stack
* @exception ArrayIndexOutOfBoundsException on attempt to pop empty stack
*/
public int pop() {
if (m_countPresent > 0) {
return m_baseArray[--m_countPresent];
} else {
throw new ArrayIndexOutOfBoundsException
("Attempt to pop empty stack");
}
}
/**
* Pop multiple values from the stack. The last value popped is the
* one returned.
*
* @param count number of values to pop from stack (must be strictly
* positive)
* @return value from top of stack
* @exception ArrayIndexOutOfBoundsException on attempt to pop past end of
* stack
*/
public int pop(int count) {
if (count <= 0) {
throw new IllegalArgumentException("Count must be greater than 0");
} else if (m_countPresent >= count) {
m_countPresent -= count;
return m_baseArray[m_countPresent];
} else {
throw new ArrayIndexOutOfBoundsException
("Attempt to pop past end of stack");
}
}
/**
* Copy a value from the stack. This returns a value from within
* the stack without modifying the stack.
*
* @param depth depth of value to be returned
* @return value from stack
* @exception ArrayIndexOutOfBoundsException on attempt to peek past end of
* stack
*/
public int peek(int depth) {
if (m_countPresent > depth) {
return m_baseArray[m_countPresent - depth - 1];
} else {
throw new ArrayIndexOutOfBoundsException
("Attempt to peek past end of stack");
}
}
/**
* Copy top value from the stack. This returns the top value without
* removing it from the stack.
*
* @return value at top of stack
* @exception ArrayIndexOutOfBoundsException on attempt to peek empty stack
*/
public int peek() {
return peek(0);
}
/**
* Constructs and returns a simple array containing the same data as held
* in this stack. Note that the items will be in reverse pop order, with
* the last item to be popped from the stack as the first item in the
* array.
*
* @return array containing a copy of the data
*/
public int[] toArray() {
int[] copy = new int[m_countPresent];
System.arraycopy(m_baseArray, 0, copy, 0, m_countPresent);
return copy;
}
/**
* Duplicates the object with the generic call.
*
* @return a copy of the object
*/
public Object clone() {
return new IntStack(this);
}
/**
* Gets the array offset for appending a value to those in the stack.
* If the underlying array is full, it is grown by the appropriate size
* increment so that the index value returned is always valid for the
* array in use by the time of the return.
*
* @return index position for added element
*/
private int getAddIndex() {
int index = m_countPresent++;
if (m_countPresent > m_countLimit) {
growArray(m_countPresent);
}
return index;
}
/**
* Get the number of values currently present in the stack.
*
* @return count of values present
*/
public int size() {
return m_countPresent;
}
/**
* Check if stack is empty.
*
* @return true if stack empty, false if not
*/
public boolean isEmpty() {
return m_countPresent == 0;
}
/**
* Set the stack to the empty state.
*/
public void clear() {
m_countPresent = 0;
}
}
libjibx-java-1.1.6a/build/src/org/jibx/runtime/JiBXConstrainedParseException.java 0000644 0001750 0001750 00000006040 11003053146 027672 0 ustar moeller moeller /*
Copyright (c) 2008, Joshua Davies.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime;
import java.util.Arrays;
/**
* Thrown when a "constrained" parsing exception is encountered (e.g. an
* enumerated value).
*
* @author Joshua Davies
*/
public class JiBXConstrainedParseException extends JiBXParseException {
private String[] m_allowableValues;
public JiBXConstrainedParseException(String msg, String value,
String[] allowableValues) {
super(msg, value);
m_allowableValues = allowableValues;
}
public JiBXConstrainedParseException(String msg, String value,
String[] allowableValues, String namespace, String tagName,
Throwable root) {
super(msg, value, namespace, tagName, root);
m_allowableValues = allowableValues;
}
/**
* @return the default message with "constraint" text appended.
*/
public String getMessage() {
StringBuffer constraint = new StringBuffer();
constraint.append(". Acceptable values are ");
for (int i = 0; i < m_allowableValues.length; i++) {
constraint.append("'" + m_allowableValues[i] + "'");
if (i < (m_allowableValues.length - 1)) {
constraint.append(", ");
}
}
return super.getMessage() + constraint.toString() + ".";
}
/**
* Solely used by unit tests.
*
* @param obj what to compare against
* @return true or false
*/
public boolean equals(Object obj) {
if (this == obj)
return true;
if (!super.equals(obj))
return false;
if (getClass() != obj.getClass())
return false;
final JiBXConstrainedParseException other = (JiBXConstrainedParseException) obj;
if (!Arrays.equals(m_allowableValues, other.m_allowableValues))
return false;
return true;
}
}
libjibx-java-1.1.6a/build/src/org/jibx/runtime/JiBXException.java 0000644 0001750 0001750 00000007161 10230250172 024511 0 ustar moeller moeller /*
Copyright (c) 2002-2005, Dennis M. Sosnoski.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime;
import java.io.PrintStream;
import java.io.PrintWriter;
/**
* Binding exception class. This is used for all types of errors that
* can be generated by the runtime.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class JiBXException extends Exception
{
/** Exception that caused this exception. */
private Throwable m_rootCause;
/**
* Constructor from message.
*
* @param msg message describing the exception condition
*/
public JiBXException(String msg) {
super(msg);
}
/**
* Constructor from message and wrapped exception.
*
* @param msg message describing the exception condition
* @param root exception which caused this exception
*/
public JiBXException(String msg, Throwable root) {
super(msg);
m_rootCause = root;
}
/**
* Get root cause exception.
*
* @return exception that caused this exception
*/
public Throwable getRootCause() {
return m_rootCause;
}
/**
* Print stack trace to standard error. This is an override of the base
* class method to implement exception chaining.
*/
public void printStackTrace() {
printStackTrace(System.err);
}
/**
* Print stack trace to stream. This is an override of the base class method
* to implement exception chaining.
*
* @param s stream for printing stack trace
*/
public void printStackTrace(PrintStream s) {
if (m_rootCause == null) {
super.printStackTrace(s);
} else {
s.println(getMessage());
m_rootCause.printStackTrace(s);
s.println();
}
}
/**
* Print stack trace to writer. This is an override of the base class method
* to implement exception chaining.
*
* @param s writer for printing stack trace
*/
public void printStackTrace(PrintWriter s) {
if (m_rootCause == null) {
super.printStackTrace(s);
} else {
s.println(getMessage());
m_rootCause.printStackTrace(s);
s.println();
}
}
} libjibx-java-1.1.6a/build/src/org/jibx/runtime/JiBXParseException.java 0000644 0001750 0001750 00000011007 11003053146 025477 0 ustar moeller moeller /*
Copyright (c) 2008, Joshua Davies.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime;
/**
* JiBX parsing exception class. This subclass of JiBXException provides
* additional details when a parsing error occurs such as what tag was
* being parsed and what value caused the error.
*
* @author Joshua Davies
*/
public class JiBXParseException extends JiBXException
{
private String m_value;
private String m_namespace;
private String m_tagName;
/**
* Constructor from message.
* @param msg the throwers description of what's gone wrong.
* @param value the value which was unparseable (in string format).
*/
public JiBXParseException(String msg, String value) {
super(msg);
m_value = value;
}
/**
* Constructor from message and wrapped exception.
* @param msg the throwers description of what's gone wrong.
* @param value the value which was unparseable (in string format).
* @param root exception which caused this exception
*/
public JiBXParseException(String msg, String value, Throwable root) {
super(msg, root);
m_value = value;
}
/**
* Constructor from message, wrapped exception and tag name.
*
* @param msg message describing the exception condition
* @param value the value which was unparseable (in string format).
* @param namespace the namespace (if any) associated with the tag.
* @param tagName the name of the tag whose element caused the exception.
* @param root exception which caused this exception
*/
public JiBXParseException(String msg, String value, String namespace, String tagName, Throwable root) {
super(msg, root);
m_value = value;
m_namespace = namespace;
m_tagName = tagName;
}
/**
* Add namespace detail to the exception.
* @param namespace the namespace of the offending tag.
*/
public void setNamespace(String namespace) {
m_namespace = namespace;
}
/**
* Add tag name detail to the exception.
* @param tagName the name of the offending tag.
*/
public void setTagName(String tagName) {
m_tagName = tagName;
}
/**
* Append useful parsing details onto the default message.
* @return the parent's message plus "caused by value" addendum.
*/
public String getMessage() {
return super.getMessage() + ", caused by value '" + m_value + "' for tag '" +
( m_namespace == null ? "" : m_namespace + ":" ) + m_tagName + "'";
}
/**
* This is only used for testing purposes.
* @param obj what to compare against.
* @return true or false
*/
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (getClass() != obj.getClass())
return false;
final JiBXParseException other = (JiBXParseException) obj;
if (m_namespace == null) {
if (other.m_namespace != null)
return false;
} else if (!m_namespace.equals(other.m_namespace))
return false;
if (m_tagName == null) {
if (other.m_tagName != null)
return false;
} else if (!m_tagName.equals(other.m_tagName))
return false;
if (m_value == null) {
if (other.m_value != null)
return false;
} else if (!m_value.equals(other.m_value))
return false;
return true;
}
}
libjibx-java-1.1.6a/build/src/org/jibx/runtime/QName.java 0000644 0001750 0001750 00000030305 10673571742 023057 0 ustar moeller moeller /*
Copyright (c) 2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.runtime;
import java.util.ArrayList;
import org.jibx.runtime.impl.MarshallingContext;
import org.jibx.runtime.impl.UnmarshallingContext;
/**
*
Representation of a qualified name. This includes the JiBX
* serializer/deserializer methods for the representation. It assumes that the
* actual namespace declarations are being handled separately for
* marshalling
*
*
Note that this implementation treats only the namespace and local name as
* significant for purposes of comparing values. The prefix is held only as a
* convenience, and the actual prefix used when writing a value may differ from
* the prefix defined by the instance.
Performance tests
For performance tests of the data binding frameworks I generated documents
containing mock airline flight timetable information. These are based
on the same structure I defined in the earlier article on mapped
data binding with Castor. Here's a sample of that structure, herein referred
to as the "compact" format because it uses mainly attributes for data:
TomSawyer1-800-555-1212after current
libjibx-java-1.1.6a/build/test/extras/jdomcontact0.xml 0000644 0001750 0001750 00000000221 10267761534 022603 0 ustar moeller moeller
TomSawyer1-800-555-1212
libjibx-java-1.1.6a/build/test/extras/jdomcontact1.xml 0000644 0001750 0001750 00000000556 10267761534 022617 0 ustar moeller moeller
TomSawyer1-800-555-1212Additional Info First LineAdditional Info Second Line
libjibx-java-1.1.6a/build/test/extras/names0.xml 0000644 0001750 0001750 00000000011 10071714432 021362 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/extras/names1.xml 0000644 0001750 0001750 00000000542 10217762724 021405 0 ustar moeller moeller TomSawyerGeorgeSmithAdamSmithHuckFinn
libjibx-java-1.1.6a/build/test/extras/names2.xml 0000644 0001750 0001750 00000000577 10217762724 021416 0 ustar moeller moeller TomSawyerGeorgeSmithAdamSmithHuckFinn
libjibx-java-1.1.6a/build/test/extras/names3.xml 0000644 0001750 0001750 00000000762 10217762724 021413 0 ustar moeller moeller TomSawyerGeorgeSmithAdamSmithHuckFinn
libjibx-java-1.1.6a/build/test/extras/names3b.xml 0000644 0001750 0001750 00000000720 10217762724 021547 0 ustar moeller moeller TomSawyerGeorgeSmithAdamSmithHuckFinn
libjibx-java-1.1.6a/build/test/extras/qnames1.xml 0000644 0001750 0001750 00000000245 10267761460 021567 0 ustar moeller moeller ns1:qnamens2:qname
libjibx-java-1.1.6a/build/test/extras/qnames2.xml 0000644 0001750 0001750 00000000211 10267761460 021561 0 ustar moeller moeller ns2:qnamens3:qname
libjibx-java-1.1.6a/build/test/extras/values0.xml 0000644 0001750 0001750 00000000613 10311007620 021555 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/extras/values1.xml 0000644 0001750 0001750 00000000734 10311007620 021562 0 ustar moeller moeller 2004-08-06T00:13:31.587Z0.00string0
libjibx-java-1.1.6a/build/test/java5/ 0000755 0001750 0001750 00000000000 11023035622 017160 5 ustar moeller moeller libjibx-java-1.1.6a/build/test/java5/Customer1.java 0000644 0001750 0001750 00000003416 10752422732 021723 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package java5;
public class Customer1
{
public String firstName;
public String lastName;
public String street1;
public String city;
public String state;
public String zip;
public String phone;
public Credit credit;
public Quality1 quality;
public enum Credit { BROKE, MAKING_DO, FLUSH }
}
libjibx-java-1.1.6a/build/test/java5/Customer2.java 0000644 0001750 0001750 00000004073 10752422732 021724 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package java5;
public class Customer2
{
public String firstName;
public String lastName;
public String street1;
public String city;
public String state;
public String zip;
public String phone;
public Credit credit;
public Quality2 quality;
public enum Credit {
BROKE("broke, busted, flat"), MAKING_DO("hanging on, hand-to-mouth"),
FLUSH("got it all");
private String xmlText;
private Credit(String text) {
xmlText = text;
}
private String textValue() {
return xmlText;
}
}
}
libjibx-java-1.1.6a/build/test/java5/Quality1.java 0000644 0001750 0001750 00000003021 10752422732 021542 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package java5;
public enum Quality1
{
GOOD, BAD, UGLY
}
libjibx-java-1.1.6a/build/test/java5/Quality2.java 0000644 0001750 0001750 00000003366 10752422732 021557 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package java5;
public enum Quality2
{
GOOD("good, but not great"), BAD("not even a little good"), UGLY("like C code");
private String text;
private Quality2(String text) {
this.text = text;
}
public String toText() {
return text;
}
}
libjibx-java-1.1.6a/build/test/java5/binding1.xml 0000644 0001750 0001750 00000001043 10434346640 021405 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/java5/binding2.xml 0000644 0001750 0001750 00000001144 10752422732 021410 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/java5/simple1.xml 0000644 0001750 0001750 00000000552 10434346640 021270 0 ustar moeller moeller
ÉmilePoincarérte st Antoine de Ginestière’ParisFR9805901 44 27 67 93MAKING_DOGOOD
libjibx-java-1.1.6a/build/test/java5/simple2.xml 0000644 0001750 0001750 00000000611 10752422732 021265 0 ustar moeller moeller
ÉmilePoincarérte st Antoine de Ginestière’ParisFR9805901 44 27 67 93hanging on, hand-to-mouthgood, but not great
libjibx-java-1.1.6a/build/test/multiple/ 0000755 0001750 0001750 00000000000 11023035622 020005 5 ustar moeller moeller libjibx-java-1.1.6a/build/test/multiple/AirportBean.java 0000644 0001750 0001750 00000004537 10071714436 023100 0 ustar moeller moeller /*
Copyright (c) 2002,2003, Sosnoski Software Solutions, Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package multiple;
/**
* Airport information.
*
* @author Dennis M. Sosnoski
* @version 0.8
*/
public class AirportBean
{ private String m_ident;
private String m_name;
private String m_location;
public AirportBean() {}
public void setIdent(String ident) {
m_ident = ident;
}
public String getIdent() {
return m_ident;
}
public void setName(String name) {
m_name = name;
}
public String getName() {
return m_name;
}
public void setLocation(String location) {
m_location = location;
}
public String getLocation() {
return m_location;
}
public boolean equals(Object obj) {
if (obj instanceof AirportBean) {
AirportBean compare = (AirportBean)obj;
return Utils.equalStrings(m_ident, compare.m_ident) &&
Utils.equalStrings(m_name, compare.m_name) &&
Utils.equalStrings(m_location, compare.m_location);
} else {
return false;
}
}
}
libjibx-java-1.1.6a/build/test/multiple/CarrierBean.java 0000644 0001750 0001750 00000004733 10071714436 023045 0 ustar moeller moeller /*
Copyright (c) 2002,2003, Sosnoski Software Solutions, Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package multiple;
/**
* Carrier information.
*
* @author Dennis M. Sosnoski
* @version 0.8
*/
public class CarrierBean
{
private String m_ident;
private String m_name;
private String m_url;
private int m_rating;
public CarrierBean() {}
public void setIdent(String ident) {
m_ident = ident;
}
public String getIdent() {
return m_ident;
}
public void setName(String name) {
m_name = name;
}
public String getName() {
return m_name;
}
public void setURL(String url) {
m_url = url;
}
public String getURL() {
return m_url;
}
public void setRating(int rating) {
m_rating = rating;
}
public int getRating() {
return m_rating;
}
public boolean equals(Object obj) {
if (obj instanceof CarrierBean) {
CarrierBean compare = (CarrierBean)obj;
return Utils.equalStrings(m_ident, compare.m_ident) &&
Utils.equalStrings(m_name, compare.m_name) &&
Utils.equalStrings(m_url, compare.m_url) &&
m_rating == compare.m_rating;
} else {
return false;
}
}
}
libjibx-java-1.1.6a/build/test/multiple/FlightBean.java 0000644 0001750 0001750 00000005530 10071714436 022667 0 ustar moeller moeller /*
Copyright (c) 2002,2003, Sosnoski Software Solutions, Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package multiple;
/**
* Flight information.
*
* @author Dennis M. Sosnoski
* @version 0.8
*/
public class FlightBean
{
private CarrierBean m_carrier;
private int m_number;
private int m_departure;
private int m_arrival;
public FlightBean() {}
public void setCarrier(CarrierBean carrier) {
m_carrier = carrier;
}
public CarrierBean getCarrier() {
return m_carrier;
}
public void setNumber(int number) {
m_number = number;
}
public int getNumber() {
return m_number;
}
public void setDeparture(int minute) {
m_departure = minute;
}
public int getDeparture() {
return m_departure;
}
public void setDepartureTime(String time) {
m_departure = Utils.timeToMinute(time);
}
public String getDepartureTime() {
return Utils.minuteToTime(m_departure);
}
public void setArrival(int minute) {
m_arrival = minute;
}
public int getArrival() {
return m_arrival;
}
public void setArrivalTime(String time) {
m_arrival = Utils.timeToMinute(time);
}
public String getArrivalTime() {
return Utils.minuteToTime(m_arrival);
}
public boolean equals(Object obj) {
if (obj instanceof FlightBean) {
FlightBean compare = (FlightBean)obj;
return Utils.equalCarriers(m_carrier, compare.m_carrier) &&
m_number == compare.m_number &&
m_departure == compare.m_departure &&
m_arrival == compare.m_arrival;
} else {
return false;
}
}
}
libjibx-java-1.1.6a/build/test/multiple/FlightIdentityBean.java 0000644 0001750 0001750 00000006071 10221061036 024366 0 ustar moeller moeller /*
Copyright (c) 2002,2003, Sosnoski Software Solutions, Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package multiple;
import java.util.Date;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.Utility;
/**
* Flight identity information.
*
* @author Dennis M. Sosnoski
* @version 0.8
*/
public class FlightIdentityBean
{
private static Date s_defaultStartDate;
private static Date s_defaultEndDate;
{
try {
s_defaultStartDate = Utility.deserializeDate("2003-01-01");
s_defaultEndDate = Utility.deserializeDate("2005-12-31");
} catch (JiBXException ex) {
s_defaultStartDate = s_defaultEndDate = new Date();
}
}
private CarrierBean m_carrier;
private String m_id;
private int m_number;
private double m_onTime;
private Date m_startDate;
private Date m_endDate;
public FlightIdentityBean() {}
public void setCarrier(CarrierBean carrier) {
m_carrier = carrier;
}
public CarrierBean getCarrier() {
return m_carrier;
}
public void setNumber(int number) {
m_number = number;
}
public int getNumber() {
return m_number;
}
public void preset() {
m_onTime = 0.5D;
}
public void postComplete() {
if (m_startDate == null) {
m_startDate = s_defaultStartDate;
}
if (m_endDate == null) {
m_endDate = s_defaultEndDate;
}
}
public void preget() {
m_onTime *= 1.5D;
}
public boolean equals(Object obj) {
if (obj instanceof FlightBean) {
FlightIdentityBean compare = (FlightIdentityBean)obj;
return Utils.equalCarriers(m_carrier, compare.m_carrier) &&
m_number == compare.m_number &&
Utils.equalDates(m_startDate, compare.m_startDate) &&
Utils.equalDates(m_endDate, compare.m_endDate);
} else {
return false;
}
}
}
libjibx-java-1.1.6a/build/test/multiple/FlightTimesBean.java 0000644 0001750 0001750 00000004244 10071714436 023672 0 ustar moeller moeller /*
Copyright (c) 2002,2003, Sosnoski Software Solutions, Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package multiple;
/**
* Flight time information.
*
* @author Dennis M. Sosnoski
* @version 0.8
*/
public class FlightTimesBean
{
private int m_departure;
private int m_arrival;
public FlightTimesBean() {}
public void setDeparture(int minute) {
m_departure = minute;
}
public int getDeparture() {
return m_departure;
}
public void setArrival(int minute) {
m_arrival = minute;
}
public int getArrival() {
return m_arrival;
}
public boolean equals(Object obj) {
if (obj instanceof FlightTimesBean) {
FlightTimesBean compare = (FlightTimesBean)obj;
return m_departure == compare.m_departure &&
m_arrival == compare.m_arrival;
} else {
return false;
}
}
}
libjibx-java-1.1.6a/build/test/multiple/RouteBean.java 0000644 0001750 0001750 00000004627 10071714436 022556 0 ustar moeller moeller /*
Copyright (c) 2002,2003, Sosnoski Software Solutions, Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package multiple;
import java.util.ArrayList;
/**
* Route information.
*
* @author Dennis M. Sosnoski
* @version 0.8
*/
public class RouteBean
{
private AirportBean m_from;
private AirportBean m_to;
private ArrayList m_flights;
public RouteBean() {
m_flights = new ArrayList();
}
public void setFrom(AirportBean from) {
m_from = from;
}
public AirportBean getFrom() {
return m_from;
}
public void setTo(AirportBean to) {
m_to = to;
}
public AirportBean getTo() {
return m_to;
}
public ArrayList getFlights() {
return m_flights;
}
public void addFlight(FlightBean flight) {
m_flights.add(flight);
}
public boolean equals(Object obj) {
if (obj instanceof RouteBean) {
RouteBean compare = (RouteBean)obj;
return Utils.equalAirports(m_to, compare.m_to) &&
Utils.equalAirports(m_from, compare.m_from) &&
Utils.equalLists(m_flights, compare.m_flights);
} else {
return false;
}
}
}
libjibx-java-1.1.6a/build/test/multiple/SplitFlightBean.java 0000644 0001750 0001750 00000003742 10071714436 023706 0 ustar moeller moeller /*
Copyright (c) 2002,2003, Sosnoski Software Solutions, Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package multiple;
/**
* Flight information in child objects.
*
* @author Dennis M. Sosnoski
* @version 0.8
*/
public class SplitFlightBean
{
private FlightIdentityBean m_identity;
private FlightTimesBean m_times;
public SplitFlightBean() {}
public boolean equals(Object obj) {
if (obj instanceof SplitFlightBean) {
SplitFlightBean compare = (SplitFlightBean)obj;
return m_identity.equals(compare.m_identity) &&
m_times.equals(compare.m_times);
} else {
return false;
}
}
}
libjibx-java-1.1.6a/build/test/multiple/SplitRouteBean.java 0000644 0001750 0001750 00000004713 10071714436 023566 0 ustar moeller moeller /*
Copyright (c) 2002,2003, Sosnoski Software Solutions, Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package multiple;
import java.util.ArrayList;
/**
* Route bean with split route information.
*
* @author Dennis M. Sosnoski
* @version 0.8
*/
public class SplitRouteBean
{
private AirportBean m_from;
private AirportBean m_to;
private ArrayList m_flights;
public SplitRouteBean() {
m_flights = new ArrayList();
}
public void setFrom(AirportBean from) {
m_from = from;
}
public AirportBean getFrom() {
return m_from;
}
public void setTo(AirportBean to) {
m_to = to;
}
public AirportBean getTo() {
return m_to;
}
public ArrayList getFlights() {
return m_flights;
}
public void addFlight(SplitFlightBean flight) {
m_flights.add(flight);
}
public boolean equals(Object obj) {
if (obj instanceof SplitRouteBean) {
SplitRouteBean compare = (SplitRouteBean)obj;
return Utils.equalAirports(m_to, compare.m_to) &&
Utils.equalAirports(m_from, compare.m_from) &&
Utils.equalLists(m_flights, compare.m_flights);
} else {
return false;
}
}
}
libjibx-java-1.1.6a/build/test/multiple/SplitTableBean.java 0000644 0001750 0001750 00000005420 10221061040 023472 0 ustar moeller moeller /*
Copyright (c) 2002,2003, Sosnoski Software Solutions, Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package multiple;
import java.util.ArrayList;
/**
* Flight timetable information with split flights.
*
* @author Dennis M. Sosnoski
* @version 0.8
*/
public class SplitTableBean
{
private ArrayList m_carriers;
private ArrayList m_airports;
private ArrayList m_flights; // used only where flights are predefined in
// collection and then referenced
private ArrayList m_routes;
public SplitTableBean() {
m_carriers = new ArrayList();
m_airports = new ArrayList();
m_flights = new ArrayList();
m_routes = new ArrayList();
}
public ArrayList getCarriers() {
return m_carriers;
}
public void addCarrier(CarrierBean carrier) {
m_carriers.add(carrier);
}
public ArrayList getAirports() {
return m_airports;
}
public void addAirport(AirportBean airport) {
m_airports.add(airport);
}
public ArrayList getRoutes() {
return m_routes;
}
public void addRoute(SplitRouteBean route) {
m_routes.add(route);
}
public boolean equals(Object obj) {
if (obj instanceof SplitTableBean) {
SplitTableBean compare = (SplitTableBean)obj;
return Utils.equalLists(m_routes, compare.m_routes) &&
Utils.equalLists(m_airports, compare.m_airports) &&
Utils.equalLists(m_carriers, compare.m_carriers);
} else {
return false;
}
}
}
libjibx-java-1.1.6a/build/test/multiple/TimeTableBean.java 0000644 0001750 0001750 00000005066 10071714436 023324 0 ustar moeller moeller /*
Copyright (c) 2002,2003, Sosnoski Software Solutions, Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package multiple;
import java.util.ArrayList;
/**
* Flight timetable information.
*
* @author Dennis M. Sosnoski
* @version 0.8
*/
public class TimeTableBean
{
private ArrayList m_carriers;
private ArrayList m_airports;
private ArrayList m_routes;
public TimeTableBean() {
m_carriers = new ArrayList();
m_airports = new ArrayList();
m_routes = new ArrayList();
}
public ArrayList getCarriers() {
return m_carriers;
}
public void addCarrier(CarrierBean carrier) {
m_carriers.add(carrier);
}
public ArrayList getAirports() {
return m_airports;
}
public void addAirport(AirportBean airport) {
m_airports.add(airport);
}
public ArrayList getRoutes() {
return m_routes;
}
public void addRoute(RouteBean route) {
m_routes.add(route);
}
public boolean equals(Object obj) {
if (obj instanceof TimeTableBean) {
TimeTableBean compare = (TimeTableBean)obj;
return Utils.equalLists(m_routes, compare.m_routes) &&
Utils.equalLists(m_airports, compare.m_airports) &&
Utils.equalLists(m_carriers, compare.m_carriers);
} else {
return false;
}
}
}
libjibx-java-1.1.6a/build/test/multiple/Utils.java 0000644 0001750 0001750 00000006743 10071714436 021773 0 ustar moeller moeller /*
Copyright (c) 2002,2003, Sosnoski Software Solutions, Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package multiple;
import java.util.Date;
import java.util.List;
/**
* Static utility class providing comparison methods.
*
* @author Dennis M. Sosnoski
* @version 0.8
*/
public abstract class Utils
{
public static boolean equalStrings(String a, String b) {
return (a == null && b == null) || a.equals(b);
}
public static boolean equalLists(List a, List b) {
return (a == null && b == null) || a.equals(b);
}
public static boolean equalAirports(AirportBean a, AirportBean b) {
return (a == null && b == null) || (a != null && a.equals(b));
}
public static boolean equalCarriers(CarrierBean a, CarrierBean b) {
return (a == null && b == null) || (a != null && a.equals(b));
}
public static boolean equalDates(Date a, Date b) {
return (a == null && b == null) || (a != null && a.equals(b));
}
public static int timeToMinute(String time) {
// find split between hour and minute
int mark = time.indexOf(':');
if (mark > 0) {
// convert hour to adjusted range (0-11)
int hour = Integer.parseInt(time.substring(0, mark));
if (hour == 12) {
hour = 0;
}
// find minute value
String mins = time.substring(mark+1, time.length()-1);
int minute = Integer.parseInt(mins);
// check am/pm flag
char last = time.charAt(time.length()-1);
boolean pm = Character.toLowerCase(last) == 'p';
// return minute number of flight time
return ((pm ? 12 : 0) + hour)*60 + minute;
} else {
throw new IllegalArgumentException("Not a valid time: " + time);
}
}
public static String minuteToTime(int minute) {
// find hour in quirky am/pm form
int hour = minute / 60;
boolean pm = false;
if (hour >= 12) {
hour -= 12;
pm = true;
}
if (hour == 0) {
hour = 12;
}
// convert minute value to double-digit text
minute %= 60;
String mtext = Integer.toString(minute);
if (mtext.length() == 1) {
mtext = '0' + mtext;
}
// return complete time text
return Integer.toString(hour) + ':' + mtext + (pm ? 'p' : 'a');
}
}
libjibx-java-1.1.6a/build/test/org/ 0000755 0001750 0001750 00000000000 11021525452 016744 5 ustar moeller moeller libjibx-java-1.1.6a/build/test/org/jibx/ 0000755 0001750 0001750 00000000000 11021525452 017700 5 ustar moeller moeller libjibx-java-1.1.6a/build/test/org/jibx/binding/ 0000755 0001750 0001750 00000000000 11021525452 021312 5 ustar moeller moeller libjibx-java-1.1.6a/build/test/org/jibx/binding/generator/ 0000755 0001750 0001750 00000000000 11023035622 023275 5 ustar moeller moeller libjibx-java-1.1.6a/build/test/org/jibx/binding/generator/BindingGeneratorCommandLineTest.java 0000644 0001750 0001750 00000007744 10602647122 032352 0 ustar moeller moeller /*
Copyright (c) 2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import java.util.Collection;
import junit.framework.TestCase;
/**
* Test code for command line processing.
*/
public class BindingGeneratorCommandLineTest extends TestCase
{
private static String[] OVERRIDE_ARGS = new String[] {
"--property-access=false",
"--require=none",
"--namespace-style=fixed",
"--namespace=http://www.sosnoski.com/ws",
"--name-style=camel-case",
"--strip-prefixes=s_ m_"
};
public void testOverrides() throws Exception {
BindingGeneratorCommandLine cmd = new BindingGeneratorCommandLine();
assertTrue("Basic argument processing", cmd.processArgs(OVERRIDE_ARGS));
ClassCustom clas = cmd.getGlobal().forceClassCustomization("org.jibx.binding.generator.DataClass1");
assertFalse("property-access setting", clas.isPropertyAccess());
assertEquals("namespace-style setting", CustomBase.DERIVE_FIXED, clas.getNamespaceStyle());
assertEquals("namespace setting", "http://www.sosnoski.com/ws", clas.getNamespace());
assertEquals("name-style setting", CustomBase.CAMEL_CASE_NAMES, clas.getNameStyle());
assertEquals("derived name", "dataClass1", clas.getElementName());
Collection members = clas.getMembers();
assertEquals("property count", 4, members.size());
MemberCustom member = clas.getMember("boolean");
assertNotNull("boolean member", member);
assertEquals("boolean type", "boolean", member.getWorkingType());
assertEquals("boolean name", "boolean", member.getXmlName());
assertFalse("boolean required", member.isRequired());
member = clas.getMember("int");
assertNotNull("int member", member);
assertEquals("int type", "int", member.getWorkingType());
assertEquals("int name", "int", member.getXmlName());
assertFalse("int required", member.isRequired());
member = clas.getMember("linked");
assertNotNull("linked member", member);
assertEquals("linked type", "org.jibx.binding.generator.DataClass1", member.getWorkingType());
assertEquals("linked name", "linked", member.getXmlName());
assertFalse("linked required", member.isRequired());
member = clas.getMember("string");
assertNotNull("string member", member);
assertEquals("string type", "java.lang.String", member.getWorkingType());
assertEquals("string name", "string", member.getXmlName());
assertFalse("string required", member.isRequired());
}
} libjibx-java-1.1.6a/build/test/org/jibx/binding/generator/ClassCustomTest.java 0000644 0001750 0001750 00000022373 10651201212 027243 0 ustar moeller moeller /*
Copyright (c) 2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import java.util.Collection;
/**
* Test code for class handling.
*/
public class ClassCustomTest extends CustomizationTestBase
{
public static final String SIMPLE_PROPERTIES_CLASS =
"\n" +
" \n" +
" \n" +
" \n" +
"";
public static final String MULTIPLE_FIELDS_CLASSES =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public static final String MULTIPLE_PROPERTIES_CLASSES =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public void testSimplePropertiesClass() throws Exception {
GlobalCustom custom = readCustom(SIMPLE_PROPERTIES_CLASS);
ClassCustom clas = custom.getClassCustomization("org.jibx.binding.generator.DataClass1");
assertTrue("property-access setting", clas.isPropertyAccess());
Collection members = clas.getMembers();
assertEquals("property count", 4, members.size());
MemberCustom member = clas.getMember("boolean");
assertNotNull("boolean member", member);
assertEquals("boolean type", "boolean", member.getWorkingType());
assertEquals("boolean name", "boolean", member.getXmlName());
assertTrue("boolean required", member.isRequired());
member = clas.getMember("int");
assertNotNull("int member", member);
assertEquals("int type", "int", member.getWorkingType());
assertEquals("int name", "int", member.getXmlName());
assertTrue("int required", member.isRequired());
member = clas.getMember("linked");
assertNotNull("linked member", member);
assertEquals("linked type", "org.jibx.binding.generator.DataClass1", member.getWorkingType());
assertEquals("linked name", "linked", member.getXmlName());
assertFalse("linked required", member.isRequired());
member = clas.getMember("string");
assertNotNull("string member", member);
assertEquals("string type", "java.lang.String", member.getWorkingType());
assertEquals("string name", "string", member.getXmlName());
assertFalse("string required", member.isRequired());
}
public void testMultipleFieldsClasses() throws Exception {
GlobalCustom custom = readCustom(MULTIPLE_FIELDS_CLASSES);
ClassCustom clas = custom.getClassCustomization("org.jibx.binding.generator.DataClass2");
Collection members = clas.getMembers();
assertEquals("property count", 1, members.size());
MemberCustom member = clas.getMember("dataClass1s");
assertNotNull("dataClass1s member", member);
assertEquals("dataClass1s type", "java.util.List", member.getWorkingType());
assertEquals("dataClass1s name", "dataClass1s", member.getXmlName());
assertTrue("dataClass1s collection", member instanceof CollectionFieldCustom);
CollectionFieldCustom coll = (CollectionFieldCustom)member;
assertEquals("dataClass1s type", "java.lang.Object", coll.getItemType());
assertEquals("dataClass1s name", "dataClass1", coll.getItemName());
clas = custom.getClassCustomization("org.jibx.binding.generator.DataClass1");
members = clas.getMembers();
assertEquals("property count", 4, members.size());
member = clas.getMember("boolean");
assertNotNull("boolean member", member);
assertEquals("boolean type", "boolean", member.getWorkingType());
assertEquals("boolean name", "boolean", member.getXmlName());
assertFalse("boolean required", member.isRequired());
member = clas.getMember("int");
assertNotNull("int member", member);
assertEquals("int type", "int", member.getWorkingType());
assertEquals("int name", "int", member.getXmlName());
assertFalse("int required", member.isRequired());
member = clas.getMember("linked");
assertNotNull("linked member", member);
assertEquals("linked type", "org.jibx.binding.generator.DataClass1", member.getWorkingType());
assertEquals("linked name", "linked", member.getXmlName());
assertFalse("linked required", member.isRequired());
member = clas.getMember("string");
assertNotNull("string member", member);
assertEquals("string type", "java.lang.String", member.getWorkingType());
assertEquals("string name", "string", member.getXmlName());
assertTrue("string required", member.isRequired());
}
public void testMultiplePropertiesClasses() throws Exception {
GlobalCustom custom = readCustom(MULTIPLE_PROPERTIES_CLASSES);
ClassCustom clas = custom.getClassCustomization("org.jibx.binding.generator.DataClass2");
Collection members = clas.getMembers();
assertEquals("property count", 1, members.size());
MemberCustom member = clas.getMember("dataClass1s");
assertNotNull("dataClass1s member", member);
assertEquals("dataClass1s type", "java.util.List", member.getWorkingType());
assertEquals("dataClass1s name", "dataClass1s", member.getXmlName());
assertFalse("dataClass1s required", member.isRequired());
assertTrue("dataClass1s collection", member instanceof CollectionFieldCustom);
CollectionFieldCustom coll = (CollectionFieldCustom)member;
assertEquals("dataClass1s type", "org.jibx.binding.generator.DataClass1", coll.getItemType());
assertEquals("dataClass1s name", "dataClass1", coll.getItemName());
clas = custom.getClassCustomization("org.jibx.binding.generator.DataClass1");
members = clas.getMembers();
assertEquals("property count", 4, members.size());
member = clas.getMember("boolean");
assertNotNull("boolean member", member);
assertEquals("boolean type", "boolean", member.getWorkingType());
assertEquals("boolean name", "boolean", member.getXmlName());
assertTrue("boolean required", member.isRequired());
member = clas.getMember("int");
assertNotNull("int member", member);
assertEquals("int type", "int", member.getWorkingType());
assertEquals("int name", "int", member.getXmlName());
assertFalse("int required", member.isRequired());
member = clas.getMember("linked");
assertNotNull("linked member", member);
assertEquals("linked type", "org.jibx.binding.generator.DataClass1", member.getWorkingType());
assertEquals("linked name", "linked", member.getXmlName());
assertFalse("linked required", member.isRequired());
member = clas.getMember("string");
assertNotNull("string member", member);
assertEquals("string type", "java.lang.String", member.getWorkingType());
assertEquals("string name", "string", member.getXmlName());
assertTrue("string required", member.isRequired());
}
} libjibx-java-1.1.6a/build/test/org/jibx/binding/generator/CustomizationTestBase.java 0000644 0001750 0001750 00000013333 10651201212 030442 0 ustar moeller moeller /*
Copyright (c) 2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.List;
import junit.framework.TestCase;
import org.jibx.binding.Loader;
import org.jibx.binding.Utility;
import org.jibx.binding.classes.BoundClass;
import org.jibx.binding.classes.ClassCache;
import org.jibx.binding.classes.ClassFile;
import org.jibx.binding.classes.MungedClass;
import org.jibx.binding.def.BindingDefinition;
import org.jibx.runtime.BindingDirectory;
import org.jibx.runtime.IBindingFactory;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
import org.jibx.schema.validation.ValidationContext;
import org.jibx.schema.validation.ValidationProblem;
/**
* Test code for class handling.
*/
public class CustomizationTestBase extends TestCase
{
protected static final String ROOT_CLASS =
"org.jibx.binding.generator.GlobalCustom";
protected static final IBindingFactory m_bindingFactory;
private static final String GlobalCustom = null;
static {
try {
// set paths to be used for loading referenced classes
URL[] urls = Loader.getClassPaths();
String[] paths = new String[urls.length];
for (int i = 0; i < urls.length; i++) {
paths[i] = urls[i].getFile();
}
ClassCache.setPaths(paths);
ClassFile.setPaths(paths);
// find the binding definition
ClassLoader loader = CustomizationTestBase.class.getClassLoader();
InputStream is = loader.getResourceAsStream("org/jibx/binding/generator/binding.xml");
if (is == null) {
throw new RuntimeException("Customizations binding definition not found");
}
// process the binding
BoundClass.reset();
MungedClass.reset();
BindingDefinition.reset();
BindingDefinition def = Utility.loadBinding("binding.xml",
"binding", is, null, true);
def.generateCode(false);
// output the modified class files
MungedClass.fixChanges(true);
// look up the mapped class and associated binding factory
Class mclas = Class.forName(ROOT_CLASS);
m_bindingFactory = BindingDirectory.getFactory(mclas);
} catch (JiBXException e) {
e.printStackTrace();
throw new RuntimeException("JiBXException: " + e.getMessage());
} catch (IOException e) {
throw new RuntimeException("IOException: " + e.getMessage());
} catch (ClassNotFoundException e) {
throw new RuntimeException("ClassNotFoundException: " +
e.getMessage());
}
}
/**
* Read a customization into model from input stream.
*
* @param is input stream
* @return root element
* @throws Exception
*/
protected GlobalCustom readCustom(InputStream is) throws Exception {
IUnmarshallingContext ictx =
m_bindingFactory.createUnmarshallingContext();
ValidationContext vctx = new ValidationContext();
ictx.setDocument(is, null);
ictx.setUserContext(vctx);
GlobalCustom custom = (GlobalCustom)ictx.unmarshalElement();
List problems = vctx.getProblems();
if (problems.size() > 0) {
StringBuffer buff = new StringBuffer();
for (int i = 0; i < problems.size(); i++) {
ValidationProblem prob = (ValidationProblem)problems.get(i);
buff.append(prob.getSeverity() >=
ValidationProblem.ERROR_LEVEL ? "Error: " : "Warning: ");
buff.append(prob.getDescription());
buff.append('\n');
}
fail(buff.toString());
}
custom.fillClasses();
return custom;
}
/**
* Read a customization into model from string.
*
* @param text customization document text
* @return root element
* @throws Exception
*/
protected GlobalCustom readCustom(String text) throws Exception {
return readCustom(new ByteArrayInputStream(text.getBytes("utf-8")));
}
} libjibx-java-1.1.6a/build/test/org/jibx/binding/generator/DataClass1.java 0000644 0001750 0001750 00000001314 10602647122 026065 0 ustar moeller moeller package org.jibx.binding.generator;
public class DataClass1
{
private int m_int;
private String m_string;
private boolean m_boolean;
private DataClass1 m_linked;
public boolean isBoolean() {
return m_boolean;
}
public void setBoolean(boolean b) {
m_boolean = b;
}
public int getInt() {
return m_int;
}
public void setInt(int i) {
m_int = i;
}
public DataClass1 getLinked() {
return m_linked;
}
public void setLinked(DataClass1 linked) {
m_linked = linked;
}
public String getString() {
return m_string;
}
public void setString(String string) {
m_string = string;
}
} libjibx-java-1.1.6a/build/test/org/jibx/binding/generator/DataClass2.java 0000644 0001750 0001750 00000001210 10602647122 026061 0 ustar moeller moeller package org.jibx.binding.generator;
import java.util.List;
public class DataClass2
{
private transient int m_transient;
private static int m_static;
private List m_dataClass1s;
public static int getStatic() {
return m_static;
}
public static void setStatic(int stat) {
m_static = stat;
}
public List getDataClass1s() {
return m_dataClass1s;
}
public void setDataClass1s(List dataClass1s) {
m_dataClass1s = dataClass1s;
}
public int getTransient() {
return m_transient;
}
public void setTransient(int trans) {
m_transient = trans;
}
} libjibx-java-1.1.6a/build/test/org/jibx/binding/generator/DataClass2Generic.java 0000644 0001750 0001750 00000001263 10602647122 027366 0 ustar moeller moeller package org.jibx.binding.generator;
import java.util.List;
public class DataClass2Generic
{
private transient int m_transient;
private static int m_static;
private List m_dataClass1s;
public static int getStatic() {
return m_static;
}
public static void setStatic(int stat) {
m_static = stat;
}
public List getDataClass1s() {
return m_dataClass1s;
}
public void setDataClass1s(List dataClass1s) {
m_dataClass1s = dataClass1s;
}
public int getTransient() {
return m_transient;
}
public void setTransient(int trans) {
m_transient = trans;
}
} libjibx-java-1.1.6a/build/test/org/jibx/binding/generator/GeneratorSuite.java 0000644 0001750 0001750 00000000733 10651201212 027077 0 ustar moeller moeller package org.jibx.binding.generator;
import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;
public class GeneratorSuite extends TestCase
{
public static Test suite() {
TestSuite suite = new TestSuite(BindingGeneratorCommandLineTest.class);
suite.addTestSuite(ClassCustomTest.class);
suite.addTestSuite(GeneratorTest.class);
suite.addTestSuite(NestingBaseTest.class);
return suite;
}
}
libjibx-java-1.1.6a/build/test/org/jibx/binding/generator/GeneratorTest.java 0000644 0001750 0001750 00000012566 10767277472 026771 0 ustar moeller moeller /*
Copyright (c) 2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
import java.net.URL;
import java.util.ArrayList;
import org.jibx.binding.Loader;
import org.jibx.binding.classes.ClassCache;
import org.jibx.binding.classes.ClassFile;
import org.jibx.binding.model.BindingElement;
import org.jibx.binding.model.BindingHolder;
import org.jibx.binding.model.MappingElement;
import org.jibx.schema.codegen.ReferenceCountMap;
/**
* Test code for binding generation.
*/
public class GeneratorTest extends CustomizationTestBase
{
public static final String MULTIPLE_PROPERTIES_CLASSES =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
/* (non-Javadoc)
* @see junit.framework.TestCase#setUp()
*/
protected void setUp() throws Exception {
// set paths to be used for loading referenced classes
URL[] urls = Loader.getClassPaths();
String[] paths = new String[urls.length];
for (int i = 0; i < urls.length; i++) {
paths[i] = urls[i].getFile();
}
ClassCache.setPaths(paths);
ClassFile.setPaths(paths);
}
public void testExpandReferences() {
GlobalCustom custom = new GlobalCustom();
BindingGenerator gen = new BindingGenerator(custom);
ReferenceCountMap refmap = new ReferenceCountMap();
gen.expandReferences("org.jibx.binding.generator.DataClass2Generic",
refmap);
assertEquals("original class references", 0, refmap.getCount("org.jibx.binding.generator.DataClass2Generic"));
assertEquals("referenced class references", 2, refmap.getCount("org.jibx.binding.generator.DataClass1"));
}
public void testMultiplePropertiesClasses() throws Exception {
GlobalCustom custom = readCustom(MULTIPLE_PROPERTIES_CLASSES);
BindingGenerator gen = new BindingGenerator(custom);
ReferenceCountMap refmap = new ReferenceCountMap();
gen.expandReferences("org.jibx.binding.generator.DataClass2Generic",
refmap);
assertEquals("original class references", 0, refmap.getCount("org.jibx.binding.generator.DataClass2"));
assertEquals("referenced class references", 2, refmap.getCount("org.jibx.binding.generator.DataClass1"));
gen.expandReferences("org.jibx.binding.generator.DataClass2Generic",
refmap);
assertEquals("original class references", 0, refmap.getCount("org.jibx.binding.generator.DataClass2Generic"));
assertEquals("referenced class references", 3, refmap.getCount("org.jibx.binding.generator.DataClass1"));
}
public void testSingleClassBinding() {
GlobalCustom custom = new GlobalCustom();
custom.initClasses();
custom.fillClasses();
BindingGenerator gen = new BindingGenerator(custom);
ArrayList types = new ArrayList();
types.add("org.jibx.binding.generator.DataClass1");
gen.generate(null, types);
BindingHolder hold = gen.getBinding("http://jibx.org/binding/generator");
assertNotNull("default namespace binding", hold);
BindingElement binding = hold.getBinding();
ArrayList childs = binding.topChildren();
assertEquals("child count", 2, childs.size());
Object child = childs.get(1);
assertTrue("child type", child instanceof MappingElement);
MappingElement mapping = (MappingElement)child;
assertEquals("mapped class", mapping.getClassName(), "org.jibx.binding.generator.DataClass1");
assertEquals("mapped items", 4, mapping.children().size());
}
} libjibx-java-1.1.6a/build/test/org/jibx/binding/generator/NestingBaseTest.java 0000644 0001750 0001750 00000027301 10651201212 027201 0 ustar moeller moeller /*
Copyright (c) 2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.binding.generator;
/**
* Test code for nested property handling.
*/
public class NestingBaseTest extends CustomizationTestBase
{
public static final String SIMPLE_CUSTOM =
"";
public static final String SIMPLE_PACKAGE =
"\n" +
" \n" +
"";
public static final String NESTED_PACKAGE =
"\n" +
" \n" +
" \n" +
" \n" +
"";
public static final String MULTIPLE_PACKAGE =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public static final String MULTIPLE_PACKAGE_HYPHENATED =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public static final String MULTIPLE_PACKAGE_UPPERCAMELCASE =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public static final String MULTIPLE_PACKAGE_DOTTED =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public static final String MULTIPLE_PACKAGE_UNDERSCORED =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public void testSimpleCustom() throws Exception {
GlobalCustom custom = readCustom(SIMPLE_CUSTOM);
assertFalse("add-constructors default", custom.isAddConstructors());
assertFalse("force-classes default", custom.isForceClasses());
assertTrue("input default", custom.isInput());
assertTrue("output default", custom.isOutput());
assertFalse("map-abstract default", custom.isMapAbstract());
assertFalse("namespace-modular default", custom.isNamespaceModular());
assertEquals("name style default", NestingBase.CAMEL_CASE_NAMES, custom.getNameStyle());
assertEquals("value style default", NestingBase.ATTRIBUTE_VALUE_STYLE, custom.getValueStyle("int"));
assertFalse("require setting", custom.isObjectRequired("java.lang.String"));
assertTrue("require setting", custom.isPrimitiveRequired("int"));
assertTrue("property-access setting", custom.isPropertyAccess());
assertEquals("get root", custom, custom.getGlobal());
assertNull("empty namespace",custom.getNamespace());
}
public void testSimplePackage() throws Exception {
GlobalCustom custom = readCustom(SIMPLE_PACKAGE);
PackageCustom pack = custom.getPackage("org.jibx.binding");
assertFalse("map-abstract default", pack.isMapAbstract());
assertEquals("name style default", NestingBase.CAMEL_CASE_NAMES, pack.getNameStyle());
assertEquals("value style default", NestingBase.ATTRIBUTE_VALUE_STYLE, pack.getValueStyle("int"));
assertFalse("require setting", pack.isObjectRequired("java.lang.String"));
assertTrue("require setting", pack.isPrimitiveRequired("int"));
assertFalse("property-access setting", pack.isPropertyAccess());
assertEquals("get root", custom, pack.getGlobal());
assertEquals("package namespace", "urn:binding", pack.getNamespace());
}
public void testNestedPackage() throws Exception {
GlobalCustom custom = readCustom(NESTED_PACKAGE);
PackageCustom pack = custom.getPackage("org.jibx.binding.generator");
assertFalse("map-abstract default", pack.isMapAbstract());
assertEquals("name style default", NestingBase.CAMEL_CASE_NAMES, pack.getNameStyle());
assertEquals("value style default", NestingBase.ATTRIBUTE_VALUE_STYLE, pack.getValueStyle("int"));
assertFalse("require setting", pack.isObjectRequired("java.lang.String"));
assertTrue("require setting", pack.isPrimitiveRequired("int"));
assertTrue("property-access setting", pack.isPropertyAccess());
assertEquals("get root", custom, pack.getGlobal());
assertEquals("package namespace", "urn:binding/generator", pack.getNamespace());
}
public void testMultiplePackage() throws Exception {
GlobalCustom custom = readCustom(MULTIPLE_PACKAGE);
PackageCustom pack = custom.getPackage("org.jibx.binding.generator");
assertTrue("property-access setting", pack.isPropertyAccess());
assertEquals("package namespace", "urn:binding.generator", pack.getNamespace());
pack = custom.getPackage("org.jibx.runtime");
assertTrue("property-access setting", pack.isPropertyAccess());
assertEquals("package namespace", "urn:runtime", pack.getNamespace());
pack = custom.getPackage("org.jibx.extras");
assertFalse("property-access setting", pack.isPropertyAccess());
assertNull("package namespace", pack.getNamespace());
assertEquals("simple name", "a", pack.convertName("a"));
assertEquals("simple name", "a", pack.convertName("A"));
assertEquals("simple name", "aName", pack.convertName("aName"));
assertEquals("leading underscore name", "aName",
pack.convertName("__aName"));
assertEquals("embedded underscores name", "aName",
pack.convertName("a__Name"));
assertEquals("complex name", "aBCDefgH",
pack.convertName("aB_cDefgH"));
}
public void testHyphenated() throws Exception {
GlobalCustom custom = readCustom(MULTIPLE_PACKAGE_HYPHENATED);
PackageCustom pack = custom.getPackage("org.jibx.binding.generator");
assertEquals("simple name", "a", pack.convertName("a"));
assertEquals("simple name", "a", pack.convertName("A"));
assertEquals("simple name", "a-name", pack.convertName("aName"));
assertEquals("leading underscore name", "a-name",
pack.convertName("__aName"));
assertEquals("embedded underscores name", "a-name",
pack.convertName("a__Name"));
assertEquals("complex name", "a-b-c-defg-h",
pack.convertName("aB_cDefgH"));
}
public void testUpperCamelCase() throws Exception {
GlobalCustom custom = readCustom(MULTIPLE_PACKAGE_UPPERCAMELCASE);
PackageCustom pack = custom.getPackage("org.jibx.binding.generator");
assertEquals("simple name", "A", pack.convertName("a"));
assertEquals("simple name", "A", pack.convertName("A"));
assertEquals("simple name", "AName", pack.convertName("aName"));
assertEquals("leading underscore name", "AName",
pack.convertName("__aName"));
assertEquals("embedded underscores name", "AName",
pack.convertName("a__Name"));
assertEquals("complex name", "ABCDefgH",
pack.convertName("aB_cDefgH"));
}
public void testDotted() throws Exception {
GlobalCustom custom = readCustom(MULTIPLE_PACKAGE_DOTTED);
PackageCustom pack = custom.getPackage("org.jibx.binding.generator");
assertEquals("simple name", "a", pack.convertName("a"));
assertEquals("simple name", "a", pack.convertName("A"));
assertEquals("simple name", "a.name", pack.convertName("aName"));
assertEquals("leading underscore name", "a.name",
pack.convertName("__aName"));
assertEquals("embedded underscores name", "a.name",
pack.convertName("a__Name"));
assertEquals("complex name", "a.b.c.defg.h",
pack.convertName("aB_cDefgH"));
}
public void testUnderscored() throws Exception {
GlobalCustom custom = readCustom(MULTIPLE_PACKAGE_UNDERSCORED);
PackageCustom pack = custom.getPackage("org.jibx.binding.generator");
assertEquals("simple name", "a", pack.convertName("a"));
assertEquals("simple name", "a", pack.convertName("A"));
assertEquals("simple name", "a_name", pack.convertName("aName"));
assertEquals("leading underscore name", "a_name",
pack.convertName("__aName"));
assertEquals("embedded underscores name", "a_name",
pack.convertName("a__Name"));
assertEquals("complex name", "a_b_c_defg_h",
pack.convertName("aB_cDefgH"));
}
} libjibx-java-1.1.6a/build/test/org/jibx/match/ 0000755 0001750 0001750 00000000000 11023035622 020771 5 ustar moeller moeller libjibx-java-1.1.6a/build/test/org/jibx/match/TestLoader.java 0000644 0001750 0001750 00000011374 10434261102 023707 0 ustar moeller moeller /*
Copyright (c) 2003-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.match;
import java.io.File;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import org.jibx.binding.Loader;
/**
* Test program for the JiBX framework. Works with sets of three input
* parameters: binding-resource, mapped-class, in-file. Unmarshals documents
* from files using the binding defined for the mapped class, then marshals them
* back out using the same bindings and compares the results. In case of a
* comparison error the output file is left as temp.xml.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class TestLoader
{
private static final Class[] RUNNER_PARAM_TYPES =
{
String.class, String.class, String.class
};
private TestLoader() {}
public static void main(String[] args) {
if (args.length >= 3 && args.length % 3 == 0) {
// delete generated output file if present
File temp = new File("temp.xml");
if (temp.exists()) {
temp.delete();
}
// process each set of three arguments
boolean err = false;
int offset = 0;
String[] pargs = new String[3];
ClassLoader base = Thread.currentThread().getContextClassLoader();
for (; offset < args.length; offset += 3) {
try {
// load the test runner class using new custom class loader
Thread.currentThread().setContextClassLoader(base);
Loader loader = new Loader();
loader.loadResourceBinding(args[offset]);
// invoke the "runTest" method of the runner class
Thread.currentThread().setContextClassLoader(loader);
Class clas = loader.loadClass("org.jibx.match.TestRunner");
Method test = clas.getDeclaredMethod("runTest",
RUNNER_PARAM_TYPES);
pargs[0] = args[offset+1];
pargs[1] = args[offset+2];
pargs[2] = args[offset+2];
Boolean result = (Boolean)test.invoke(null, pargs);
if (!result.booleanValue()) {
err = true;
break;
}
} catch (InvocationTargetException ex) {
ex.getTargetException().printStackTrace();
err = true;
break;
} catch (Exception ex) {
ex.printStackTrace();
err = true;
break;
}
}
// take error exit if difference found
if (err) {
System.err.println("Error on argument set: " + args[offset] +
", " + args[offset+1] + ", " + args[offset+2]);
System.err.println("File path " + temp.getAbsolutePath());
System.exit(1);
}
} else {
System.err.println("Requires arguments in sets of three:\n" +
" binding-resource mapped-class in-file\n" +
"Leaves output as temp.xml in case of error");
System.exit(1);
}
}
}
libjibx-java-1.1.6a/build/test/org/jibx/match/TestLoaderDiff.java 0000644 0001750 0001750 00000011770 10210704526 024504 0 ustar moeller moeller /*
Copyright (c) 2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.match;
import java.io.File;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import org.jibx.binding.Loader;
/**
* Test program for the JiBX framework. Works with sets of four input
* parameters: binding-resource, mapped-class, in-file, comp-file. Unmarshals
* documents from files using the binding defined for the mapped class, then
* marshals them back out using the same bindings and compares the results to
* the comparison file. This form of test is intended for asymmetric bindings,
* where the output differs from the input. In case of a comparison error the
* output file is left as temp.xml.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class TestLoaderDiff
{
private static final Class[] RUNNER_PARAM_TYPES =
{
String.class, String.class, String.class
};
private TestLoaderDiff() {}
public static void main(String[] args)
throws ClassNotFoundException, NoSuchMethodException {
if (args.length >= 4 && args.length % 4 == 0) {
// delete generated output file if present
File temp = new File("temp.xml");
if (temp.exists()) {
temp.delete();
}
// process each set of three arguments
boolean err = false;
int offset = 0;
String[] pargs = new String[3];
ClassLoader base = Thread.currentThread().getContextClassLoader();
for (; offset < args.length; offset += 4) {
try {
// load the test runner class using new custom class loader
Thread.currentThread().setContextClassLoader(base);
Loader loader = new Loader();
loader.loadResourceBinding(args[offset]);
// invoke the "runTest" method of the runner class
Thread.currentThread().setContextClassLoader(loader);
Class clas = loader.loadClass("org.jibx.match.TestRunner");
Method test = clas.getDeclaredMethod("runTest",
RUNNER_PARAM_TYPES);
pargs[0] = args[offset+1];
pargs[1] = args[offset+2];
pargs[2] = args[offset+3];
Boolean result = (Boolean)test.invoke(null, pargs);
if (!result.booleanValue()) {
err = true;
break;
}
} catch (InvocationTargetException ex) {
ex.getTargetException().printStackTrace();
err = true;
break;
} catch (Exception ex) {
ex.printStackTrace();
err = true;
break;
}
}
// take error exit if difference found
if (err) {
System.err.println("Error on argument set: " +
args[offset] + ", " + args[offset+1] + ", " + args[offset+2] +
", " + args[offset+3]);
System.err.println("File path " + temp.getAbsolutePath());
System.exit(1);
}
} else {
System.err.println("Requires arguments in sets of four:\n" +
" binding-resource mapped-class in-file comp-file\n" +
"Leaves output as temp.xml in case of error");
System.exit(1);
}
}
} libjibx-java-1.1.6a/build/test/org/jibx/match/TestLoaderStAX.java 0000644 0001750 0001750 00000011437 10434261102 024447 0 ustar moeller moeller /*
Copyright (c) 2003-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.match;
import java.io.File;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import org.jibx.binding.Loader;
/**
* Test program for the JiBX framework. Works with sets of three input
* parameters: binding-resource, mapped-class, in-file. Unmarshals documents
* from files using the binding defined for the mapped class, then marshals them
* back out using the same bindings and compares the results. In case of a
* comparison error the output file is left as temp.xml.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class TestLoaderStAX
{
private static final Class[] RUNNER_PARAM_TYPES =
{
String.class, String.class, String.class
};
private TestLoaderStAX() {}
public static void main(String[] args) {
if (args.length >= 3 && args.length % 3 == 0) {
// delete generated output file if present
File temp = new File("temp.xml");
if (temp.exists()) {
temp.delete();
}
// process each set of three arguments
boolean err = false;
int offset = 0;
String[] pargs = new String[3];
ClassLoader base = Thread.currentThread().getContextClassLoader();
for (; offset < args.length; offset += 3) {
try {
// load the test runner class using new custom class loader
Thread.currentThread().setContextClassLoader(base);
Loader loader = new Loader();
loader.loadResourceBinding(args[offset]);
// invoke the "runTest" method of the runner class
Thread.currentThread().setContextClassLoader(loader);
Class clas =
loader.loadClass("org.jibx.match.TestRunnerStAX");
Method test = clas.getDeclaredMethod("runTest",
RUNNER_PARAM_TYPES);
pargs[0] = args[offset+1];
pargs[1] = args[offset+2];
pargs[2] = args[offset+2];
Boolean result = (Boolean)test.invoke(null, pargs);
if (!result.booleanValue()) {
err = true;
break;
}
} catch (InvocationTargetException ex) {
ex.getTargetException().printStackTrace();
err = true;
break;
} catch (Exception ex) {
ex.printStackTrace();
err = true;
break;
}
}
// take error exit if difference found
if (err) {
System.err.println("Error on argument set: " + args[offset] +
", " + args[offset+1] + ", " + args[offset+2]);
System.err.println("File path " + temp.getAbsolutePath());
System.exit(1);
}
} else {
System.err.println("Requires arguments in sets of three:\n" +
" binding-resource mapped-class in-file\n" +
"Leaves output as temp.xml in case of error");
System.exit(1);
}
}
} libjibx-java-1.1.6a/build/test/org/jibx/match/TestMultiple.java 0000644 0001750 0001750 00000014115 10240174126 024274 0 ustar moeller moeller /*
Copyright (c) 2003-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.match;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import org.jibx.extras.*;
import org.jibx.runtime.*;
import org.xmlpull.v1.XmlPullParserException;
/**
* Test program for the JiBX framework. Works with sets of five input
* parameters: mapped-class, in-binding, in-file, out-binding, compare-file.
* Unmarshals documents from files using the specified in-bindings for the
* specified classes, then marshals them back out using the same or different
* bindings and compares the results with match files. In case of a comparison
* error the output file is left as temp.xml.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class TestMultiple {
protected static boolean runTest(String mname, String bin, String fin,
String bout, String cout)
throws IOException, JiBXException, XmlPullParserException {
// look up the mapped class
Class mclas;
try {
mclas = TestMultiple.class.getClassLoader().loadClass(mname);
} catch (ClassNotFoundException ex) {
System.err.println("Class " + mname + " not found");
return false;
}
// get binding factories for the named bindings
IBindingFactory ibf = BindingDirectory.getFactory(bin, mclas);
IBindingFactory obf = BindingDirectory.getFactory(bout, mclas);
// unmarshal document to construct bean
IUnmarshallingContext uctx = ibf.createUnmarshallingContext();
Object obj = uctx.unmarshalDocument(new FileInputStream(fin), null);
if (!mclas.isInstance(obj)) {
System.err.println("Unmarshalled result not expected type");
return false;
}
// marshal bean back out to document in memory
IMarshallingContext mctx = obf.createMarshallingContext();
ByteArrayOutputStream bos = new ByteArrayOutputStream();
mctx.setIndent(1, "\n", ' ');
mctx.marshalDocument(obj, "UTF-8", null, bos);
// compare with expected result document
InputStreamReader brdr = new InputStreamReader
(new ByteArrayInputStream(bos.toByteArray()), "UTF-8");
InputStreamReader frdr = new InputStreamReader
(new FileInputStream(cout), "UTF-8");
DocumentComparator comp = new DocumentComparator(System.err);
if (comp.compare(frdr, brdr)) {
return true;
} else {
// save file before returning failure
try {
File fout = new File("temp.xml");
fout.delete();
FileOutputStream fos = new FileOutputStream(fout);
fos.write(bos.toByteArray());
fos.close();
} catch (IOException ex) {
System.err.println("Error writing to temp.xml: " +
ex.getMessage());
}
return false;
}
}
public static void main(String[] args) {
if (args.length >= 5 && args.length % 5 == 0) {
// delete generated output file if present
File temp = new File("temp.xml");
if (temp.exists()) {
temp.delete();
}
// process each set of four arguments
boolean err = false;
int base = 0;
for (; base < args.length; base += 5) {
try {
if (!runTest(args[base], args[base+1], args[base+2],
args[base+3], args[base+4])) {
err = true;
break;
}
} catch (Exception ex) {
System.err.println("Exception: " + ex.getMessage());
ex.printStackTrace();
err = true;
break;
}
}
// take error exit if difference found
if (err) {
System.err.println("Error on argument set: " +
args[base] + ", " + args[base+1] + ", " +
args[base+2] + ", " + args[base+3] + ", " + args[base+4]);
System.exit(1);
}
} else {
System.err.println("Requires arguments in sets of five:\n" +
" mapped-class in-binding in-file out-binding compare-file\n" +
"Leaves output as temp.xml in case of error");
System.exit(1);
}
}
} libjibx-java-1.1.6a/build/test/org/jibx/match/TestMultipleStAX.java 0000644 0001750 0001750 00000015046 10434261102 025034 0 ustar moeller moeller /*
Copyright (c) 2003-2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.match;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import javax.xml.stream.XMLOutputFactory;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;
import org.jibx.extras.*;
import org.jibx.runtime.*;
import org.jibx.runtime.impl.StAXWriter;
import org.xmlpull.v1.XmlPullParserException;
/**
* Test program for the JiBX framework. Works with sets of five input
* parameters: mapped-class, in-binding, in-file, out-binding, compare-file.
* Unmarshals documents from files using the specified in-bindings for the
* specified classes, then marshals them back out using the same or different
* bindings and compares the results with match files. In case of a comparison
* error the output file is left as temp.xml.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class TestMultipleStAX {
protected static boolean runTest(String mname, String bin, String fin,
String bout, String cout)
throws IOException, JiBXException, XmlPullParserException {
// look up the mapped class
Class mclas;
try {
mclas = TestMultipleStAX.class.getClassLoader().loadClass(mname);
} catch (ClassNotFoundException ex) {
System.err.println("Class " + mname + " not found");
return false;
}
// get binding factories for the named bindings
IBindingFactory ibf = BindingDirectory.getFactory(bin, mclas);
IBindingFactory obf = BindingDirectory.getFactory(bout, mclas);
// unmarshal document to construct bean
IUnmarshallingContext uctx = ibf.createUnmarshallingContext();
Object obj = uctx.unmarshalDocument(new FileInputStream(fin), null);
if (!mclas.isInstance(obj)) {
System.err.println("Unmarshalled result not expected type");
return false;
}
// marshal bean back out to document in memory
IMarshallingContext mctx = obf.createMarshallingContext();
ByteArrayOutputStream bos = new ByteArrayOutputStream();
try {
XMLOutputFactory ofact = XMLOutputFactory.newInstance();
XMLStreamWriter wrtr = ofact.createXMLStreamWriter(bos, "UTF-8");
mctx.setXmlWriter(new StAXWriter(obf.getNamespaces(), wrtr));
mctx.marshalDocument(obj);
} catch (XMLStreamException e) {
throw new JiBXException("Error creating writer", e);
}
// compare with expected result document
InputStreamReader brdr = new InputStreamReader
(new ByteArrayInputStream(bos.toByteArray()), "UTF-8");
InputStreamReader frdr = new InputStreamReader
(new FileInputStream(cout), "UTF-8");
DocumentComparator comp = new DocumentComparator(System.err);
if (comp.compare(frdr, brdr)) {
return true;
} else {
// save file before returning failure
try {
File fout = new File("temp.xml");
fout.delete();
FileOutputStream fos = new FileOutputStream(fout);
fos.write(bos.toByteArray());
fos.close();
} catch (IOException ex) {
System.err.println("Error writing to temp.xml: " +
ex.getMessage());
}
return false;
}
}
public static void main(String[] args) {
if (args.length >= 5 && args.length % 5 == 0) {
// delete generated output file if present
File temp = new File("temp.xml");
if (temp.exists()) {
temp.delete();
}
// process each set of four arguments
boolean err = false;
int base = 0;
for (; base < args.length; base += 5) {
try {
if (!runTest(args[base], args[base+1], args[base+2],
args[base+3], args[base+4])) {
err = true;
break;
}
} catch (Exception ex) {
System.err.println("Exception: " + ex.getMessage());
ex.printStackTrace();
err = true;
break;
}
}
// take error exit if difference found
if (err) {
System.err.println("Error on argument set: " +
args[base] + ", " + args[base+1] + ", " +
args[base+2] + ", " + args[base+3] + ", " + args[base+4]);
System.exit(1);
}
} else {
System.err.println("Requires arguments in sets of five:\n" +
" mapped-class in-binding in-file out-binding compare-file\n" +
"Leaves output as temp.xml in case of error");
System.exit(1);
}
}
} libjibx-java-1.1.6a/build/test/org/jibx/match/TestRunner.java 0000644 0001750 0001750 00000011365 10213525436 023762 0 ustar moeller moeller /*
Copyright (c) 2003-2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.match;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import org.jibx.extras.*;
import org.jibx.runtime.*;
import org.jibx.runtime.impl.UnmarshallingContext;
import org.xmlpull.v1.XmlPullParserException;
/**
* Test runner for the JiBX framework. This has a single static method, which
* runs a test using a mapped class to unmarshal an input file and then
* compares the result to an match file. In case of a comparison error the
* output file is left as temp.xml. This is a separate class to allow
* easy use with a custom classloader.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class TestRunner
{
private TestRunner() {}
public static Boolean runTest(String mname, String fin, String fcomp,
boolean save)
throws IOException, JiBXException, XmlPullParserException {
// look up the mapped class and associated binding factory
Class mclas;
try {
mclas = TestSimple.class.getClassLoader().loadClass(mname);
} catch (ClassNotFoundException ex) {
System.err.println("Class " + mname + " not found");
return Boolean.FALSE;
}
IBindingFactory bfact = BindingDirectory.getFactory(mclas);
// unmarshal document to construct objects
IUnmarshallingContext uctx = bfact.createUnmarshallingContext();
Object obj = uctx.unmarshalDocument(new FileInputStream(fin), fin, null);
if (!mclas.isInstance(obj)) {
System.err.println("Unmarshalled result not expected type");
return Boolean.FALSE;
}
// determine encoding of input document
String enc = ((UnmarshallingContext)uctx).getInputEncoding();
// marshal root object back out to document in memory
IMarshallingContext mctx = bfact.createMarshallingContext();
ByteArrayOutputStream bos = new ByteArrayOutputStream();
mctx.setIndent(2);
mctx.marshalDocument(obj, enc, null, bos);
// compare with match document
InputStreamReader brdr = new InputStreamReader
(new ByteArrayInputStream(bos.toByteArray()), enc);
InputStreamReader frdr = new InputStreamReader
(new FileInputStream(fcomp), enc);
DocumentComparator comp = new DocumentComparator(System.err);
boolean match = comp.compare(frdr, brdr);
if (!match || save) {
// save file before returning
try {
File fout = new File("temp.xml");
fout.delete();
FileOutputStream fos = new FileOutputStream(fout);
fos.write(bos.toByteArray());
fos.close();
} catch (IOException ex) {
System.err.println("Error writing to temp.xml: " +
ex.getMessage());
}
}
return match ? Boolean.TRUE : Boolean.FALSE;
}
public static Boolean runTest(String mname, String fin, String fcomp)
throws IOException, JiBXException, XmlPullParserException {
return runTest(mname, fin, fcomp, false);
}
}
libjibx-java-1.1.6a/build/test/org/jibx/match/TestRunnerStAX.java 0000644 0001750 0001750 00000012334 10434261102 024507 0 ustar moeller moeller /*
Copyright (c) 2003-2006, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.match;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import javax.xml.stream.XMLOutputFactory;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;
import org.jibx.extras.*;
import org.jibx.runtime.*;
import org.jibx.runtime.impl.StAXWriter;
import org.jibx.runtime.impl.UnmarshallingContext;
import org.xmlpull.v1.XmlPullParserException;
/**
* Test runner for the JiBX framework. This has a single static method, which
* runs a test using a mapped class to unmarshal an input file and then
* compares the result to an match file. In case of a comparison error the
* output file is left as temp.xml. This is a separate class to allow
* easy use with a custom classloader.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class TestRunnerStAX
{
private TestRunnerStAX() {}
public static Boolean runTest(String mname, String fin, String fcomp,
boolean save)
throws IOException, JiBXException, XmlPullParserException {
// look up the mapped class and associated binding factory
Class mclas;
try {
mclas = TestSimple.class.getClassLoader().loadClass(mname);
} catch (ClassNotFoundException ex) {
System.err.println("Class " + mname + " not found");
return Boolean.FALSE;
}
IBindingFactory bfact = BindingDirectory.getFactory(mclas);
// unmarshal document to construct objects
IUnmarshallingContext uctx = bfact.createUnmarshallingContext();
Object obj = uctx.unmarshalDocument(new FileInputStream(fin), fin, null);
if (!mclas.isInstance(obj)) {
System.err.println("Unmarshalled result not expected type");
return Boolean.FALSE;
}
// determine encoding of input document
String enc = ((UnmarshallingContext)uctx).getInputEncoding();
// marshal root object back out to document in memory
IMarshallingContext mctx = bfact.createMarshallingContext();
ByteArrayOutputStream bos = new ByteArrayOutputStream();
try {
XMLOutputFactory ofact = XMLOutputFactory.newInstance();
XMLStreamWriter wrtr = ofact.createXMLStreamWriter(bos, enc);
mctx.setXmlWriter(new StAXWriter(bfact.getNamespaces(), wrtr));
mctx.marshalDocument(obj);
} catch (XMLStreamException e) {
throw new JiBXException("Error creating writer", e);
}
// compare with match document
InputStreamReader brdr = new InputStreamReader
(new ByteArrayInputStream(bos.toByteArray()), enc);
InputStreamReader frdr = new InputStreamReader
(new FileInputStream(fcomp), enc);
DocumentComparator comp = new DocumentComparator(System.err);
boolean match = comp.compare(frdr, brdr);
if (!match || save) {
// save file before returning
try {
File fout = new File("temp.xml");
fout.delete();
FileOutputStream fos = new FileOutputStream(fout);
fos.write(bos.toByteArray());
fos.close();
} catch (IOException ex) {
System.err.println("Error writing to temp.xml: " +
ex.getMessage());
}
}
return match ? Boolean.TRUE : Boolean.FALSE;
}
public static Boolean runTest(String mname, String fin, String fcomp)
throws IOException, JiBXException, XmlPullParserException {
return runTest(mname, fin, fcomp, false);
}
}
libjibx-java-1.1.6a/build/test/org/jibx/match/TestSimple.java 0000644 0001750 0001750 00000013677 10074705376 023762 0 ustar moeller moeller /*
Copyright (c) 2003-2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.match;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import org.jibx.extras.*;
import org.jibx.runtime.*;
import org.jibx.runtime.impl.UnmarshallingContext;
import org.xmlpull.v1.XmlPullParserException;
/**
* Test program for the JiBX framework. Works with sets of two input
* parameters: mapped-class, in-file. Unmarshals documents from files using the
* binding defined for the mapped class, then marshals them back out using the
* same bindings and compares the results. In case of a comparison error the
* output file is left as temp.xml.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class TestSimple {
protected static boolean runTest(String mname, String fin)
throws IOException, JiBXException, XmlPullParserException {
// look up the mapped class and associated binding factory
Class mclas;
try {
mclas = TestSimple.class.getClassLoader().loadClass(mname);
} catch (ClassNotFoundException ex) {
System.err.println("Class " + mname + " not found");
return false;
}
IBindingFactory bfact = BindingDirectory.getFactory(mclas);
// unmarshal document to construct objects
IUnmarshallingContext uctx = bfact.createUnmarshallingContext();
Object obj = uctx.unmarshalDocument(new FileInputStream(fin), null);
if (!mclas.isInstance(obj)) {
System.err.println("Unmarshalled result not expected type");
return false;
}
// determine encoding of input document
String enc = ((UnmarshallingContext)uctx).getInputEncoding();
if (enc == null) {
enc = "UTF-8";
}
// marshal root object back out to document in memory
IMarshallingContext mctx = bfact.createMarshallingContext();
ByteArrayOutputStream bos = new ByteArrayOutputStream();
mctx.setIndent(2);
mctx.marshalDocument(obj, enc, null, bos);
// compare with original input document
InputStreamReader brdr = new InputStreamReader
(new ByteArrayInputStream(bos.toByteArray()), enc);
InputStreamReader frdr = new InputStreamReader
(new FileInputStream(fin), enc);
DocumentComparator comp = new DocumentComparator(System.err);
if (comp.compare(frdr, brdr)) {
return true;
} else {
// save file before returning failure
try {
File fout = new File("temp.xml");
fout.delete();
FileOutputStream fos = new FileOutputStream(fout);
fos.write(bos.toByteArray());
fos.close();
} catch (IOException ex) {
System.err.println("Error writing to temp.xml: " +
ex.getMessage());
}
return false;
}
}
public static void main(String[] args) {
if (args.length >= 2 && args.length % 2 == 0) {
// delete generated output file if present
File temp = new File("temp.xml");
if (temp.exists()) {
temp.delete();
}
// process each set of two arguments
boolean err = false;
int base = 0;
for (; base < args.length; base += 2) {
try {
if (!runTest(args[base], args[base+1])) {
err = true;
break;
}
} catch (Exception ex) {
ex.printStackTrace();
// System.err.println(ex.getMessage());
err = true;
break;
}
}
// take error exit if difference found
if (err) {
System.err.println("Error on argument set: " +
args[base] + ", " + args[base+1]);
System.err.println("File path " + temp.getAbsolutePath());
System.exit(1);
}
} else {
System.err.println("Requires arguments in sets of two:\n" +
" mapped-class in-file\n" +
"Leaves output as temp.xml in case of error");
System.exit(1);
}
}
}
libjibx-java-1.1.6a/build/test/org/jibx/match/TestSimpleStAX.java 0000644 0001750 0001750 00000015162 10434261102 024471 0 ustar moeller moeller /*
Copyright (c) 2003-2004, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.match;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import javax.xml.stream.XMLOutputFactory;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;
import org.jibx.extras.DocumentComparator;
import org.jibx.runtime.BindingDirectory;
import org.jibx.runtime.IBindingFactory;
import org.jibx.runtime.IMarshallingContext;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.impl.StAXWriter;
import org.jibx.runtime.impl.UnmarshallingContext;
import org.xmlpull.v1.XmlPullParserException;
/**
* Test program for the JiBX framework. Works with sets of two input
* parameters: mapped-class, in-file. Unmarshals documents from files using the
* binding defined for the mapped class, then marshals them back out using the
* same bindings and compares the results. In case of a comparison error the
* output file is left as temp.xml.
*
* @author Dennis M. Sosnoski
* @version 1.0
*/
public class TestSimpleStAX {
protected static boolean runTest(String mname, String fin)
throws IOException, JiBXException, XmlPullParserException {
// look up the mapped class and associated binding factory
Class mclas;
try {
mclas = TestSimpleStAX.class.getClassLoader().loadClass(mname);
} catch (ClassNotFoundException ex) {
System.err.println("Class " + mname + " not found");
return false;
}
IBindingFactory bfact = BindingDirectory.getFactory(mclas);
// unmarshal document to construct objects
IUnmarshallingContext uctx = bfact.createUnmarshallingContext();
Object obj = uctx.unmarshalDocument(new FileInputStream(fin), null);
if (!mclas.isInstance(obj)) {
System.err.println("Unmarshalled result not expected type");
return false;
}
// determine encoding of input document
String enc = ((UnmarshallingContext)uctx).getInputEncoding();
if (enc == null) {
enc = "UTF-8";
}
// marshal root object back out to document in memory
IMarshallingContext mctx = bfact.createMarshallingContext();
ByteArrayOutputStream bos = new ByteArrayOutputStream();
try {
XMLOutputFactory ofact = XMLOutputFactory.newInstance();
XMLStreamWriter wrtr = ofact.createXMLStreamWriter(bos, enc);
mctx.setXmlWriter(new StAXWriter(bfact.getNamespaces(), wrtr));
mctx.marshalDocument(obj);
} catch (XMLStreamException e) {
throw new JiBXException("Error creating writer", e);
}
// compare with original input document
InputStreamReader brdr = new InputStreamReader
(new ByteArrayInputStream(bos.toByteArray()), enc);
InputStreamReader frdr = new InputStreamReader
(new FileInputStream(fin), enc);
DocumentComparator comp = new DocumentComparator(System.err);
if (comp.compare(frdr, brdr)) {
return true;
} else {
// save file before returning failure
try {
File fout = new File("temp.xml");
fout.delete();
FileOutputStream fos = new FileOutputStream(fout);
fos.write(bos.toByteArray());
fos.close();
} catch (IOException ex) {
System.err.println("Error writing to temp.xml: " +
ex.getMessage());
}
return false;
}
}
public static void main(String[] args) {
if (args.length >= 2 && args.length % 2 == 0) {
// delete generated output file if present
File temp = new File("temp.xml");
if (temp.exists()) {
temp.delete();
}
// process each set of two arguments
boolean err = false;
int base = 0;
for (; base < args.length; base += 2) {
try {
if (!runTest(args[base], args[base+1])) {
err = true;
break;
}
} catch (Exception ex) {
ex.printStackTrace();
// System.err.println(ex.getMessage());
err = true;
break;
}
}
// take error exit if difference found
if (err) {
System.err.println("Error on argument set: " +
args[base] + ", " + args[base+1]);
System.err.println("File path " + temp.getAbsolutePath());
System.exit(1);
}
} else {
System.err.println("Requires arguments in sets of two:\n" +
" mapped-class in-file\n" +
"Leaves output as temp.xml in case of error");
System.exit(1);
}
}
}
libjibx-java-1.1.6a/build/test/org/jibx/runtime/ 0000755 0001750 0001750 00000000000 11023035622 021360 5 ustar moeller moeller libjibx-java-1.1.6a/build/test/org/jibx/runtime/impl/ 0000755 0001750 0001750 00000000000 11023035622 022321 5 ustar moeller moeller libjibx-java-1.1.6a/build/test/org/jibx/runtime/impl/UnmarshallingContextTest.java 0000644 0001750 0001750 00000052454 11005477264 030223 0 ustar moeller moeller /*
* Created on Feb 5 2008
*/
package org.jibx.runtime.impl;
import org.jibx.runtime.IXMLReader;
import org.jibx.runtime.JiBXConstrainedParseException;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.JiBXParseException;
import junit.framework.TestCase;
/**
* Stubbed-out implementation of IXMLReader to be passed into the
* unmarshalling context.
* @author Joshua Davies
*/
class TestDocument implements IXMLReader {
private int[] m_events;
private String m_namespace;
private String m_tagName;
private String m_textContent;
private String m_attributeName;
private String m_attributeValue;
private int nextEvent = 0;
/**
* Describe one single element that should be pulled out of this reader instance.
* @param events
* @param namespace
* @param tagName
* @param textContent
*/
public TestDocument(int[] events, String namespace, String tagName, String textContent) {
m_events = events;
m_namespace = namespace;
m_tagName = tagName;
m_textContent = textContent;
}
/**
* Describe one single attribute that should be pulled out of this reader instance.
* @param attributeName
* @param attributeValue
*/
public TestDocument(String attributeName, String attributeValue) {
m_attributeName = attributeName;
m_attributeValue = attributeValue;
}
public int nextToken() {
return ++nextEvent;
}
public int next() throws JiBXException {
return ++nextEvent;
}
public String getName() {
return m_tagName;
}
public String getNamespace() {
return m_namespace;
}
public int getEventType() {
return m_events[nextEvent];
}
public String getText() {
return m_textContent;
}
public String buildPositionString() {
return null;
}
public int getAttributeCount() {
return 0;
}
public String getAttributeName(int index) {
return m_attributeName;
}
public String getAttributeNamespace(int index) {
return null;
}
public String getAttributePrefix(int index) {
return null;
}
public String getAttributeValue(int index) {
return m_attributeValue;
}
public String getAttributeValue(String ns, String name) {
return m_attributeValue;
}
public int getColumnNumber() {
return 0;
}
public String getDocumentName() {
return null;
}
public String getInputEncoding() {
return null;
}
public int getLineNumber() {
return 0;
}
public String getNamespace(String prefix) {
return null;
}
public int getNamespaceCount(int depth) {
return 0;
}
public String getNamespacePrefix(int index) {
return null;
}
public String getNamespaceUri(int index) {
return null;
}
public int getNestingDepth() {
return 0;
}
public String getPrefix() {
return null;
}
public boolean isNamespaceAware() {
return false;
}
}
/**
* Test the unmarshalling context.
* @author Joshua Davies
*/
public class UnmarshallingContextTest extends TestCase {
/**
* Verify that malformed integer content throws a properly
* formed JiBXParseException.
*/
public void testParseContentInt() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument(new int [] {IXMLReader.TEXT, IXMLReader.END_TAG},
"namespace", "tag", "abc"));
try {
uctx.parseContentInt("namespace", "tag");
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "tag", null));
}
}
/**
* Verify that malformed integer attributes throw a properly
* formed JiBXParseException.
*/
public void testParseAttributeInt() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument("attr", "abc"));
try {
uctx.attributeInt("namespace", "attr");
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "attr", null));
}
}
/**
* Verify that malformed integer attributes throw a properly
* formed JiBXParseException.
*/
public void testParseAttributeIntDefault() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument("attr", "abc"));
try {
uctx.attributeInt("namespace", "attr", 5);
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "attr", null));
}
}
/**
* Verify that malformed enum-constrained attributes throw a properly
* formed JiBXConstrainedParseException.
*/
public void testParseAttributeEnumeration() {
UnmarshallingContext uctx = new UnmarshallingContext();
String[] enums = new String[] {"def", "ghi"};
uctx.setDocument(new TestDocument("attr", "abc"));
try {
uctx.attributeEnumeration("namespace", "attr", enums, new int[] {1, 2});
fail("Expected JiBXConstrainedParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXConstrainedParseException(null, "abc", enums, "namespace", "attr", null));
}
}
/**
* Verify that malformed enum-constrained attributes throw a properly
* formed JiBXConstrainedParseException.
*/
public void testParseAttributeEnumerationDefault() {
UnmarshallingContext uctx = new UnmarshallingContext();
String[] enums = new String[] {"def", "ghi"};
uctx.setDocument(new TestDocument("attr", "abc"));
try {
uctx.attributeEnumeration("namespace", "attr", enums, new int[] {1, 2}, 1);
fail("Expected JiBXConstrainedParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXConstrainedParseException(null, "abc", enums, "namespace", "attr", null));
}
}
/**
* Verify that malformed enum-constrained content throws a properly
* formed JiBXConstrainedParseException.
*/
public void testParseContentEnumeration() {
UnmarshallingContext uctx = new UnmarshallingContext();
String[] enums = new String[] {"def", "ghi"};
uctx.setDocument(new TestDocument(new int [] {IXMLReader.TEXT, IXMLReader.END_TAG},
"namespace", "tag", "abc"));
try {
uctx.parseContentEnumeration("namespace", "tag", enums, new int[] {1, 2});
fail("Expected JiBXConstrainedParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXConstrainedParseException(null, "abc", enums, "namespace", "tag", null));
}
}
/**
* Verify that malformed enum-constrained content throws a properly
* formed JiBXConstrainedParseException.
*/
public void testParseContentEnumerationDefault() {
UnmarshallingContext uctx = new UnmarshallingContext();
String[] enums = new String[] {"def", "ghi"};
uctx.setDocument(new TestDocument(new int [] {IXMLReader.START_TAG, IXMLReader.TEXT, IXMLReader.END_TAG},
"namespace", "tag", "abc"));
try {
uctx.parseElementEnumeration("namespace", "tag", enums, new int[] {1, 2}, 1);
fail("Expected JiBXConstrainedParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXConstrainedParseException(null, "abc", enums, "namespace", "tag", null));
}
}
/**
* Verify that malformed short content throws a properly formed
* JiBXParseException.
*/
public void testParseAttributeShort() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument("attr", "abc"));
try {
uctx.attributeShort("namespace", "attr");
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "attr", null));
}
}
/**
* Verify that malformed short content throws a properly formed
* JiBXParseException.
*/
public void testParseAttributeShortDefault() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument("attr", "abc"));
try {
uctx.attributeShort("namespace", "attr", (short) 1);
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "attr", null));
}
}
/**
* Verify that malformed short content throws a properly formed
* JiBXParseException.
*/
public void testParseContentShort() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument(new int [] {IXMLReader.TEXT, IXMLReader.END_TAG},
"namespace", "tag", "abc"));
try {
uctx.parseContentShort("namespace", "tag");
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "tag", null));
}
}
/**
* Verify that malformed short content throws a properly formed
* JiBXParseException.
*/
public void testParseElementShort() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument(new int [] {IXMLReader.START_TAG, IXMLReader.TEXT, IXMLReader.END_TAG},
"namespace", "tag", "abc"));
try {
uctx.parseElementShort("namespace", "tag", (byte) 1);
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "tag", null));
}
}
/**
* Verify that malformed byte content throws a properly formed
* JiBXParseException.
*/
public void testParseAttributeByte() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument("attr", "abc"));
try {
uctx.attributeByte("namespace", "attr");
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "attr", null));
}
}
/**
* Verify that malformed byte content throws a properly formed
* JiBXParseException.
*/
public void testParseAttributeByteDefault() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument("attr", "abc"));
try {
uctx.attributeByte("namespace", "attr", (byte) 1);
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "attr", null));
}
}
/**
* Verify that malformed byte content throws a properly formed
* JiBXParseException.
*/
public void testParseContentByte() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument(new int [] {IXMLReader.TEXT, IXMLReader.END_TAG},
"namespace", "tag", "abc"));
try {
uctx.parseContentByte("namespace", "tag");
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "tag", null));
}
}
/**
* Verify that malformed byte content throws a properly formed
* JiBXParseException.
*/
public void testParseElementByte() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument(new int [] {IXMLReader.START_TAG, IXMLReader.TEXT, IXMLReader.END_TAG},
"namespace", "tag", "abc"));
try {
uctx.parseElementByte("namespace", "tag", (byte) 1);
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "tag", null));
}
}
/**
* Verify that malformed char content throws a properly formed
* JiBXParseException.
*/
public void testParseAttributeChar() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument("attr", "abc"));
try {
uctx.attributeChar("namespace", "attr");
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "attr", null));
}
}
/**
* Verify that malformed char content throws a properly formed
* JiBXParseException.
*/
public void testParseAttributeCharDefault() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument("attr", "abc"));
try {
uctx.attributeChar("namespace", "attr", 'a');
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "attr", null));
}
}
/**
* Verify that malformed char content throws a properly formed
* JiBXParseException.
*/
public void testParseContentChar() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument(new int [] {IXMLReader.TEXT, IXMLReader.END_TAG},
"namespace", "tag", "abc"));
try {
uctx.parseContentChar("namespace", "tag");
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "tag", null));
}
}
/**
* Verify that malformed char content throws a properly formed
* JiBXParseException.
*/
public void testParseElementChar() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument(new int [] {IXMLReader.START_TAG, IXMLReader.TEXT, IXMLReader.END_TAG},
"namespace", "tag", "abc"));
try {
uctx.parseElementChar("namespace", "tag", 'a');
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "tag", null));
}
}
/**
* Verify that malformed long content throws a properly formed
* JiBXParseException.
*/
public void testParseAttributeLong() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument("attr", "abc"));
try {
uctx.attributeLong("namespace", "attr");
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "attr", null));
}
}
/**
* Verify that malformed long content throws a properly formed
* JiBXParseException.
*/
public void testParseAttributeLongDefault() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument("attr", "abc"));
try {
uctx.attributeLong("namespace", "attr", 1L);
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "attr", null));
}
}
/**
* Verify that malformed long content throws a properly formed
* JiBXParseException.
*/
public void testParseContentLong() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument(new int [] {IXMLReader.START_TAG, IXMLReader.TEXT, IXMLReader.END_TAG},
"namespace", "tag", "abc"));
try {
uctx.parseElementLong("namespace", "tag");
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "tag", null));
}
}
/**
* Verify that malformed long content throws a properly formed
* JiBXParseException.
*/
public void testParseElementLong() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument(new int [] {IXMLReader.START_TAG, IXMLReader.TEXT, IXMLReader.END_TAG},
"namespace", "tag", "abc"));
try {
uctx.parseElementLong("namespace", "tag", 1L);
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "tag", null));
}
}
/**
* Verify that malformed boolean content throws a properly formed
* JiBXParseException.
*/
public void testParseAttributeBool() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument("attr", "abc"));
try {
uctx.attributeBoolean("namespace", "attr");
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "attr", null));
}
}
/**
* Verify that malformed boolean content throws a properly formed
* JiBXParseException.
*/
public void testParseAttributeBoolDefault() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument("attr", "abc"));
try {
uctx.attributeBoolean("namespace", "attr", false);
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "attr", null));
}
}
/**
* Verify that malformed boolean content throws a properly formed
* JiBXParseException.
*/
public void testParseContentBool() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument(new int [] {IXMLReader.START_TAG, IXMLReader.TEXT, IXMLReader.END_TAG},
"namespace", "tag", "abc"));
try {
uctx.parseElementBoolean("namespace", "tag");
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "tag", null));
}
}
/**
* Verify that malformed boolean content throws a properly formed
* JiBXParseException.
*/
public void testParseElementBool() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument(new int [] {IXMLReader.START_TAG, IXMLReader.TEXT, IXMLReader.END_TAG},
"namespace", "tag", "abc"));
try {
uctx.parseElementBoolean("namespace", "tag", false);
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "tag", null));
}
}
/**
* Verify that malformed float content throws a properly formed
* JiBXParseException.
*/
public void testParseAttributeFloat() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument("attr", "abc"));
try {
uctx.attributeFloat("namespace", "attr");
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "attr", null));
}
}
/**
* Verify that malformed float content throws a properly formed
* JiBXParseException.
*/
public void testParseAttributeFloatDefault() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument("attr", "abc"));
try {
uctx.attributeFloat("namespace", "attr", (float) 1.0);
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "attr", null));
}
}
/**
* Verify that malformed float content throws a properly formed
* JiBXParseException.
*/
public void testParseContentFloat() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument(new int [] {IXMLReader.START_TAG, IXMLReader.TEXT, IXMLReader.END_TAG},
"namespace", "tag", "abc"));
try {
uctx.parseElementFloat("namespace", "tag");
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "tag", null));
}
}
/**
* Verify that malformed float content throws a properly formed
* JiBXParseException.
*/
public void testParseElementFloat() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument(new int [] {IXMLReader.START_TAG, IXMLReader.TEXT, IXMLReader.END_TAG},
"namespace", "tag", "abc"));
try {
uctx.parseElementFloat("namespace", "tag", (float) 1.0);
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "tag", null));
}
}
/**
* Verify that malformed double content throws a properly formed
* JiBXParseException.
*/
public void testParseAttributeDouble() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument("attr", "abc"));
try {
uctx.attributeDouble("namespace", "attr");
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "attr", null));
}
}
/**
* Verify that malformed double content throws a properly formed
* JiBXParseException.
*/
public void testParseAttributeDoubleDefault() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument("attr", "abc"));
try {
uctx.attributeDouble("namespace", "attr", 1.0);
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "attr", null));
}
}
/**
* Verify that malformed double content throws a properly formed
* JiBXParseException.
*/
public void testParseContentDouble() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument(new int [] {IXMLReader.START_TAG, IXMLReader.TEXT, IXMLReader.END_TAG},
"namespace", "tag", "abc"));
try {
uctx.parseElementDouble("namespace", "tag");
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "tag", null));
}
}
/**
* Verify that malformed float content throws a properly formed
* JiBXParseException.
*/
public void testParseElementDouble() {
UnmarshallingContext uctx = new UnmarshallingContext();
uctx.setDocument(new TestDocument(new int [] {IXMLReader.START_TAG, IXMLReader.TEXT, IXMLReader.END_TAG},
"namespace", "tag", "abc"));
try {
uctx.parseElementDouble("namespace", "tag", 1.0);
fail("Expected JiBXParseException to be thrown");
} catch (JiBXException e) {
assertEquals(e, new JiBXParseException(null, "abc", "namespace", "tag", null));
}
}
}
libjibx-java-1.1.6a/build/test/org/jibx/runtime/JiBXConstrainedParseExceptionTest.java 0000644 0001750 0001750 00000001664 11005477264 030746 0 ustar moeller moeller package org.jibx.runtime;
import junit.framework.TestCase;
/**
* Verify the permutations of the constrained parse exception (specifically,
* string creation).
*/
public class JiBXConstrainedParseExceptionTest extends TestCase {
public void testOneValue() {
JiBXConstrainedParseException e = new JiBXConstrainedParseException(
"msg", "value", new String[] {"abc"});
assertTrue(e.getMessage().endsWith(". Acceptable values are 'abc'."));
}
public void testTwoValues() {
JiBXConstrainedParseException e = new JiBXConstrainedParseException(
"msg", "value", new String[] {"abc", "def"});
assertTrue(e.getMessage().endsWith(". Acceptable values are 'abc', 'def'."));
}
public void testThreeValues() {
JiBXConstrainedParseException e = new JiBXConstrainedParseException(
"msg", "value", new String[] {"abc", "def", "ghi"});
assertTrue(e.getMessage().endsWith(". Acceptable values are 'abc', 'def', 'ghi'."));
}
}
libjibx-java-1.1.6a/build/test/org/jibx/runtime/UtilityTest.java 0000644 0001750 0001750 00000072047 11002545610 024540 0 ustar moeller moeller /*
* Created on Mar 6, 2003
*
* To change this generated comment go to
* Window>Preferences>Java>Code Generation>Code Template
*/
package org.jibx.runtime;
import java.sql.Timestamp;
import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Date;
import java.util.GregorianCalendar;
import java.util.TimeZone;
import junit.framework.TestCase;
/**
* @author dennis
*/
public class UtilityTest extends TestCase {
private static long LMS_PER_DAY = (long)24*60*60*1000;
private DateFormat m_dateTimeFormat =
new SimpleDateFormat("yyyy-MM-dd'T'hh:mm:ss");
private DateFormat m_dateFormat =
new SimpleDateFormat("yyyy-MM-dd");
private DateFormat m_yearFormat =
new SimpleDateFormat("yyyy");
private Calendar m_calendar =
new GregorianCalendar(TimeZone.getTimeZone("UTC"));
/**
* Constructor for UtilityTest.
* @param arg0
*/
public UtilityTest(String arg0) {
super(arg0);
m_dateTimeFormat.setCalendar(m_calendar);
m_dateFormat.setCalendar(m_calendar);
m_yearFormat.setCalendar(m_calendar);
}
public void testParseInt() throws JiBXException {
assertEquals(0, Utility.parseInt("0"));
assertEquals(2000000000, Utility.parseInt("2000000000"));
assertEquals(-2000000000, Utility.parseInt("-2000000000"));
assertEquals(2000000000, Utility.parseInt("+2000000000"));
try {
Utility.parseInt("-");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseInt("+");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseInt("20000000000");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseInt("-20000000000");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseInt("+20000000000");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseInt("2000000X");
fail();
} catch (JiBXException ex) {}
}
public void testSerializeInt() throws JiBXException {
assertEquals("0", Utility.serializeInt(0));
assertEquals("2000000", Utility.serializeInt(2000000));
assertEquals("2000000000", Utility.serializeInt(2000000000));
assertEquals("-2000000", Utility.serializeInt(-2000000));
assertEquals("-2000000000", Utility.serializeInt(-2000000000));
}
public void testParseLong() throws JiBXException {
assertEquals(0, Utility.parseLong("0"));
assertEquals(2000000000, Utility.parseLong("2000000000"));
assertEquals(-2000000000, Utility.parseLong("-2000000000"));
assertEquals(2000000000, Utility.parseLong("+2000000000"));
assertEquals(200000000000000L, Utility.parseLong("200000000000000"));
assertEquals(-200000000000000L, Utility.parseLong("-200000000000000"));
assertEquals(200000000000000L, Utility.parseLong("+200000000000000"));
try {
Utility.parseLong("-");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseLong("+");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseLong("2000000X");
fail();
} catch (JiBXException ex) {}
}
public void testSerializeLong() {
assertEquals("0", Utility.serializeLong(0));
assertEquals("2000000", Utility.serializeLong(2000000));
assertEquals("2000000000000000",
Utility.serializeLong(2000000000000000L));
assertEquals("-2000000", Utility.serializeLong(-2000000));
assertEquals("-2000000000000000",
Utility.serializeLong(-2000000000000000L));
}
public void testParseShort() throws JiBXException {
assertEquals(0, Utility.parseShort("0"));
assertEquals(20000, Utility.parseShort("20000"));
assertEquals(-20000, Utility.parseShort("-20000"));
assertEquals(20000, Utility.parseShort("+20000"));
try {
Utility.parseShort("-");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseShort("+");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseShort("2000000");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseShort("2000X");
fail();
} catch (JiBXException ex) {}
}
public void testSerializeShort() {
assertEquals("0", Utility.serializeShort((short)0));
assertEquals("20000", Utility.serializeShort((short)20000));
assertEquals("-20000", Utility.serializeShort((short)-20000));
}
public void testParseByte() throws JiBXException {
assertEquals(0, Utility.parseByte("0"));
assertEquals(100, Utility.parseByte("100"));
assertEquals(-100, Utility.parseByte("-100"));
assertEquals(100, Utility.parseByte("+100"));
try {
Utility.parseByte("-");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseByte("+");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseByte("128");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseByte("10X");
fail();
} catch (JiBXException ex) {}
}
public void testSerializeByte() {
assertEquals("0", Utility.serializeByte((byte)0));
assertEquals("100", Utility.serializeByte((byte)100));
assertEquals("-100", Utility.serializeByte((byte)-100));
}
public void testParseBoolean() throws JiBXException {
assertTrue(Utility.parseBoolean("true"));
assertTrue(Utility.parseBoolean("1"));
assertFalse(Utility.parseBoolean("false"));
assertFalse(Utility.parseBoolean("0"));
try {
Utility.parseBoolean("x");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseBoolean("2");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseBoolean("+1");
fail();
} catch (JiBXException ex) {}
}
public void testSerializeBoolean() {
assertEquals("true", Utility.serializeBoolean(true));
assertEquals("false", Utility.serializeBoolean(false));
}
public void testParseChar() throws JiBXException {
assertEquals(0, Utility.parseChar("0"));
assertEquals(100, Utility.parseChar("100"));
assertEquals(1000, Utility.parseChar("+1000"));
assertEquals(65000, Utility.parseChar("65000"));
try {
Utility.parseChar("-");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseChar("+");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseChar("-10");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseChar("69000");
fail();
} catch (JiBXException ex) {}
}
public void testSerializeChar() {
assertEquals("0", Utility.serializeChar((char)0));
assertEquals("100", Utility.serializeChar((char)100));
assertEquals("60000", Utility.serializeChar((char)60000));
}
public void testParseFloat() throws JiBXException {
assertEquals(1.0f, Utility.parseFloat("1.0"), 0.000001f);
assertEquals(1000000000.0f, Utility.parseFloat("1000000000.0"), 100.0f);
assertEquals(0.0000000001f,
Utility.parseFloat("0.0000000001"), 1.0e-17f);
assertEquals(0, Float.compare(-0.0f, Utility.parseFloat("-0")));
assertEquals(0, Float.compare(Float.NEGATIVE_INFINITY,
Utility.parseFloat("-INF")));
assertEquals(0, Float.compare(Float.POSITIVE_INFINITY,
Utility.parseFloat("INF")));
assertEquals(0, Float.compare(Float.NaN, Utility.parseFloat("NaN")));
try {
Utility.parseFloat("NAN");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseFloat("+INF");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseFloat("1E+2.5");
fail();
} catch (JiBXException ex) {}
}
public void testSerializeFloat() {
assertEquals("1.0", Utility.serializeFloat(1.0f));
assertEquals("1.0E9", Utility.serializeFloat(1000000000.0f));
assertEquals("1.0E-10", Utility.serializeFloat(0.0000000001f));
assertEquals("-INF", Utility.serializeFloat(Float.NEGATIVE_INFINITY));
assertEquals("INF", Utility.serializeFloat(Float.POSITIVE_INFINITY));
assertEquals("NaN", Utility.serializeFloat(Float.NaN));
}
public void testParseDouble() throws JiBXException {
assertEquals(1.0d, Utility.parseDouble("1.0"), 1.0e-12d);
assertEquals(1000000000.0d, Utility.parseDouble("1000000000.0"), 0.01d);
assertEquals(0.0000000001d,
Utility.parseDouble("0.0000000001"), 1.0e-22d);
assertEquals(0, Double.compare(-0.0d, Utility.parseDouble("-0")));
assertEquals(0, Double.compare(Double.NEGATIVE_INFINITY,
Utility.parseDouble("-INF")));
assertEquals(0, Double.compare(Double.POSITIVE_INFINITY,
Utility.parseDouble("INF")));
assertEquals(0, Double.compare(Double.NaN, Utility.parseDouble("NaN")));
try {
Utility.parseDouble("NAN");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseDouble("+INF");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseDouble("1E+2.5");
fail();
} catch (JiBXException ex) {}
}
public void testSerializeDouble() {
assertEquals("1.0", Utility.serializeDouble(1.0d));
assertEquals("1.0E9", Utility.serializeDouble(1000000000.0d));
assertEquals("1.0E-10", Utility.serializeDouble(0.0000000001d));
assertEquals("-INF", Utility.serializeDouble(Double.NEGATIVE_INFINITY));
assertEquals("INF", Utility.serializeDouble(Double.POSITIVE_INFINITY));
assertEquals("NaN", Utility.serializeDouble(Double.NaN));
}
public void testParseYear() {
}
public void testParseYearMonth() {
}
public void testParseDate() throws JiBXException {
assertEquals(0, Utility.parseDate("1970-01-01"));
assertEquals(LMS_PER_DAY, Utility.parseDate("1970-01-02"));
assertEquals(LMS_PER_DAY,
Utility.parseDate("0001-03-01") - Utility.parseDate("0001-02-28"));
assertEquals(LMS_PER_DAY,
Utility.parseDate("0001-01-01") - Utility.parseDate("-0001-12-31"));
assertEquals(LMS_PER_DAY,
Utility.parseDate("-0001-03-01") -
Utility.parseDate("-0001-02-28"));
assertEquals(LMS_PER_DAY*2,
Utility.parseDate("-0004-03-01") -
Utility.parseDate("-0004-02-28"));
try {
Utility.parseDate("+1970-01-01");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseDate("197X-01-01");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseDate("1970-1-01");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseDate("1970-01-32");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseDate("1970-02-29");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseDate("01-01-01");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseDate("0001-02-29");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseDate("0000-01-01");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseDate("-0001-02-29");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseDate("-0003-02-29");
fail();
} catch (JiBXException ex) {}
}
public void testParseDateTime() throws JiBXException {
assertEquals(0, Utility.parseDateTime("1970-01-01T00:00:00.000"));
assertEquals(0, Utility.parseDateTime("1970-01-01T00:00:00"));
assertEquals(1, Utility.parseDateTime("1970-01-01T00:00:00.001"));
assertEquals(1000, Utility.parseDateTime("1970-01-01T00:00:01"));
assertEquals(60*1000, Utility.parseDateTime("1970-01-01T00:01:00"));
assertEquals(60*60*1000, Utility.parseDateTime("1970-01-01T01:00:00Z"));
assertEquals(60*60*1000,
Utility.parseDateTime("1970-01-01T02:00:00+01:00"));
assertEquals(LMS_PER_DAY,
Utility.parseDateTime("1970-01-02T00:00:00Z"));
assertEquals(LMS_PER_DAY,
Utility.parseDateTime("0001-03-01T00:00:00Z") -
Utility.parseDateTime("0001-02-28T00:00:00Z"));
assertEquals(1000, Utility.parseDateTime("0001-01-01T00:00:00Z") -
Utility.parseDateTime("-0001-12-31T23:59:59Z"));
assertEquals(LMS_PER_DAY,
Utility.parseDateTime("0001-01-01T00:00:00Z") -
Utility.parseDateTime("-0001-12-31T00:00:00Z"));
assertEquals(LMS_PER_DAY,
Utility.parseDateTime("-0001-03-01T00:00:00Z") -
Utility.parseDateTime("-0001-02-28T00:00:00Z"));
assertEquals(LMS_PER_DAY*2,
Utility.parseDateTime("-0004-03-01T00:00:00Z") -
Utility.parseDateTime("-0004-02-28T00:00:00Z"));
try {
Utility.parseDateTime("+1970-01-01T00:00:00.000");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseDateTime("197X-01-01T00:00:00.000");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseDateTime("1970-1-01T00:00:00.000");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseDateTime("1970-01-01T00:00");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseDateTime("1970-01-32T00:00:00");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseDateTime("1970-02-29T00:00:00");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseDateTime("1970-01-01T60:00:00");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseDateTime("1970-01-01T-5:00:00");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseDateTime("01-01-01T00:00:00");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseDateTime("0001-02-29T00:00:00");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseDateTime("0000-01-01T00:00:00");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseDateTime("-0001-02-29T00:00:00");
fail();
} catch (JiBXException ex) {}
try {
Utility.parseDateTime("-0003-02-29T00:00:00");
fail();
} catch (JiBXException ex) {}
}
public void testDeserializeDateTime() {
}
private void trySerializeYear(String dt)
throws JiBXException, ParseException {
Date date = m_yearFormat.parse(dt);
String result = Utility.serializeYear(date);
assertEquals(dt, result);
}
private void tryRoundtripYear(String dt) throws JiBXException {
long time = Utility.parseYear(dt);
String result = Utility.serializeYear(new Date(time));
// System.out.println("Parsed date " + dt + " to value " + time +
// ", serialized as " + result);
assertEquals(dt, result);
}
public void testSerializeYear() throws JiBXException, ParseException {
trySerializeYear("1970");
trySerializeYear("1969");
trySerializeYear("1968");
trySerializeYear("1967");
trySerializeYear("1966");
trySerializeYear("1965");
trySerializeYear("1800");
trySerializeYear("1600");
trySerializeYear("1999");
trySerializeYear("2000");
trySerializeYear("2999");
trySerializeYear("3000");
trySerializeYear("9999");
tryRoundtripYear("1970");
tryRoundtripYear("1969");
tryRoundtripYear("1968");
tryRoundtripYear("1967");
tryRoundtripYear("1966");
tryRoundtripYear("1965");
tryRoundtripYear("1800");
tryRoundtripYear("1600");
tryRoundtripYear("1999");
tryRoundtripYear("2000");
tryRoundtripYear("2001");
tryRoundtripYear("2002");
tryRoundtripYear("2999");
tryRoundtripYear("3000");
tryRoundtripYear("9999");
// the following values can only be tested roundtrip (because Java
// conversion insists on a discontinuity in Gregorian calendar)
tryRoundtripYear("12999");
tryRoundtripYear("1300");
tryRoundtripYear("0300");
tryRoundtripYear("0001");
tryRoundtripYear("-0001");
tryRoundtripYear("-0004");
tryRoundtripYear("-0005");
tryRoundtripYear("-0199");
tryRoundtripYear("-0198");
}
public void testSerializeYearMonth() throws JiBXException {
assertEquals("1970-01", Utility.serializeYearMonth(new Date(0)));
}
private void trySerializeDate(String dt)
throws JiBXException, ParseException {
Date date = m_dateFormat.parse(dt);
String result = Utility.serializeDate(date);
assertEquals(dt, result);
}
// ignores trailing time zone information
private void tryRoundtripDate(String dt) throws JiBXException {
long time = Utility.parseDate(dt);
String result = Utility.serializeDate(new Date(time));
// System.out.println("Parsed date " + dt + " to value " + time +
// ", serialized as " + result);
assertEquals(dt.substring(0, result.length()), result);
}
//#!j2me{
private void trySerializeSqlDate(String dt)
throws JiBXException, ParseException {
java.sql.Date date = java.sql.Date.valueOf(dt);
String result = Utility.serializeSqlDate(date);
assertEquals(dt, result);
}
// ignores trailing time zone information
private void tryRoundtripSqlDate(String dt) throws JiBXException {
java.sql.Date date1 = Utility.deserializeSqlDate(dt);
int split = dt.indexOf('-', 1);
java.sql.Date date2 = java.sql.Date.valueOf(dt.substring(0, split+6));
assertEquals(date1, date2);
String result = Utility.serializeSqlDate(date1);
assertEquals(dt.substring(0, result.length()), result);
}
private void tryRoundtripOnlySqlDate(String dt) throws JiBXException {
java.sql.Date date1 = Utility.deserializeSqlDate(dt);
String result = Utility.serializeSqlDate(date1);
assertEquals(dt, result);
}
//#j2me}
public void testSerializeDate() throws JiBXException, ParseException {
trySerializeDate("1970-01-01");
trySerializeDate("1970-02-01");
trySerializeDate("1970-01-02");
trySerializeDate("1969-12-31");
trySerializeDate("1969-01-01");
trySerializeDate("1969-02-28");
trySerializeDate("1969-03-01");
trySerializeDate("1968-01-01");
trySerializeDate("1968-02-29");
trySerializeDate("1968-03-01");
trySerializeDate("1967-01-01");
trySerializeDate("1966-01-01");
trySerializeDate("1965-01-01");
trySerializeDate("1800-01-01");
trySerializeDate("1600-11-11");
trySerializeDate("1999-12-31");
trySerializeDate("2000-01-01");
trySerializeDate("2000-02-29");
trySerializeDate("2000-12-31");
trySerializeDate("2001-01-01");
trySerializeDate("2001-12-31");
trySerializeDate("2002-01-01");
trySerializeDate("2002-02-13");
trySerializeDate("2999-12-31");
trySerializeDate("3000-01-01");
trySerializeDate("3000-12-31");
trySerializeDate("9999-12-31");
tryRoundtripDate("1970-01-01");
tryRoundtripDate("1970-02-01");
tryRoundtripDate("1970-01-02");
tryRoundtripDate("1969-12-31");
tryRoundtripDate("1969-01-01");
tryRoundtripDate("1969-02-28");
tryRoundtripDate("1969-03-01");
tryRoundtripDate("1968-01-01");
tryRoundtripDate("1968-02-29");
tryRoundtripDate("1968-03-01");
tryRoundtripDate("1967-01-01");
tryRoundtripDate("1966-01-01");
tryRoundtripDate("1965-01-01");
tryRoundtripDate("1800-01-01");
tryRoundtripDate("1600-11-11");
tryRoundtripDate("1999-12-31");
tryRoundtripDate("2000-01-01");
tryRoundtripDate("2000-02-29");
tryRoundtripDate("2000-12-31");
tryRoundtripDate("2001-01-01");
tryRoundtripDate("2001-12-31");
tryRoundtripDate("2002-01-01");
tryRoundtripDate("2002-02-13");
tryRoundtripDate("2999-12-31");
tryRoundtripDate("3000-01-01");
tryRoundtripDate("3000-12-31");
tryRoundtripDate("9999-12-31");
tryRoundtripDate("1970-01-01Z");
tryRoundtripDate("1969-03-01+10:30");
tryRoundtripDate("1800-01-01-04:00");
tryRoundtripDate("1600-11-11Z");
tryRoundtripDate("3000-12-31+00:00");
tryRoundtripDate("9999-12-31-12:00");
// the following values can only be tested roundtrip (because Java
// conversion insists on a discontinuity in Gregorian calendar)
tryRoundtripDate("12999-12-31");
tryRoundtripDate("1300-01-01");
tryRoundtripDate("0300-12-31");
tryRoundtripDate("0001-01-01");
tryRoundtripDate("-0001-12-31");
tryRoundtripDate("-0004-02-29");
tryRoundtripDate("-0004-03-01");
tryRoundtripDate("-0004-12-31");
tryRoundtripDate("-0005-02-28");
tryRoundtripDate("-0005-03-01");
tryRoundtripDate("-0199-12-31");
tryRoundtripDate("-0198-01-01");
}
//#!j2me{
public void testSerializeSqlDate() throws JiBXException, ParseException {
trySerializeSqlDate("1970-01-01");
trySerializeSqlDate("1970-02-01");
trySerializeSqlDate("1970-01-02");
trySerializeSqlDate("1969-12-31");
trySerializeSqlDate("1969-01-01");
trySerializeSqlDate("1969-02-28");
trySerializeSqlDate("1969-03-01");
trySerializeSqlDate("1968-01-01");
trySerializeSqlDate("1968-02-29");
trySerializeSqlDate("1968-03-01");
trySerializeSqlDate("1967-01-01");
trySerializeSqlDate("1966-01-01");
trySerializeSqlDate("1965-01-01");
trySerializeSqlDate("1800-01-01");
trySerializeSqlDate("1600-11-11");
trySerializeSqlDate("1999-12-31");
trySerializeSqlDate("2000-01-01");
trySerializeSqlDate("2000-02-29");
trySerializeSqlDate("2000-12-31");
trySerializeSqlDate("2001-01-01");
trySerializeSqlDate("2001-12-31");
trySerializeSqlDate("2002-01-01");
trySerializeSqlDate("2002-02-13");
trySerializeSqlDate("2999-12-31");
trySerializeSqlDate("3000-01-01");
trySerializeSqlDate("3000-12-31");
trySerializeSqlDate("9999-12-31");
tryRoundtripSqlDate("1970-01-01");
tryRoundtripSqlDate("1970-02-01");
tryRoundtripSqlDate("1970-01-02");
tryRoundtripSqlDate("1969-12-31");
tryRoundtripSqlDate("1969-01-01");
tryRoundtripSqlDate("1969-02-28");
tryRoundtripSqlDate("1969-03-01");
tryRoundtripSqlDate("1968-01-01");
tryRoundtripSqlDate("1968-02-29");
tryRoundtripSqlDate("1968-03-01");
tryRoundtripSqlDate("1967-01-01");
tryRoundtripSqlDate("1966-01-01");
tryRoundtripSqlDate("1965-01-01");
tryRoundtripSqlDate("1800-01-01");
tryRoundtripSqlDate("1600-11-11");
tryRoundtripSqlDate("1999-12-31");
tryRoundtripSqlDate("2000-01-01");
tryRoundtripSqlDate("2000-02-29");
tryRoundtripSqlDate("2000-12-31");
tryRoundtripSqlDate("2001-01-01");
tryRoundtripSqlDate("2001-12-31");
tryRoundtripSqlDate("2002-01-01");
tryRoundtripSqlDate("2002-02-13");
tryRoundtripSqlDate("2999-12-31");
tryRoundtripSqlDate("3000-01-01");
tryRoundtripSqlDate("3000-12-31");
tryRoundtripSqlDate("9999-12-31");
tryRoundtripSqlDate("12999-12-31");
tryRoundtripSqlDate("1970-01-01Z");
tryRoundtripSqlDate("1969-03-01+10:30");
tryRoundtripSqlDate("1800-01-01-04:00");
tryRoundtripSqlDate("1600-11-11Z");
tryRoundtripSqlDate("3000-12-31+00:00");
tryRoundtripSqlDate("9999-12-31-12:00");
// the following values can only be tested roundtrip (because Java
// conversion insists on a discontinuity in Gregorian calendar)
tryRoundtripOnlySqlDate("1300-01-01");
tryRoundtripOnlySqlDate("0300-12-31");
tryRoundtripOnlySqlDate("0001-01-01");
tryRoundtripOnlySqlDate("-0001-12-31");
// should work, but inconsistency in conversions at present
// tryRoundtripOnlySqlDate("-0004-02-29");
tryRoundtripOnlySqlDate("-0004-03-01");
tryRoundtripOnlySqlDate("-0004-12-31");
tryRoundtripOnlySqlDate("-0005-02-28");
tryRoundtripOnlySqlDate("-0005-03-01");
tryRoundtripOnlySqlDate("-0199-12-31");
tryRoundtripOnlySqlDate("-0198-01-01");
}
public void testSerializeTimestamp() throws JiBXException {
Timestamp ts = Timestamp.valueOf("2006-09-07 15:37:10.123456");
String text = Utility.serializeTimestamp(ts);
assertTrue("Timestamp serialization error",
text.startsWith("2006-09-0"));
assertTrue("Timestamp serialization error",
text.endsWith(":37:10.123456Z"));
assertEquals("Timestamp deserialization error", ts,
Utility.deserializeTimestamp(text));
}
//#j2me}
private void trySerializeDateTime(String dt)
throws JiBXException, ParseException {
Date date = m_dateTimeFormat.parse(dt);
String result = Utility.serializeDateTime(date);
assertEquals(dt, result);
}
private void tryRoundtripDateTime(String dt) throws JiBXException {
long time = Utility.parseDateTime(dt);
String result = Utility.serializeDateTime(new Date(time));
// System.out.println("Parsed date " + dt + " to value " + time +
// ", serialized as " + result);
assertEquals(dt, result);
}
public void testSerializeDateTime() throws JiBXException, ParseException {
assertEquals("1970-01-01T00:00:00Z",
Utility.serializeDateTime(new Date(0)));
trySerializeDateTime("1970-01-01T00:00:00Z");
trySerializeDateTime("1970-01-01T01:00:00Z");
trySerializeDateTime("1970-01-01T00:01:00Z");
trySerializeDateTime("1970-01-01T00:00:01Z");
trySerializeDateTime("1970-01-01T23:59:59Z");
trySerializeDateTime("1970-02-01T00:00:00Z");
trySerializeDateTime("1970-01-02T00:00:00Z");
trySerializeDateTime("1969-12-31T23:59:59Z");
trySerializeDateTime("1969-01-01T00:00:00Z");
trySerializeDateTime("1969-02-28T00:00:00Z");
trySerializeDateTime("1969-03-01T00:00:00Z");
trySerializeDateTime("1968-01-01T00:00:00Z");
trySerializeDateTime("1968-02-29T00:00:00Z");
trySerializeDateTime("1968-03-01T00:00:00Z");
trySerializeDateTime("1967-01-01T00:00:00Z");
trySerializeDateTime("1966-01-01T00:00:00Z");
trySerializeDateTime("1965-01-01T00:00:00Z");
trySerializeDateTime("1800-01-01T00:00:00Z");
trySerializeDateTime("1600-11-11T23:59:59Z");
trySerializeDateTime("1999-12-31T23:59:59Z");
trySerializeDateTime("2000-01-01T00:00:00Z");
trySerializeDateTime("2000-02-29T00:00:00Z");
trySerializeDateTime("2000-12-31T23:59:59Z");
trySerializeDateTime("2001-01-01T00:00:00Z");
trySerializeDateTime("2001-02-28T18:54:31Z");
trySerializeDateTime("2001-12-31T23:59:59Z");
trySerializeDateTime("2002-01-01T00:00:00Z");
trySerializeDateTime("2999-12-31T23:59:59Z");
trySerializeDateTime("3000-01-01T00:00:00Z");
trySerializeDateTime("3000-12-31T23:59:59Z");
trySerializeDateTime("9999-12-31T23:59:59Z");
tryRoundtripDateTime("1970-01-01T00:00:00Z");
tryRoundtripDateTime("1970-01-01T01:00:00Z");
tryRoundtripDateTime("1970-01-01T00:01:00Z");
tryRoundtripDateTime("1970-01-01T00:00:01Z");
tryRoundtripDateTime("1970-01-01T23:59:59Z");
tryRoundtripDateTime("1970-02-01T00:00:00Z");
tryRoundtripDateTime("1970-01-02T00:00:00Z");
tryRoundtripDateTime("1969-12-31T23:59:59Z");
tryRoundtripDateTime("1969-01-01T00:00:00Z");
tryRoundtripDateTime("1969-02-28T00:00:00Z");
tryRoundtripDateTime("1969-03-01T00:00:00Z");
tryRoundtripDateTime("1968-01-01T00:00:00Z");
tryRoundtripDateTime("1968-02-29T00:00:00Z");
tryRoundtripDateTime("1968-03-01T00:00:00Z");
tryRoundtripDateTime("1967-01-01T00:00:00Z");
tryRoundtripDateTime("1966-01-01T00:00:00Z");
tryRoundtripDateTime("1965-01-01T00:00:00Z");
tryRoundtripDateTime("1800-01-01T00:00:00Z");
tryRoundtripDateTime("1600-11-11T23:59:59Z");
tryRoundtripDateTime("1999-12-31T23:59:59Z");
tryRoundtripDateTime("2000-01-01T00:00:00Z");
tryRoundtripDateTime("2000-02-29T00:00:00Z");
tryRoundtripDateTime("2000-12-31T23:59:59Z");
tryRoundtripDateTime("2001-01-01T00:00:00Z");
tryRoundtripDateTime("2001-02-28T18:54:31Z");
tryRoundtripDateTime("2001-12-31T23:59:59Z");
tryRoundtripDateTime("2002-01-01T00:00:00Z");
tryRoundtripDateTime("2999-12-31T23:59:59Z");
tryRoundtripDateTime("3000-01-01T00:00:00Z");
tryRoundtripDateTime("3000-12-31T23:59:59Z");
tryRoundtripDateTime("9999-12-31T23:59:59Z");
// the following values can only be tested roundtrip (because Java
// conversion insists on a discontinuity in Gregorian calendar)
tryRoundtripDateTime("12999-12-31T23:59:59Z");
tryRoundtripDateTime("1300-01-01T00:00:00Z");
tryRoundtripDateTime("0300-12-31T23:59:59Z");
tryRoundtripDateTime("0001-01-01T00:00:00Z");
tryRoundtripDateTime("-0001-12-31T23:59:59Z");
tryRoundtripDateTime("-0004-02-29T23:59:59Z");
tryRoundtripDateTime("-0004-03-01T23:59:59Z");
tryRoundtripDateTime("-0199-12-31T23:59:59Z");
tryRoundtripDateTime("-0198-01-01T00:00:00Z");
}
private boolean equalsBytes(byte[] a, byte[] b) {
if (a == null) {
return b == null;
} else if (b == null) {
return false;
} else if (a.length != b.length) {
return false;
} else {
for (int i = 0; i < a.length; i++) {
if (a[i] != b[i]) {
return false;
}
}
return true;
}
}
public void testParseBase64() throws JiBXException {
assertTrue(equalsBytes(Utility.parseBase64(""), new byte[0]));
assertTrue(equalsBytes(Utility.parseBase64("Cg=="), "\n".getBytes()));
assertTrue(equalsBytes(Utility.parseBase64("d2hhdA=="),
"what".getBytes()));
assertTrue(equalsBytes(Utility.parseBase64
("d2hhdCB3aWxsIHByaW50IG91dA=="),
"what will print out".getBytes()));
assertTrue(equalsBytes(Utility.parseBase64
("d2hhdCAgd2lsbCAgIHByaW50ICAgICBvdXQgICAgICA="),
"what will print out ".getBytes()));
assertTrue(equalsBytes(Utility.parseBase64
("d2hhdCAgd2lsbCAgIHByaW50ICAgICBvdXQ="),
"what will print out".getBytes()));
}
public void testSerializeBase64() {
assertEquals(Utility.serializeBase64(new byte[0]), "");
assertEquals(Utility.serializeBase64("\n".getBytes()), "Cg==");
assertEquals(Utility.serializeBase64("what".getBytes()), "d2hhdA==");
assertEquals(Utility.serializeBase64("what will print out".getBytes()),
"d2hhdCB3aWxsIHByaW50IG91dA==");
assertEquals(Utility.serializeBase64
("what will print out ".getBytes()),
"d2hhdCAgd2lsbCAgIHByaW50ICAgICBvdXQgICAgICA=");
assertEquals(Utility.serializeBase64
("what will print out".getBytes()),
"d2hhdCAgd2lsbCAgIHByaW50ICAgICBvdXQ=");
}
public void testIsEqual() {
assertTrue(Utility.isEqual(null, null));
assertFalse(Utility.isEqual(null, "text"));
assertFalse(Utility.isEqual("text", null));
assertTrue(Utility.isEqual("text", "text"));
}
public static void main(String[] args) {
String[] names = { UtilityTest.class.getName() };
junit.textui.TestRunner.main(names);
}
}
libjibx-java-1.1.6a/build/test/org/jibx/schema/ 0000755 0001750 0001750 00000000000 11023035622 021135 5 ustar moeller moeller libjibx-java-1.1.6a/build/test/org/jibx/schema/codegen/ 0000755 0001750 0001750 00000000000 11023035622 022541 5 ustar moeller moeller libjibx-java-1.1.6a/build/test/org/jibx/schema/codegen/CodeGenerationTest.java 0000644 0001750 0001750 00000022465 10767277472 027174 0 ustar moeller moeller
package org.jibx.schema.codegen;
import java.io.IOException;
import java.util.ArrayList;
import org.jibx.runtime.JiBXException;
import org.jibx.schema.SchemaTestBase;
import org.jibx.schema.codegen.custom.SchemasetCustom;
import org.jibx.schema.elements.SchemaElement;
/**
* Test code generation from schemas.
*/
public class CodeGenerationTest extends SchemaTestBase
{
static final StringObjectPair[] DATA1 = new StringObjectPair[] {
new StringObjectPair("something.Element", new StringPair[] {
new StringPair("DATE_FORM", "int"),
new StringPair("DATE_TIME_FORM", "int"),
new StringPair("RATING_FORM", "int"),
new StringPair("date", "Date"),
new StringPair("dateTime", "java.util.Date"),
new StringPair("male", "boolean"),
new StringPair("mixedSelectSelect", "int"),
new StringPair("name", "String"),
new StringPair("rated", "int"),
new StringPair("rated1", "Integer"),
new StringPair("rating", "int")})
};
static final StringObjectPair[] DATA2 = new StringObjectPair[] {
};
static final StringObjectPair[] DATA3_A = new StringObjectPair[] {
new StringObjectPair("something.Element", new StringPair[] {
new StringPair("DATE_FORM", "int"),
new StringPair("DATE_TIME_FORM", "int"),
new StringPair("_INT_FORM", "int"),
new StringPair("_int", "int"),
new StringPair("date", "Date"),
new StringPair("dateTime", "java.util.Date"),
new StringPair("enum1", "Enum1"),
new StringPair("enum2", "Enum2"),
new StringPair("enum3", "Enum3"),
new StringPair("male", "boolean"),
new StringPair("mixedSelectSelect", "int"),
new StringPair("name", "String"),
new StringPair("rated", "int"),
new StringPair("rated1", "Integer")}),
new StringObjectPair("something.Element.Enum1", new StringPair[] {
new StringPair("A1", "Enum1"),
new StringPair("B2", "Enum1"),
new StringPair("instances", "Enum1[]"),
new StringPair("value", "String"),
new StringPair("values", "String[]")}),
new StringObjectPair("something.Element.Enum2", new StringPair[] {
new StringPair("A1", "Enum2"),
new StringPair("B2", "Enum2"),
new StringPair("instances", "Enum2[]"),
new StringPair("value", "String"),
new StringPair("values", "String[]")}),
new StringObjectPair("something.Element.Enum3", new StringPair[] {
new StringPair("A1", "Enum3"),
new StringPair("B2", "Enum3"),
new StringPair("instances", "Enum3[]"),
new StringPair("value", "String"),
new StringPair("values", "String[]")}),
};
static final StringObjectPair[] DATA3_B = new StringObjectPair[] {
new StringObjectPair("anything.Enum1", new StringPair[] {
new StringPair("A1", "Enum1"),
new StringPair("B2", "Enum1"),
new StringPair("instances", "Enum1[]"),
new StringPair("value", "String"),
new StringPair("values", "String[]")}),
new StringObjectPair("anything.Enum2", new StringPair[] {
new StringPair("A1", "Enum2"),
new StringPair("B2", "Enum2"),
new StringPair("instances", "Enum2[]"),
new StringPair("value", "String"),
new StringPair("values", "String[]")}),
new StringObjectPair("anything.Enum3", new StringPair[] {
new StringPair("X1", "Enum3"),
new StringPair("Y2", "Enum3"),
new StringPair("Z3", "Enum3"),
new StringPair("instances", "Enum3[]"),
new StringPair("value", "String"),
new StringPair("values", "String[]")}),
new StringObjectPair("something.Element", new StringPair[] {
new StringPair("DATE_FORM", "int"),
new StringPair("DATE_TIME_FORM", "int"),
new StringPair("_INT_FORM", "int"),
new StringPair("_int", "int"),
new StringPair("date", "Date"),
new StringPair("dateTime", "java.util.Date"),
new StringPair("enum1", "Enum1"),
new StringPair("enum1a", "Enum1"),
new StringPair("enum2", "Enum2"),
new StringPair("enum2a", "Enum2"),
new StringPair("enum3", "Enum3"),
new StringPair("enum3a", "Enum3"),
new StringPair("male", "boolean"),
new StringPair("mixedUnionSelect", "int"),
new StringPair("name", "String"),
new StringPair("rated", "int"),
new StringPair("rated1", "Integer")}),
};
static final StringObjectPair[] DATA4 = new StringObjectPair[] {
};
static final StringObjectPair[] DATA5 = new StringObjectPair[] {
};
private static void dumpImage(StringObjectPair[] classdefs) {
for (int i = 0; i < classdefs.length; i++) {
StringObjectPair pair = classdefs[i];
StringPair[] fielddefs = (StringPair[])pair.getValue();
System.out.print(" new StringObjectPair(\"");
System.out.print(pair.getKey());
System.out.print("\", new StringPair[] { ");
for (int j = 0; j < fielddefs.length; j++) {
StringPair fielddef = fielddefs[j];
System.out.println(j > 0 ? "," : "");
System.out.print(" new StringPair(\"");
System.out.print(fielddef.getKey());
System.out.print("\", \"");
System.out.print(fielddef.getValue());
System.out.print("\")");
}
System.out.println("}),");
}
}
private void testDump(SchemasetCustom custom, SchemaElement[] schemas) throws JiBXException, IOException {
CodeGenerator generator = new CodeGenerator(custom, m_validationContext, schemas);
assertTrue("Schema customization failure", generator.customizeSchemas());
generator.applyExtensions();
generator.pruneDefinitions();
generator.validateSchemas(true);
generator.generate();
ArrayList packages = generator.getPackageDirectory().getPackages();
System.out.println("Data model dump:");
for (int i = 0; i < packages.size(); i++) {
PackageHolder packhold = (PackageHolder)packages.get(i);
StringObjectPair[] classdefs = packhold.getClassFields();
dumpImage(classdefs);
}
}
private void testGeneration(SchemasetCustom custom, SchemaElement[] schemas, StringObjectPair[] image)
throws JiBXException, IOException {
CodeGenerator generator = new CodeGenerator(custom, m_validationContext, schemas);
assertTrue("Schema customization failure", generator.customizeSchemas());
generator.applyExtensions();
generator.pruneDefinitions();
generator.validateSchemas(true);
generator.generate();
StringObjectPair[] classpairs = DataModelUtils.getImage(generator.getPackageDirectory());
String diff = DataModelUtils.imageDiff(image, classpairs);
if (diff != null) {
fail(diff);
}
}
// public void testGeneration1() throws Exception {
// SchemaElement[] schemas = new SchemaElement[] { loadSchema(TypeReplacementTest.RESOLVER1) };
// testGeneration(new SchemasetCustom(null), schemas, DATA1);
// }
//
// public void testGeneration3() throws Exception {
// SchemaElement[] schemas = new SchemaElement[] { loadSchema(TypeReplacementTest.RESOLVER3) };
// SchemasetCustom custom = loadCustomization(TypeReplacementTest.CUSTOMIZATION3_B);
// testGeneration(custom, schemas, DATA3_B);
// }
public void testGeneration3b() throws Exception {
SchemaElement[] schemas = new SchemaElement[] { loadSchema(TypeReplacementTest.RESOLVER3) };
SchemasetCustom custom = loadCustomization(TypeReplacementTest.CUSTOMIZATION3_B);
testDump(custom, schemas);
testGeneration(custom, schemas, DATA3_B);
// testDump(custom, schemas);
}
/* public void testTypeReplacement() throws Exception {
SchemaElement[] schemas = new SchemaElement[] { loadSchema(TypeReplacementTest.RESOLVER1) };
SchemasetCustom custom = loadCustomization(TypeReplacementTest.CUSTOMIZATION2);
testGeneration(custom, schemas);
}
public void testTypeRemoval() throws Exception {
SchemaElement[] schemas = new SchemaElement[] { loadSchema(TypeReplacementTest.RESOLVER1) };
SchemasetCustom custom = loadCustomization(TypeReplacementTest.CUSTOMIZATION3);
testGeneration(custom, schemas);
}
public void testTypeReplacement2() throws Exception {
SchemaElement[] schemas = new SchemaElement[] { loadSchema(TypeReplacementTest.RESOLVER2) };
SchemasetCustom custom = loadCustomization(TypeReplacementTest.CUSTOMIZATION4);
testGeneration(custom, schemas);
}
public void testCombinedRemovalReplacement() throws Exception {
SchemaElement[] schemas = new SchemaElement[] { loadSchema(TypeReplacementTest.RESOLVER2) };
SchemasetCustom custom = loadCustomization(TypeReplacementTest.CUSTOMIZATION5);
testGeneration(custom, schemas);
} */
} libjibx-java-1.1.6a/build/test/org/jibx/schema/codegen/CodegenSuite.java 0000644 0001750 0001750 00000000635 10756366774 026021 0 ustar moeller moeller package org.jibx.schema.codegen;
import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;
public class CodegenSuite extends TestCase
{
public static Test suite() {
TestSuite suite = new TestSuite(UsageVisitorTest.class);
suite.addTestSuite(TypeReplacementTest.class);
suite.addTestSuite(CodeGenerationTest.class);
return suite;
}
}
libjibx-java-1.1.6a/build/test/org/jibx/schema/codegen/TypeReplacementTest.java 0000644 0001750 0001750 00000055335 10756366774 027413 0 ustar moeller moeller
package org.jibx.schema.codegen;
import java.util.HashMap;
import java.util.Map;
import org.jibx.schema.SchemaTestBase;
import org.jibx.schema.codegen.custom.SchemasetCustom;
import org.jibx.schema.elements.SchemaElement;
/**
* Test schema simplification and normalization.
*/
public class TypeReplacementTest extends SchemaTestBase
{
// test data, also used by CodeGenerationTest
// any changes here also need to be matched by changes there
static final String MAIN_SCHEMA1 =
"\n" +
" \n" +
" \n" +
"";
static final String INCLUDED_SCHEMA1 =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
static final String RESULT_SCHEMA1_A =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
static final String CUSTOMIZATION1_B =
"\n" +
" \n" +
" ";
static final String RESULT_SCHEMA1_B =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
static final String CUSTOMIZATION1_C =
"\n" +
" \n" +
" ";
static final String RESULT_SCHEMA1_C =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
static final String MAIN_SCHEMA2 =
"\n" +
" \n" +
" \n" +
"";
static final String INCLUDED_SCHEMA2 =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" " +
"";
static final String CUSTOMIZATION2_A =
"\n" +
" \n" +
" ";
static final String RESULT_SCHEMA2_A =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" " +
"";
static final String CUSTOMIZATION2_B =
"\n" +
" \n" +
" ";
static final String RESULT_SCHEMA2_B =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" " +
"";
static final String MAIN_SCHEMA3 =
"\n" +
" \n" +
" \n" +
"";
static final String INCLUDED_SCHEMA3 =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" " +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
static final String CUSTOMIZATION3_A =
"\n" +
" \n" +
" ";
static final String RESULT_SCHEMA3_A =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" " +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
static final String CUSTOMIZATION3_B =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
private static final Map MAP = new HashMap();
static final TestResolver RESOLVER1 = new TestResolver(MAIN_SCHEMA1, "MAIN_SCHEMA1", MAP);
static final TestResolver RESOLVER2 = new TestResolver(MAIN_SCHEMA2, "MAIN_SCHEMA2", MAP);
static final TestResolver RESOLVER3 = new TestResolver(MAIN_SCHEMA3, "MAIN_SCHEMA3", MAP);
static {
MAP.put(RESOLVER1.getName(), RESOLVER1);
MAP.put("INCLUDED_SCHEMA1", new TestResolver(INCLUDED_SCHEMA1, "INCLUDED_SCHEMA1", MAP));
MAP.put(RESOLVER2.getName(), RESOLVER2);
MAP.put("INCLUDED_SCHEMA2", new TestResolver(INCLUDED_SCHEMA2, "INCLUDED_SCHEMA2", MAP));
MAP.put(RESOLVER3.getName(), RESOLVER3);
MAP.put("INCLUDED_SCHEMA3", new TestResolver(INCLUDED_SCHEMA3, "INCLUDED_SCHEMA3", MAP));
}
/**
* Test the schema simplification handling. This first loads and validates the supplied main schema, which
* automatically loads and validates any included/imported schemas. It then applies any customizations and finally
* simplifies the (possibly modified) included/imported schemas and checks that the result matches expectations.
*
* @param resolver root schema resolver
* @param custom customizations document text
* @param inclname included schema name
* @param rslttext simplified result schema expected
* @throws Exception
*/
private void testSimplification(TestResolver resolver, String custom, String inclname, String rslttext)
throws Exception {
SchemaElement[] schemas = new SchemaElement[] { loadSchema(resolver) };
SchemasetCustom custroot;
if (custom == null) {
custroot = new SchemasetCustom(null);
} else {
custroot = loadCustomization(custom);
}
CodeGenerator generator = new CodeGenerator(custroot, m_validationContext, schemas);
assertTrue("Schema customization failure", generator.customizeSchemas());
generator.applyExtensions();
generator.pruneDefinitions();
verifySchema(resolver.getText(), writeSchema(schemas[0]));
SchemaElement schema = m_validationContext.getSchema(inclname);
verifySchema(rslttext, writeSchema(schema));
}
public void testSchemaSimplification() throws Exception {
testSimplification(RESOLVER1, null, "INCLUDED_SCHEMA1", RESULT_SCHEMA1_A);
}
public void testTypeReplacement() throws Exception {
testSimplification(RESOLVER1, CUSTOMIZATION1_B, "INCLUDED_SCHEMA1", RESULT_SCHEMA1_B);
}
public void testTypeRemoval() throws Exception {
testSimplification(RESOLVER1, CUSTOMIZATION1_C, "INCLUDED_SCHEMA1", RESULT_SCHEMA1_C);
}
public void testTypeReplacement2() throws Exception {
testSimplification(RESOLVER2, CUSTOMIZATION2_A, "INCLUDED_SCHEMA2", RESULT_SCHEMA2_A);
}
public void testCombinedRemovalReplacement() throws Exception {
testSimplification(RESOLVER2, CUSTOMIZATION2_B, "INCLUDED_SCHEMA2", RESULT_SCHEMA2_B);
}
public void testSimplificationWithEnums() throws Exception {
testSimplification(RESOLVER3, CUSTOMIZATION3_A, "INCLUDED_SCHEMA3", RESULT_SCHEMA3_A);
}
} libjibx-java-1.1.6a/build/test/org/jibx/schema/codegen/UsageVisitorTest.java 0000644 0001750 0001750 00000006264 10673717224 026717 0 ustar moeller moeller
package org.jibx.schema.codegen;
import org.jibx.runtime.QName;
import org.jibx.schema.SchemaTestBase;
import org.jibx.schema.codegen.classes.UsageFinder;
import org.jibx.schema.elements.SchemaElement;
/**
* Test usage visitor operation for counting references.
*/
public class UsageVisitorTest extends SchemaTestBase
{
public static final String REFERENCE_SCHEMA =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
private void checkAttributeUsage(String name, ReferenceCountMap map, int count) {
Object key = m_nameRegister.findAttribute(new QName("urn:anything", name));
assertEquals("Usage count error on attribute '" + name + '\'', count, map.getCount(key));
}
private void checkElementUsage(String name, ReferenceCountMap map, int count) {
Object key = m_nameRegister.findElement(new QName("urn:anything", name));
assertEquals("Usage count error on element '" + name + '\'', count, map.getCount(key));
}
private void checkTypeUsage(String name, ReferenceCountMap map, int count) {
Object key = m_nameRegister.findType(new QName("urn:anything", name));
assertEquals("Usage count error on type '" + name + '\'', count, map.getCount(key));
}
public void testComplexReferenced() throws Exception {
SchemaElement root = runNoErrors(REFERENCE_SCHEMA);
if (!hasProblem(m_validationContext)) {
UsageFinder usage = new UsageFinder();
usage.countSchemaTree(root);
ReferenceCountMap map = usage.getUsageMap();
checkTypeUsage("simple1", map, 1);
checkElementUsage("simple1", map, 1);
checkTypeUsage("simple2", map, 0);
checkTypeUsage("simple3", map, 0);
checkTypeUsage("rating", map, 3);
checkTypeUsage("mixedUnion", map, 1);
}
}
} libjibx-java-1.1.6a/build/test/org/jibx/schema/elements/ 0000755 0001750 0001750 00000000000 11023035622 022751 5 ustar moeller moeller libjibx-java-1.1.6a/build/test/org/jibx/schema/elements/Annotations.java 0000644 0001750 0001750 00000005420 10602647122 026120 0 ustar moeller moeller
package org.jibx.schema.elements;
import org.jibx.schema.SchemaTestBase;
/**
* Test handling of simple schemas with annotations.
*/
public class Annotations extends SchemaTestBase
{
public static final String EMPTY_ANNOTATION =
"\n" +
" \n" +
"";
public static final String DOCUMENTATION_ANNOTATION =
"\n" +
" \n" +
" \n" +
" this is all good" +
" \n" +
" \n" +
"";
public static final String APPINFO_ANNOTATION =
"\n" +
" \n" +
" \n" +
" special good stuff\n" +
" \n" +
" \n" +
"";
public static final String MULTIPLE_ANNOTATION =
"\n" +
" \n" +
" \n" +
" special good stuff\n" +
" \n" +
" \n" +
" this is all good" +
" \n" +
" \n" +
" this is all good" +
" \n" +
" \n" +
" \n" +
" more good stuff" +
" \n" +
" \n" +
" \n" +
" last good stuff\n" +
" \n" +
" \n" +
"";
public void testEmptyAnnotation() throws Exception {
runNoErrors(EMPTY_ANNOTATION);
}
public void testDocumentationAnnotation() throws Exception {
runNoErrors(DOCUMENTATION_ANNOTATION);
}
public void testAppInfoAnnotation() throws Exception {
runNoErrors(APPINFO_ANNOTATION);
}
public void testMultipleAnnotation() throws Exception {
runNoErrors(MULTIPLE_ANNOTATION);
}
} libjibx-java-1.1.6a/build/test/org/jibx/schema/elements/ElementsSuite.java 0000644 0001750 0001750 00000001050 10602647122 026404 0 ustar moeller moeller package org.jibx.schema.elements;
import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;
public class ElementsSuite extends TestCase
{
public static Test suite() {
TestSuite suite = new TestSuite(EmptySchema.class);
suite.addTestSuite(Annotations.class);
suite.addTestSuite(SimpleGlobals.class);
suite.addTestSuite(SimpleComplexTypes.class);
suite.addTestSuite(SimpleSimpleTypes.class);
suite.addTestSuite(SimpleGroups.class);
return suite;
}
}
libjibx-java-1.1.6a/build/test/org/jibx/schema/elements/EmptySchema.java 0000644 0001750 0001750 00000007520 10602647122 026045 0 ustar moeller moeller
package org.jibx.schema.elements;
import org.jibx.schema.SchemaTestBase;
/**
* Test handling of simple schemas.
*/
public class EmptySchema extends SchemaTestBase
{
public static final String EMPTY_SCHEMA =
"";
public static final String EMPTY_SCHEMA_ATTRIBUTES =
"";
public static final String EMPTY_SCHEMA_PREFIX =
"";
public static final String EMPTY_SCHEMA_EXTRA_NAMESPACES =
"";
public static final String EMPTY_SCHEMA_EXTRA_ATTRIBUTE =
"";
public static final String EMPTY_SCHEMA_UNKNOWN_ATTRIBUTE =
"";
public static final String EMPTY_SCHEMA_ALL_ATTRIBUTES1 =
"";
public static final String EMPTY_SCHEMA_ALL_ATTRIBUTES2 =
"";
public static final String EMPTY_SCHEMA_UNKNOWN_VALUES =
"";
public void testEmpty() throws Exception {
runNoErrors(EMPTY_SCHEMA);
}
public void testEmptyAttributes() throws Exception {
runNoErrors(EMPTY_SCHEMA_ATTRIBUTES);
}
public void testEmptyPrefix() throws Exception {
runNoErrors(EMPTY_SCHEMA_PREFIX);
}
public void testEmptyExtraNamespaces() throws Exception {
runNoErrors(EMPTY_SCHEMA_EXTRA_NAMESPACES);
}
public void testEmptyExtraAttribute() throws Exception {
runNoErrors(EMPTY_SCHEMA_EXTRA_ATTRIBUTE);
}
public void testEmptyUnknownAttribute() throws Exception {
runOneError(EMPTY_SCHEMA_UNKNOWN_ATTRIBUTE,
"Unknown attribute not reported");
}
public void testEmptyAllAttributes1() throws Exception {
runNoErrors(EMPTY_SCHEMA_ALL_ATTRIBUTES1);
}
public void testEmptyAllAttributes2() throws Exception {
runNoErrors(EMPTY_SCHEMA_ALL_ATTRIBUTES2);
}
public void testEmptyUnknownValues() throws Exception {
runErrors(EMPTY_SCHEMA_UNKNOWN_VALUES, 4,
"Unknown attribute value not reported");
}
} libjibx-java-1.1.6a/build/test/org/jibx/schema/elements/SchemaPaths.java 0000644 0001750 0001750 00000022206 10752423164 026030 0 ustar moeller moeller
package org.jibx.schema.elements;
import org.jibx.schema.SchemaTestBase;
/**
* Test handling of schemas paths.
*/
public class SchemaPaths extends SchemaTestBase
{
public static final String TEST_SCHEMA =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
private void verifyNoProblems() {
assertFalse(getProblemText(m_validationContext), hasProblem(m_validationContext));
}
public void testDirectSpecification() throws Exception {
SchemaElement schema = prepareSchema(TEST_SCHEMA);
SchemaPath path = SchemaPath.buildPath(null, "complexType", "simple", null, this, m_validationContext);
verifyNoProblems();
OpenAttrBase match = path.matchUnique(schema);
verifyNoProblems();
assertTrue("Path not matched", match instanceof ComplexTypeElement);
path = SchemaPath.buildPath(null, "complexType", null, "1", this, m_validationContext);
verifyNoProblems();
match = path.matchUnique(schema);
verifyNoProblems();
assertTrue("Path not matched", match instanceof ComplexTypeElement);
path = SchemaPath.buildPath(null, "complexType", "simple", "1", this, m_validationContext);
verifyNoProblems();
match = path.matchUnique(schema);
verifyNoProblems();
assertTrue("Path not matched", match instanceof ComplexTypeElement);
}
public void testDirectPath() throws Exception {
SchemaElement schema = prepareSchema(TEST_SCHEMA);
SchemaPath path = SchemaPath.buildPath("complexType[@name=simple]", "complexType", null, null, this,
m_validationContext);
verifyNoProblems();
OpenAttrBase match = path.matchUnique(schema);
verifyNoProblems();
assertTrue("Path not matched", match instanceof ComplexTypeElement);
path = SchemaPath.buildPath("complexType[1]", "complexType", null, null, this, m_validationContext);
verifyNoProblems();
match = path.matchUnique(schema);
verifyNoProblems();
assertTrue("Path not matched", match instanceof ComplexTypeElement);
path = SchemaPath.buildPath("complexType[@name=simple][1]", "complexType", null, null, this,
m_validationContext);
verifyNoProblems();
match = path.matchUnique(schema);
verifyNoProblems();
assertTrue("Path not matched", match instanceof ComplexTypeElement);
path = SchemaPath.buildPath("[@name=simple][1]", "complexType", null, null, this, m_validationContext);
verifyNoProblems();
match = path.matchUnique(schema);
verifyNoProblems();
assertTrue("Path not matched", match instanceof ComplexTypeElement);
}
public void testPathAndSpecification() throws Exception {
SchemaElement schema = prepareSchema(TEST_SCHEMA);
SchemaPath path = SchemaPath.buildPath("complexType[@name=complex]/", "attribute", "male", null, this,
m_validationContext);
verifyNoProblems();
OpenAttrBase match = path.matchUnique(schema);
verifyNoProblems();
assertTrue("Path not matched",
match instanceof AttributeElement && ((AttributeElement)match).getName().equals("male"));
path = SchemaPath.buildPath("complexType[1]/", "attribute", null, "2", this, m_validationContext);
verifyNoProblems();
match = path.matchUnique(schema);
verifyNoProblems();
assertTrue("Path not matched",
match instanceof AttributeElement && ((AttributeElement)match).getName().equals("registered"));
path = SchemaPath.buildPath("complexType[2]/", "sequence", null, null, this, m_validationContext);
verifyNoProblems();
match = path.matchUnique(schema);
verifyNoProblems();
assertTrue("Path not matched", match instanceof SequenceElement);
}
public void testWildcardPath() throws Exception {
SchemaElement schema = prepareSchema(TEST_SCHEMA);
SchemaPath path = SchemaPath.buildPath("complexType[@name=complex]/*/element[@name=age]", "element", null, null,
this, m_validationContext);
verifyNoProblems();
OpenAttrBase match = path.matchUnique(schema);
verifyNoProblems();
assertTrue("Path not matched",
match instanceof ElementElement && ((ElementElement)match).getName().equals("age"));
path = SchemaPath.buildPath("complexType[1]/*/element[3]", "element", null, null, this, m_validationContext);
verifyNoProblems();
match = path.matchUnique(schema);
verifyNoProblems();
assertTrue("Path not matched", match instanceof ElementElement && ((ElementElement)match).getName() == null);
path = SchemaPath.buildPath("complexType[1]/*/[3]", "element", null, null, this, m_validationContext);
verifyNoProblems();
match = path.matchUnique(schema);
verifyNoProblems();
assertTrue("Path not matched", match instanceof ElementElement && ((ElementElement)match).getName() == null);
path = SchemaPath.buildPath("complexType[1]/**/[3]", "element", null, null, this, m_validationContext);
verifyNoProblems();
match = path.matchUnique(schema);
verifyNoProblems();
assertTrue("Path not matched", match instanceof ElementElement && ((ElementElement)match).getName() == null);
path = SchemaPath.buildPath("complexType[2]/**/[3]", "enumeration", null, null, this, m_validationContext);
verifyNoProblems();
match = path.matchUnique(schema);
verifyNoProblems();
assertTrue("Path not matched", match instanceof FacetElement.Enumeration &&
((FacetElement.Enumeration)match).getValue().equals("good"));
}
public void testErrors() throws Exception {
SchemaElement schema = prepareSchema(TEST_SCHEMA);
SchemaPath path = SchemaPath.buildPath("complexType[1][1]/", "element", null, null, this, m_validationContext);
assertTrue("Multiple position predicates on path step", hasProblem(m_validationContext));
m_validationContext.getProblems().clear();
path = SchemaPath.buildPath("complexType[1][@name=xxx]/", "element", null, null, this, m_validationContext);
assertTrue("Predicates in wrong order on path step", hasProblem(m_validationContext));
m_validationContext.getProblems().clear();
path = SchemaPath.buildPath("complexType[1]/*/[3]", "element", null, "2", this, m_validationContext);
assertTrue("Position predicate mismatch with specified value", hasProblem(m_validationContext));
m_validationContext.getProblems().clear();
path = SchemaPath.buildPath("complexType[1]/*/[@name=xxx]", "element", "yyy", null, this, m_validationContext);
assertTrue("Name predicate mismatch with specified value", hasProblem(m_validationContext));
m_validationContext.getProblems().clear();
path = SchemaPath.buildPath("complexType[1]/**/", "element", null, null, this, m_validationContext);
verifyNoProblems();
OpenAttrBase match = path.matchUnique(schema);
assertTrue("Multiple matches for path expression", hasProblem(m_validationContext));
m_validationContext.getProblems().clear();
assertNull("Multiple matches for path expression", match);
path = SchemaPath.buildPath("complexType[2]/**/[7]", "enumeration", null, null, this, m_validationContext);
verifyNoProblems();
match = path.matchUnique(schema);
assertTrue("No match for path expression", hasProblem(m_validationContext));
m_validationContext.getProblems().clear();
assertNull("No match for path expression", match);
}
} libjibx-java-1.1.6a/build/test/org/jibx/schema/elements/SimpleComplexTypes.java 0000644 0001750 0001750 00000007257 10602647122 027443 0 ustar moeller moeller
package org.jibx.schema.elements;
import org.jibx.schema.SchemaTestBase;
/**
* Test handling of schemas with simple complex type definitions.
*/
public class SimpleComplexTypes extends SchemaTestBase
{
public static final String COMPLEX_EMPTY_SCHEMA =
"\n" +
" \n" +
"";
public static final String COMPLEX_SEQUENCE_SCHEMA =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public static final String COMPLEX_SEQUENCE_ATTRIBUTES_SCHEMA =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public static final String COMPLEX_EMBEDDED_SCHEMA =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public static final String COMPLEX_REFERENCED_SCHEMA =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public void testComplexEmpty() throws Exception {
runNoErrors(COMPLEX_EMPTY_SCHEMA);
}
public void testComplexSequence() throws Exception {
runNoErrors(COMPLEX_SEQUENCE_SCHEMA);
}
public void testComplexSequenceAttributes() throws Exception {
runNoErrors(COMPLEX_SEQUENCE_ATTRIBUTES_SCHEMA);
}
public void testComplexEmbedded() throws Exception {
runNoErrors(COMPLEX_EMBEDDED_SCHEMA);
}
public void testComplexReferenced() throws Exception {
runNoErrors(COMPLEX_REFERENCED_SCHEMA);
}
} libjibx-java-1.1.6a/build/test/org/jibx/schema/elements/SimpleGlobals.java 0000644 0001750 0001750 00000011152 10602647122 026357 0 ustar moeller moeller
package org.jibx.schema.elements;
import org.jibx.schema.SchemaTestBase;
/**
* Test handling of simple schemas with only global elements or attributes and
* no nested structure.
*/
public class SimpleGlobals extends SchemaTestBase
{
public static final String SIMPLE_ELEMENT_BLANK_SCHEMA =
"\n" +
" \n" +
"";
public static final String SIMPLE_ATTRIBUTE_BLANK_SCHEMA =
"\n" +
" \n" +
"";
public static final String SIMPLE_ELEMENT_SCHEMA =
"\n" +
" \n" +
"";
public static final String SIMPLE_ATTRIBUTE_SCHEMA =
"\n" +
" \n" +
"";
public static final String COMPLEX_ELEMENT_SCHEMA =
"\n" +
" \n" +
" \n" +
" this should mean something\n" +
" \n" +
" \n" +
"";
public static final String COMPLEX_ATTRIBUTE_SCHEMA =
"\n" +
" \n" +
" \n" +
" this should mean something\n" +
" \n" +
" \n" +
" \n" +
"";
public static final String COMPLEX_ELEMENT_ERROR_SCHEMA =
"\n" +
" \n" +
"";
public static final String COMPLEX_ATTRIBUTE_ERROR_SCHEMA =
"\n" +
" \n" +
"";
public static final String ELEMENT_TYPE_REFERENCE_ERROR_SCHEMA =
"\n" +
" \n" +
"";
public void testSimpleElementBlank() throws Exception {
runNoErrors(SIMPLE_ELEMENT_BLANK_SCHEMA);
}
public void testSimpleAttributeBlank() throws Exception {
runNoErrors(SIMPLE_ATTRIBUTE_BLANK_SCHEMA);
}
public void testSimpleElement() throws Exception {
runNoErrors(SIMPLE_ELEMENT_SCHEMA);
}
public void testSimpleAttribute() throws Exception {
runNoErrors(SIMPLE_ATTRIBUTE_SCHEMA);
}
public void testComplexElement() throws Exception {
runNoErrors(COMPLEX_ELEMENT_SCHEMA);
}
public void testComplexAttribute() throws Exception {
runNoErrors(COMPLEX_ATTRIBUTE_SCHEMA);
}
public void testComplexElementError() throws Exception {
runOneError(COMPLEX_ELEMENT_ERROR_SCHEMA,
"Invalid attributes on global not reported");
}
public void testComplexAttributeError() throws Exception {
runOneError(COMPLEX_ATTRIBUTE_ERROR_SCHEMA,
"Invalid attributes on global not reported");
}
public void testElementTypeReferenceError() throws Exception {
runOneError(ELEMENT_TYPE_REFERENCE_ERROR_SCHEMA,
"Undefined type reference on not reported");
}
} libjibx-java-1.1.6a/build/test/org/jibx/schema/elements/SimpleGroups.java 0000644 0001750 0001750 00000012166 10602647122 026261 0 ustar moeller moeller
package org.jibx.schema.elements;
import org.jibx.schema.SchemaTestBase;
/**
* Test handling of schemas with simple group and attributeGroup components.
*/
public class SimpleGroups extends SchemaTestBase
{
public static final String GROUP_EMPTY_SCHEMA =
"\n" +
" \n" +
" \n" +
" \n" +
"";
public static final String ATTRIBUTEGROUP_EMPTY_SCHEMA =
"\n" +
" \n" +
"";
public static final String GROUP_SIMPLE_SCHEMA1 =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public static final String GROUP_SIMPLE_SCHEMA2 =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public static final String GROUP_SIMPLE_SCHEMA3 =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public static final String ATTRIBUTEGROUP_SIMPLE_SCHEMA =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public static final String GROUP_REF_SCHEMA =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public static final String ATTRIBUTEGROUP_REF_SCHEMA =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public void testGroupEmpty() throws Exception {
runNoErrors(GROUP_EMPTY_SCHEMA);
}
public void testAttributeGroupEmpty() throws Exception {
runNoErrors(ATTRIBUTEGROUP_EMPTY_SCHEMA);
}
public void testGroupSimpleSchema1() throws Exception {
runNoErrors(GROUP_SIMPLE_SCHEMA1);
}
public void testGroupSimpleSchema2() throws Exception {
runNoErrors(GROUP_SIMPLE_SCHEMA2);
}
public void testGroupSimpleSchema3() throws Exception {
runNoErrors(GROUP_SIMPLE_SCHEMA3);
}
public void testAttributeGroupSimple() throws Exception {
runNoErrors(ATTRIBUTEGROUP_SIMPLE_SCHEMA);
}
public void testGroupRef() throws Exception {
runNoErrors(GROUP_REF_SCHEMA);
}
public void testAttributeGroupRef() throws Exception {
runNoErrors(ATTRIBUTEGROUP_REF_SCHEMA);
}
} libjibx-java-1.1.6a/build/test/org/jibx/schema/elements/SimpleSimpleTypes.java 0000644 0001750 0001750 00000032624 10602647122 027261 0 ustar moeller moeller
package org.jibx.schema.elements;
import org.jibx.schema.SchemaTestBase;
/**
* Test handling of schemas with simple simple type definitions.
*/
public class SimpleSimpleTypes extends SchemaTestBase
{
public static final String PREDEFINED_SIMPLE_TYPES =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public static final String SIMPLE_RESTRICTION_SCHEMA =
"\n" +
" \n" +
" \n" +
" \n" +
"";
public static final String COMPLEX_RESTRICTION_SCHEMA1 =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public static final String COMPLEX_RESTRICTION_SCHEMA2 =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public static final String COMPLEX_RESTRICTION_SCHEMA3 =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public static final String RESTRICTION_FACET_ERROR_SCHEMA =
// invalid attributes on facets
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public static final String RESTRICTION_REFERENCE_SCHEMA =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public static final String SIMPLE_LIST_SCHEMA =
"\n" +
" \n" +
" \n" +
" \n" +
"";
public static final String RESTRICTION_LIST_SCHEMA =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public static final String REFERENCE_LIST_SCHEMA =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public static final String LIST_ERROR_SCHEMA =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public static final String UNION_REFERENCE_SCHEMA =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public static final String UNION_INLINE_SCHEMA =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public static final String UNION_MIXED_SCHEMA =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public void testPredefinedSimpleTypes() throws Exception {
runNoErrors(PREDEFINED_SIMPLE_TYPES);
}
public void testSimpleRestriction() throws Exception {
runNoErrors(SIMPLE_RESTRICTION_SCHEMA);
}
public void testComplexRestrictionSchema1() throws Exception {
runNoErrors(COMPLEX_RESTRICTION_SCHEMA1);
}
public void testComplexRestrictionSchema2() throws Exception {
runNoErrors(COMPLEX_RESTRICTION_SCHEMA2);
}
public void testComplexRestrictionSchema3() throws Exception {
runNoErrors(COMPLEX_RESTRICTION_SCHEMA3);
}
public void testRestrictionFacetError() throws Exception {
runOneError(RESTRICTION_FACET_ERROR_SCHEMA,
"facets with illegal attribute not reported");
}
public void testRestrictionReference() throws Exception {
runNoErrors(RESTRICTION_REFERENCE_SCHEMA);
}
public void testSimpleList() throws Exception {
runNoErrors(SIMPLE_LIST_SCHEMA);
}
public void testRestrictionList() throws Exception {
runNoErrors(RESTRICTION_LIST_SCHEMA);
}
public void testReferenceList() throws Exception {
runNoErrors(REFERENCE_LIST_SCHEMA);
}
public void testListError() throws Exception {
runOneError(LIST_ERROR_SCHEMA,
" with embedded type and itemType attribute not reported");
}
public void testUnionReference() throws Exception {
runNoErrors(UNION_REFERENCE_SCHEMA);
}
public void testUnionInline() throws Exception {
runNoErrors(UNION_INLINE_SCHEMA);
}
public void testUnionMixed() throws Exception {
runNoErrors(UNION_MIXED_SCHEMA);
}
} libjibx-java-1.1.6a/build/test/org/jibx/schema/SchemaSuite.java 0000644 0001750 0001750 00000001045 10752423130 024215 0 ustar moeller moeller package org.jibx.schema;
import org.jibx.schema.codegen.CodegenSuite;
import org.jibx.schema.elements.ElementsSuite;
import org.jibx.schema.elements.SchemaPaths;
import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;
public class SchemaSuite extends TestCase
{
public static Test suite() {
TestSuite suite = new TestSuite();
suite.addTest(ElementsSuite.suite());
suite.addTest(CodegenSuite.suite());
suite.addTestSuite(SchemaPaths.class);
return suite;
}
}
libjibx-java-1.1.6a/build/test/org/jibx/schema/SchemaTestBase.java 0000644 0001750 0001750 00000027256 10756366774 024702 0 ustar moeller moeller package org.jibx.schema;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.PrintStream;
import java.io.StringReader;
import java.io.StringWriter;
import java.net.URL;
import java.util.ArrayList;
import java.util.Map;
import junit.framework.TestCase;
import org.jibx.binding.Loader;
import org.jibx.binding.Utility;
import org.jibx.binding.classes.BoundClass;
import org.jibx.binding.classes.ClassCache;
import org.jibx.binding.classes.ClassFile;
import org.jibx.binding.classes.MungedClass;
import org.jibx.binding.def.BindingDefinition;
import org.jibx.extras.DocumentComparator;
import org.jibx.runtime.BindingDirectory;
import org.jibx.runtime.IBindingFactory;
import org.jibx.runtime.IMarshallingContext;
import org.jibx.runtime.IUnmarshallable;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
import org.jibx.schema.codegen.custom.SchemasetCustom;
import org.jibx.schema.elements.SchemaElement;
import org.jibx.schema.validation.PrevalidationVisitor;
import org.jibx.schema.validation.RegistrationVisitor;
import org.jibx.schema.validation.ValidationContext;
import org.jibx.schema.validation.ValidationProblem;
import org.jibx.schema.validation.ValidationVisitor;
/**
* Base class for all schema tests. This binds and loads the schema classes during initialization, and provides access
* methods for working with the schema classes.
*/
public class SchemaTestBase extends TestCase
{
private static final String SCHEMA_CLASS = "org.jibx.schema.elements.SchemaElement";
private static final IBindingFactory m_bindingFactory;
static {
try {
// set paths to be used for loading referenced classes
URL[] urls = Loader.getClassPaths();
String[] paths = new String[urls.length];
for (int i = 0; i < urls.length; i++) {
paths[i] = urls[i].getFile();
}
ClassCache.setPaths(paths);
ClassFile.setPaths(paths);
// find the binding definition
ClassLoader loader = SchemaTestBase.class.getClassLoader();
InputStream is = loader.getResourceAsStream("org/jibx/schema/binding.xml");
if (is == null) {
throw new RuntimeException("Schema binding definition not found");
}
// process the binding
BoundClass.reset();
MungedClass.reset();
BindingDefinition.reset();
BindingDefinition def = Utility.loadBinding("binding.xml", "binding", is, null, true);
def.generateCode(false);
// output the modified class files
MungedClass.fixChanges(true);
// look up the mapped class and associated binding factory
Class mclas = Class.forName(SCHEMA_CLASS);
m_bindingFactory = BindingDirectory.getFactory(mclas);
} catch (JiBXException e) {
throw new RuntimeException("JiBXException: " + e.getMessage());
} catch (IOException e) {
throw new RuntimeException("IOException: " + e.getMessage());
} catch (ClassNotFoundException e) {
throw new RuntimeException("ClassNotFoundException: " + e.getMessage());
}
}
protected ValidationContext m_validationContext;
protected NameRegister m_nameRegister;
protected void setUp() throws Exception {
m_validationContext = new ValidationContext();
}
/**
* Read a schema definition into model.
*
* @param is schema input stream
* @param vctx validation context
* @return schema element
* @throws Exception
*/
protected SchemaElement readSchema(InputStream is, ValidationContext vctx) throws Exception {
final IUnmarshallingContext ictx = m_bindingFactory.createUnmarshallingContext();
ictx.setDocument(is, null);
ictx.setUserContext(vctx);
SchemaElement schema = (SchemaElement)ictx.unmarshalElement();
m_nameRegister = schema.getRegister();
return schema;
}
/**
* Read a schema definition into model.
*
* @param text schema text
* @param vctx validation context
* @return schema element
* @throws Exception
*/
protected SchemaElement readSchema(String text, ValidationContext vctx) throws Exception {
return readSchema(new ByteArrayInputStream(text.getBytes("utf-8")), vctx);
}
/**
* Validate a schema definition.
*
* @param schema schema element
* @param vctx validation context
*/
protected void validateSchema(SchemaElement schema, ValidationContext vctx) {
TreeWalker tctx = new TreeWalker(vctx, vctx);
tctx.walkSchema(schema, new PrevalidationVisitor(vctx));
vctx.clearTraversed();
tctx.walkSchema(schema, new RegistrationVisitor(vctx));
vctx.clearTraversed();
tctx.walkSchema(schema, new ValidationVisitor(vctx));
}
/**
* Check for validation problem.
*
* @param vctx
* @return true if any problem
*/
protected boolean hasProblem(ValidationContext vctx) {
return vctx.getProblems().size() > 0;
}
/**
* Get validation problem report.
*
* @param vctx
* @return problem text
*/
protected String getProblemText(ValidationContext vctx) {
StringWriter writer = new StringWriter();
writer.append("Problems found in schema definition");
ArrayList problems = vctx.getProblems();
for (int i = 0; i < problems.size(); i++) {
writer.append('\n');
ValidationProblem prob = (ValidationProblem)problems.get(i);
writer.append(prob.getDescription());
}
return writer.toString();
}
/**
* Write schema to text string.
*
* @param schema schema element
* @return output schema text
* @throws Exception
*/
protected String writeSchema(SchemaElement schema) throws Exception {
StringWriter writer = new StringWriter();
IMarshallingContext ictx = m_bindingFactory.createMarshallingContext();
ictx.setOutput(writer);
ictx.setIndent(2);
ictx.marshalDocument(schema);
return writer.toString();
}
/**
* Verify that output schema matches original input. Fails the test if there's any difference between the two
* versions of the schema.
*
* @param text1 original schema text
* @param text2 output schema text
* @throws Exception
*/
protected void verifySchema(String text1, String text2) throws Exception {
StringReader rdr1 = new StringReader(text1);
StringReader rdr2 = new StringReader(text2);
ByteArrayOutputStream bos = new ByteArrayOutputStream();
PrintStream pstr = new PrintStream(bos);
DocumentComparator comp = new DocumentComparator(pstr);
boolean match = comp.compare(rdr1, rdr2);
if (!match) {
pstr.close();
fail("Error roundtripping schema:\n" + new String(bos.toByteArray()) + "\nOriginal schema:\n" + text1
+ "\nOutput schema:\n" + text2);
}
}
/**
* Read and validate schema, with one or more validation errors expected.
*
* @param text schema text
* @param count number of errors expected
* @param msg text for wrong number of errors found
* @throws Exception on unexpected error
*/
protected void runErrors(String text, int count, String msg) throws Exception {
SchemaElement schema = readSchema(text, m_validationContext);
validateSchema(schema, m_validationContext);
assertEquals(msg, count, m_validationContext.getProblems().size());
}
/**
* Read and validate schema, with a particular validation error expected.
*
* @param text schema text
* @param msg text for wrong number of errors found
* @throws Exception on unexpected error
*/
protected void runOneError(String text, String msg) throws Exception {
SchemaElement schema = readSchema(text, m_validationContext);
validateSchema(schema, m_validationContext);
assertTrue(msg, hasProblem(m_validationContext));
}
/**
* Prepare schema model for use.
*
* @param text schema text
* @return schema
* @throws Exception on unexpected error
*/
protected SchemaElement prepareSchema(String text) throws Exception {
SchemaElement schema = readSchema(text, m_validationContext);
validateSchema(schema, m_validationContext);
assertFalse(getProblemText(m_validationContext), hasProblem(m_validationContext));
return schema;
}
/**
* Run schema round-trip with validation, with no validation errors.
*
* @param text schema text
* @return schema
* @throws Exception on unexpected error
*/
protected SchemaElement runNoErrors(String text) throws Exception {
SchemaElement schema = prepareSchema(text);
verifySchema(text, writeSchema(schema));
return schema;
}
/**
* Load and validate schema directly. This takes the root schema resolver as input, and loads the schema along with
* all associated schemas. Only the main schema document is actually validated, though.
*
* @param resolve resolver for all schema texts
* @return root schema
* @throws Exception
*/
protected SchemaElement loadSchema(TestResolver resolve) throws Exception {
SchemaElement schema = readSchema(resolve.getContent(), m_validationContext);
schema.setResolver(resolve);
m_validationContext.setSchema(resolve.getName(), schema);
validateSchema(schema, m_validationContext);
assertFalse(getProblemText(m_validationContext), hasProblem(m_validationContext));
verifySchema(resolve.getText(), writeSchema(schema));
return schema;
}
/**
* Load a code generation customization.
*
* @param text customizations document text
* @throws Exception
*/
protected SchemasetCustom loadCustomization(String text) throws Exception {
SchemasetCustom custom = new SchemasetCustom(null);
IBindingFactory fact = BindingDirectory.getFactory("binding", "org.jibx.schema.codegen.custom");
IUnmarshallingContext ictx = fact.createUnmarshallingContext();
ictx.setDocument(new StringReader(text));
ictx.setUserContext(m_validationContext);
((IUnmarshallable)custom).unmarshal(ictx);
return custom;
}
/**
* Resolver used for handling schema text strings directly.
*/
protected static class TestResolver implements ISchemaResolver
{
/** Schema document. */
private final String m_document;
/** Schema name. */
private final String m_name;
/** Map from schema name to resolver. */
private final Map m_schemaMap;
public TestResolver(String document, String name, Map map) {
m_document = document;
m_name = name;
m_schemaMap = map;
}
public InputStream getContent() throws IOException {
return new ByteArrayInputStream(m_document.getBytes("UTF-8"));
}
public String getId() {
return m_name;
}
public String getName() {
return m_name;
}
public ISchemaResolver resolve(String loc) throws IOException {
return (ISchemaResolver)m_schemaMap.get(loc);
}
public String getText() {
return m_document;
}
}
} libjibx-java-1.1.6a/build/test/org/jibx/ws/ 0000755 0001750 0001750 00000000000 11021525452 020331 5 ustar moeller moeller libjibx-java-1.1.6a/build/test/org/jibx/ws/wsdl/ 0000755 0001750 0001750 00000000000 11023035622 021277 5 ustar moeller moeller libjibx-java-1.1.6a/build/test/org/jibx/ws/wsdl/CustomizationTestBase.java 0000644 0001750 0001750 00000011651 10611643354 026462 0 ustar moeller moeller /*
Copyright (c) 2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.ws.wsdl;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import junit.framework.TestCase;
import org.jibx.binding.Loader;
import org.jibx.binding.Utility;
import org.jibx.binding.classes.BoundClass;
import org.jibx.binding.classes.ClassCache;
import org.jibx.binding.classes.ClassFile;
import org.jibx.binding.classes.MungedClass;
import org.jibx.binding.def.BindingDefinition;
import org.jibx.binding.generator.GlobalCustom;
import org.jibx.runtime.BindingDirectory;
import org.jibx.runtime.IBindingFactory;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
/**
* Test code for class handling.
*/
public class CustomizationTestBase extends TestCase
{
protected static final String ROOT_CLASS = "org.jibx.ws.wsdl.WsdlCustom";
protected static final IBindingFactory m_bindingFactory;
static {
try {
// set paths to be used for loading referenced classes
URL[] urls = Loader.getClassPaths();
String[] paths = new String[urls.length];
for (int i = 0; i < urls.length; i++) {
paths[i] = urls[i].getFile();
}
ClassCache.setPaths(paths);
ClassFile.setPaths(paths);
// find the binding definition
ClassLoader loader = CustomizationTestBase.class.getClassLoader();
URL url = loader.getResource("org/jibx/ws/wsdl/binding.xml");
InputStream is = url.openStream();
if (is == null) {
throw new RuntimeException("Customizations binding definition not found");
}
// process the binding
BoundClass.reset();
MungedClass.reset();
BindingDefinition.reset();
BindingDefinition def = Utility.loadBinding("binding.xml",
"binding", is, url, true);
def.generateCode(false);
// output the modified class files
MungedClass.fixChanges(true);
// look up the mapped class and associated binding factory
Class mclas = Class.forName(ROOT_CLASS);
m_bindingFactory = BindingDirectory.getFactory(mclas);
} catch (JiBXException e) {
throw new RuntimeException("JiBXException: " + e.getMessage());
} catch (IOException e) {
throw new RuntimeException("IOException: " + e.getMessage());
} catch (ClassNotFoundException e) {
throw new RuntimeException("ClassNotFoundException: " +
e.getMessage());
}
}
/**
* Read a customization into model from input stream.
*
* @param is input stream
* @return root element
* @throws Exception
*/
protected GlobalCustom readCustom(InputStream is)
throws Exception {
IUnmarshallingContext ictx =
m_bindingFactory.createUnmarshallingContext();
GlobalCustom global = (GlobalCustom)ictx.unmarshalDocument(is, null);
global.fillClasses();
return global;
}
/**
* Read a customization into model from string.
*
* @param text customization document text
* @return root element
* @throws Exception
*/
protected GlobalCustom readCustom(String text)
throws Exception {
return readCustom(new ByteArrayInputStream(text.getBytes("utf-8")));
}
} libjibx-java-1.1.6a/build/test/org/jibx/ws/wsdl/Service1.java 0000644 0001750 0001750 00000004141 10602647122 023631 0 ustar moeller moeller /*
Copyright (c) 2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.ws.wsdl;
import java.util.List;
import org.jibx.binding.generator.*;
public class Service1
{
public static DataClass1 getStatic() {
return null;
}
public DataClass1 getDataClass1() {
return null;
}
public void setDataClass1(DataClass1 data) {}
public DataClass1 changeDataClass1(int index, DataClass1 data) {
return null;
}
public List getTypedList() {
return null;
}
public void setTypedList(List list) {}
public List getList() {
return null;
}
public void setList(List list) {}
}
libjibx-java-1.1.6a/build/test/org/jibx/ws/wsdl/ServiceCustomTest.java 0000644 0001750 0001750 00000046214 10611643354 025615 0 ustar moeller moeller /*
Copyright (c) 2007, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jibx.ws.wsdl;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.jibx.binding.generator.GlobalCustom;
/**
* Test code for class handling.
*/
public class ServiceCustomTest extends CustomizationTestBase
{
public static final String SIMPLE_SERVICE_CLASS =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public static final String CUSTOMIZED_SERVICE_CLASS1 =
"\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"";
public void testSimpleServiceClass() throws Exception {
GlobalCustom custom = readCustom(SIMPLE_SERVICE_CLASS);
List extens = custom.getExtensionChildren();
assertEquals("extension count", 1, extens.size());
Object item = extens.get(0);
assertTrue("extension child type", item instanceof WsdlCustom);
WsdlCustom wsdl = (WsdlCustom)item;
List services = wsdl.getServices();
assertEquals("service count", 1, services.size());
ServiceCustom service = (ServiceCustom)services.get(0);
assertEquals("service name", "Service1", service.getServiceName());
assertEquals("service port", "Service1Port", service.getPortName());
assertEquals("service binding", "Service1Binding", service.getBindingName());
assertEquals("service portType", "Service1PortType", service.getPortTypeName());
assertEquals("service wsdl namespace", "http://jibx.org/ws/wsdl/Service1", service.getWsdlNamespace());
assertEquals("service schema namespace", "http://jibx.org/ws/wsdl/Service1", service.getNamespace());
assertNull("service address", service.getServiceAddress());
List operations = service.getOperations();
assertEquals("operation count", 7, operations.size());
Map opmap = new HashMap();
for (int i = 0; i < operations.size(); i++) {
OperationCustom op = (OperationCustom)operations.get(i);
opmap.put(op.getOperationName(), op);
}
// getDataClass1 method and operation
OperationCustom op = (OperationCustom)opmap.get("getDataClass1");
assertNotNull("getDataClass1 operation", op);
assertEquals("getDataClass1 request message", "getDataClass1Message", op.getRequestMessageName());
assertEquals("getDataClass1 request wrapper", "getDataClass1", op.getRequestWrapperName());
assertEquals("getDataClass1 response message", "getDataClass1ResponseMessage", op.getResponseMessageName());
assertEquals("getDataClass1 response wrapper", "getDataClass1Response", op.getResponseWrapperName());
List params = op.getParameters();
assertEquals("getDataClass1 parameters count", 0, params.size());
ValueCustom ret = op.getReturn();
assertEquals("getDataClass1 returned type", "org.jibx.binding.generator.DataClass1", ret.getType());
assertNull("getDataClass1 returned element name", ret.getElementName());
// setDataClass1 method and operation
op = (OperationCustom)opmap.get("setDataClass1");
assertNotNull("setDataClass1 operation", op);
assertEquals("setDataClass1 request message", "setDataClass1Message", op.getRequestMessageName());
assertEquals("setDataClass1 request wrapper", "setDataClass1", op.getRequestWrapperName());
assertEquals("setDataClass1 response message", "setDataClass1ResponseMessage", op.getResponseMessageName());
assertEquals("setDataClass1 response wrapper", "setDataClass1Response", op.getResponseWrapperName());
params = op.getParameters();
assertEquals("setDataClass1 parameters count", 1, params.size());
ValueCustom param = (ValueCustom)params.get(0);
assertEquals("setDataClass1 parameter type", "org.jibx.binding.generator.DataClass1", param.getType());
assertEquals("setDataClass1 returned element name", "data", param.getElementName());
ret = op.getReturn();
assertEquals("setDataClass1 returned type", "void", ret.getType());
assertNull("setDataClass1 returned element name", ret.getElementName());
// changeDataClass1 method and operation
op = (OperationCustom)opmap.get("changeDataClass1");
assertNotNull("changeDataClass1 operation", op);
assertEquals("changeDataClass1 request message", "changeDataClass1Message", op.getRequestMessageName());
assertEquals("changeDataClass1 request wrapper", "changeDataClass1", op.getRequestWrapperName());
assertEquals("changeDataClass1 response message", "changeDataClass1ResponseMessage", op.getResponseMessageName());
assertEquals("changeDataClass1 response wrapper", "changeDataClass1Response", op.getResponseWrapperName());
params = op.getParameters();
assertEquals("setDataClass1 parameters count", 2, params.size());
param = (ValueCustom)params.get(0);
assertEquals("changeDataClass1 parameter type", "int", param.getType());
assertEquals("changeDataClass1 returned element name", "index", param.getElementName());
param = (ValueCustom)params.get(1);
assertEquals("changeDataClass1 parameter type", "org.jibx.binding.generator.DataClass1", param.getType());
assertEquals("changeDataClass1 returned element name", "data", param.getElementName());
ret = op.getReturn();
assertEquals("changeDataClass1 returned type", "org.jibx.binding.generator.DataClass1", ret.getType());
assertNull("changeDataClass1 returned element name", ret.getElementName());
// getTypedList method and operation
op = (OperationCustom)opmap.get("getTypedList");
assertNotNull("getTypedList operation", op);
assertEquals("getTypedList request message", "getTypedListMessage", op.getRequestMessageName());
assertEquals("getTypedList request wrapper", "getTypedList", op.getRequestWrapperName());
assertEquals("getTypedList response message", "getTypedListResponseMessage", op.getResponseMessageName());
assertEquals("getTypedList response wrapper", "getTypedListResponse", op.getResponseWrapperName());
params = op.getParameters();
assertEquals("getTypedList parameters count", 0, params.size());
ret = op.getReturn();
assertEquals("getTypedList returned type", "java.util.List", ret.getType());
assertEquals("getTypedList returned item type", "org.jibx.binding.generator.DataClass1", ret.getItemType());
assertNull("getTypedList returned element name", ret.getElementName());
assertEquals("getTypedList returned item element name", "dataClass1", ret.getItemElementName());
// setTypedList method and operation
op = (OperationCustom)opmap.get("setTypedList");
assertNotNull("setTypedList operation", op);
assertEquals("setTypedList request message", "setTypedListMessage", op.getRequestMessageName());
assertEquals("setTypedList request wrapper", "setTypedList", op.getRequestWrapperName());
assertEquals("setTypedList response message", "setTypedListResponseMessage", op.getResponseMessageName());
assertEquals("setTypedList response wrapper", "setTypedListResponse", op.getResponseWrapperName());
params = op.getParameters();
assertEquals("setTypedList parameters count", 1, params.size());
param = (ValueCustom)params.get(0);
assertEquals("setTypedList parameter type", "java.util.List", param.getType());
assertEquals("setTypedList parameter item type", "org.jibx.binding.generator.DataClass1", param.getItemType());
assertEquals("setTypedList parameter element name", "list", param.getElementName());
assertEquals("setTypedList parameter item element name", "dataClass1", param.getItemElementName());
ret = op.getReturn();
assertEquals("setTypedList returned type", "void", ret.getType());
assertNull("setTypedList returned element name", ret.getElementName());
// getList method and operation
op = (OperationCustom)opmap.get("getList");
assertNotNull("getList operation", op);
assertEquals("getList request message", "getListMessage", op.getRequestMessageName());
assertEquals("getList request wrapper", "getList", op.getRequestWrapperName());
assertEquals("getList response message", "getListResponseMessage", op.getResponseMessageName());
assertEquals("getList response wrapper", "getListResponse", op.getResponseWrapperName());
params = op.getParameters();
assertEquals("getList parameters count", 0, params.size());
ret = op.getReturn();
assertEquals("getList returned type", "java.util.List", ret.getType());
assertEquals("getList returned item type", "java.lang.Object", ret.getItemType());
assertNull("getList returned element name", ret.getElementName());
assertEquals("getList returned item element name", "item", ret.getItemElementName());
// setList method and operation
op = (OperationCustom)opmap.get("setList");
assertNotNull("setList operation", op);
assertEquals("setList request message", "setListMessage", op.getRequestMessageName());
assertEquals("setList request wrapper", "setList", op.getRequestWrapperName());
assertEquals("setList response message", "setListResponseMessage", op.getResponseMessageName());
assertEquals("setList response wrapper", "setListResponse", op.getResponseWrapperName());
params = op.getParameters();
assertEquals("setList parameters count", 1, params.size());
param = (ValueCustom)params.get(0);
assertEquals("setList parameter type", "java.util.List", param.getType());
assertEquals("setList parameter item type", "java.lang.Object", param.getItemType());
assertEquals("setList parameter element name", "list", param.getElementName());
assertEquals("setList parameter item element name", "item", param.getItemElementName());
ret = op.getReturn();
assertEquals("setList returned type", "void", ret.getType());
assertNull("setList returned element name", ret.getElementName());
}
public void testCustomizedServiceClass1() throws Exception {
GlobalCustom custom = readCustom(CUSTOMIZED_SERVICE_CLASS1);
List extens = custom.getExtensionChildren();
assertEquals("extension count", 1, extens.size());
Object item = extens.get(0);
assertTrue("extension child type", item instanceof WsdlCustom);
WsdlCustom wsdl = (WsdlCustom)item;
List services = wsdl.getServices();
assertEquals("service count", 1, services.size());
ServiceCustom service = (ServiceCustom)services.get(0);
assertEquals("service name", "MyService", service.getServiceName());
assertEquals("service port", "MyPort", service.getPortName());
assertEquals("service binding", "MyBinding", service.getBindingName());
assertEquals("service portType", "MyPortType", service.getPortTypeName());
assertEquals("service wsdl namespace", "urn:a", service.getWsdlNamespace());
assertEquals("service schema namespace", "urn:b", service.getNamespace());
assertEquals("service address", "http://localhost:8080/jibxsoap/MyService", service.getServiceAddress());
List operations = service.getOperations();
assertEquals("operation count", 4, operations.size());
Map opmap = new HashMap();
for (int i = 0; i < operations.size(); i++) {
OperationCustom op = (OperationCustom)operations.get(i);
opmap.put(op.getOperationName(), op);
}
// getTypedList method and operation
OperationCustom op = (OperationCustom)opmap.get("getTypedList");
assertNotNull("getTypedList operation", op);
assertEquals("getTypedList request message", "getTypedListMessage", op.getRequestMessageName());
assertEquals("getTypedList request wrapper", "getTypedList", op.getRequestWrapperName());
assertEquals("getTypedList response message", "getTypedListResponseMessage", op.getResponseMessageName());
assertEquals("getTypedList response wrapper", "getTypedListResponse", op.getResponseWrapperName());
List params = op.getParameters();
assertEquals("getTypedList parameters count", 0, params.size());
ValueCustom ret = op.getReturn();
assertEquals("getTypedList returned type", "java.util.List", ret.getType());
assertEquals("getTypedList returned item type", "org.jibx.binding.generator.DataClass1", ret.getItemType());
assertNull("getTypedList returned element name", ret.getElementName());
assertEquals("getTypedList returned item element name", "dataClass1", ret.getItemElementName());
// setTypedList method and operation
op = (OperationCustom)opmap.get("setTypedList");
assertNotNull("setTypedList operation", op);
assertEquals("setTypedList request message", "setTypedListMessage", op.getRequestMessageName());
assertEquals("setTypedList request wrapper", "setTypedList", op.getRequestWrapperName());
assertEquals("setTypedList response message", "setTypedListResponseMessage", op.getResponseMessageName());
assertEquals("setTypedList response wrapper", "setTypedListResponse", op.getResponseWrapperName());
params = op.getParameters();
assertEquals("setTypedList parameters count", 1, params.size());
ValueCustom param = (ValueCustom)params.get(0);
assertEquals("setTypedList parameter type", "java.util.List", param.getType());
assertEquals("setTypedList parameter item type", "org.jibx.binding.generator.DataClass1", param.getItemType());
assertEquals("setTypedList parameter element name", "list", param.getElementName());
assertEquals("setTypedList parameter item element name", "dataClass1", param.getItemElementName());
ret = op.getReturn();
assertEquals("setTypedList returned type", "void", ret.getType());
assertNull("setTypedList returned element name", ret.getElementName());
// getList method and operation
op = (OperationCustom)opmap.get("getList");
assertNotNull("getList operation", op);
assertEquals("getList request message", "glreq", op.getRequestMessageName());
assertEquals("getList request wrapper", "glreqwrap", op.getRequestWrapperName());
assertEquals("getList response message", "glrsp", op.getResponseMessageName());
assertEquals("getList response wrapper", "glrspwrap", op.getResponseWrapperName());
params = op.getParameters();
assertEquals("getList parameters count", 0, params.size());
ret = op.getReturn();
assertEquals("getList returned type", "java.util.List", ret.getType());
assertEquals("getList returned item type", "org.jibx.binding.generator.DataClass1", ret.getItemType());
assertNull("getList returned element name", ret.getElementName());
assertEquals("getList returned item element name", "dataClass1", ret.getItemElementName());
// setList method and operation
op = (OperationCustom)opmap.get("setList");
assertNotNull("setList operation", op);
assertEquals("setList request message", "setListMessage", op.getRequestMessageName());
assertEquals("setList request wrapper", "setList", op.getRequestWrapperName());
assertEquals("setList response message", "setListResponseMessage", op.getResponseMessageName());
assertEquals("setList response wrapper", "setListResponse", op.getResponseWrapperName());
params = op.getParameters();
assertEquals("setList parameters count", 1, params.size());
param = (ValueCustom)params.get(0);
assertEquals("setList parameter type", "java.util.List", param.getType());
assertEquals("setList parameter item type", "org.jibx.binding.generator.DataClass1", param.getItemType());
assertEquals("setList parameter element name", "data-classes", param.getElementName());
assertEquals("setList parameter item element name", "data-class", param.getItemElementName());
ret = op.getReturn();
assertEquals("setList returned type", "void", ret.getType());
assertNull("setList returned element name", ret.getElementName());
}
} libjibx-java-1.1.6a/build/test/org/jibx/ws/wsdl/SignatureParserTest.java 0000644 0001750 0001750 00000017770 10602647122 026142 0 ustar moeller moeller package org.jibx.ws.wsdl;
import junit.framework.TestCase;
public class SignatureParserTest extends TestCase
{
private static final String RETURN_PARAMETERIZED_SIGNATURE =
"Signature(()Ljava/util/List;)";
private static final String CALL_PARAMETERIZED_SIGNATURE =
"Signature((Ljava/util/List;)V)";
private static final String COMPLEX_PARAMETERIZED_SIGNATURE =
"Signature((ILjava/util/List;Ljava/util/List;Ljava/lang/Object;Ljava/lang/Integer;ZF)Ljava/util/List;)";
public void testReturnParameterized() {
SignatureParser parse = new SignatureParser(RETURN_PARAMETERIZED_SIGNATURE);
assertEquals("start method parameters event", SignatureParser.METHOD_PARAMETERS_START_EVENT, parse.next());
assertEquals("start method parameters state", SignatureParser.METHOD_PARAMETERS_START_EVENT, parse.getEvent());
assertEquals("end method parameters event", SignatureParser.METHOD_PARAMETERS_END_EVENT, parse.next());
assertEquals("type event", SignatureParser.TYPE_EVENT, parse.next());
assertEquals("type value", "java.util.List", parse.getType());
assertFalse("type primitive", parse.isPrimitive());
assertTrue("type parameterized", parse.isParameterized());
assertEquals("start type parameters event", SignatureParser.TYPE_PARAMETERS_START_EVENT, parse.next());
assertEquals("type event", SignatureParser.TYPE_EVENT, parse.next());
assertEquals("type value", "org.jibx.binding.generator.DataClass1", parse.getType());
assertFalse("type primitive", parse.isPrimitive());
assertFalse("type parameterized", parse.isParameterized());
assertEquals("end type parameters event", SignatureParser.TYPE_PARAMETERS_END_EVENT, parse.next());
assertEquals("end event", SignatureParser.END_EVENT, parse.next());
}
public void testCallParameterized() {
SignatureParser parse = new SignatureParser(CALL_PARAMETERIZED_SIGNATURE);
assertEquals("start method parameters event", SignatureParser.METHOD_PARAMETERS_START_EVENT, parse.next());
assertEquals("type event", SignatureParser.TYPE_EVENT, parse.next());
assertEquals("type value", "java.util.List", parse.getType());
assertFalse("type primitive", parse.isPrimitive());
assertTrue("type parameterized", parse.isParameterized());
assertEquals("start type parameters event", SignatureParser.TYPE_PARAMETERS_START_EVENT, parse.next());
assertEquals("type event", SignatureParser.TYPE_EVENT, parse.next());
assertEquals("type value", "org.jibx.binding.generator.DataClass1", parse.getType());
assertFalse("type primitive", parse.isPrimitive());
assertFalse("type parameterized", parse.isParameterized());
assertEquals("end type parameters event", SignatureParser.TYPE_PARAMETERS_END_EVENT, parse.next());
assertEquals("end method parameters event", SignatureParser.METHOD_PARAMETERS_END_EVENT, parse.next());
assertEquals("type event", SignatureParser.TYPE_EVENT, parse.next());
assertEquals("type value", "void", parse.getType());
assertTrue("type primitive", parse.isPrimitive());
assertFalse("type parameterized", parse.isParameterized());
assertEquals("end event", SignatureParser.END_EVENT, parse.next());
}
public void testComplexParameterized() {
SignatureParser parse = new SignatureParser(COMPLEX_PARAMETERIZED_SIGNATURE);
assertEquals("start method parameters event", SignatureParser.METHOD_PARAMETERS_START_EVENT, parse.next());
// first method parameter is an int
assertEquals("type event", SignatureParser.TYPE_EVENT, parse.next());
assertEquals("type value", "int", parse.getType());
assertTrue("type primitive", parse.isPrimitive());
assertFalse("type parameterized", parse.isParameterized());
// second method parameter is a List
assertEquals("type event", SignatureParser.TYPE_EVENT, parse.next());
assertEquals("type value", "java.util.List", parse.getType());
assertFalse("type primitive", parse.isPrimitive());
assertTrue("type parameterized", parse.isParameterized());
assertEquals("start type parameters event", SignatureParser.TYPE_PARAMETERS_START_EVENT, parse.next());
assertEquals("type event", SignatureParser.TYPE_EVENT, parse.next());
assertEquals("type value", "org.jibx.binding.generator.DataClass1", parse.getType());
assertFalse("type primitive", parse.isPrimitive());
assertFalse("type parameterized", parse.isParameterized());
assertEquals("end type parameters event", SignatureParser.TYPE_PARAMETERS_END_EVENT, parse.next());
// third method parameter is a List
assertEquals("type event", SignatureParser.TYPE_EVENT, parse.next());
assertEquals("type value", "java.util.List", parse.getType());
assertFalse("type primitive", parse.isPrimitive());
assertTrue("type parameterized", parse.isParameterized());
assertEquals("start type parameters event", SignatureParser.TYPE_PARAMETERS_START_EVENT, parse.next());
assertEquals("type event", SignatureParser.TYPE_EVENT, parse.next());
assertEquals("type value", "java.lang.String", parse.getType());
assertFalse("type primitive", parse.isPrimitive());
assertFalse("type parameterized", parse.isParameterized());
assertEquals("end type parameters event", SignatureParser.TYPE_PARAMETERS_END_EVENT, parse.next());
// fourth method parameter is an Object
assertEquals("type event", SignatureParser.TYPE_EVENT, parse.next());
assertEquals("type value", "java.lang.Object", parse.getType());
assertFalse("type primitive", parse.isPrimitive());
assertFalse("type parameterized", parse.isParameterized());
// fifth method parameter is an Integer
assertEquals("type event", SignatureParser.TYPE_EVENT, parse.next());
assertEquals("type value", "java.lang.Integer", parse.getType());
assertFalse("type primitive", parse.isPrimitive());
assertFalse("type parameterized", parse.isParameterized());
// sixth method parameter is a boolean
assertEquals("type event", SignatureParser.TYPE_EVENT, parse.next());
assertEquals("type value", "boolean", parse.getType());
assertTrue("type primitive", parse.isPrimitive());
assertFalse("type parameterized", parse.isParameterized());
// seventh method parameter is a float
assertEquals("type event", SignatureParser.TYPE_EVENT, parse.next());
assertEquals("type value", "float", parse.getType());
assertTrue("type primitive", parse.isPrimitive());
assertFalse("type parameterized", parse.isParameterized());
assertEquals("end method parameters event", SignatureParser.METHOD_PARAMETERS_END_EVENT, parse.next());
// return value is a List
assertEquals("type event", SignatureParser.TYPE_EVENT, parse.next());
assertEquals("type value", "java.util.List", parse.getType());
assertFalse("type primitive", parse.isPrimitive());
assertTrue("type parameterized", parse.isParameterized());
assertEquals("start type parameters event", SignatureParser.TYPE_PARAMETERS_START_EVENT, parse.next());
assertEquals("type event", SignatureParser.TYPE_EVENT, parse.next());
assertEquals("type value", "org.jibx.binding.generator.DataClass1", parse.getType());
assertFalse("type primitive", parse.isPrimitive());
assertFalse("type parameterized", parse.isParameterized());
assertEquals("end type parameters event", SignatureParser.TYPE_PARAMETERS_END_EVENT, parse.next());
assertEquals("end event", SignatureParser.END_EVENT, parse.next());
}
} libjibx-java-1.1.6a/build/test/simple/ 0000755 0001750 0001750 00000000000 11023035622 017443 5 ustar moeller moeller libjibx-java-1.1.6a/build/test/simple/Address.java 0000644 0001750 0001750 00000003156 10330637714 021712 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
public class Address
{
private Address() {}
public String street1;
public String city;
public String state;
public String zip;
}
libjibx-java-1.1.6a/build/test/simple/Address9.java 0000644 0001750 0001750 00000000216 10311010000 021741 0 ustar moeller moeller package simple;
public class Address9 {
public String street;
public String city;
public String state;
public Integer zip;
}
libjibx-java-1.1.6a/build/test/simple/Company10.java 0000644 0001750 0001750 00000000160 10311010000 022030 0 ustar moeller moeller package simple;
public class Company10 extends Identity10 {
public String name;
public String taxId;
}
libjibx-java-1.1.6a/build/test/simple/Customer0.java 0000644 0001750 0001750 00000003513 10435065574 022210 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
public class Customer0
{
public Name name;
public String street1;
public String city;
public String state;
public String zip;
public String phone;
public Customer0() {
name = new Name();
name.firstName = "first";
name.lastName = "last";
}
public void setName(Name name) {
this.name = name;
}
}
libjibx-java-1.1.6a/build/test/simple/Customer1.java 0000644 0001750 0001750 00000003400 10217763160 022176 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
public class Customer1
{
public String firstName;
public String lastName;
public String street1;
public String city;
public String state;
public String zip;
public String phone;
public boolean hasName() {
return firstName != null || lastName != null;
}
}
libjibx-java-1.1.6a/build/test/simple/Customer10.java 0000644 0001750 0001750 00000000311 10311010000 022221 0 ustar moeller moeller package simple;
public class Customer10 {
public Identity10 identity;
public String street;
public String city;
public String state;
public Integer zip;
public String phone;
}
libjibx-java-1.1.6a/build/test/simple/Customer2.java 0000644 0001750 0001750 00000003520 10330637714 022203 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
public class Customer2
{
public String firstName;
public String lastName;
public Address address;
public String phone;
public boolean hasName() {
return firstName != null || lastName != null;
}
public Address getAddress() {
return address;
}
public void setAddress(Address addr) {
address = addr;
}
}
libjibx-java-1.1.6a/build/test/simple/Customer3.java 0000644 0001750 0001750 00000003602 10221341134 022170 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
import java.util.ArrayList;
public class Customer3
{
public Name name = new Name();
public String street1;
public String city;
public String state;
public String zip;
public String phone;
public Customer3 referral;
public Object oreferral;
public ArrayList orderIds;
public static Name nameFactory() {
throw new IllegalStateException("Name factory should not be called");
}
}
libjibx-java-1.1.6a/build/test/simple/Customer4.java 0000644 0001750 0001750 00000003323 10071714444 022204 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
import java.util.ArrayList;
public class Customer4
{
public Name name;
public Object oname;
public String street1;
public String city;
public String state;
public String zip;
public String phone;
public ArrayList referrals;
}
libjibx-java-1.1.6a/build/test/simple/Customer5.java 0000644 0001750 0001750 00000003404 10071714444 022205 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
import java.util.ArrayList;
public class Customer5 extends Customer5Base
{
public long customerId;
public boolean repeat;
public short orderCount;
public double discount;
// items in array can be Customer5a, Customer5b, and Customer5c (that order)
public ArrayList referrals;
}
libjibx-java-1.1.6a/build/test/simple/Customer5Base.java 0000644 0001750 0001750 00000003204 10071714444 022776 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
public class Customer5Base
{
public Name name;
public String street1;
public String city;
public String state;
public String zip;
public String phone;
}
libjibx-java-1.1.6a/build/test/simple/Customer5a.java 0000644 0001750 0001750 00000003057 10071714444 022352 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
public class Customer5a extends Customer5Base
{
public int sourceCode;
}
libjibx-java-1.1.6a/build/test/simple/Customer5b.java 0000644 0001750 0001750 00000003027 10071714444 022350 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
public class Customer5b extends Customer5Base
{
}
libjibx-java-1.1.6a/build/test/simple/Customer5c.java 0000644 0001750 0001750 00000003056 10071714444 022353 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
public class Customer5c extends Customer5
{
public short qualityCode;
}
libjibx-java-1.1.6a/build/test/simple/Customer6a.java 0000644 0001750 0001750 00000003217 10756367204 022361 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
public class Customer6a extends Customer6aIntermediary
{
public long customerId;
public boolean repeat;
public byte orderCount;
public ICustomer6 innerCustomer;
}
libjibx-java-1.1.6a/build/test/simple/Customer6aBase.java 0000644 0001750 0001750 00000003224 10756367204 023152 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
public abstract class Customer6aBase implements ICustomer6a
{
private Name name;
private String street1;
private String city;
private String state;
private String zip;
}
libjibx-java-1.1.6a/build/test/simple/Customer6aIntermediary.java 0000644 0001750 0001750 00000003107 10410214130 024704 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
public abstract class Customer6aIntermediary extends Customer6aBase
{
public String unused;
}
libjibx-java-1.1.6a/build/test/simple/Customer6b.java 0000644 0001750 0001750 00000003223 10756367204 022357 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
public class Customer6b extends Customer6bBase implements ICustomer6a
{
public long customerId;
public boolean repeat;
public int orderCount;
public float discount;
}
libjibx-java-1.1.6a/build/test/simple/Customer6bBase.java 0000644 0001750 0001750 00000003170 10410214130 023123 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
public abstract class Customer6bBase
{
public Name name;
public String street1;
public String city;
public String state;
public String zip;
}
libjibx-java-1.1.6a/build/test/simple/Customer8a.java 0000644 0001750 0001750 00000004254 10257173436 022363 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
public class Customer8a implements ICustomer8
{
protected String id;
protected Name name;
protected String street1;
protected String city;
protected String state;
protected int zip;
public void setId(String value) { id = value; }
public Name getName() { return name; }
public String getStreet() { return street1; }
public String getCity() { return city; }
public String getState() { return state; }
public String getId() { return id; }
public void setName(Name name) { this.name = name; }
public void setStreet(String value) { street1 = value; }
public void setCity(String value) { city = value; }
public void setState(String value) { state = value; }
}
libjibx-java-1.1.6a/build/test/simple/Customer8b.java 0000644 0001750 0001750 00000004253 10221061172 022343 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
public class Customer8b implements ICustomer8, ICustomer8b
{
public String id;
public Name name;
public String street1;
public String city;
public String state;
public Integer zip;
public String getId() { return id; }
public Name getName() { return name; }
public String getStreet() { return street1; }
public String getCity() { return city; }
public String getState() { return state; }
public void setId(String value) { id = value; }
public void setName(Name name) { this.name = name; }
public void setStreet(String value) { street1 = value; }
public void setCity(String value) { city = value; }
public void setState(String value) { state = value; }
}
libjibx-java-1.1.6a/build/test/simple/Customer8c.java 0000644 0001750 0001750 00000004253 10221061172 022344 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
public class Customer8c implements ICustomer8, ICustomer8c
{
public String id;
public Name name;
public String street1;
public String city;
public String state;
public Integer zip;
public String getId() { return id; }
public Name getName() { return name; }
public String getStreet() { return street1; }
public String getCity() { return city; }
public String getState() { return state; }
public void setId(String value) { id = value; }
public void setName(Name name) { this.name = name; }
public void setStreet(String value) { street1 = value; }
public void setCity(String value) { city = value; }
public void setState(String value) { state = value; }
}
libjibx-java-1.1.6a/build/test/simple/Customer8d.java 0000644 0001750 0001750 00000003221 10257173436 022357 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
public class Customer8d extends Customer8a
{
private Integer getZip() { return new Integer(zip); }
private void setZip(Integer value) { zip = value.intValue(); }
}
libjibx-java-1.1.6a/build/test/simple/Customer9.java 0000644 0001750 0001750 00000000337 10311010000 022161 0 ustar moeller moeller package simple;
public class Customer9 {
public int customerNumber;
public String firstName;
public String lastName;
public Address9 shipAddress;
public Address9 billAddress;
public String phone;
}
libjibx-java-1.1.6a/build/test/simple/Customers6.java 0000644 0001750 0001750 00000005002 10071714444 022365 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
import java.util.Iterator;
public class Customers6
{
private int fillPosition;
private Object[] customers;
private void setCustomerCount(int count) {
customers = new Object[count];
fillPosition = 0;
}
private int getCustomerCount() {
return fillPosition;
}
private void addCustomer(Object obj) {
customers[fillPosition++] = obj;
}
private Iterator getCustomerIterator() {
return new CustomerIterator();
}
private class CustomerIterator implements Iterator {
int nextIndex;
private CustomerIterator() {
nextIndex = 0;
}
public boolean hasNext() {
return nextIndex < fillPosition;
}
public Object next() {
if (nextIndex < fillPosition) {
return customers[nextIndex++];
} else {
return null;
}
}
public void remove() {
throw new UnsupportedOperationException("No remove support");
}
}
}
libjibx-java-1.1.6a/build/test/simple/Customers7.java 0000644 0001750 0001750 00000012370 10756367204 022404 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
import java.util.Iterator;
public class Customers7
{
private DerivedCollection collection = new DerivedCollection();
private void setCustomerCount(int count) {
if (count > 0) {
collection.setCustomerCount(count);
} else {
collection = null;
}
}
private int getCustomerCount() {
if (collection == null) {
return 0;
} else {
return collection.getCustomerCount();
}
}
private void wrappedAddCustomer(Object obj) {
collection.addCustomer((CustomerInterface)obj);
}
private boolean wrappedHasCustomer() {
return collection.hasCustomer();
}
private Iterator wrappedGetCustomerIterator() {
return new CustomerIterator(collection);
}
private static class CustomerCollection {
private int fillPosition;
private CustomerInterface[] customers;
protected void setCustomerCount(int count) {
customers = new Customer[count];
fillPosition = 0;
}
protected int getCustomerCount() {
return fillPosition;
}
protected void addCustomer(CustomerInterface obj) {
customers[fillPosition++] = obj;
}
protected boolean hasCustomer() {
return fillPosition > 0;
}
protected CustomerInterface getCustomer(int index) {
return customers[index];
}
protected Iterator getCustomerIterator() {
return new CustomerIterator(this);
}
}
private static class DerivedCollection extends CustomerCollection {
}
private static class CustomerIterator implements Iterator {
private final CustomerCollection collection;
int nextIndex;
private CustomerIterator(CustomerCollection coll) {
collection = coll;
nextIndex = 0;
}
public boolean hasNext() {
return collection != null && nextIndex < collection.fillPosition;
}
public Object next() {
if (nextIndex < collection.fillPosition) {
return collection.getCustomer(nextIndex++);
} else {
return null;
}
}
public void remove() {
throw new UnsupportedOperationException("No remove support");
}
}
public static CustomerInterface createCustomer() {
return new Customer();
}
public interface CustomerInterface
{
public Name getName();
public String getStreet1();
public String getCity();
public String getState();
public String getZip();
public void setName(Name name);
public void setStreet1(String street1);
public void setCity(String city);
public void setState(String state);
public void setZip(String zip);
}
public interface ExtendedCustomerInterface extends CustomerInterface {}
public static class Customer implements ExtendedCustomerInterface
{
private Name name;
private String street1;
private String city;
private String state;
private String zip;
public Name getName() { return name; }
public String getStreet1() { return street1; }
public String getCity() { return city; }
public String getState() { return state; }
public String getZip() { return zip; }
public void setName(Name name) { this.name = name; }
public void setStreet1(String street1) { this.street1 = street1; }
public void setCity(String city) { this.city = city; }
public void setState(String state) { this.state = state; }
public void setZip(String zip) { this.zip = zip; }
}
}
libjibx-java-1.1.6a/build/test/simple/Customers8.java 0000644 0001750 0001750 00000004400 10257173436 022376 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
import java.util.ArrayList;
public class Customers8
{
private ArrayList customers = new SubclassedArrayList();
private int getCount() {
return customers.size();
}
private Object getObject(int index) {
return customers.get(index);
}
private void addObject(Object obj) {
customers.add(obj);
}
private ICustomer8 getCustomer(int index) {
return (ICustomer8)customers.get(index);
}
private void addCustomer(ICustomer8 customer) {
customers.add(customer);
}
private static class SubclassedArrayList extends ArrayList {
public SubclassedArrayList() { super(); }
private void internalAddCustomer(ICustomer8 customer) {
super.add(customer);
}
}
}
libjibx-java-1.1.6a/build/test/simple/ICustomer6.java 0000644 0001750 0001750 00000000061 10337570716 022322 0 ustar moeller moeller package simple;
public interface ICustomer6
{
}
libjibx-java-1.1.6a/build/test/simple/ICustomer6a.java 0000644 0001750 0001750 00000000105 10756367204 022463 0 ustar moeller moeller package simple;
public interface ICustomer6a extends ICustomer6
{
}
libjibx-java-1.1.6a/build/test/simple/ICustomer8.java 0000644 0001750 0001750 00000003522 10217763160 022323 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
public interface ICustomer8
{
public String getId();
public Name getName();
public String getStreet();
public String getCity();
public String getState();
public void setId(String id);
public void setName(Name name);
public void setStreet(String value);
public void setCity(String value);
public void setState(String value);
} libjibx-java-1.1.6a/build/test/simple/ICustomer8b.java 0000644 0001750 0001750 00000003005 10221061172 022446 0 ustar moeller moeller /*
Copyright (c) 2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
public interface ICustomer8b
{
} libjibx-java-1.1.6a/build/test/simple/ICustomer8c.java 0000644 0001750 0001750 00000003005 10221061172 022447 0 ustar moeller moeller /*
Copyright (c) 2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
public interface ICustomer8c
{
} libjibx-java-1.1.6a/build/test/simple/Identity10.java 0000644 0001750 0001750 00000000114 10311010000 022212 0 ustar moeller moeller package simple;
public class Identity10 {
public int customerNumber;
}
libjibx-java-1.1.6a/build/test/simple/MyClass.java 0000644 0001750 0001750 00000000431 10071714446 021671 0 ustar moeller moeller
package simple;
import java.util.ArrayList;
class MyClass {
private int a;
private String b;
private ArrayList ints;
public int getA() { return a; }
public void setA(int a) { this.a = a; }
public String getB() { return b; }
public void setB(String b) { this.b = b; }
}
libjibx-java-1.1.6a/build/test/simple/MyClass1.java 0000644 0001750 0001750 00000001033 10541617342 021750 0 ustar moeller moeller
package simple;
import java.awt.Dimension;
import java.awt.Rectangle;
import java.util.ArrayList;
class MyClass1 extends MyClass1Base {
private int a;
private String b;
private Dimension dimen;
private Rectangle rect;
private ArrayList ints;
// force generation of default constructor
public MyClass1(int a) {
super(a);
this.a = a;
}
public int getA() { return a; }
public void setA(int a) { this.a = a; }
public String getB() { return b; }
public void setB(String b) { this.b = b; }
}
libjibx-java-1.1.6a/build/test/simple/MyClass1Base.java 0000644 0001750 0001750 00000000120 10541617342 022537 0 ustar moeller moeller
package simple;
class MyClass1Base {
protected MyClass1Base(int any) {}
}
libjibx-java-1.1.6a/build/test/simple/MyClass2.java 0000644 0001750 0001750 00000002470 10425211274 021752 0 ustar moeller moeller
package simple;
import java.awt.Dimension;
import java.awt.Rectangle;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;
class MyClass2 {
private int a;
private String b;
private double c;
private boolean d;
private Object e;
private Integer f;
private Integer g;
private Dimension dimen;
private Rectangle rect;
private List ints;
private Set orderedStrings;
public int getA() { return a; }
public void setA(String a) { this.a = Integer.parseInt(a); }
public void setA(int a) { this.a = a; }
public String getB() { return b; }
public void setB(String b) { this.b = b; }
public void setB(int b) { this.b = Integer.toString(b); }
public double getC() { return c; }
public void setC(double c) { this.c = c; }
private Object getG() {
return g;
}
private void setG(Object value) {
g = (Integer)value;
}
private List getList() {
return ints;
}
private void setList(ArrayList list) {
ints = list;
}
private static List listFactory() {
return new ArrayList();
}
private static ArrayList arrayListFactory() {
return new ArrayList();
}
private static SortedSet sortedSetFactory() {
return new TreeSet();
}
}
libjibx-java-1.1.6a/build/test/simple/MyClass3.java 0000644 0001750 0001750 00000002044 10347115046 021753 0 ustar moeller moeller
package simple;
import java.awt.Dimension;
import java.awt.Rectangle;
import java.util.ArrayList;
class MyClass3 {
private int a;
private String b;
private double c;
private boolean d;
private char e;
private Dimension dimen;
private Rectangle rect;
private int[] ints;
private Integer[] integers;
private long[] longs;
private void addInt(Integer value) {
if (integers == null) {
integers = new Integer[1];
integers[0] = value;
} else {
int length = integers.length;
Integer[] newints = new Integer[length+1];
System.arraycopy(integers, 0, newints, 0, length);
newints[length] = value;
integers = newints;
}
}
private int sizeInts() {
if (integers == null) {
return 0;
} else {
return integers.length;
}
}
private Integer getInt(int index) {
return integers[index];
}
private boolean hasInts() {
return integers != null;
}
}
libjibx-java-1.1.6a/build/test/simple/MyClass4.java 0000644 0001750 0001750 00000004426 10435141302 021752 0 ustar moeller moeller
package simple;
import java.util.Vector;
class MyClass4 {
private int a;
private String b;
private double c;
private Boolean d;
private Integer e;
private Integer f;
private String g;
private boolean h;
private boolean i;
private boolean j;
private byte[] k;
private byte l;
private byte m;
private char n;
private String o;
//#!j2me{
private java.sql.Date p;
//#j2me}
private String q;
private String r;
private String s;
private Vector intsAndStrings;
private boolean testG() {
return g != null;
}
private boolean testJ() {
return j;
}
private String getJ() {
return "";
}
private void setJ(String value) {
j = value != null;
}
private void setO(String value) {
o = value;
}
private boolean testO() {
return o != null && !"".equals(o);
}
private static String serializeInteger(Integer value) {
return value.toString();
}
private static String yesNoSerializer(boolean flag) {
return flag ? "yes" : "no";
}
private static boolean yesNoDeserializer(String text) {
return "yes".equals(text);
}
private void postSet() {
if (q != null && q.length() == 0) {
q = null;
}
if (r != null && r.length() == 0) {
r = null;
}
}
private static class IntWrapper
{
private int ivalue;
}
protected static String serializeNumber(Number num) {
return num.toString();
}
protected static Number deserializeNumber(String value) {
if (value.indexOf('.') >= 0) {
return new Float(value);
} else {
return new Integer(value);
}
}
private static String reverse(String string) {
StringBuffer buff = new StringBuffer(string.length());
for (int i = string.length() - 1; i >= 0 ; i--) {
buff.append(string.charAt(i));
}
return buff.toString();
}
protected static String serializeReverse(Number num) {
return reverse(serializeNumber(num));
}
protected static Number deserializeReverse(String value) {
return deserializeNumber(reverse(value));
}
}
libjibx-java-1.1.6a/build/test/simple/MyClass4Format.java 0000644 0001750 0001750 00000000401 10071714446 023123 0 ustar moeller moeller
package simple;
class MyClass4Format
{
/*package*/ static String yesNoSerializer(boolean flag) {
return flag ? "yes" : "no";
}
/*package*/ static boolean yesNoDeserializer(String text) {
return "yes".equals(text);
}
}
libjibx-java-1.1.6a/build/test/simple/MyClass5.java 0000644 0001750 0001750 00000006657 10425211274 021770 0 ustar moeller moeller
package simple;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;
import java.util.Set;
import org.jibx.runtime.IUnmarshallingContext;
public class MyClass5 {
private ArrayList childs1;
private ArrayList childs2;
private ArrayList childs3;
private Set altchilds2;
private Set altchilds3;
private void unmarshalDone() {
for (int i = 0; i < childs1.size(); i++) {
((MyClass5a)childs1.get(i)).verify();
}
if (childs2 != null) {
for (int i = 0; i < childs2.size(); i++) {
((MyClass5a)childs2.get(i)).verify();
}
}
if (childs3 != null) {
for (int i = 0; i < childs3.size(); i++) {
((MyClass5a)childs3.get(i)).verify();
}
}
}
private static MyClass5a bFactory() {
MyClass5b inst = new MyClass5b();
inst.factory = true;
return inst;
}
private static MyClass5a cFactory(Object obj) {
if (!(obj instanceof ArrayList)) {
throw new IllegalStateException("factory called with wrong object");
}
MyClass5c inst = new MyClass5c();
inst.factory = true;
return inst;
}
private static MyClass5a dFactory(IUnmarshallingContext ctx) {
if (!(ctx.getStackObject(1) instanceof MyClass5)) {
throw new IllegalStateException("wrong object in stack");
}
MyClass5d inst = new MyClass5d();
inst.factory = true;
return inst;
}
private static Set setFactory() {
return new OrderedSet();
}
private static class OrderedSet implements Set
{
private final ArrayList list;
private OrderedSet() {
list = new ArrayList();
}
private OrderedSet(OrderedSet original) {
list = new ArrayList(original.list);
}
public boolean add(Object arg0) {
return list.add(arg0);
}
public boolean addAll(Collection arg0) {
return list.addAll(arg0);
}
public void clear() {
list.clear();
}
public Object clone() {
return new OrderedSet(this);
}
public boolean contains(Object elem) {
return list.contains(elem);
}
public boolean containsAll(Collection arg0) {
return list.containsAll(arg0);
}
public boolean equals(Object o) {
if (o instanceof OrderedSet) {
return ((OrderedSet)o).list.equals(list);
} else {
return false;
}
}
public int hashCode() {
return list.hashCode();
}
public boolean isEmpty() {
return list.isEmpty();
}
public Iterator iterator() {
return list.iterator();
}
public boolean remove(Object o) {
return list.remove(o);
}
public boolean removeAll(Collection arg0) {
return list.removeAll(arg0);
}
public boolean retainAll(Collection arg0) {
return list.retainAll(arg0);
}
public int size() {
return list.size();
}
public Object[] toArray() {
return list.toArray();
}
public Object[] toArray(Object[] arg0) {
return list.toArray(arg0);
}
public String toString() {
return list.toString();
}
}
}
libjibx-java-1.1.6a/build/test/simple/MyClass5a.java 0000644 0001750 0001750 00000000175 10316003036 022110 0 ustar moeller moeller
package simple;
public class MyClass5a
{
protected int value;
protected int altvalue;
protected void verify() {}
}
libjibx-java-1.1.6a/build/test/simple/MyClass5b.java 0000644 0001750 0001750 00000001004 10071714446 022115 0 ustar moeller moeller
package simple;
class MyClass5b extends MyClass5a
{
/*package*/ boolean factory;
private boolean preset;
private boolean postset;
private int value;
private void preset() {
preset = true;
value = 1;
}
private void postset() {
postset = true;
if (value == 2) {
value = 3;
}
}
private void preget() {
value = 2;
}
protected void verify() {
if (!factory || !preset || !postset) {
throw new IllegalStateException
("factory, pre-set, or post-set method not called");
}
}
}
libjibx-java-1.1.6a/build/test/simple/MyClass5c.java 0000644 0001750 0001750 00000001622 10071714446 022124 0 ustar moeller moeller
package simple;
import java.util.ArrayList;
class MyClass5c extends MyClass5a
{
/*package*/ boolean factory;
private boolean preset;
private boolean postset;
private int value;
private void preset(Object obj) {
if (!(obj instanceof ArrayList)) {
throw new IllegalStateException("factory called with wrong object");
}
preset = true;
value = 1;
}
private void postset(Object obj) {
if (!(obj instanceof ArrayList)) {
throw new IllegalStateException("factory called with wrong object");
}
postset = true;
if (value == 2) {
value = 3;
}
}
private void preget(Object obj) {
if (!(obj instanceof ArrayList)) {
throw new IllegalStateException("factory called with wrong object");
}
value = 2;
}
protected void verify() {
if (!factory || !preset || !postset) {
throw new IllegalStateException
("factory, pre-set, or post-set method not called");
}
}
}
libjibx-java-1.1.6a/build/test/simple/MyClass5d.java 0000644 0001750 0001750 00000003051 10316003036 022107 0 ustar moeller moeller
package simple;
import org.jibx.runtime.IMarshallingContext;
import org.jibx.runtime.ITrackSource;
import org.jibx.runtime.IUnmarshallingContext;
class MyClass5d extends MyClass5a
{
/*package*/ boolean factory;
private boolean preset;
private boolean postset;
private String text1;
private String text2;
private void preset(IUnmarshallingContext ctx) {
if (!(ctx.getStackObject(1) instanceof MyClass5)) {
throw new IllegalStateException("wrong object in stack: " +
ctx.getStackObject(1).getClass().getName());
}
preset = true;
value = 1;
}
private void postset(IUnmarshallingContext ctx) {
if (!(ctx.getStackObject(1) instanceof MyClass5)) {
throw new IllegalStateException("wrong object in stack: " +
ctx.getStackObject(1).getClass().getName());
}
postset = true;
if (value == 2) {
value = 3;
}
}
private void preget(IMarshallingContext ctx) {
if (!(ctx.getStackObject(1) instanceof MyClass5)) {
throw new IllegalStateException("wrong object in stack: " +
ctx.getStackObject(1).getClass().getName());
}
value = 2;
}
protected void verify() {
if (!factory || !preset || !postset) {
throw new IllegalStateException
("factory, pre-set, or post-set method not called");
}
ITrackSource track = (ITrackSource)this;
System.out.println("Verified " + this.getClass().getName() +
" from \"" + track.jibx_getDocumentName() + "\" (" +
track.jibx_getLineNumber() + ":" + track.jibx_getColumnNumber() +
")");
}
}
libjibx-java-1.1.6a/build/test/simple/MyClass6.java 0000644 0001750 0001750 00000001674 10231200704 021752 0 ustar moeller moeller
package simple;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
class MyClass6
{
private final List ints = new ArrayList();
private final List strings = new ArrayList();
private byte a;
private boolean b;
public static ArrayList createList() {
throw new IllegalStateException
("Factory method should never be called");
}
protected void setInts(final List list) {
if (list != ints) {
throw new IllegalStateException
("Set method called with different list object");
}
}
private boolean isPresent() {
return ints.size() > 0;
}
private Iterator intsIterator() {
return ints.iterator();
}
private void addInt(Object o) {
ints.add((Integer)o);
}
private void addString(Object o) {
strings.add((String)o);
}
}
libjibx-java-1.1.6a/build/test/simple/MyClass7.java 0000644 0001750 0001750 00000000375 10524454444 021771 0 ustar moeller moeller
package simple;
import java.util.List;
class MyClass7
{
private List list;
private Object[] array;
private String[] array2;
private int[][] array3;
private long[][] array4;
private double[][] array5;
private List list2;
}
libjibx-java-1.1.6a/build/test/simple/Name.java 0000644 0001750 0001750 00000003342 10447004420 021171 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
public class Name
{
/*package*/ Name() {}
public String firstName;
public String lastName;
private void setFirst(String name) {
firstName = name;
}
private void setLast(String name) {
lastName = name;
}
}
libjibx-java-1.1.6a/build/test/simple/NameExtended.java 0000644 0001750 0001750 00000003044 10316003036 022646 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
public class NameExtended extends Name
{
public String ssn;
}
libjibx-java-1.1.6a/build/test/simple/NameMarshaller.java 0000644 0001750 0001750 00000004523 10257173436 023223 0 ustar moeller moeller /*
Copyright (c) 2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
import org.jibx.runtime.IMarshaller;
import org.jibx.runtime.IMarshallingContext;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.impl.MarshallingContext;
public class NameMarshaller implements IMarshaller
{
/* (non-Javadoc)
* @see org.jibx.runtime.IMarshaller#isExtension(int)
*/
public boolean isExtension(int index) {
return false;
}
/* (non-Javadoc)
* @see org.jibx.runtime.IMarshaller#marshal(java.lang.Object, org.jibx.runtime.IMarshallingContext)
*/
public void marshal(Object obj, IMarshallingContext ictx)
throws JiBXException {
MarshallingContext ctx = (MarshallingContext)ictx;
Name name = (Name)obj;
ctx.startTag(0, "name");
ctx.element(0, "first-name", name.firstName);
ctx.element(0, "last-name", name.lastName);
ctx.endTag(0, "name");
}
} libjibx-java-1.1.6a/build/test/simple/NamePrivate.java 0000644 0001750 0001750 00000003122 10330637714 022531 0 ustar moeller moeller /*
Copyright (c) 2003, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
public class NamePrivate
{
private NamePrivate() {}
public String firstName;
public String lastName;
}
libjibx-java-1.1.6a/build/test/simple/NameUnmarshaller.java 0000644 0001750 0001750 00000005110 10316003036 023537 0 ustar moeller moeller /*
Copyright (c) 2005, Dennis M. Sosnoski
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of JiBX nor the names of its contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package simple;
import org.jibx.runtime.IUnmarshaller;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.impl.UnmarshallingContext;
public class NameUnmarshaller implements IUnmarshaller
{
/* (non-Javadoc)
* @see org.jibx.runtime.IUnmarshaller#isPresent(org.jibx.runtime.IUnmarshallingContext)
*/
public boolean isPresent(IUnmarshallingContext ctx) throws JiBXException {
return ctx.isAt(null, "name");
}
/* (non-Javadoc)
* @see org.jibx.runtime.IUnmarshaller#unmarshal(java.lang.Object, org.jibx.runtime.IUnmarshallingContext)
*/
public Object unmarshal(Object obj, IUnmarshallingContext ictx) throws JiBXException {
UnmarshallingContext ctx = (UnmarshallingContext)ictx;
Name name = (Name)obj;
if (name == null) {
name = new Name();
}
ctx.parsePastStartTag(null, "name");
name.firstName = ctx.parseElementText(null, "first-name");
name.lastName = ctx.parseElementText(null, "last-name");
ctx.parsePastEndTag(null, "name");
return name;
}
} libjibx-java-1.1.6a/build/test/simple/Person10.java 0000644 0001750 0001750 00000000167 10311010000 021677 0 ustar moeller moeller package simple;
public class Person10 extends Identity10 {
public String firstName;
public String lastName;
}
libjibx-java-1.1.6a/build/test/simple/Subscriber9.java 0000644 0001750 0001750 00000000147 10311010000 022462 0 ustar moeller moeller package simple;
public class Subscriber9 {
public String name;
public Address9 mailAddress;
}
libjibx-java-1.1.6a/build/test/simple/binding0.xml 0000644 0001750 0001750 00000000673 10071714446 021677 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding0a.xml 0000644 0001750 0001750 00000001224 10447004252 022023 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding0b.xml 0000644 0001750 0001750 00000000714 10435066032 022030 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding0c.xml 0000644 0001750 0001750 00000001022 10435066032 022022 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding0d.xml 0000644 0001750 0001750 00000001016 10435066032 022026 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding1.xml 0000644 0001750 0001750 00000000656 10435065660 021702 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding10.xml 0000644 0001750 0001750 00000002053 10330637714 021752 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding1a.xml 0000644 0001750 0001750 00000001102 10217763156 022031 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding1b.xml 0000644 0001750 0001750 00000000676 10434546306 022046 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding2.xml 0000644 0001750 0001750 00000001277 10071714446 021702 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding2a.xml 0000644 0001750 0001750 00000002043 10425211274 022025 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding2b.xml 0000644 0001750 0001750 00000001433 10434347154 022037 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding2c.xml 0000644 0001750 0001750 00000001320 10524445116 022030 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding3.xml 0000644 0001750 0001750 00000001603 10264375570 021701 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding3a.xml 0000644 0001750 0001750 00000001330 10071714446 022032 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding3b.xml 0000644 0001750 0001750 00000001365 10264375570 022050 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding3d.xml 0000644 0001750 0001750 00000001313 10264375570 022043 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding3e.xml 0000644 0001750 0001750 00000001665 10330637714 022051 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding4.xml 0000644 0001750 0001750 00000001201 10071714446 021667 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding4a.xml 0000644 0001750 0001750 00000001237 10071714446 022041 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding4b.xml 0000644 0001750 0001750 00000001304 10221341134 022020 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding4c.xml 0000644 0001750 0001750 00000001263 10221341134 022025 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding4d.xml 0000644 0001750 0001750 00000001210 10434261270 022026 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding4e.xml 0000644 0001750 0001750 00000001203 10435066032 022031 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding5.xml 0000644 0001750 0001750 00000004241 10305515602 021670 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding5a.xml 0000644 0001750 0001750 00000004544 10305515602 022037 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding5b.xml 0000644 0001750 0001750 00000004065 10305515602 022036 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding5c.xml 0000644 0001750 0001750 00000005222 10602647376 022051 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding5d.xml 0000644 0001750 0001750 00000005075 10330637714 022051 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding5e.xml 0000644 0001750 0001750 00000004673 10330637714 022055 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding5f.xml 0000644 0001750 0001750 00000004173 10334452106 022043 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding5g.xml 0000644 0001750 0001750 00000005223 10425211274 022041 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding6.xml 0000644 0001750 0001750 00000003765 10071714452 021707 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding6a.xml 0000644 0001750 0001750 00000004106 10264375570 022046 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding6b.xml 0000644 0001750 0001750 00000004667 11005500010 022030 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding6c.xml 0000644 0001750 0001750 00000004550 11005500010 022020 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding7.xml 0000644 0001750 0001750 00000002500 10425211274 021667 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding7a.xml 0000644 0001750 0001750 00000002132 10756367204 022045 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding7b.xml 0000644 0001750 0001750 00000002306 10257173436 022047 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding8.xml 0000644 0001750 0001750 00000002443 10222704776 021707 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding8a.xml 0000644 0001750 0001750 00000003351 10222704776 022047 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding8b.xml 0000644 0001750 0001750 00000003326 10221061172 022033 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding8c.xml 0000644 0001750 0001750 00000003414 10257173436 022052 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding8d.xml 0000644 0001750 0001750 00000003765 10257173436 022064 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding9.xml 0000644 0001750 0001750 00000002572 10311010000 021654 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/binding9d.xml 0000644 0001750 0001750 00000003122 10541617520 022041 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding.xml 0000644 0001750 0001750 00000000471 10071714452 022156 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding1.xml 0000644 0001750 0001750 00000001627 10434261270 022241 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding2.xml 0000644 0001750 0001750 00000002611 10230703350 022226 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding2a.xml 0000644 0001750 0001750 00000002644 10425211274 022402 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding2b.xml 0000644 0001750 0001750 00000002560 10230703350 022373 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding2c.xml 0000644 0001750 0001750 00000002522 10272065366 022410 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding3.xml 0000644 0001750 0001750 00000002221 10434261270 022232 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding3a.xml 0000644 0001750 0001750 00000002227 10434261270 022401 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding3b.xml 0000644 0001750 0001750 00000001736 10434261270 022406 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding3c.xml 0000644 0001750 0001750 00000002144 10434261270 022401 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding3d.xml 0000644 0001750 0001750 00000002216 10434261270 022402 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding3e.xml 0000644 0001750 0001750 00000001750 10434261270 022405 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding3f.xml 0000644 0001750 0001750 00000001755 10434261270 022413 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding3g.xml 0000644 0001750 0001750 00000002057 10435545616 022422 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding3h.xml 0000644 0001750 0001750 00000002062 10435545616 022417 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding4.xml 0000644 0001750 0001750 00000004730 10240174212 022234 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding4a.xml 0000644 0001750 0001750 00000004554 10305475730 022414 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding4b.xml 0000644 0001750 0001750 00000004700 10330637714 022406 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding4c.xml 0000644 0001750 0001750 00000005350 10435141302 022376 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding5.xml 0000644 0001750 0001750 00000002052 10425211274 022235 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding5a.xml 0000644 0001750 0001750 00000002055 10677535700 022415 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding5b.xml 0000644 0001750 0001750 00000002052 10425211274 022377 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding6.xml 0000644 0001750 0001750 00000000672 10071714452 022247 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding6a.xml 0000644 0001750 0001750 00000001236 10264375570 022415 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding6b.xml 0000644 0001750 0001750 00000001232 10264375570 022412 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding7.xml 0000644 0001750 0001750 00000001121 10263166470 022242 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding7a.xml 0000644 0001750 0001750 00000001022 10263166470 022403 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding7b.xml 0000644 0001750 0001750 00000001354 10330637714 022413 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding7c.xml 0000644 0001750 0001750 00000001563 10434347154 022417 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mybinding7d.xml 0000644 0001750 0001750 00000002643 10752662354 022425 0 ustar moeller moeller
libjibx-java-1.1.6a/build/test/simple/mytest.xml 0000644 0001750 0001750 00000000231 10071714452 021515 0 ustar moeller moeller 42The Answer1231234567890
libjibx-java-1.1.6a/build/test/simple/mytest1.xml 0000644 0001750 0001750 00000000435 10434261270 021602 0 ustar moeller moeller 42<![CDATAThe Answer]]>22331231234567890
libjibx-java-1.1.6a/build/test/simple/mytest2.xml 0000644 0001750 0001750 00000000446 10272065366 021615 0 ustar moeller moeller 1234567822331234567890
libjibx-java-1.1.6a/build/test/simple/mytest2a.xml 0000644 0001750 0001750 00000000174 10337570716 021756 0 ustar moeller moeller 12345678
libjibx-java-1.1.6a/build/test/simple/mytest3.xml 0000644 0001750 0001750 00000000475 10071714452 021612 0 ustar moeller moeller 42The Answer1.234134true22331231234567890
libjibx-java-1.1.6a/build/test/simple/mytest3a.xml 0000644 0001750 0001750 00000000323 10071714452 021743 0 ustar moeller moeller 55true1231234567890
libjibx-java-1.1.6a/build/test/simple/mytest3b.xml 0000644 0001750 0001750 00000000323 10071714452 021744 0 ustar moeller moeller true551231234567890
libjibx-java-1.1.6a/build/test/simple/mytest3c.xml 0000644 0001750 0001750 00000002306 10263166550 021753 0 ustar moeller moeller The Answer223312345678910111213141516171819202122232425262728291234567891011121314151617181920212223242526272829
libjibx-java-1.1.6a/build/test/simple/mytest3d.xml 0000644 0001750 0001750 00000000237 10331457526 021757 0 ustar moeller moeller The Answer2233
libjibx-java-1.1.6a/build/test/simple/mytest3e.xml 0000644 0001750 0001750 00000000377 10331641174 021757 0 ustar moeller moeller The Answer22331231234567890
libjibx-java-1.1.6a/build/test/simple/mytest3f.xml 0000644 0001750 0001750 00000000745 10435545616 021770 0 ustar moeller moeller The Answer1.23413442trueall my content33all my content22all my content1231234567890
libjibx-java-1.1.6a/build/test/simple/mytest3g.xml 0000644 0001750 0001750 00000001052 10435545616 021761 0 ustar moeller moeller false4.88The Wrong AnswerThe Answer1.234134true42-1all my content33all my content22all my content1231234567890
libjibx-java-1.1.6a/build/test/simple/mytest4.xml 0000644 0001750 0001750 00000000535 10435141302 021600 0 ustar moeller moeller 42The Answer1.23413412345658a
Binding selector that supports versioned XML documents. This looks for a
version attribute on the root element of the document, and selects the
mapping to be used for unmarshalling based on the value. It also supports
selecting the version for marshalling based on a supplied version argument
value.
Get initial unmarshalling context. This gives access to the unmarshalling
context used before the specific version is determined. The document
information must be set for this context before calling unmarshalVersioned(java.lang.Class).
Returns:
initial unmarshalling context
setOutput
public void setOutput(java.io.OutputStream outs,
java.lang.String enc)
Set output stream and encoding.
Parameters:
outs - stream for document data output
enc - document output encoding, or null for default
setOutput
public void setOutput(java.io.Writer outw)
Set output writer.
Parameters:
outw - writer for document data output
setIndent
public void setIndent(int indent)
Set nesting indent spaces.
Parameters:
indent - number of spaces to indent per level, or disable
indentation if negative
marshalVersioned
public void marshalVersioned(java.lang.Object obj,
java.lang.String version)
throws JiBXException
Marshal according to supplied version.
Parameters:
obj - root object to be marshalled
version - identifier for version to be used in marshalling
Custom marshaller/unmarshaller for arbitrary ignored element. This ignores
an element when unmarshalling, if one is present, and does nothing when
marshalling.
Check if marshaller represents an extension mapping. This is used by the
framework in generated code to verify compatibility of objects being
marshalled using an abstract mapping.
Marshal instance of handled class. This method call is responsible
for all handling of the marshalling of an object to XML text. It is
called at the point where the start tag for the associated element
should be generated.
Check if instance present in XML. This method can be called when the
unmarshalling context is positioned at or just before the start of the
data corresponding to an instance of this mapping. It verifies that the
expected data is present.
Unmarshal instance of handled class. This method call is responsible
for all handling of the unmarshalling of an object from XML text,
including creating the instance of the handled class if an instance is
not supplied. When it is called the unmarshalling context is always
positioned at or just before the start tag corresponding to the start of
the class data.
Custom marshaller/unmarshaller for arbitrary ignored content to end of
element. This ignores all content to the end of the enclosing element when
unmarshalling, and does nothing with marshalling.
Check if marshaller represents an extension mapping. This is used by the
framework in generated code to verify compatibility of objects being
marshalled using an abstract mapping.
Marshal instance of handled class. This method call is responsible
for all handling of the marshalling of an object to XML text. It is
called at the point where the start tag for the associated element
should be generated.
Check if instance present in XML. This method can be called when the
unmarshalling context is positioned at or just before the start of the
data corresponding to an instance of this mapping. It verifies that the
expected data is present.
Unmarshal instance of handled class. This method call is responsible
for all handling of the unmarshalling of an object from XML text,
including creating the instance of the handled class if an instance is
not supplied. When it is called the unmarshalling context is always
positioned at or just before the start tag corresponding to the start of
the class data.
XML document comparator. This uses XMLPull parsers to read a pair of
documents in parallel, comparing the streams of components seen from the two
documents. The comparison ignores differences in whitespace separating
elements, but treats whitespace as significant within elements with only
character data content.
public DocumentComparator(java.io.PrintStream print)
throws org.xmlpull.v1.XmlPullParserException
Constructor. Builds the actual parser.
Parameters:
print - print stream for reporting differences
Throws:
org.xmlpull.v1.XmlPullParserException - on error creating parsers
Method Detail
compare
public boolean compare(java.io.Reader rdra,
java.io.Reader rdrb)
Compares a pair of documents by reading them in parallel from a pair of
parsers. The comparison ignores differences in whitespace separating
elements, but treats whitespace as significant within elements with only
character data content.
Parameters:
rdra - reader for first document to be compared
rdrb - reader for second document to be compared
Returns:
true if the documents are the same,
false if they're different
Base implementation for custom marshaller/unmarshallers to any document
model representation. This class just provides a few basic operations that
are used by the representation-specific subclasses.
Custom element marshaller/unmarshaller to dom4j representation. This
allows you to mix data binding and document model representations for XML
within the same application. You simply use this marshaller/unmarshaller with
a linked object type of org.dom4j.Element (the actual runtime
type - the declared type is ignored and can be anything). If a name is
supplied on a reference that element name will always be matched when
unmarshalling but will be ignored when marshalling (with the actual dom4j
element name used). If no name is supplied this will unmarshal a single
element with any name.
public Dom4JElementMapper(java.lang.String uri,
int index,
java.lang.String name)
Aliased constructor. This takes a name definition for the element. It'll
be used by JiBX when a name is supplied by the mapping which references
this custom marshaller/unmarshaller.
Parameters:
uri - namespace URI for the top-level element
index - namespace index corresponding to the defined URI within the
marshalling context definitions
Check if marshaller represents an extension mapping. This is used by the
framework in generated code to verify compatibility of objects being
marshalled using an abstract mapping.
Marshal instance of handled class. This method call is responsible
for all handling of the marshalling of an object to XML text. It is
called at the point where the start tag for the associated element
should be generated.
Check if instance present in XML. This method can be called when the
unmarshalling context is positioned at or just before the start of the
data corresponding to an instance of this mapping. It verifies that the
expected data is present.
Unmarshal instance of handled class. This method call is responsible
for all handling of the unmarshalling of an object from XML text,
including creating the instance of the handled class if an instance is
not supplied. When it is called the unmarshalling context is always
positioned at or just before the start tag corresponding to the start of
the class data.
Custom content list marshaller/unmarshaller to dom4j representation. This
allows you to mix data binding and document model representations for XML
within the same application. You simply use this marshaller/unmarshaller with
a linked object type that implements java.util.List (the actual
runtime type - the declared type is ignored and can be anything). When
unmarshalling it will create an instance of java.util.ArrayList
if a list is not passed in and any content is present, then return all the
content up to the close tag for the enclosing element in the list. When
marshalling, it will simply write out any content directly.
Check if marshaller represents an extension mapping. This is used by the
framework in generated code to verify compatibility of objects being
marshalled using an abstract mapping.
Marshal instance of handled class. This method call is responsible
for all handling of the marshalling of an object to XML text. It is
called at the point where the start tag for the associated element
should be generated.
Check if instance present in XML. This method can be called when the
unmarshalling context is positioned at or just before the start of the
data corresponding to an instance of this mapping. It verifies that the
expected data is present.
Unmarshal instance of handled class. This method call is responsible
for all handling of the unmarshalling of an object from XML text,
including creating the instance of the handled class if an instance is
not supplied. When it is called the unmarshalling context is always
positioned at or just before the start tag corresponding to the start of
the class data.
Base implementation for custom marshaller/unmarshallers to dom4j
representation. This provides the basic code used for both single element and
content list handling.
Custom element marshaller/unmarshaller to DOM representation. This allows
you to mix data binding and document model representations for XML within the
same application. You simply use this marshaller/unmarshaller with a linked
object of type org.w3c.dom.Element (the actual runtime type -
the declared type is ignored and can be anything). If a name is supplied on a
reference that element name will always be matched when unmarshalling but
will be ignored when marshalling (with the actual DOM element name used). If
no name is supplied this will unmarshal a single element with any name.
public DomElementMapper(java.lang.String uri,
int index,
java.lang.String name)
throws JiBXException
Aliased constructor. This takes a name definition for the element. It'll
be used by JiBX when a name is supplied by the mapping which references
this custom marshaller/unmarshaller.
Parameters:
uri - namespace URI for the top-level element
index - namespace index corresponding to the defined URI within the
marshalling context definitions
Check if marshaller represents an extension mapping. This is used by the
framework in generated code to verify compatibility of objects being
marshalled using an abstract mapping.
Marshal instance of handled class. This method call is responsible
for all handling of the marshalling of an object to XML text. It is
called at the point where the start tag for the associated element
should be generated.
Check if instance present in XML. This method can be called when the
unmarshalling context is positioned at or just before the start of the
data corresponding to an instance of this mapping. It verifies that the
expected data is present.
Unmarshal instance of handled class. This method call is responsible
for all handling of the unmarshalling of an object from XML text,
including creating the instance of the handled class if an instance is
not supplied. When it is called the unmarshalling context is always
positioned at or just before the start tag corresponding to the start of
the class data.
Custom content list marshaller/unmarshaller to DOM representation. This
allows you to mix data binding and document model representations for XML
within the same application. You simply use this marshaller/unmarshaller with
a linked object type of org.w3c.dom.DocumentFragment (the actual
runtime type - the declared type is ignored and can be anything). When
unmarshalling it will create a fragment to hold any content up to the close
tag for the enclosing element in the list. When marshalling, it will simply
write out any content directly.
Check if marshaller represents an extension mapping. This is used by the
framework in generated code to verify compatibility of objects being
marshalled using an abstract mapping.
Marshal instance of handled class. This method call is responsible
for all handling of the marshalling of an object to XML text. It is
called at the point where the start tag for the associated element
should be generated.
Check if instance present in XML. This method can be called when the
unmarshalling context is positioned at or just before the start of the
data corresponding to an instance of this mapping. It verifies that the
expected data is present.
Unmarshal instance of handled class. This method call is responsible
for all handling of the unmarshalling of an object from XML text,
including creating the instance of the handled class if an instance is
not supplied. When it is called the unmarshalling context is always
positioned at or just before the start tag corresponding to the start of
the class data.
Custom content list marshaller/unmarshaller to DOM representation. This
allows you to mix data binding and document model representations for XML
within the same application. You simply use this marshaller/unmarshaller with
a linked object type that implements java.util.List (the actual
runtime type - the declared type is ignored and can be anything). When
unmarshalling it will create an instance of java.util.ArrayList
if a list is not passed in and any content is present, then return all the
content up to the close tag for the enclosing element in the list. When
marshalling, it will simply write out any content directly.
Check if marshaller represents an extension mapping. This is used by the
framework in generated code to verify compatibility of objects being
marshalled using an abstract mapping.
Marshal instance of handled class. This method call is responsible
for all handling of the marshalling of an object to XML text. It is
called at the point where the start tag for the associated element
should be generated.
Check if instance present in XML. This method can be called when the
unmarshalling context is positioned at or just before the start of the
data corresponding to an instance of this mapping. It verifies that the
expected data is present.
Unmarshal instance of handled class. This method call is responsible
for all handling of the unmarshalling of an object from XML text,
including creating the instance of the handled class if an instance is
not supplied. When it is called the unmarshalling context is always
positioned at or just before the start tag corresponding to the start of
the class data.
Base implementation for custom marshaller/unmarshallers to DOM
representation. This provides the basic code used for both single element and
content list handling.
Custom marshaller/unmarshaller for java.util.Map
instances. This handles mapping hash maps with simple keys and complex values
to and from XML. There are a number of limitations, though. First off, the
key objects are marshalled as simple text values, using the
toString() method to convert them to String. When
unmarshalling the keys are always treated as String values. The
corresponding values can be any complex type with a <mapping> defined in
the binding. The name of the top-level element in the XML structure can be
configured in the binding definition, but the rest of the names are
predefined and set in the code (though the namespace configured for the
top-level element will be used with all the names).
The net effect is that the XML structure will always be of the form:
where "map-name" is the configured top-level element name, the "size"
attribute is the number of pairs in the hash map, and the "entry" elements
are the actual entries in the hash map.
This is obviously not intended to handle all types of hash maps, but it
should be useful as written for many applications and easily customized to
handle other requirements.
Default constructor. This uses a pre-defined name for the top-level
element. It'll be used by JiBX when no name information is supplied by
the mapping which references this custom marshaller/unmarshaller.
HashMapperStringToComplex
public HashMapperStringToComplex(java.lang.String uri,
int index,
java.lang.String name)
Aliased constructor. This takes a name definition for the top-level
element. It'll be used by JiBX when a name is supplied by the mapping
which references this custom marshaller/unmarshaller.
Parameters:
uri - namespace URI for the top-level element (also used for all
other names within the binding)
index - namespace index corresponding to the defined URI within the
marshalling context definitions
Check if marshaller represents an extension mapping. This is used by the
framework in generated code to verify compatibility of objects being
marshalled using an abstract mapping.
Marshal instance of handled class. This method call is responsible
for all handling of the marshalling of an object to XML text. It is
called at the point where the start tag for the associated element
should be generated.
Check if instance present in XML. This method can be called when the
unmarshalling context is positioned at or just before the start of the
data corresponding to an instance of this mapping. It verifies that the
expected data is present.
Unmarshal instance of handled class. This method call is responsible
for all handling of the unmarshalling of an object from XML text,
including creating the instance of the handled class if an instance is
not supplied. When it is called the unmarshalling context is always
positioned at or just before the start tag corresponding to the start of
the class data.
Custom marshaller/unmarshaller for java.util.Map
instances. This handles mapping hash maps with string keys and values that
match basic schema datatypes to and from XML. The key objects are marshalled
as simple text values, using the toString() method to convert
them to String if they are not already of that type. When
unmarshalling the keys are always treated as String values. The
corresponding values can be any of the object types corresponding to basic
schema data types, and are marshalled with xsi:type attributes to specify the
type of each value. The types currently supported are Byte,
Double, Float, Integer,
Long, java.util.Date (as xsd:dateTime),
java.sql.Date (as xsd:date), java.sql.Time (as
xsd:time), java.math.BigDecimal (with no exponent allowed, as
xsd:decimal), and java.math.BigInteger (as xsd:integer). The
xsd:type attribute is checked when unmarshalling values to select the proper
deserialization and value type. The name of the top-level element in the XML
structure can be configured in the binding definition, but the rest of the
names are predefined and set in the code (though the namespace configured for
the top-level element will be used with all the names).
The net effect is that the XML structure will always be of the form:
where "map-name" is the configured top-level element name, the "size"
attribute is the number of pairs in the hash map, and the "entry" elements
are the actual entries in the hash map.
For unmarshalling this requires an active namespace declaration with a
prefix for the schema namespace. All xsi:type attribute values must use this
prefix. If more than one prefix is declared for the schema namespace, the
innermost one declared must be used.
Default constructor. This uses a pre-defined name for the top-level
element. It'll be used by JiBX when no name information is supplied by
the mapping which references this custom marshaller/unmarshaller.
HashMapperStringToSchemaType
public HashMapperStringToSchemaType(java.lang.String uri,
int index,
java.lang.String name)
Aliased constructor. This takes a name definition for the top-level
element. It'll be used by JiBX when a name is supplied by the mapping
which references this custom marshaller/unmarshaller.
Parameters:
uri - namespace URI for the top-level element (also used for all
other names within the binding)
index - namespace index corresponding to the defined URI within the
marshalling context definitions
Check if marshaller represents an extension mapping. This is used by the
framework in generated code to verify compatibility of objects being
marshalled using an abstract mapping.
Marshal instance of handled class. This method call is responsible
for all handling of the marshalling of an object to XML text. It is
called at the point where the start tag for the associated element
should be generated.
Check if instance present in XML. This method can be called when the
unmarshalling context is positioned at or just before the start of the
data corresponding to an instance of this mapping. It verifies that the
expected data is present.
Unmarshal instance of handled class. This method call is responsible
for all handling of the unmarshalling of an object from XML text,
including creating the instance of the handled class if an instance is
not supplied. When it is called the unmarshalling context is always
positioned at or just before the start tag corresponding to the start of
the class data.
Abstract base custom marshaller/unmarshaller for an object that may have
multiple references. The first time an object is seen when marshalling the
full XML representation is generated; successive uses of the same object then
use XML references to the object ID. To use this class you need to create a
subclass with a constructor using the same signature as the one provided
(calling the base class constructor from your subclass constructor) and
implement the abstract getIdValue(java.lang.Object) method in your subclass. You can
also override the provided getAttributeName() method to change the
name used for the IDREF attribute, which must not match the name of an
attribute used in the normal marshalled form of the object. The name used for
this marshaller/unmarshaller in the mapping definition must match the name
used for the base object type being handled.
Version:
1.0
Author:
Dennis M. Sosnoski
Constructor Summary
IdDefRefMapperBase(java.lang.String uri,
int index,
java.lang.String name)
Aliased constructor taking a name definition for reference elements.
Method Summary
boolean
isExtension(int index)
Check if marshaller represents an extension mapping.
public IdDefRefMapperBase(java.lang.String uri,
int index,
java.lang.String name)
Aliased constructor taking a name definition for reference elements. The
subclass version will be used by JiBX to define the element name to be
used with this custom marshaller/unmarshaller.
Parameters:
uri - namespace URI for the top-level element
index - namespace index corresponding to the defined URI within the
marshalling context definitions
Check if marshaller represents an extension mapping. This is used by the
framework in generated code to verify compatibility of objects being
marshalled using an abstract mapping.
Marshal instance of handled class. This method call is responsible
for all handling of the marshalling of an object to XML text. It is
called at the point where the start tag for the associated element
should be generated.
Check if instance present in XML. This method can be called when the
unmarshalling context is positioned at or just before the start of the
data corresponding to an instance of this mapping. It verifies that the
expected data is present.
Unmarshal instance of handled class. This method call is responsible
for all handling of the unmarshalling of an object from XML text,
including creating the instance of the handled class if an instance is
not supplied. When it is called the unmarshalling context is always
positioned at or just before the start tag corresponding to the start of
the class data.
Abstract base custom marshaller/unmarshaller for an object reference. This
marshals the reference as an empty element with a single IDREF attribute, and
unmarshals an element with the same structure to create a reference to the
object with that ID value. To use this class you need to create a subclass
with a constructor using the same signature as the one provided (calling the
base class constructor from your subclass constructor) and implement the
abstract getIdValue(java.lang.Object) method in your subclass. You can also override
the provided getAttributeName() method to change the name used for the
IDREF attribute. Note that this class can only be used when the definitions
precede the references in the XML document; if a referenced ID is not defined
the unmarshaller throws an exception.
Version:
1.0
Author:
Dennis M. Sosnoski
Constructor Summary
IdRefMapperBase(java.lang.String uri,
int index,
java.lang.String name)
Aliased constructor taking a name definition for the element.
Method Summary
boolean
isExtension(int index)
Check if marshaller represents an extension mapping.
public IdRefMapperBase(java.lang.String uri,
int index,
java.lang.String name)
Aliased constructor taking a name definition for the element. The
subclass version will be used by JiBX to define the element name to be
used with this custom marshaller/unmarshaller.
Parameters:
uri - namespace URI for the top-level element
index - namespace index corresponding to the defined URI within the
marshalling context definitions
Check if marshaller represents an extension mapping. This is used by the
framework in generated code to verify compatibility of objects being
marshalled using an abstract mapping.
Marshal instance of handled class. This method call is responsible
for all handling of the marshalling of an object to XML text. It is
called at the point where the start tag for the associated element
should be generated.
Check if instance present in XML. This method can be called when the
unmarshalling context is positioned at or just before the start of the
data corresponding to an instance of this mapping. It verifies that the
expected data is present.
Unmarshal instance of handled class. This method call is responsible
for all handling of the unmarshalling of an object from XML text,
including creating the instance of the handled class if an instance is
not supplied. When it is called the unmarshalling context is always
positioned at or just before the start tag corresponding to the start of
the class data.
Generate open start tag. This allows attributes and/or namespace
declarations to be added to the start tag, but must be followed by a
IXMLWriter.closeStartTag() call.
Parameters:
index - namespace URI index number
name - unqualified element name
Throws:
java.io.IOException - on error writing to document
Generate start tag for element with namespaces. This creates the actual
start tag, along with any necessary namespace declarations. Previously
active namespace declarations are not duplicated. The tag is
left incomplete, allowing other attributes to be added.
Parameters:
index - namespace URI index number
name - element name
nums - array of namespace indexes defined by this element (must
be constant, reference is kept until end of element)
prefs - array of namespace prefixes mapped by this element (no
null values, use "" for default namespace declaration)
Throws:
java.io.IOException - on error writing to document
addAttribute
public void addAttribute(int index,
java.lang.String name,
java.lang.String value)
throws java.io.IOException
Custom marshaller/unmarshaller for Object[] instances. This
handles mapping arrays typed as java.lang.Object[], where each
item in the array must be of a mapped type. If a name is specified by the
mapping definition that name is used as a wrapper around the elements
representing the items in the array; otherwise, the elements are just handled
inline.
Default constructor. This just sets up for an XML representation with no
element wrapping the actual item structures. It'll be used by JiBX when
no name information is supplied by the mapping which references this
custom marshaller/unmarshaller.
ObjectArrayMapper
public ObjectArrayMapper(java.lang.String uri,
int index,
java.lang.String name)
Aliased constructor. This takes a name definition for the top-level
wrapper element. It'll be used by JiBX when a name is supplied by the
mapping which references this custom marshaller/unmarshaller.
Parameters:
uri - namespace URI for the top-level element
index - namespace index corresponding to the defined URI within the
marshalling context definitions
Check if marshaller represents an extension mapping. This is used by the
framework in generated code to verify compatibility of objects being
marshalled using an abstract mapping.
Marshal instance of handled class. This method call is responsible
for all handling of the marshalling of an object to XML text. It is
called at the point where the start tag for the associated element
should be generated.
Check if instance present in XML. This method can be called when the
unmarshalling context is positioned at or just before the start of the
data corresponding to an instance of this mapping. It verifies that the
expected data is present.
Unmarshal instance of handled class. This method call is responsible
for all handling of the unmarshalling of an object from XML text,
including creating the instance of the handled class if an instance is
not supplied. When it is called the unmarshalling context is always
positioned at or just before the start tag corresponding to the start of
the class data.
Representation of a qualified name. This includes the serializer/deserializer
methods for the representation. It assumes that the actual namespace
declarations are being handled separately for marshalling.
JiBX serializer method. This is intended for use as a serializer for
instances of the class. The namespace must be active in the output
document at the point where this is called.
Test program for the JiBX framework. Works with three or four command line
arguments: mapped-class, binding-name, in-file, and out-file (optional, only
needed if different from in-file). You can also supply a multiple of four
input arguments, in which case each set of four is processed in turn (in this
case the out-file is required). Unmarshals documents from files using the
specified bindings for the mapped classes, then marshals them back out using
the same bindings and compares the results. In case of a comparison error the
output file is left as temp.xml .
Test program for the JiBX framework. Works with two or three command line
arguments: mapped-class, in-file, and out-file (optional, only needed if
different from in-file). You can also supply a multiple of three input
arguments, in which case each set of three is processed in turn (in this case
the out-file is required). Unmarshals documents from files using the binding
defined for the mapped class, then marshals them back out using the same
bindings and compares the results. In case of a comparison error the output
file is left as temp.xml.
Custom marshaller/unmarshaller for reference arrays of a particular type.
This handles mapping arrays typed as object-type[], where the
object-type is any class name (not a primitive type). All items in the
array must be of a mapped type. If a name is specified by the mapping
definition that name is used as a wrapper around the elements representing
the items in the array; otherwise, the elements are just handled inline.
public TypedArrayMapper(java.lang.String uri,
int index,
java.lang.String name,
java.lang.String type)
Aliased constructor. This takes a name definition for the top-level
wrapper element. It'll be used by JiBX when a name is supplied by the
mapping which references this custom marshaller/unmarshaller.
Parameters:
uri - namespace URI for the top-level element
index - namespace index corresponding to the defined URI within the
marshalling context definitions
name - local name for the top-level element
type - class name for type of items in array
TypedArrayMapper
public TypedArrayMapper(java.lang.String type)
Class only constructor. This just sets up for an XML representation with
no element wrapping the actual item structures. It'll be used by JiBX
when no name information is supplied by the mapping which references this
custom marshaller/unmarshaller.
Check if marshaller represents an extension mapping. This is used by the
framework in generated code to verify compatibility of objects being
marshalled using an abstract mapping.
Marshal instance of handled class. This method call is responsible
for all handling of the marshalling of an object to XML text. It is
called at the point where the start tag for the associated element
should be generated.
Check if instance present in XML. This method can be called when the
unmarshalling context is positioned at or just before the start of the
data corresponding to an instance of this mapping. It verifies that the
expected data is present.
Unmarshal instance of handled class. This method call is responsible
for all handling of the unmarshalling of an object from XML text,
including creating the instance of the handled class if an instance is
not supplied. When it is called the unmarshalling context is always
positioned at or just before the start tag corresponding to the start of
the class data.
Backfill reference item, used for filling in forward references as
members of arrays. Each item holds both the array containing the
reference and the offset in the array.
Add forward reference to tracked object. This method is called by
the framework when a reference item is created for the object
associated with this holder.
Parameters:
ref - backfill reference item
defineValue
public void defineValue(java.lang.Object obj)
Define referenced object. This method is called by the framework
when the forward-referenced object is defined, and in turn calls each
reference to fill in the reference.
Backfill reference item, used for filling in forward references to
objects. Each reference to an item must define a class implementing
this interface, to be used when a referenced item is not yet defined.
The references for a particular object are collected by a BackFillHolder
instance, and are processed when the object is defined.
Generic handler for marshalling text document to a writer. This is the
most general output handler since it can be used with any character encoding
and and output writer.
uris - ordered array of URIs for namespaces used in document (must
be constant; the value in position 0 must always be the empty string "",
and the value in position 1 must always be the XML namespace
"http://www.w3.org/XML/1998/namespace")
GenericXMLWriter
public GenericXMLWriter(GenericXMLWriter base,
java.lang.String[] uris)
Copy constructor. This takes the writer from a supplied instance, while
setting a new array of namespace URIs. It's intended for use when
invoking one binding from within another binding.
public void setOutput(java.io.Writer outw,
ICharacterEscaper escaper)
Set output writer and escaper. If an output writer is currently open when
this is called the existing writer is flushed and closed, with any
errors ignored.
Parameters:
outw - writer for document data output
escaper - character escaper for chosen encoding
setIndentSpaces
public void setIndentSpaces(int count,
java.lang.String newline,
char indent)
Set nesting indentation. This is advisory only, and implementations of
this interface are free to ignore it. The intent is to indicate that the
generated output should use indenting to illustrate element nesting.
Parameters:
count - number of character to indent per level, or disable
indentation if negative (zero means new line only)
newline - sequence of characters used for a line ending
(null means use the single character '\n')
indent - whitespace character used for indentation
writeTextContent
public void writeTextContent(java.lang.String text)
throws java.io.IOException
Write ordinary character data text content to document. This needs to
write the text with any appropriate escaping.
Parameters:
text - content value text
Throws:
java.io.IOException - on error writing to document
writeCData
public void writeCData(java.lang.String text)
throws java.io.IOException
Write CDATA text to document. This needs to write the text with any
appropriate escaping.
Parameters:
text - content value text
Throws:
java.io.IOException - on error writing to document
indent
public void indent(int bias)
throws java.io.IOException
Request output indent. Output the line end sequence followed by the
appropriate number of indent characters.
Parameters:
bias - indent depth difference (positive or negative) from current
element nesting depth
Throws:
java.io.IOException - on error writing to document
indent
public void indent()
throws java.io.IOException
Request output indent. Output the line end sequence followed by the
appropriate number of indent characters for the current nesting level.
Throws:
java.io.IOException - on error writing to document
flush
public void flush()
throws java.io.IOException
Flush document output. Forces out all output generated to this point.
java.io.IOException - on error writing to document
createChildWriter
public IXMLWritercreateChildWriter(java.lang.String[] uris)
Create a child writer instance to be used for a separate binding. The
child writer inherits the stream and encoding from this writer, while
using the supplied namespace URIs.
Interface used to enhance an output stream with a separate method for writing
the last chunk of data in a message. This is useful when working with a
chunking transport layer, so that the output stream knows which particular
write operation is the last one in the sequence.
Author:
Dennis M. Sosnoski
Method Summary
void
write(byte[] b,
int off,
int len)
Normal write from byte array.
void
writeFinal(byte[] b,
int off,
int len)
Write last data chunk from byte array.
Method Detail
write
void write(byte[] b,
int off,
int len)
throws java.io.IOException
Normal write from byte array. This method is included only to make it
clear that the writeFinal(byte[], int, int) is an alternative to
the normal write.
Parameters:
b - byte array
off - starting offset
len - number of bytes to write
Throws:
java.io.IOException - on write error
writeFinal
void writeFinal(byte[] b,
int off,
int len)
throws java.io.IOException
Write last data chunk from byte array. This method finishes output. It is
an error if any further write operations (using either the write(byte[], int, int) method defined in this interface, or any of the
other java.io.OutputStream methods) are executed after the
call to this method.
Handler for writing ASCII output stream. This code is specifically for XML
1.0 and would require changes for XML 1.1 (to handle the added legal
characters, rather than throwing an exception).
java.io.IOException - on error writing to document
writeCData
public void writeCData(java.lang.String text,
java.io.Writer writer)
throws java.io.IOException
Write CDATA to document. This writes the beginning and ending sequences
for a CDATA section as well as the actual text, verifying that only
characters allowed by the encoding are included in the text.
public ISO88591StreamWriter(java.lang.String[] uris,
byte[] buffer)
Constructor with supplied buffer.
Parameters:
uris - ordered array of URIs for namespaces used in document (must
be constant; the value in position 0 must always be the empty string "",
and the value in position 1 must always be the XML namespace
"http://www.w3.org/XML/1998/namespace")
buffer - output data buffer
ISO88591StreamWriter
public ISO88591StreamWriter(java.lang.String[] uris)
Constructor using default buffer size.
Parameters:
uris - ordered array of URIs for namespaces used in document (must
be constant; the value in position 0 must always be the empty string "",
and the value in position 1 must always be the XML namespace
"http://www.w3.org/XML/1998/namespace")
Copy constructor. This uses the stream and actual buffer from a supplied
instance, while setting a new array of namespace URIs. It's intended for
use when invoking one binding from within another binding.
public void writeTextContent(java.lang.String text)
throws java.io.IOException
Write ordinary character data text content to document.
Parameters:
text - content value text
Throws:
java.io.IOException - on error writing to document
writeCData
public void writeCData(java.lang.String text)
throws java.io.IOException
Write CDATA text to document.
Parameters:
text - content value text
Throws:
java.io.IOException - on error writing to document
createChildWriter
public IXMLWritercreateChildWriter(java.lang.String[] uris)
throws java.io.IOException
Create a child writer instance to be used for a separate binding. The
child writer inherits the stream and encoding from this writer, while
using the supplied namespace URIs.
Unmarshalling source tracking implementation interface. This interface is
added to bound classes when requested by the binding definition. It defines
the method used by JiBX to add unmarshal source tracking information to an
instance of a bound class.
Version:
1.0
Author:
Dennis M. Sosnoski
Method Summary
void
jibx_setSource(java.lang.String name,
int line,
int column)
Set source document information.
Methods inherited from interface org.jibx.runtime.ITrackSource
createReader(java.io.InputStream is,
java.lang.String name,
java.lang.String enc,
boolean nsf)
Get new XML reader instance for document from input stream.
recycleReader(IXMLReader old,
java.io.InputStream is,
java.lang.String name,
java.lang.String enc)
Recycle XML reader instance for new document from input stream.
Recycle XML reader instance for new document from input stream. If the
supplied reader can be reused it will be configured for the new document
and returned; otherwise, a new reader will be created for the document.
The namespace enabled state of the returned reader is always the same as
that of the supplied reader.
Parameters:
old - reader instance to be recycled
is - document input stream
name - document name (null if unknown)
enc - document character encoding (null if unknown)
Recycle XML reader instance for document from reader. If the supplied
reader can be reused it will be configured for the new document and
returned; otherwise, a new reader will be created for the document. The
namespace enabled state of the returned reader is always the same as that
of the supplied reader.
Wrapper for input stream that supports multiple character encodings. This is
needed because the XPP3 pull parser does not support detecting the character
encoding for a document based on the content of the document. If used with a
common encoding this performs the conversion to characters using an inner
reader class; otherwise, this creates the appropriate reader type
Set input stream with encoding to be defined later. If an input stream is
currently open when this is called the existing stream is closed, with
any errors ignored.
Parameters:
ins - stream for document data input
setInput
public void setInput(java.io.InputStream ins,
java.lang.String enc)
throws java.io.IOException
Set input stream with specified encoding. If an input stream is currently
open when this is called the existing stream is closed, with any errors
ignored.
Parameters:
ins - stream for document data input
enc - character encoding used for input from stream
(null if to be determined from XML input)
Throws:
java.io.IOException
setEncoding
public void setEncoding(java.lang.String enc)
throws java.io.IOException
Set encoding for stream. This call is only valid if the encoding has not
been set previously, and if the encoding is a recognized type.
Parameters:
enc - character encoding used for input from stream
(null if to be determined from XML input)
Throws:
java.io.IOException - if unknown encoding, or encoding already set
getReader
public java.io.Reader getReader()
throws java.io.IOException
Get reader for wrapped input stream. This creates and returns a reader
using the appropriate encoding, if necessary reading and examining the
first part of the stream (including the XML declaration, if present) to
determine the encoding.
Returns:
reader
Throws:
java.io.IOException - if error reading from document or creating a reader
for the encoding found
getEncoding
public java.lang.String getEncoding()
Get encoding for input document. This call may not return an accurate
result until after getReader() is called.
Returns:
character encoding for input document
close
public void close()
throws java.io.IOException
Close document input. Completes reading of document input, including
closing the input medium.
setFromContext(MarshallingContext parent)
Initializes the context to use the same marshalled text destination and
parameters as another marshalling context.
public MarshallingContext(java.lang.String[] classes,
java.lang.String[] mcs,
java.lang.String[] uris,
IBindingFactory ifact)
Constructor.
Parameters:
classes - ordered array of class names included in mapping
definition (reference kept, must be constant)
mcs - names of marshaller classes for indexes with fixed marshallers
(as opposed to mapping slots, which may be overridden; reference kept,
must be constant)
uris - ordered array of URIs for namespaces used in binding (must
be constant; the value in position 0 must always be the empty string "",
and the value in position 1 must always be the XML namespace
"http://www.w3.org/XML/1998/namespace")
ifact - binding factory creating this unmarshaller
Set output stream with encoding and escaper. This forces handling of the
output stream to use the Java character encoding support with the
supplied escaper.
number of spaces indented per level, or negative if indentation
disabled
setIndent
public void setIndent(int count)
Set nesting indent spaces. This is advisory only, and implementations of
this interface are free to ignore it. The intent is to indicate that the
generated output should use indenting to illustrate element nesting.
count - number of spaces to indent per level, or disable
indentation if negative
setIndent
public void setIndent(int count,
java.lang.String newline,
char indent)
Set nesting indentation. This is advisory only, and implementations of
this interface are free to ignore it. The intent is to indicate that the
generated output should use indenting to illustrate element nesting.
count - number of character to indent per level, or disable
indentation if negative (zero means new line only)
newline - sequence of characters used for a line ending
(null means use the single character '\n')
indent - whitespace character used for indentation
setFromContext
public void setFromContext(MarshallingContext parent)
throws java.io.IOException
Initializes the context to use the same marshalled text destination and
parameters as another marshalling context. This method is designed for
use when an initial context needs to create and invoke a secondary
context (generally from a different binding) in the course of an
marshalling operation. Note that once the secondary context has been used
it's generally necessary to do a XMLWriterBase.flush() operation
on the writer used by the that context before resuming output on the
parent.
Parameters:
parent - context supplying target for marshalled document text
Throws:
java.io.IOException - on error writing output
reset
public void reset()
Reset to initial state for reuse. The context is serially reusable,
as long as this method is called to clear any retained state information
between uses. It is automatically called when output is set.
Return the binding factory used to create this unmarshaller.
Returns:
binding factory
getNamespaces
public java.lang.String[] getNamespaces()
Get namespace URIs for mapping. This gets the full ordered array of
namespaces known in the binding used for this marshalling, where the
index number of each namespace URI is the namespace index used to lookup
the prefix when marshalling a name in that namespace. The returned array
must not be modified.
Returns:
array of namespaces
startDocument
public void startDocument(java.lang.String enc,
java.lang.Boolean alone)
throws JiBXException
Start document. This can only be validly called immediately following
one of the set output methods; otherwise the output document will be
corrupt.
alone - standalone document flag, null if not
specified
Throws:
JiBXException - on any error (possibly wrapping other exception)
startDocument
public void startDocument(java.lang.String enc,
java.lang.Boolean alone,
java.io.OutputStream outs)
throws JiBXException
Start document with output stream and encoding. The effect is the same
as from first setting the output stream and encoding, then making the
call to start document.
End document. Finishes all output and closes the document. Note that if
this is called with an imcomplete marshalling the result will not be
well-formed XML.
Generate integer attribute. This can only be used following an open start
tag.
Parameters:
index - namespace URI index number
name - attribute name
value - integer value for attribute
Returns:
this context (to allow chained calls)
Throws:
JiBXException - on any error (possibly wrapping other exception)
attribute
public MarshallingContextattribute(int index,
java.lang.String name,
int value,
java.lang.String[] table)
throws JiBXException
Generate enumeration attribute. The actual text to be written is obtained
by indexing into the supplied array of values. This can only be used
following an open start tag.
Parameters:
index - namespace URI index number
name - attribute name
value - integer enumeration value (zero-based)
table - text values in enumeration
Returns:
this context (to allow chained calls)
Throws:
JiBXException - on any error (possibly wrapping other exception)
Marshal all items in a collection. This variation is for Vector
collections.
Parameters:
col - collection of items to be marshalled
Returns:
this context (to allow chained calls)
Throws:
JiBXException - on any error (possibly wrapping other exception)
addMarshalling
public void addMarshalling(int index,
java.lang.String name)
Define marshalling for class. Adds the marshalling definition using fixed
indexes for each class, allowing direct lookup of the marshaller when
multiple versions are defined.
Parameters:
index - class index for marshalling definition
name - marshaller class name handling
removeMarshalling
public void removeMarshalling(int index)
Undefine marshalling for element. Removes the marshalling
definition for a particular class index.
Generate start tag for element with namespaces. This creates the actual
start tag, along with any necessary namespace declarations. Previously
active namespace declarations are not duplicated. The tag is
left incomplete, allowing other attributes to be added.
TODO: Handle nested default namespaces declarations, prefixes for outers
Parameters:
index - namespace URI index number
name - element name
nums - array of namespace indexes defined by this element (must
be constant, reference is kept until end of element)
prefs - array of namespace prefixes mapped by this element (no
null values, use "" for default namespace declaration)
Returns:
this context (to allow chained calls)
Throws:
JiBXException - on any error (possibly wrapping other exception)
Find the marshaller for a particular class index
in the current context.
TODO: Eliminate the string passing, since it's not a common enough
problem to be worth checking (and with abstract mappings can be really
difficult to set properly)
name - fully qualified name of class to be marshalled (used only
for validation)
Returns:
marshalling handler for class
Throws:
JiBXException - on any error (possibly wrapping other exception)
marshalDocument
public void marshalDocument(java.lang.Object root)
throws JiBXException
Marshal document from root object without XML declaration. This can only
be validly called immediately following one of the set output methods;
otherwise the output document will be corrupt. The effect of this method
is the same as the sequence of a call to marshal the root object using
this context followed by a call to endDocument().
root - object at root of structure to be marshalled, which must have
a top-level mapping in the binding
Throws:
JiBXException - on any error (possibly wrapping other exception)
marshalDocument
public void marshalDocument(java.lang.Object root,
java.lang.String enc,
java.lang.Boolean alone)
throws JiBXException
Marshal document from root object. This can only be validly called
immediately following one of the set output methods; otherwise the output
document will be corrupt. The effect of this method is the same as the
sequence of a call to startDocument(java.lang.String, java.lang.Boolean), a call to marshal the root
object using this context, and finally a call to endDocument().
Marshal document from root object to output stream with encoding. The
effect of this method is the same as the sequence of a call to startDocument(java.lang.String, java.lang.Boolean), a call to marshal the root object using this context,
and finally a call to endDocument().
Marshal document from root object to writer. The effect of this method
is the same as the sequence of a call to startDocument(java.lang.String, java.lang.Boolean), a call
to marshal the root object using this context, and finally a call to
endDocument().
root - object at root of structure to be marshalled, which must have
a top-level mapping in the binding
enc - document encoding, null if not specified
alone - standalone document flag, null if not
specified
outw - writer for document data output
Throws:
JiBXException - on any error (possibly wrapping other exception)
getIdMap
public java.util.HashMap getIdMap()
Get shared ID map. The ID map returned is not used directly by the
marshalling code, but is provided to support user extensions.
Returns:
ID map
setUserContext
public void setUserContext(java.lang.Object obj)
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 the reset() method,
so to make use of this you need to first call the appropriate version of
the setOutput() method, then this method, and finally one of
the marshalDocument methods which uses the previously-set
output (not the ones which take a stream or writer as parameter, since
they call setOutput() themselves).
Push created object to marshalling stack. This must be called before
beginning the marshalling of the object. It is only called for objects
with structure, not for those converted directly to and from text.
Get current marshalling object stack depth. This allows tracking
nested calls to marshal one object while in the process of
marshalling another object. The bottom item on the stack is always the
root object being marshalled.
Get object from marshalling stack. This stack allows tracking nested
calls to marshal one object while in the process of marshalling
another object. The bottom item on the stack is always the root object
being marshalled.
public static java.lang.String[] splitClassNames(int count,
java.lang.String blob)
Split concatenated class names string into an array of individual class
names. This is used by the generated binding factory code, to reduce the
size of the generated classes and methods. It takes as input a string
consisting of compacted fully-qualified class names separated by '|'
delimitor characters. If the compacted name starts with one or more '.'
characters the corresponding number of package name levels are taken from
the last class name. Empty names are left null in the array.
Parameters:
count - number of names
blob - compacted class names separated by '|' delimitors
Returns:
expanded class names
expandNamespaces
public static java.lang.String[] expandNamespaces(java.lang.String blob,
java.lang.String[] uris)
Expand names URI indexes into an array of individual names URIs. This is
used by the generated binding factory code, to reduce the size of the
generated classes and methods. It takes as input a string where each
character is a namespace index, biased by +2 in order to avoid the use of
null characters, along with a table of corresponding namespace URIs. The
character value 1 is used as a marker for the case where no namespace is
associated with an index.
Parameters:
blob - string of characters representing namespace indexes
uris - namespace URIs defined in binding
Returns:
expanded class names
splitNames
public static java.lang.String[] splitNames(int count,
java.lang.String blob)
Split concatenated names string into an array of individual names. This
is used by the generated binding factory code, to reduce the size of the
generated classes and methods. It takes as input a string consisting of
names separated by '|' delimitor characters.
createReader(java.io.InputStream is,
java.lang.String name,
java.lang.String enc,
boolean nsf)
Get new XML reader instance for document from input stream.
recycleReader(IXMLReader old,
java.io.InputStream is,
java.lang.String name,
java.lang.String enc)
Recycle XML reader instance for new document from input stream.
Recycle XML reader instance for new document from input stream. If the
supplied reader can be reused it will be configured for the new document
and returned; otherwise, a new reader will be created for the document.
The namespace enabled state of the returned reader is always the same as
that of the supplied reader.
Recycle XML reader instance for document from reader. If the supplied
reader can be reused it will be configured for the new document and
returned; otherwise, a new reader will be created for the document. The
namespace enabled state of the returned reader is always the same as that
of the supplied reader.
Wrapper for a StAX parser implementation. This delegates most calls
more or less directly, only adding the required namespace functionality
on top of the StAX API.
Field Summary
Fields inherited from interface org.jibx.runtime.IXMLReader
Advance to next binding component of input document. This is a
higher-level operation than IXMLReader.nextToken(), which consolidates text
content and ignores parse events for components such as comments and PIs.
Get current text. When positioned on a TEXT event this returns the actual
text; for CDSECT it returns the text inside the CDATA section; for
COMMENT, DOCDECL, or PROCESSING_INSTRUCTION it returns the text inside
the structure.
uris - ordered array of URIs for namespaces used in document (must
be constant; the value in position 0 must always be the empty string "",
and the value in position 1 must always be the XML namespace
"http://www.w3.org/XML/1998/namespace")
StAXWriter
public StAXWriter(java.lang.String[] uris,
javax.xml.stream.XMLStreamWriter wrtr)
Constructor with writer supplied.
Parameters:
uris - ordered array of URIs for namespaces used in document (must
be constant; the value in position 0 must always be the empty string "",
and the value in position 1 must always be the XML namespace
"http://www.w3.org/XML/1998/namespace")
wrtr - StAX writer for parse event output
StAXWriter
public StAXWriter(StAXWriter base,
java.lang.String[] uris)
Copy constructor. This initializes the writer and extension namespace
information from an existing instance.
Parameters:
base - existing instance
uris - ordered array of URIs for namespaces used in document
Method Detail
setWriter
public void setWriter(javax.xml.stream.XMLStreamWriter wrtr)
Set StAX writer.
Parameters:
wrtr - StAX writer for parse event output
setIndentSpaces
public void setIndentSpaces(int count,
java.lang.String newline,
char indent)
Set nesting indentation. This is advisory only, and implementations of
this interface are free to ignore it. The intent is to indicate that the
generated output should use indenting to illustrate element nesting.
Generate open start tag. This allows attributes and/or namespace
declarations to be added to the start tag, but must be followed by a
IXMLWriter.closeStartTag() call.
Generate start tag for element with namespaces. This creates the actual
start tag, along with any necessary namespace declarations. Previously
active namespace declarations are not duplicated. The tag is
left incomplete, allowing other attributes to be added.
Request output indent. The writer implementation should normally indent
output as appropriate. This method can be used to request indenting of
output that might otherwise not be indented. The normal effect when used
with a text-oriented writer should be to output the appropriate line end
sequence followed by the appropriate number of indent characters for the
current nesting level.
Flush document output. Writes any buffered data to the output medium.
This does not flush the output medium itself, only any internal
buffering within the writer.
java.io.IOException - on error writing to document
createChildWriter
public IXMLWritercreateChildWriter(java.lang.String[] uris)
Create a child writer instance to be used for a separate binding. The
child writer inherits the output handling from this writer, while using
the supplied namespace URIs.
Base handler for marshalling text document to an output stream. This is
designed for use with character encodings that use standard one-byte values
for Unicode characters in the 0x20-0x7F range, which includes the most
widely used encodings for XML documents. It needs to be subclassed with
implementation methods specific to the encoding used.
public StreamWriterBase(java.lang.String enc,
java.lang.String[] uris)
Constructor using default buffer size.
Parameters:
enc - character encoding used for output to streams (upper case)
uris - ordered array of URIs for namespaces used in document (must
be constant; the value in position 0 must always be the empty string "",
and the value in position 1 must always be the XML namespace
"http://www.w3.org/XML/1998/namespace")
StreamWriterBase
public StreamWriterBase(StreamWriterBase base,
java.lang.String[] uris)
Copy constructor. This takes the stream and encoding information from a
supplied instance, while setting a new array of namespace URIs. It's
intended for use when invoking one binding from within another binding.
Get the name of the character encoding used by this writer.
Returns:
encoding
setOutput
public void setOutput(java.io.OutputStream outs)
Set output stream. If an output stream is currently open when this is
called the existing stream is flushed and closed, with any errors
ignored.
Parameters:
outs - stream for document data output
setNamespaceUris
public void setNamespaceUris(java.lang.String[] uris)
throws java.io.IOException
Set namespace URIs. This forces a reset of the writer, clearing any
buffered output. It is intended to be used only for reconfiguring an
existing writer for reuse.
Parameters:
uris - ordered array of URIs for namespaces used in document
Throws:
java.io.IOException
setIndentSpaces
public void setIndentSpaces(int count,
java.lang.String newline,
char indent)
Set nesting indentation. This is advisory only, and implementations of
this interface are free to ignore it. The intent is to indicate that the
generated output should use indenting to illustrate element nesting.
Parameters:
count - number of character to indent per level, or disable
indentation if negative (zero means new line only)
newline - sequence of characters used for a line ending
(null means use the single character '\n')
indent - whitespace character used for indentation
pushExtensionNamespaces
public void pushExtensionNamespaces(java.lang.String[] uris)
Append extension namespace URIs to those in mapping.
Growable String array with type specific access methods. This
implementation is unsynchronized in order to provide the best possible
performance for typical usage scenarios, so explicit synchronization must
be implemented by a wrapper class or directly by the application in cases
where instances are modified in a multithreaded environment.
Hash map using String values as keys mapped to primitive
int values. This implementation is unsynchronized in order to
provide the best possible performance for typical usage scenarios, so
explicit synchronization must be implemented by a wrapper class or directly
by the application in cases where instances are modified in a multithreaded
environment. The map implementation is not very efficient when resizing, but
works well when the size of the map is known in advance.
Version:
1.1
Author:
Dennis M. Sosnoski
Field Summary
static int
DEFAULT_NOT_FOUND
Default value returned when key not found in table.
Handler for writing ASCII output stream. This code is specifically for XML
1.0 and would require changes for XML 1.1 (to handle the added legal
characters, rather than throwing an exception).
java.io.IOException - on error writing to document
writeCData
public void writeCData(java.lang.String text,
java.io.Writer writer)
throws java.io.IOException
Write CDATA to document. This writes the beginning and ending sequences
for a CDATA section as well as the actual text, verifying that only
characters allowed by the encoding are included in the text.
Handler for writing UTF output stream (for any form of UTF, despite the
name). This code is specifically for XML 1.0 and would require changes for
XML 1.1 (to handle the added legal characters, rather than throwing an
exception).
java.io.IOException - on error writing to document
writeCData
public void writeCData(java.lang.String text,
java.io.Writer writer)
throws java.io.IOException
Write CDATA to document. This writes the beginning and ending sequences
for a CDATA section as well as the actual text, verifying that only
characters allowed by the encoding are included in the text.
public UTF8StreamWriter(java.lang.String[] uris,
byte[] buffer)
Constructor with supplied buffer.
Parameters:
uris - ordered array of URIs for namespaces used in document (must
be constant; the value in position 0 must always be the empty string "",
and the value in position 1 must always be the XML namespace
"http://www.w3.org/XML/1998/namespace")
buffer - output data buffer
UTF8StreamWriter
public UTF8StreamWriter(java.lang.String[] uris)
Constructor creating a buffer of the default size.
Parameters:
uris - ordered array of URIs for namespaces used in document (must
be constant; the value in position 0 must always be the empty string "",
and the value in position 1 must always be the XML namespace
"http://www.w3.org/XML/1998/namespace")
UTF8StreamWriter
public UTF8StreamWriter(UTF8StreamWriter base,
java.lang.String[] uris)
Copy constructor. This takes the stream from a supplied instance, while
setting a new array of namespace URIs. It's intended for use when
invoking one binding from within another binding.
public void writeTextContent(java.lang.String text)
throws java.io.IOException
Write ordinary character data text content to document.
Parameters:
text - content value text
Throws:
java.io.IOException - on error writing to document
writeCData
public void writeCData(java.lang.String text)
throws java.io.IOException
Write CDATA text to document.
Parameters:
text - content value text
Throws:
java.io.IOException - on error writing to document
createChildWriter
public IXMLWritercreateChildWriter(java.lang.String[] uris)
throws java.io.IOException
Create a child writer instance to be used for a separate binding. The
child writer inherits the stream and encoding from this writer, while
using the supplied namespace URIs.
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.
getUnmarshaller(java.lang.String ns,
java.lang.String name)
Find the unmarshaller for a particular element name (including
namespace) in the current context.
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.
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.
Constructor. Builds the actual parser and initializes internal data
structures.
Parameters:
nmap - number of mapping definitions included
umcs - 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 definitions
names - names for elements of classes with global definitions
idcs - 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 Detail
buildNameString
public static java.lang.String buildNameString(java.lang.String ns,
java.lang.String name)
Build name with optional namespace. Just returns the appropriate
name format.
Parameters:
ns - namespace URI of name
name - local name part of name
Returns:
formatted name string
currentNameString
public java.lang.String currentNameString()
Build current element name, with optional namespace.
Returns:
formatted name string
buildPositionString
public java.lang.String buildPositionString()
Build current parse input position description.
Returns:
text description of current parse position
throwStartTagNameError
public void throwStartTagNameError(java.lang.String ns,
java.lang.String name)
throws JiBXException
Throw exception for expected element start tag not found.
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 data
name - document name (null if unknown)
enc - document input encoding, or null if to be
determined by parser
public void setDocument(java.io.Reader rdr,
java.lang.String name,
boolean nsa)
throws JiBXException
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.
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.
public java.lang.String toStart()
throws JiBXException
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
public java.lang.String toEnd()
throws JiBXException
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)
ns - namespace URI for expected element (may be null
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
public boolean hasAttribute(java.lang.String ns,
java.lang.String name)
throws JiBXException
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 be null
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
public boolean hasAnyAttribute(java.lang.String[] nss,
java.lang.String[] names)
throws JiBXException
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 be
null 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
public void checkAllowedAttributes(java.lang.String[] nss,
java.lang.String[] names)
throws JiBXException
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 be
null 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)
parseToStartTag
public void parseToStartTag(java.lang.String ns,
java.lang.String name)
throws JiBXException
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 be null
or the empty string for the empty namespace)
name - element name expected
Throws:
JiBXException - on any error (possibly wrapping other exception)
parsePastStartTag
public void parsePastStartTag(java.lang.String ns,
java.lang.String name)
throws JiBXException
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 be null
or the empty string for the empty namespace)
name - element name expected
Throws:
JiBXException - on any error (possibly wrapping other exception)
parseIfStartTag
public boolean parseIfStartTag(java.lang.String ns,
java.lang.String name)
throws JiBXException
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 be null
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
public void parsePastCurrentEndTag(java.lang.String ns,
java.lang.String name)
throws JiBXException
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 be null
or the empty string for the empty namespace)
name - element name expected
Throws:
JiBXException - on any error (possibly wrapping other exception)
parsePastEndTag
public void parsePastEndTag(java.lang.String ns,
java.lang.String name)
throws JiBXException
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 be null
or the empty string for the empty namespace)
name - element name expected
Throws:
JiBXException - on any error (possibly wrapping other exception)
JiBXException - on any error (possibly wrapping other exception)
accumulateText
public java.lang.String accumulateText()
throws JiBXException
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)
public java.lang.String parseContentText()
throws JiBXException
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
public java.lang.String parseContentText(java.lang.String ns,
java.lang.String tag)
throws JiBXException
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 be null
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
public int parseContentInt(java.lang.String ns,
java.lang.String tag)
throws JiBXException
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 be null
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
public java.lang.String parseElementText(java.lang.String ns,
java.lang.String tag)
throws JiBXException
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 be null
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
public java.lang.String parseElementText(java.lang.String ns,
java.lang.String tag,
java.lang.String dflt)
throws JiBXException
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 be null
or the empty string for the empty namespace)
tag - element name expected
dflt - default text value
Returns:
content text from element
Throws:
JiBXException - on any error (possible wrapping other exception)
attributeText
public java.lang.String attributeText(java.lang.String ns,
java.lang.String name)
throws JiBXException
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 be null
or the empty string for the empty namespace)
public java.lang.Object parseElementForwardIDREF(java.lang.String ns,
java.lang.String tag,
int index)
throws JiBXException
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 be null
or the empty string for the empty namespace)
tag - attribute name expected
index - 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
public java.lang.Object attributeForwardIDREF(java.lang.String ns,
java.lang.String name,
int index)
throws JiBXException
Get object (if defined yet) corresponding to IDREF attribute from
current start tag.
Parameters:
ns - namespace URI for expected attribute (may be null
or the empty string for the empty namespace)
name - attribute name expected
index - 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
public java.lang.Object parseElementExistingIDREF(java.lang.String ns,
java.lang.String tag,
int index)
throws JiBXException
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 be null
or the empty string for the empty namespace)
tag - attribute name expected
index - 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
public java.lang.Object attributeExistingIDREF(java.lang.String ns,
java.lang.String name,
int index)
throws JiBXException
Get previously defined object corresponding to IDREF attribute from
current start tag.
Parameters:
ns - namespace URI for expected attribute (may be null
or the empty string for the empty namespace)
name - attribute name expected
index - 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
public int attributeInt(java.lang.String ns,
java.lang.String name)
throws JiBXException
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 be null
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
public int attributeInt(java.lang.String ns,
java.lang.String name,
int dflt)
throws JiBXException
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 be null
or the empty string for the empty namespace)
name - attribute name expected
dflt - value to be returned if attribute is not present
Returns:
attribute integer value
Throws:
JiBXException - if attribute value is not a valid integer
parseElementInt
public int parseElementInt(java.lang.String ns,
java.lang.String tag)
throws JiBXException
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 be null
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
public int parseElementInt(java.lang.String ns,
java.lang.String tag,
int dflt)
throws JiBXException
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 be null
or the empty string for the empty namespace)
tag - element name expected
dflt - default value
Returns:
content text from element
Throws:
JiBXException - on any error (possibly wrapping other exception)
convertEnum
public int convertEnum(java.lang.String target,
java.lang.String[] enums,
int[] vals)
throws JiBXException
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 enumeration
enums - ordered array of texts included in enumeration
vals - array of values to be returned for corresponding text match
positions (position returned directly if this is null)
Returns:
enumeration value for target text
Throws:
JiBXException - if target text not found in enumeration
convertEnum
public int convertEnum(java.lang.String target,
java.lang.String[] enums,
int[] vals,
int dflt)
throws JiBXException
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 is null.
Parameters:
target - text to be found in enumeration (may be null)
enums - ordered array of texts included in enumeration
vals - 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
Returns:
enumeration value for target text
Throws:
JiBXException - if target text not found in enumeration
attributeEnumeration
public int attributeEnumeration(java.lang.String ns,
java.lang.String name,
java.lang.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 be null
or the empty string for the empty namespace)
name - attribute name expected
enums - ordered array of texts included in enumeration
vals - array of values to be returned for corresponding text match
positions (position returned directly if this is null)
Returns:
enumeration value for target text
Throws:
JiBXException - if attribute not present or value not found in
enumeration list
attributeEnumeration
public int attributeEnumeration(java.lang.String ns,
java.lang.String name,
java.lang.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 be null
or the empty string for the empty namespace)
name - attribute name expected
enums - ordered array of texts included in enumeration
vals - 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
Returns:
enumeration value for target text
Throws:
JiBXException - if attribute not present or value not found in
enumeration list
parseContentEnumeration
public int parseContentEnumeration(java.lang.String ns,
java.lang.String tag,
java.lang.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 be null
or the empty string for the empty namespace)
tag - element name expected
enums - ordered array of texts included in enumeration
vals - array of values to be returned for corresponding text match
positions (position returned directly if this is null)
Returns:
enumeration value for element text
Throws:
JiBXException - on any error (possible wrapping other exception)
parseElementEnumeration
public int parseElementEnumeration(java.lang.String ns,
java.lang.String tag,
java.lang.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 be null
or the empty string for the empty namespace)
tag - element name expected
enums - ordered array of texts included in enumeration
vals - array of values to be returned for corresponding text match
positions (position returned directly if this is null)
dflt - default value
Returns:
enumeration value for element text
Throws:
JiBXException - on any error (possibly wrapping other exception)
convertByte
public byte convertByte(java.lang.String text)
throws JiBXException
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.
public byte attributeByte(java.lang.String ns,
java.lang.String name)
throws JiBXException
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 be null
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
public byte attributeByte(java.lang.String ns,
java.lang.String name,
byte dflt)
throws JiBXException
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 be null
or the empty string for the empty namespace)
name - attribute name expected
dflt - value to be returned if attribute is not present
Returns:
attribute byte value
Throws:
JiBXException - if attribute value is not a valid byte
parseContentByte
public byte parseContentByte(java.lang.String ns,
java.lang.String tag)
throws JiBXException
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 be null
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
public byte parseElementByte(java.lang.String ns,
java.lang.String tag)
throws JiBXException
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 be null
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
public byte parseElementByte(java.lang.String ns,
java.lang.String tag,
byte dflt)
throws JiBXException
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 be null
or the empty string for the empty namespace)
tag - element name expected
dflt - default value
Returns:
content text from element
Throws:
JiBXException - on any error (possibly wrapping other exception)
convertShort
public short convertShort(java.lang.String text)
throws JiBXException
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.
public short attributeShort(java.lang.String ns,
java.lang.String name)
throws JiBXException
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 be null
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
public short attributeShort(java.lang.String ns,
java.lang.String name,
short dflt)
throws JiBXException
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 be null
or the empty string for the empty namespace)
name - attribute name expected
dflt - value to be returned if attribute is not present
Returns:
attribute short value
Throws:
JiBXException - if attribute value is not a valid short
parseContentShort
public short parseContentShort(java.lang.String ns,
java.lang.String tag)
throws JiBXException
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 be null
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
public short parseElementShort(java.lang.String ns,
java.lang.String tag)
throws JiBXException
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 be null
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
public short parseElementShort(java.lang.String ns,
java.lang.String tag,
short dflt)
throws JiBXException
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 be null
or the empty string for the empty namespace)
tag - element name expected
dflt - default value
Returns:
content text from element
Throws:
JiBXException - on any error (possibly wrapping other exception)
convertChar
public char convertChar(java.lang.String text)
throws JiBXException
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.
public char attributeChar(java.lang.String ns,
java.lang.String name)
throws JiBXException
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 be null
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
public char attributeChar(java.lang.String ns,
java.lang.String name,
char dflt)
throws JiBXException
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 be null
or the empty string for the empty namespace)
name - attribute name expected
dflt - value to be returned if attribute is not present
Returns:
attribute char value
Throws:
JiBXException - if attribute value is not a valid char
parseContentChar
public char parseContentChar(java.lang.String ns,
java.lang.String tag)
throws JiBXException
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 be null
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
public char parseElementChar(java.lang.String ns,
java.lang.String tag)
throws JiBXException
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 be null
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
public char parseElementChar(java.lang.String ns,
java.lang.String tag,
char dflt)
throws JiBXException
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 be null
or the empty string for the empty namespace)
tag - element name expected
dflt - default value
Returns:
content text from element
Throws:
JiBXException - on any error (possibly wrapping other exception)
convertLong
public long convertLong(java.lang.String text)
throws JiBXException
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.
public long attributeLong(java.lang.String ns,
java.lang.String name)
throws JiBXException
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 be null
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
public long attributeLong(java.lang.String ns,
java.lang.String name,
long dflt)
throws JiBXException
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 be null
or the empty string for the empty namespace)
name - attribute name expected
dflt - value to be returned if attribute is not present
Returns:
attribute long value
Throws:
JiBXException - if attribute value is not a valid long
parseElementLong
public long parseElementLong(java.lang.String ns,
java.lang.String tag)
throws JiBXException
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 be null
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
public long parseElementLong(java.lang.String ns,
java.lang.String tag,
long dflt)
throws JiBXException
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 be null
or the empty string for the empty namespace)
tag - element name expected
dflt - default value
Returns:
content text from element
Throws:
JiBXException - on any error (possibly wrapping other exception)
convertBoolean
public boolean convertBoolean(java.lang.String text)
throws JiBXException
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.
public boolean attributeBoolean(java.lang.String ns,
java.lang.String name)
throws JiBXException
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 be null
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
public boolean attributeBoolean(java.lang.String ns,
java.lang.String name,
boolean dflt)
throws JiBXException
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 be null
or the empty string for the empty namespace)
name - attribute name expected
dflt - value to be returned if attribute is not present
Returns:
attribute boolean value
Throws:
JiBXException - if attribute value is not a valid boolean
parseElementBoolean
public boolean parseElementBoolean(java.lang.String ns,
java.lang.String tag)
throws JiBXException
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 be null
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
public boolean parseElementBoolean(java.lang.String ns,
java.lang.String tag,
boolean dflt)
throws JiBXException
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 be null
or the empty string for the empty namespace)
tag - element name expected
dflt - default value
Returns:
content text from element
Throws:
JiBXException - on any error (possibly wrapping other exception)
convertFloat
public float convertFloat(java.lang.String text)
throws JiBXException
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.
public float attributeFloat(java.lang.String ns,
java.lang.String name)
throws JiBXException
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 be null
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
public float attributeFloat(java.lang.String ns,
java.lang.String name,
float dflt)
throws JiBXException
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 be null
or the empty string for the empty namespace)
name - attribute name expected
dflt - value to be returned if attribute is not present
Returns:
attribute float value
Throws:
JiBXException - if attribute value is not a valid float
parseElementFloat
public float parseElementFloat(java.lang.String ns,
java.lang.String tag)
throws JiBXException
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 be null
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
public float parseElementFloat(java.lang.String ns,
java.lang.String tag,
float dflt)
throws JiBXException
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 be null
or the empty string for the empty namespace)
tag - element name expected
dflt - default value
Returns:
content text from element
Throws:
JiBXException - on any error (possibly wrapping other exception)
convertDouble
public double convertDouble(java.lang.String text)
throws JiBXException
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.
public double attributeDouble(java.lang.String ns,
java.lang.String name)
throws JiBXException
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 be null
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
public double attributeDouble(java.lang.String ns,
java.lang.String name,
double dflt)
throws JiBXException
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 be null
or the empty string for the empty namespace)
name - attribute name expected
dflt - value to be returned if attribute is not present
Returns:
attribute double value
Throws:
JiBXException - if attribute value is not a valid double
parseElementDouble
public double parseElementDouble(java.lang.String ns,
java.lang.String tag)
throws JiBXException
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 be null
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
public double parseElementDouble(java.lang.String ns,
java.lang.String tag,
double dflt)
throws JiBXException
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 be null
or the empty string for the empty namespace)
tag - element name expected
dflt - default value
Returns:
content text from element
Throws:
JiBXException - on any error (possibly wrapping other exception)
convertDate
public java.util.Date convertDate(java.lang.String text)
throws JiBXException
Convert 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.
public java.util.Date attributeDate(java.lang.String ns,
java.lang.String name)
throws JiBXException
Get 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.
Parameters:
ns - namespace URI for expected attribute (may be null
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
public java.util.Date attributeDate(java.lang.String ns,
java.lang.String name,
java.util.Date dflt)
throws JiBXException
Get java.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 be null
or the empty string for the empty namespace)
name - attribute name expected
dflt - value to be returned if attribute is not present
Returns:
attribute Date value
Throws:
JiBXException - if attribute value is not a valid Date
parseElementDate
public java.util.Date parseElementDate(java.lang.String ns,
java.lang.String tag)
throws JiBXException
Parse past end of element, returning 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.
Parameters:
ns - namespace URI for expected element (may be null
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
public java.util.Date parseElementDate(java.lang.String ns,
java.lang.String tag,
java.util.Date dflt)
throws JiBXException
Parse entire element, returning 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.
Parameters:
ns - namespace URI for expected element (may be null
or the empty string for the empty namespace)
tag - element name expected
dflt - default value
Returns:
content text from element
Throws:
JiBXException - on any error (possibly wrapping other exception)
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 value
index - target reference type index
fill - back fill item
Throws:
JiBXException - if attribute not present, or ID already defined
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 index
fill - back fill item
Throws:
JiBXException - if attribute not present, or ID already defined
defineID
public void defineID(java.lang.String id,
int index,
java.lang.Object obj)
throws JiBXException
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.
public void addUnmarshalling(int index,
java.lang.String ns,
java.lang.String name,
java.lang.String cname)
Define unmarshalling for element. Enables the unmarshalling definition
linking an element name (including namespace) with a handler. The
unmarshalling definitions use fixed indexes for each class, allowing
direct lookup of the unmarshaller when multiple versions are defined.
Parameters:
index - class index for unmarshalling definition
ns - namespace for element (may be null
or the empty string for the empty namespace)
name - name for element
cname - name of class created by unmarshaller
removeUnmarshalling
public void removeUnmarshalling(int index)
Undefine unmarshalling for element. Disables the unmarshalling
definition for a particular class index.
public java.lang.Object unmarshalOptionalElement()
throws JiBXException
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
public java.lang.Object unmarshalElement(java.lang.Class clas)
throws JiBXException
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
public java.lang.Object unmarshalElement()
throws JiBXException
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.
JiBXException - on any error (possibly wrapping other exception)
parsePastElement
public void parsePastElement(java.lang.String ns,
java.lang.String tag)
throws JiBXException
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 be null
or the empty string for the empty namespace)
tag - element name expected
Throws:
JiBXException - on any error (possible wrapping other exception)
getElementName
public java.lang.String getElementName()
throws JiBXException
Returns current element name.
Returns:
local name part of name, or null if not at a start
or end tag
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
public void setUserContext(java.lang.Object obj)
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 the 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.
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.
Set position tracking information for object, if supported.
Parameters:
obj - object being tracked
pushTrackedObject
public void pushTrackedObject(java.lang.Object obj)
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.
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.
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.
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)
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)
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
public java.lang.String 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:
java.lang.IllegalStateException - if not at a start or end tag (optional)
getNamespace
public java.lang.String 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:
java.lang.IllegalStateException - if not at a start or end tag (optional)
getPrefix
public java.lang.String 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:
java.lang.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:
java.lang.IllegalStateException - if not at a start tag (optional)
getAttributeName
public java.lang.String getAttributeName(int index)
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:
java.lang.IllegalStateException - if not at a start tag or invalid index
getAttributeNamespace
public java.lang.String getAttributeNamespace(int index)
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:
java.lang.IllegalStateException - if not at a start tag or invalid index
getAttributePrefix
public java.lang.String getAttributePrefix(int index)
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:
java.lang.IllegalStateException - if not at a start tag or invalid index
getAttributeValue
public java.lang.String getAttributeValue(int index)
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:
java.lang.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
public java.lang.String getNamespaceUri(int index)
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:
java.lang.IllegalArgumentException - if invalid index
getNamespacePrefix
public java.lang.String getNamespacePrefix(int index)
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:
java.lang.IllegalArgumentException - if invalid index
getNamespaceUri
public java.lang.String getNamespaceUri(java.lang.String prefix)
Get namespace URI matching prefix.
Parameters:
prefix - namespace prefix to be matched (null for
default namespace)
createReader(java.io.InputStream is,
java.lang.String name,
java.lang.String enc,
boolean nsf)
Get new XML reader instance for document from input stream.
recycleReader(IXMLReader old,
java.io.InputStream is,
java.lang.String name,
java.lang.String enc)
Recycle XML reader instance for new document from input stream.
Recycle XML reader instance for new document from input stream. If the
supplied reader can be reused it will be configured for the new document
and returned; otherwise, a new reader will be created for the document.
The namespace enabled state of the returned reader is always the same as
that of the supplied reader.
Recycle XML reader instance for document from reader. If the supplied
reader can be reused it will be configured for the new document and
returned; otherwise, a new reader will be created for the document. The
namespace enabled state of the returned reader is always the same as that
of the supplied reader.
Base implementation of XML writer interface. This provides common handling of
indentation and formatting that can be used for all forms of text output.
uris - ordered array of URIs for namespaces used in document (must
be constant; the value in position 0 must always be the empty string "",
and the value in position 1 must always be the XML namespace
"http://www.w3.org/XML/1998/namespace")
XMLWriterBase
public XMLWriterBase(XMLWriterBase base,
java.lang.String[] uris)
Copy constructor. This initializes the extension namespace information
from an existing instance.
Parameters:
base - existing instance
uris - ordered array of URIs for namespaces used in document
Method Detail
writeXMLDecl
public void writeXMLDecl(java.lang.String version,
java.lang.String encoding,
java.lang.String standalone)
throws java.io.IOException
Write XML declaration to document. This can only be called before any
other methods in the interface are called.
Generate start tag for element with namespaces. This creates the actual
start tag, along with any necessary namespace declarations. Previously
active namespace declarations are not duplicated. The tag is
left incomplete, allowing other attributes to be added.
java.io.IOException - on error writing to document
flush
public abstract void flush()
throws java.io.IOException
Flush document output. Subclasses must implement this method to force all
buffered output to be written. To assure proper handling of an open start
tag they should first call flagContent().
java.io.IOException - on error writing to document
reset
public void reset()
Reset to initial state for reuse. The writer is serially reusable,
as long as this method is called to clear any retained state information
between uses. It is automatically called when output is set.
Base implementation of XML writer interface namespace handling. This tracks
only the namespace declarations and the element nesting depth. It can be used
as a base class for all forms of output.
public XMLWriterNamespaceBase(java.lang.String[] uris)
Constructor.
Parameters:
uris - ordered array of URIs for namespaces used in document (must
be constant; the value in position 0 must always be the empty string "",
and the value in position 1 must always be the XML namespace
"http://www.w3.org/XML/1998/namespace")
nums - array of namespace indexes defined by this element (must
be constant, reference is kept until end of element)
prefs - array of namespace prefixes mapped by this element (no
null values, use "" for default namespace declaration)
Returns:
array of indexes for namespaces not previously active (the ones
actually needing to be declared, in the case of text output)
Throws:
java.io.IOException - on error writing to document
getNestingDepth
public final int getNestingDepth()
Get the current element nesting depth. Elements are only counted in the
depth returned when they're officially open - after the start tag has
been output and before the end tag has been output.
Get namespace URIs for mapping. This gets the full ordered array of
namespaces known in the binding used for this marshalling, where the
index number of each namespace URI is the namespace index used to lookup
the prefix when marshalling a name in that namespace. The returned array
must not be modified.
current prefix text, or null if the namespace is not
currently mapped
getPrefixIndex
public final int getPrefixIndex(java.lang.String prefix)
Get index of namespace mapped to prefix. This can be an expensive
operation with time proportional to the number of namespaces defined, so
it should be used with care.
Base implementation of XML writer interface namespace handling.
Package org.jibx.runtime.impl Description
JiBX data binding framework runtime implementation package. These classes are
designed for use in generated code by the binding generator portion of the framework.
They are not generally intended for direct use by end users, and are subject
to more change than the published external APIs.
The only circumstance in which an end user of the framework should need to work
with these classes is when writing a marshaller or unmarshaller for a class.
These replace generated code for the classes involved, and hence allow full
control over the operation of the framework.
Get instance of binding factory. Finds the binding factory for the
target class, then loads that factory and returns an instance. This
method can only be used with target classes that are mapped in only
one binding.
Parameters:
clas - target class for binding
Returns:
binding factory instance
Throws:
JiBXException - on any error in finding or accessing factory
getFactory
public static IBindingFactorygetFactory(java.lang.String bname,
java.lang.String pack,
java.lang.ClassLoader loader)
throws JiBXException
Get instance of binding factory. Finds the binding factory for the
named binding on the target class, then loads that factory and returns
an instance.
Parameters:
bname - binding name
pack - target package for binding
loader - class loader to be used for loading factory
Returns:
binding factory instance
Throws:
JiBXException - on any error in finding or accessing factory
Get instance of binding factory. Finds the binding factory for the named
binding compiled to the specified package, then loads that factory and
returns an instance.
Parameters:
bname - binding name
pack - target package for binding
Returns:
binding factory instance
Throws:
JiBXException - on any error in finding or accessing factory
Named value set support class. This provides convenience methods to support
working with a set of named static final int values, including
translating them to and from String representations. It's
intended for use with relatively small nonnegative int values.
Constructor from array of enumeration items. The supplied items can be in
any order, and the numeric values do not need to be contiguous (but must
be unique, nonnegative, and should be fairly small). Note that this
constructor will reorder the items in the supplied array as a side
effect.
Parameters:
items - array of enumeration items (will be reordered)
EnumSet
public EnumSet(int start,
java.lang.String[] names)
Constructor from array of names. The value associated with each name is
just the position index in the array added to the start value.
Parameters:
start - item value for first added name
names - array of names (no null entries allowed)
EnumSet
public EnumSet(EnumSet base,
int start,
java.lang.String[] names)
Constructor from existing enumeration with added names. The value
associated with each name is just the position index in the array added
to the start value.
Parameters:
base - base enumeration to be extended
start - item value for first added name
names - array of names (no null entries allowed)
Method Detail
getName
public java.lang.String getName(int value)
Get name for value if defined.
Parameters:
value - enumeration value
Returns:
name for value, or null if not defined
getNameChecked
public java.lang.String getNameChecked(int value)
Get name for value. If the supplied value is not defined in the
enumeration this throws an exception.
Parameters:
value - enumeration value
Returns:
name for value
getValue
public int getValue(java.lang.String name)
Get value for name if defined.
Parameters:
name - possible enumeration name
Returns:
value for name, or -1 if not found in enumeration
getValueChecked
public int getValueChecked(java.lang.String name)
Get value for name. If the supplied name is not present in the
enumeration this throws an exception.
Parameters:
name - enumeration name
Returns:
value for name
checkValue
public void checkValue(int value)
Check value with exception. Throws an exception if the supplied value is
not defined by this enumeration.
Abstract base marshaller interface definition. This interface must be
implemented by the handler for marshalling an object as an instance of a
binding with extension mappings.
This extension to the normal marshaller interface allows the base
marshalling to determine the proper marshaller implementation to use at
runtime. The code needs to check that the object to be marshalled has a
marshaller that extends this base mapping.
Version:
1.0
Author:
Dennis M. Sosnoski
Method Summary
void
baseMarshal(java.lang.Object obj,
IMarshallingContext ctx)
Marshal instance of class with mapping extending this abstract mapping.
Methods inherited from interface org.jibx.runtime.IMarshaller
Marshal instance of class with mapping extending this abstract mapping.
This method call is responsible for all handling of the marshalling of an
appropriate object to XML text. It is called at the point where the start
tag for the associated element should be generated.
Parameters:
obj - object to be marshalled (may be null, in the case
of a non-optional property with no value supplied)
Nameable extension interface definition. This interface must be implemented
by a marshaller IMarshaller or unmarshaller IUnmarshaller that can use different top-level element
names. Although it does not define any methods, it designates the marshaller
or unmarshaller as being usable with a namespace and element name, and
particular bound class name, defined within a binding.
If this interface is implemented by a marshaller or unmarshaller class used
with a specified element name in a binding the binding compiler will actually
generate a subclass of the original class. The subclass uses a standard
no-argument constructor, but calls a superclass constructor with the
specified element name and bound class information. The superclass code can
then make use of the specified name in marshalling and/or unmarshalling.
Binding factory interface definition. This interface is implemented by
the binding factory class generated by each binding definition. All binding
factory instances are guaranteed to be threadsafe and reusable.
java.lang.UnsupportedOperationException - if unmarshalling not supported
by binding
getCompilerVersion
int getCompilerVersion()
Get version number for binding compiler used.
Returns:
version number of code used to compile binding
getCompilerDistribution
java.lang.String getCompilerDistribution()
Get distribution name for binding compiler used.
Returns:
name of distribution for binding compiler
getNamespaces
java.lang.String[] getNamespaces()
Get namespaces defined in mapping. The returned array is indexed by the
namespace index number used when marshalling.
Returns:
array of namespaces defined in binding (null if not
an output binding)
getPrefixes
java.lang.String[] getPrefixes()
Get initial prefixes for namespaces defined in mapping. The returned
array is indexed by the namespace index number used when marshalling.
Note that these are only the first prefixes associated with each
namespace; it's possible to reuse the namespace in the binding with a
different prefix.
Returns:
array of prefixes for namespaces defined in binding
(null if not an output binding)
getMappedClasses
java.lang.String[] getMappedClasses()
Get mapped class names (or type names, in the case of abstract mappings).
Returns array of fully-qualified class and/or type names, ordered by
index number of the class.
Returns:
array of class names
getElementNamespaces
java.lang.String[] getElementNamespaces()
Get namespaces of elements corresponding to mapped classes. The returned
array uses the same ordering as the result of the getMappedClasses() call. Entries in the array are null if
there is no element for a class or the element is in the default
namespace.
Returns:
array of element namespaces
getElementNames
java.lang.String[] getElementNames()
Get names of elements corresponding to mapped classes. The returned array
uses the same ordering as the result of the getMappedClasses()
call. Entries in the array are null if there is no element
for a class.
Returns:
array of element names
getTypeIndex
int getTypeIndex(java.lang.String type)
Get mapped class index from type name for abstract non-base mappings
included in the binding. This is intended to allow identifying and using
abstract mappings (basically type mappings) at runtime. The method is
only returns a non-negative result if the "force-classes" option is used
for the binding definition (since otherwise no marshaller/unmarshaller
classes are created for abstract non-base mappings).
Parameters:
type - fully-qualified class or type name
Returns:
mapping index for type, or -1 if type is not an
abstract non-base mapping
Escaper for character data to be written to output document. This allows
special character encodings to be handled appropriately on output. It's used
by the generic output handler class during document marshalling.
Version:
1.0
Author:
Dennis M. Sosnoski
Method Summary
void
writeAttribute(java.lang.String text,
java.io.Writer writer)
Write attribute value with character entity substitutions.
void
writeCData(java.lang.String text,
java.io.Writer writer)
Write CDATA to document.
void
writeContent(java.lang.String text,
java.io.Writer writer)
Write content value with character entity substitutions.
Write CDATA to document. This writes the beginning and ending sequences
for a CDATA section as well as the actual text, verifying that only
characters allowed by the encoding are included in the text.
Parameters:
text - content value text
writer - sink for output text
Throws:
java.io.IOException - on error writing to document
Create a child writer instance to be used for a separate binding. The
child writer inherits the output handling from this writer, while using
the supplied namespace URIs.
Parameters:
uris - ordered array of URIs for namespaces used in document
Marshallable interface definition. This interface must be implemented by all
classes which can be marshalled as independent units (not just as children of
other objects). Classes implementing this interface may either marshal
themselves directly (if there's only one marshalling format defined), or
obtain an instance of the appropriate marshaller from the context and use
that. This interface is automatically added by the binding compiler to all
classes targeted by <mapping> elements in a binding.
Get class index. This returns the mapping index number for a class within
the compiled bindings. It's intended primarily for internal use by the
binding framework.
Marshaller interface definition. This interface must be implemented
by the handler for marshalling an object.
Instances of classes implementing this interface must be serially
reusable, meaning they can store state information while in the process
of marshalling an object but must reset all state when called to
marshal another object after the first one is done (even if the first
object throws an exception during marshalling).
The JiBX framework will only create one instance of a marshaller class
for each mapped class using that marshaller. Generally the marshaller
instance will not be called recursively, but this may happen in cases where
the binding definition includes recursive mappings and the marshaller
uses other marshallers (as opposed to handling all children directly).
Version:
1.0
Author:
Dennis M. Sosnoski
Method Summary
boolean
isExtension(int index)
Check if marshaller represents an extension mapping.
Check if marshaller represents an extension mapping. This is used by the
framework in generated code to verify compatibility of objects being
marshalled using an abstract mapping.
Parameters:
index - abstract mapping index to be checked
Returns:
true if this mapping is an extension of the abstract
mapping, false if not
Marshal instance of handled class. This method call is responsible
for all handling of the marshalling of an object to XML text. It is
called at the point where the start tag for the associated element
should be generated.
Parameters:
obj - object to be marshalled (may be null if property
is not optional)
User interface for serializer to XML. This provides methods used to set up
and control the marshalling process, as well as access to the marshalling
object stack while marshalling.
Set output stream with encoding and escaper. This forces handling of the
output stream to use the Java character encoding support with the
supplied escaper.
Parameters:
outs - stream for document data output
enc - document output encoding, or null uses UTF-8
default
Get current nesting indent spaces. This returns the number of spaces used
to show indenting, if used.
Returns:
number of spaces indented per level, or negative if indentation
disabled
setIndent
void setIndent(int count)
Set nesting indent spaces. This is advisory only, and implementations of
this interface are free to ignore it. The intent is to indicate that the
generated output should use indenting to illustrate element nesting.
Parameters:
count - number of spaces to indent per level, or disable
indentation if negative
Set nesting indentation. This is advisory only, and implementations of
this interface are free to ignore it. The intent is to indicate that the
generated output should use indenting to illustrate element nesting.
Parameters:
count - number of character to indent per level, or disable
indentation if negative (zero means new line only)
newline - sequence of characters used for a line ending
(null means use the single character '\n')
indent - whitespace character used for indentation
reset
void reset()
Reset to initial state for reuse. The context is serially reusable,
as long as this method is called to clear any retained state information
between uses. It is automatically called when output is set.
Start document, writing the XML declaration. This can only be validly
called immediately following one of the set output methods; otherwise the
output document will be corrupt.
Parameters:
enc - document encoding, null uses UTF-8 default
alone - standalone document flag, null if not
specified
Throws:
JiBXException - on any error (possibly wrapping other exception)
Start document with output stream and encoding. The effect is the same
as from first setting the output stream and encoding, then making the
call to start document.
Parameters:
enc - document encoding, null uses UTF-8 default
alone - standalone document flag, null if not
specified
outs - stream for document data output
Throws:
JiBXException - on any error (possibly wrapping other exception)
End document. Finishes all output and closes the document. Note that if
this is called with an imcomplete marshalling the result will not be
well-formed XML.
Throws:
JiBXException - on any error (possibly wrapping other exception)
Marshal document from root object without XML declaration. This can only
be validly called immediately following one of the set output methods;
otherwise the output document will be corrupt. The effect of this method
is the same as the sequence of a call to marshal the root object using
this context followed by a call to endDocument().
Parameters:
root - object at root of structure to be marshalled, which must have
a top-level mapping in the binding
Throws:
JiBXException - on any error (possibly wrapping other exception)
Marshal document from root object. This can only be validly called
immediately following one of the set output methods; otherwise the output
document will be corrupt. The effect of this method is the same as the
sequence of a call to startDocument(java.lang.String, java.lang.Boolean), a call to marshal the root
object using this context, and finally a call to endDocument().
Parameters:
root - object at root of structure to be marshalled, which must have
a top-level mapping in the binding
enc - document encoding, null uses UTF-8 default
alone - standalone document flag, null if not
specified
Throws:
JiBXException - on any error (possibly wrapping other exception)
Marshal document from root object to output stream with encoding. The
effect of this method is the same as the sequence of a call to startDocument(java.lang.String, java.lang.Boolean), a call to marshal the root object using this context,
and finally a call to endDocument().
Parameters:
root - object at root of structure to be marshalled, which must have
a top-level mapping in the binding
enc - document encoding, null uses UTF-8 default
alone - standalone document flag, null if not
specified
outs - stream for document data output
Throws:
JiBXException - on any error (possibly wrapping other exception)
Marshal document from root object to writer. The effect of this method
is the same as the sequence of a call to startDocument(java.lang.String, java.lang.Boolean), a call
to marshal the root object using this context, and finally a call to
endDocument().
Parameters:
root - object at root of structure to be marshalled, which must have
a top-level mapping in the binding
enc - document encoding, null uses UTF-8 default
alone - standalone document flag, null if not
specified
outw - writer for document data output
Throws:
JiBXException - on any error (possibly wrapping other exception)
setUserContext
void setUserContext(java.lang.Object obj)
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 the reset() method,
so to make use of this you need to first call the appropriate version of
the setOutput() method, then this method, and finally one of
the marshalDocument methods which uses the previously-set
output (not the ones which take a stream or writer as parameter, since
they call setOutput() themselves).
Parameters:
obj - user context object, or null if clearing existing
context object
Push created object to marshalling stack. This must be called before
beginning the marshalling of the object. It is only called for objects
with structure, not for those converted directly to and from text.
Get current marshalling object stack depth. This allows tracking
nested calls to marshal one object while in the process of marshalling
another object. The bottom item on the stack is always the root object
of the marshalling.
Returns:
number of objects in marshalling stack
getStackObject
java.lang.Object getStackObject(int depth)
Get object from marshalling stack. This stack allows tracking nested
calls to marshal one object while in the process of marshalling
another object. The bottom item on the stack is always the root object
of the marshalling.
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 marshalling stack
getStackTop
java.lang.Object getStackTop()
Get top object on marshalling stack. This is safe to call even when no
objects are on the stack.
Unmarshalling source tracking interface. This interface is added to bound
classes when requested by the binding definition. It allows the user to
retrieve information about the location in the input document corresponding
to an unmarshalled object, if the parser used for unmarshalling supports
reporting this information.
Unmarshallable interface definition. This interface must be implemented by
all classes which can be unmarshalled as independent units (not just as
children of other objects). Classes implementing this interface may either
unmarshal themselves directly (if there's only one unmarshalling format
defined), or obtain an instance of the appropriate unmarshaller from the
context and use that.
Unmarshaller interface definition. This interface must be implemented
by the handler for unmarshalling an object.
Instances of classes implementing this interface must be serially
reusable, meaning they can store state information while in the process
of unmarshalling an object but must reset all state when called to
unmarshal another object after the first one is done (even if the first
object throws an exception during unmarshalling).
The JiBX framework will only create one instance of an unmarshaller class
for each mapped class using that unmarshaller. Generally the unmarshaller
instance will not be called recursively, but this may happen in cases where
the binding definition includes recursive mappings and the unmarshaller
uses other unmarshallers (as opposed to handling all children directly).
Check if instance present in XML. This method can be called when the
unmarshalling context is positioned at or just before the start of the
data corresponding to an instance of this mapping. It verifies that the
expected data is present.
Unmarshal instance of handled class. This method call is responsible
for all handling of the unmarshalling of an object from XML text,
including creating the instance of the handled class if an instance is
not supplied. When it is called the unmarshalling context is always
positioned at or just before the start tag corresponding to the start of
the class data.
User interface for deserializer from XML. This provides methods used to set
up and control the marshalling process, as well as access to the
unmarshalling object stack while unmarshalling.
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.
Unmarshal the current element. If not currently positioned at a start
or end tag this first advances the parse to the next start or end tag.
There must be an unmarshalling defined for the current element, and this
unmarshalling is used to build an object from that element.
Returns:
unmarshalled object from element
Throws:
JiBXException - on any error (possibly wrapping other exception)
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 the 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() method.
Parameters:
obj - user context object, or null if clearing existing
context object
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.
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.
Returns:
number of objects in unmarshalling stack
getStackObject
java.lang.Object getStackObject(int depth)
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.
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
java.lang.Object getStackTop()
Get top object on unmarshalling stack. This is safe to call even when no
objects are on the stack.
Advance to next binding component of input document. This is a
higher-level operation than nextToken(), which consolidates text
content and ignores parse events for components such as comments and PIs.
Returns:
parse event type code
Throws:
JiBXException - if error reading or parsing document
Get an attribute value from the current start tag.
Parameters:
ns - namespace URI for expected attribute (may be null
or the empty string for the empty namespace)
name - attribute name expected
Returns:
attribute value text, or null if missing
Throws:
java.lang.IllegalStateException - if not at a start tag
getText
java.lang.String getText()
Get current text. When positioned on a TEXT event this returns the actual
text; for CDSECT it returns the text inside the CDATA section; for
COMMENT, DOCDECL, or PROCESSING_INSTRUCTION it returns the text inside
the structure.
Returns:
text for current event
getNestingDepth
int getNestingDepth()
Get current element nesting depth. The returned depth always includes the
current start or end tag (if positioned on a start or end tag).
Returns:
element nesting depth
getNamespaceCount
int getNamespaceCount(int depth)
Get number of namespace declarations active at depth.
Parameters:
depth - element nesting depth
Returns:
number of namespaces active at depth
Throws:
java.lang.IllegalArgumentException - if invalid depth
getNamespaceUri
java.lang.String getNamespaceUri(int index)
Get namespace URI.
Parameters:
index - declaration index
Returns:
namespace URI
Throws:
java.lang.IllegalArgumentException - if invalid index
getNamespacePrefix
java.lang.String getNamespacePrefix(int index)
Get namespace prefix.
Parameters:
index - declaration index
Returns:
namespace prefix, null if a default namespace
Throws:
java.lang.IllegalArgumentException - if invalid index
getDocumentName
java.lang.String getDocumentName()
Get document name.
Returns:
document name, null if not known
getLineNumber
int getLineNumber()
Get current source line number.
Returns:
line number from source document, -1 if line number
information not available
getColumnNumber
int getColumnNumber()
Get current source column number.
Returns:
column number from source document, -1 if column
number information not available
XML writer interface used for output of marshalled document. This interface
allows easy substitution of different output formats, including parse event
stream equivalents. This makes heavy use of state information, so each
method call defined is only valid in certain states.
Author:
Dennis M. Sosnoski
Method Summary
void
addAttribute(int index,
java.lang.String name,
java.lang.String value)
Add attribute to current open start tag.
writeEntityRef(java.lang.String name)
Write entity reference to document.
void
writePI(java.lang.String target,
java.lang.String data)
Write processing instruction to document.
void
writeTextContent(java.lang.String text)
Write ordinary character data text content to document.
void
writeXMLDecl(java.lang.String version,
java.lang.String encoding,
java.lang.String standalone)
Write XML declaration to document.
Method Detail
getNestingDepth
int getNestingDepth()
Get the current element nesting depth. Elements are only counted in the
depth returned when they're officially open - after the start tag has
been output and before the end tag has been output.
Returns:
number of nested elements at current point in output
getNamespaceCount
int getNamespaceCount()
Get the number of namespaces currently defined. This is equivalent to the
index of the next extension namespace added.
Set nesting indentation. This is advisory only, and implementations of
this interface are free to ignore it. The intent is to indicate that the
generated output should use indenting to illustrate element nesting.
Parameters:
count - number of character to indent per level, or disable
indentation if negative (zero means new line only)
newline - sequence of characters used for a line ending
(null means use the single character '\n')
indent - whitespace character used for indentation
Generate open start tag. This allows attributes and/or namespace
declarations to be added to the start tag, but must be followed by a
closeStartTag() call.
Parameters:
index - namespace URI index number
name - unqualified element name
Throws:
java.io.IOException - on error writing to document
Generate start tag for element with namespaces. This creates the actual
start tag, along with any necessary namespace declarations. Previously
active namespace declarations are not duplicated. The tag is
left incomplete, allowing other attributes to be added.
Parameters:
index - namespace URI index number
name - element name
nums - array of namespace indexes defined by this element (must
be constant, reference is kept until end of element)
prefs - array of namespace prefixes mapped by this element (no
null values, use "" for default namespace declaration)
Throws:
java.io.IOException - on error writing to document
target - processing instruction target name (must not be
null)
data - processing instruction data (must not be null)
Throws:
java.io.IOException - on error writing to document
indent
void indent()
throws java.io.IOException
Request output indent. The writer implementation should normally indent
output as appropriate. This method can be used to request indenting of
output that might otherwise not be indented. The normal effect when used
with a text-oriented writer should be to output the appropriate line end
sequence followed by the appropriate number of indent characters for the
current nesting level.
Throws:
java.io.IOException - on error writing to document
flush
void flush()
throws java.io.IOException
Flush document output. Writes any buffered data to the output medium.
This does not flush the output medium itself, only any internal
buffering within the writer.
Throws:
java.io.IOException - on error writing to document
close
void close()
throws java.io.IOException
Close document output. Completes writing of document output, including
flushing and closing the output medium.
Throws:
java.io.IOException - on error writing to document
reset
void reset()
Reset to initial state for reuse. The context is serially reusable,
as long as this method is called to clear any retained state information
between uses. It is automatically called when output is set.
getNamespaces
java.lang.String[] getNamespaces()
Get namespace URIs for mapping. This gets the full ordered array of
namespaces known in the binding used for this marshalling, where the
index number of each namespace URI is the namespace index used to lookup
the prefix when marshalling a name in that namespace. The returned array
must not be modified.
Returns:
array of namespaces
getNamespaceUri
java.lang.String getNamespaceUri(int index)
Get URI for namespace.
Parameters:
index - namespace URI index number
Returns:
namespace URI text, or null if the namespace index
is invalid
getNamespacePrefix
java.lang.String getNamespacePrefix(int index)
Get current prefix defined for namespace.
Parameters:
index - namespace URI index number
Returns:
current prefix text, or null if the namespace is not
currently mapped
getPrefixIndex
int getPrefixIndex(java.lang.String prefix)
Get index of namespace mapped to prefix. This can be an expensive
operation with time proportional to the number of namespaces defined, so
it should be used with care.
Parameters:
prefix - text to match (non-null, use "" for default
prefix)
Open the specified namespaces for use. This method is normally only
called internally, when namespace declarations are actually written to
output. It is exposed as part of this interface to allow for special
circumstances where namespaces are being written outside the usual
processing. The namespaces will remain open for use until the current
element is closed.
Parameters:
nums - array of namespace indexes defined by this element (must
be constant, reference is kept until namespaces are closed)
prefs - array of namespace prefixes mapped by this element (no
null values, use "" for default namespace declaration)
Returns:
array of indexes for namespaces not previously active (the ones
actually needing to be declared, in the case of text output)
Throws:
java.io.IOException - on error writing to document
Growable int stack with type specific access methods. This
implementation is unsynchronized in order to provide the best possible
performance for typical usage scenarios, so explicit synchronization must
be implemented by a wrapper class or directly by the application in cases
where instances are modified in a multithreaded environment. See the base
classes for other details of the implementation.
Ensure that the array has the capacity for at least the specified
number of values.
Parameters:
min - minimum capacity to be guaranteed
push
public void push(int value)
Push a value on the stack.
Parameters:
value - value to be added
pop
public int pop()
Pop a value from the stack.
Returns:
value from top of stack
Throws:
java.lang.ArrayIndexOutOfBoundsException - on attempt to pop empty stack
pop
public int pop(int count)
Pop multiple values from the stack. The last value popped is the
one returned.
Parameters:
count - number of values to pop from stack (must be strictly
positive)
Returns:
value from top of stack
Throws:
java.lang.ArrayIndexOutOfBoundsException - on attempt to pop past end of
stack
peek
public int peek(int depth)
Copy a value from the stack. This returns a value from within
the stack without modifying the stack.
Parameters:
depth - depth of value to be returned
Returns:
value from stack
Throws:
java.lang.ArrayIndexOutOfBoundsException - on attempt to peek past end of
stack
peek
public int peek()
Copy top value from the stack. This returns the top value without
removing it from the stack.
Returns:
value at top of stack
Throws:
java.lang.ArrayIndexOutOfBoundsException - on attempt to peek empty stack
toArray
public int[] toArray()
Constructs and returns a simple array containing the same data as held
in this stack. Note that the items will be in reverse pop order, with
the last item to be popped from the stack as the first item in the
array.
Returns:
array containing a copy of the data
clone
public java.lang.Object clone()
Duplicates the object with the generic call.
Overrides:
clone in class java.lang.Object
Returns:
a copy of the object
size
public int size()
Get the number of values currently present in the stack.
JiBX parsing exception class. This subclass of JiBXException provides
additional details when a parsing error occurs such as what tag was
being parsed and what value caused the error.
Representation of a qualified name. This includes the JiBX
serializer/deserializer methods for the representation. It assumes that the
actual namespace declarations are being handled separately for
marshalling
Note that this implementation treats only the namespace and local name as
significant for purposes of comparing values. The prefix is held only as a
convenience, and the actual prefix used when writing a value may differ from
the prefix defined by the instance.
Author:
Dennis M. Sosnoski
Constructor Summary
QName(java.lang.String name)
Constructor from local name only.
QName(java.lang.String uri,
java.lang.String name)
Constructor from namespace and local name.
QName(java.lang.String uri,
java.lang.String prefix,
java.lang.String name)
Constructor from full set of components.
public QName(java.lang.String uri,
java.lang.String prefix,
java.lang.String name)
Constructor from full set of components.
Parameters:
uri - namespace uri, null if no-namespace namespace
prefix - namespace prefix, null if unspecified, empty
string if default namespace
name - local name
QName
public QName(java.lang.String uri,
java.lang.String name)
Constructor from namespace and local name. This constructor is provided
as a convenience for when the actual prefix used for a namespace is
irrelevant.
Parameters:
uri - namespace uri, null if no-namespace namespace
name -
QName
public QName(java.lang.String name)
Constructor from local name only. This constructor is provided as a
convenience for names in the no-namespace namespace.
Parameters:
name -
Method Detail
equals
public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object
hashCode
public int hashCode()
Overrides:
hashCode in class java.lang.Object
toString
public java.lang.String toString()
Overrides:
toString in class java.lang.Object
getName
public java.lang.String getName()
Get local name.
Returns:
name
setName
public void setName(java.lang.String name)
Set local name.
Parameters:
name - name
getPrefix
public java.lang.String getPrefix()
Get namespace prefix.
Returns:
prefix, null if unspecified, empty string if default
namespace
setPrefix
public void setPrefix(java.lang.String prefix)
Set namespace prefix.
Parameters:
prefix - prefix, null if unspecified, empty string if
default namespace
getUri
public java.lang.String getUri()
Get namespace URI.
Returns:
uri namespace uri, null if no-namespace namespace
setUri
public void setUri(java.lang.String uri)
Set namespace URI.
Parameters:
uri - namespace uri, null if no-namespace namespace
JiBX serializer method. This is intended for use as a serializer for
instances of the class. The namespace must be active in the output
document at the point where this is called.
JiBX serializer method. This is intended for use as a serializer for a
list made up of instances of the class. The namespace must be active in
the output document at the point where this is called.
Utility class supplying static methods. Date serialization is based on the
algorithms published by Peter Baum (http://www.capecod.net/~pbaum). All date
handling is done according to the W3C Schema specification, which uses a
proleptic Gregorian calendar with no year 0. Note that this differs from the
Java date handling, which uses a discontinuous Gregorian calendar.
public static java.lang.String serializeCharString(char value)
Serialize char value to text as string of length one.
Parameters:
value - char value to be serialized
Returns:
text representation of value
parseFloat
public static float parseFloat(java.lang.String text)
throws JiBXException
Parse float value from text. This uses the W3C XML Schema format for
floats, with the exception that it will accept "+NaN" and "-NaN" as
valid formats. This is not in strict compliance with the specification,
but is included for interoperability with other Java XML processing.
public static java.lang.String serializeFloat(float value)
Serialize float value to text.
Parameters:
value - float value to be serialized
Returns:
text representation of value
parseDouble
public static double parseDouble(java.lang.String text)
throws JiBXException
Parse double value from text. This uses the W3C XML Schema format for
doubles, with the exception that it will accept "+NaN" and "-NaN" as
valid formats. This is not in strict compliance with the specification,
but is included for interoperability with other Java XML processing.
public static long parseDate(java.lang.String text)
throws JiBXException
Convert date text to Java date. Date values are expected to be in
W3C XML Schema standard format as CCYY-MM-DD, with optional
leading sign and trailing time zone (though the time zone is ignored
in this case).
Note that the returned value is based on UTC, which matches the
definition of java.util.Date but will typically not be the
expected value if you're using a java.util.Calendar on the
result. In this case you probably want to instead use deserializeSqlDate(String), which does adjust the value to match
the local time zone.
Parameters:
text - text to be parsed
Returns:
start of day in month and year date as millisecond value
public static java.util.Date deserializeDate(java.lang.String text)
throws JiBXException
Deserialize date from text. Date values are expected to match W3C XML
Schema standard format as CCYY-MM-DD, with optional leading sign and
trailing time zone (though the time zone is ignored in this case). This
method follows standard JiBX deserializer usage requirements by accepting
a null input.
Note that the returned value is based on UTC, which matches the
definition of java.util.Date but will typically not be the
expected value if you're using a java.util.Calendar on the
result. In this case you probably want to instead use deserializeSqlDate(String), which does adjust the value to match
the local time zone.
public static java.sql.Date deserializeSqlDate(java.lang.String text)
throws JiBXException
Deserialize SQL date from text. Date values are expected to match W3C XML
Schema standard format as CCYY-MM-DD, with optional leading sign and
trailing time zone (though the time zone is ignored in this case). This
method follows standard JiBX deserializer usage requirements by accepting
a null input.
public static long parseTime(java.lang.String text,
int start,
int length)
throws JiBXException
Parse general time value from text. Time values are expected to be in W3C
XML Schema standard format as hh:mm:ss.fff, with optional leading sign
and trailing time zone.
public static long parseDateTime(java.lang.String text)
throws JiBXException
Parse general dateTime value from text. Date values are expected to be in
W3C XML Schema standard format as CCYY-MM-DDThh:mm:ss.fff, with optional
leading sign and trailing time zone.
public static java.util.Date deserializeDateTime(java.lang.String text)
throws JiBXException
Deserialize date from general dateTime text. Date values are expected to
match W3C XML Schema standard format as CCYY-MM-DDThh:mm:ss, with
optional leading minus sign and trailing seconds decimal, as necessary.
This method follows standard JiBX deserializer usage requirements by
accepting a null input.
public static java.sql.Timestamp deserializeTimestamp(java.lang.String text)
throws JiBXException
Deserialize timestamp from general dateTime text. Timestamp values are
represented in the same way as regular dates, but allow more precision in
the fractional second value (down to nanoseconds). This method follows
standard JiBX deserializer usage requirements by accepting a
null input.
public static java.sql.Time deserializeSqlTime(java.lang.String text)
throws JiBXException
Deserialize time from text. Time values obey the rules of the time
portion of a dataTime value. This method follows standard JiBX
deserializer usage requirements by accepting a null input.
public static java.lang.String serializeYear(long time)
Serialize time to general gYear text. Date values are formatted in
W3C XML Schema standard format as CCYY, with optional
leading sign included if necessary.
Parameters:
time - time to be converted, as milliseconds from January 1, 1970
Returns:
converted gYear text
serializeYear
public static java.lang.String serializeYear(java.util.Date date)
Serialize date to general gYear text. Date values are formatted in
W3C XML Schema standard format as CCYY, with optional
leading sign included if necessary.
Parameters:
date - date to be converted
Returns:
converted gYear text
serializeYearMonth
public static java.lang.String serializeYearMonth(long time)
Serialize time to general gYearMonth text. Date values are formatted in
W3C XML Schema standard format as CCYY-MM, with optional
leading sign included if necessary.
Parameters:
time - time to be converted, as milliseconds from January 1, 1970
Returns:
converted gYearMonth text
serializeYearMonth
public static java.lang.String serializeYearMonth(java.util.Date date)
Serialize date to general gYearMonth text. Date values are formatted in
W3C XML Schema standard format as CCYY-MM, with optional
leading sign included if necessary.
Parameters:
date - date to be converted
Returns:
converted gYearMonth text
serializeDate
public static java.lang.String serializeDate(long time)
Serialize time to general date text. Date values are formatted in
W3C XML Schema standard format as CCYY-MM-DD, with optional
leading sign included if necessary.
Parameters:
time - time to be converted, as milliseconds from January 1, 1970
Returns:
converted date text
serializeDate
public static java.lang.String serializeDate(java.util.Date date)
Serialize date to general date text. Date values are formatted in
W3C XML Schema standard format as CCYY-MM-DD, with optional
leading sign included if necessary.
Note that the conversion is based on UTC, which matches the
definition of java.util.Date but may not match the value as
serialized using java.util.Calendar (which assumes values
are in the local time zone). To work with values in the local time zone
you want to instead use serializeSqlDate(java.sql.Date).
Parameters:
date - date to be converted
Returns:
converted date text
serializeSqlDate
public static java.lang.String serializeSqlDate(java.sql.Date date)
Serialize SQL date to general date text. Date values are formatted in
W3C XML Schema standard format as CCYY-MM-DD, with optional
leading sign included if necessary. This interprets the date value with
respect to the local time zone, as fits the definition of the
java.sql.Date type.
Parameters:
date - date to be converted
Returns:
converted date text
serializeTime
public static void serializeTime(int time,
java.lang.StringBuffer buff)
Serialize time to general time text in buffer. Time values are formatted
in W3C XML Schema standard format as hh:mm:ss, with optional trailing
seconds decimal, as necessary. This form uses a supplied buffer to
support flexible use, including with dateTime combination values.
Parameters:
time - time to be converted, as milliseconds in day
buff - buffer for appending time text
serializeDateTime
public static java.lang.String serializeDateTime(long time,
boolean zone)
Serialize time to general dateTime text. Date values are formatted in
W3C XML Schema standard format as CCYY-MM-DDThh:mm:ss, with optional
leading sign and trailing seconds decimal, as necessary.
Parameters:
time - time to be converted, as milliseconds from January 1, 1970
zone - flag for trailing 'Z' to be appended to indicate UTC
Returns:
converted dateTime text
serializeDateTime
public static java.lang.String serializeDateTime(long time)
Serialize time to general dateTime text. This method is provided for
backward compatibility. It generates the dateTime text without the
trailing 'Z' to indicate UTC.
Parameters:
time - time to be converted, as milliseconds from January 1, 1970
Returns:
converted dateTime text
serializeDateTime
public static java.lang.String serializeDateTime(java.util.Date date)
Serialize date to general dateTime text. Date values are formatted in
W3C XML Schema standard format as CCYY-MM-DDThh:mm:ssZ, with optional
leading sign and trailing seconds decimal, as necessary.
Parameters:
date - date to be converted
Returns:
converted dateTime text
serializeTimestamp
public static java.lang.String serializeTimestamp(java.sql.Timestamp stamp)
Serialize timestamp to general dateTime text. Timestamp values are
represented in the same way as regular dates, but allow more precision in
the fractional second value (down to nanoseconds).
Parameters:
stamp - timestamp to be converted
Returns:
converted dateTime text
serializeSqlTime
public static java.lang.String serializeSqlTime(java.sql.Time time)
Serialize time to standard text. Time values are formatted in W3C XML
Schema standard format as hh:mm:ss, with optional trailing seconds
decimal, as necessary. The standard conversion does not append a time
zone indication.
Parameters:
time - time to be converted
Returns:
converted time text
isEqual
public static boolean isEqual(java.lang.Object a,
java.lang.Object b)
General object comparison method. Don't know why Sun hasn't seen fit to
include this somewhere, but at least it's easy to write (over and over
again).
Parameters:
a - first object to be compared
b - second object to be compared
Returns:
true if both objects are null, or if
a.equals(b); false otherwise
enumValue
public static int enumValue(java.lang.String target,
java.lang.String[] enums,
int[] vals)
throws JiBXException
Find text value in enumeration. This first does a binary search through
an array of allowed text matches. If a separate array of corresponding
values is supplied, the value at the matched position is returned;
otherwise the match index is returned directly.
Parameters:
target - text to be found in enumeration
enums - ordered array of texts included in enumeration
vals - array of values to be returned for corresponding text match
positions (position returned directly if this is null)
Returns:
enumeration value for target text
Throws:
JiBXException - if target text not found in enumeration
parseBase64
public static byte[] parseBase64(java.lang.String text)
throws JiBXException
Parse base64 data from text. This converts the base64 data into a byte
array of the appopriate length. In keeping with the recommendations,
Parameters:
text - text to be parsed (may include extra characters)
Returns:
byte array of data
Throws:
JiBXException - if invalid character in base64 representation
deserializeBase64
public static byte[] deserializeBase64(java.lang.String text)
throws JiBXException
Parse base64 data from text. This converts the base64 data into a byte
array of the appopriate length. In keeping with the recommendations,
Parameters:
text - text to be parsed (may be null, or include extra characters)
Returns:
byte array of data
Throws:
JiBXException - if invalid character in base64 representation
encodeChunk
public static void encodeChunk(int base,
byte[] byts,
java.lang.StringBuffer buff)
Encode a chunk of data to base64 encoding. Converts the next three bytes
of data into four characters of text representation, using padding at the
end of less than three bytes of data remain.
Parameters:
base - starting offset within byte array
byts - byte data array
buff - buffer for encoded text
serializeBase64
public static java.lang.String serializeBase64(byte[] byts)
Serialize byte array to base64 text. In keeping with the specification,
this adds a line break every 76 characters in the encoded representation.
Parameters:
byts - byte data array
Returns:
base64 encoded text
resizeArray
public static java.lang.Object resizeArray(int size,
java.lang.Object base)
Resize array of arbitrary type.
Parameters:
size - new aray size
base - array to be resized
Returns:
resized array, with all data to minimum of the two sizes copied
growArray
public static java.lang.Object growArray(java.lang.Object base)
Grow array of arbitrary type. The returned array is double the size of
the original array, providing this is at least the defined minimum size.
Parameters:
base - array to be grown
Returns:
array of twice the size as original array, with all data copied
arrayListFactory
public static java.util.List arrayListFactory()
Factory method to create a java.util.ArrayList as the
implementation of a java.util.List.
Convert whitespace-separated list of values. This implements the
whitespace skipping, calling the supplied item deserializer for handling
each individual value.
Parameters:
text - value to be converted
ideser - list item deserializer
Returns:
list of deserialized items (null if input
null, or if nonrecoverable error)
public static java.lang.String serializeTokenList(java.lang.String[] tokens)
Serialize an array of strings into a whitespace-separated token list.
Parameters:
tokens - array of strings to be serialized
Returns:
list text
safeEquals
public static boolean safeEquals(java.lang.Object a,
java.lang.Object b)
Safe equals test. This does an equals comparison for objects which may be
null.
Parameters:
a -
b -
Returns:
true if both null or a.equals(b),
false otherwise
ifInIntegerRange
public static boolean ifInIntegerRange(java.lang.String text,
int digitmax,
java.lang.String abslimit)
Check if a text string is a valid integer subtype representation.
Parameters:
text - (non-null)
digitmax - maximum number of digits allowed
abslimit - largest absolute value allowed (null if no
limit)
Returns:
true if valid representation, false if
not
ifByte
public static boolean ifByte(java.lang.String text)
Check if a text string is a valid byte representation.
Parameters:
text - (non-null)
Returns:
true if valid byte, false if not
ifShort
public static boolean ifShort(java.lang.String text)
Check if a text string is a valid short representation.
Parameters:
text - (non-null)
Returns:
true if valid short, false if not
ifInt
public static boolean ifInt(java.lang.String text)
Check if a text string is a valid int representation.
Parameters:
text - (non-null)
Returns:
true if valid int, false if not
ifLong
public static boolean ifLong(java.lang.String text)
Check if a text string is a valid long representation.
Parameters:
text - (non-null)
Returns:
true if valid long, false if not
ifInteger
public static boolean ifInteger(java.lang.String text)
Check if a text string is a valid integer representation.
Parameters:
text - (non-null)
Returns:
true if valid integer, false if not
ifDigits
public static boolean ifDigits(java.lang.String text,
int offset,
int limit)
Check if a portion of a text string consists of decimal digits.
Parameters:
text -
offset - starting offset
limit - ending offset plus one (false return if the
text length is less than this value)
Returns:
true if digits, false if not
ifFixedDigits
public static boolean ifFixedDigits(java.lang.String text,
int offset,
java.lang.String bound)
Check if a portion of a text string is a bounded string of decimal
digits. This is used for checking fixed-length decimal fields with a
maximum value.
Parameters:
text -
offset -
bound -
Returns:
true if bounded decimal, false if not
ifZoneSuffix
public static boolean ifZoneSuffix(java.lang.String text,
int offset)
Check if a text string ends with a valid zone suffix. This accepts an
empty suffix, the single letter 'Z', or an offset of +/-HH:MM.
Parameters:
text -
offset -
Returns:
true if valid suffix, false if not
ifDate
public static boolean ifDate(java.lang.String text)
Check if a text string follows the schema date format. This does not
assure that the text string is actually a valid date representation,
since it doesn't fully check the value ranges (such as the day number
range for a particular month).
Parameters:
text - (non-null)
Returns:
true if date format, false if not
ifTimeSuffix
public static boolean ifTimeSuffix(java.lang.String text,
int offset)
Check if a text string ends with a valid time suffix. This matches the
format HH:MM:SS with optional training fractional seconds and optional
time zone.
Parameters:
text -
offset -
Returns:
true if valid suffix, false if not
ifDateTime
public static boolean ifDateTime(java.lang.String text)
Check if a text string follows the schema dateTime format. This does not
assure that the text string is actually a valid dateTime representation,
since it doesn't fully check the value ranges (such as the day number
range for a particular month).
Parameters:
text - (non-null)
Returns:
true if date format, false if not
ifTime
public static boolean ifTime(java.lang.String text)
Check if a text string follows the schema dateTime format. This does not
assure that the text string is actually a valid dateTime representation,
since it doesn't fully check the value ranges (such as the day number
range for a particular month).
public ValidationException(java.lang.String msg,
java.lang.Throwable root)
Constructor from message and wrapped exception.
Parameters:
msg - message describing the exception condition
root - exception which caused this exception
ValidationException
public ValidationException(java.lang.String msg,
java.lang.Object obj)
Constructor from message and validation object.
Parameters:
msg - message describing the exception condition
obj - source object for validation error
ValidationException
public ValidationException(java.lang.String msg,
java.lang.Throwable root,
java.lang.Object obj)
Constructor from message, wrapped exception, and validation object.
Parameters:
msg - message describing the exception condition
root - exception which caused this exception
obj - source object for validation error
ValidationException
public ValidationException(java.lang.String msg,
java.lang.Object obj,
IUnmarshallingContext ctx)
Constructor from message, validation object, and unmarshalling context.
Parameters:
msg - message describing the exception condition
obj - source object for validation error
ctx - context used for unmarshalling
Method Detail
describe
public static java.lang.String describe(java.lang.Object obj)
Get description information for a validation object. For an unmarshalled
object with source references available this returns the source position
description. Otherwise, it returns the result of a Object.toString() method call.
Parameters:
obj - source object for validation error
Returns:
object description text
addDescription
public static java.lang.String addDescription(java.lang.String msg,
java.lang.Object obj)
Add description information for a validation object to message. This just
appends the result of a describe(java.lang.Object) call to the supplied message,
with some appropriate formatting.
User interface to JiBX data binding framework runtime. These are the classes and interfaces
generally intended for direct use by end users, and are considered published APIs
which will remain stable.
libjibx-java-1.1.6a/docs/api/allclasses-noframe.html 0000644 0001750 0001750 00000022166 11023035704 022246 0 ustar moeller moeller
All Classes (JiBX Java data binding to XML - Version 1.1.6a)
All Classes
libjibx-java-1.1.6a/docs/api/constant-values.html 0000644 0001750 0001750 00000060660 11023035704 021622 0 ustar moeller moeller
Constant Field Values (JiBX Java data binding to XML - Version 1.1.6a)
libjibx-java-1.1.6a/docs/api/deprecated-list.html 0000644 0001750 0001750 00000010442 11023035704 021536 0 ustar moeller moeller
Deprecated List (JiBX Java data binding to XML - Version 1.1.6a)
libjibx-java-1.1.6a/docs/api/index.html 0000644 0001750 0001750 00000002624 11023035704 017577 0 ustar moeller moeller
JiBX Java data binding to XML - Version 1.1.6a
libjibx-java-1.1.6a/docs/api/overview-frame.html 0000644 0001750 0001750 00000002365 11023035704 021430 0 ustar moeller moeller
Overview List (JiBX Java data binding to XML - Version 1.1.6a)
JiBX has been supported for use in the Axis2 web services framework since
Axis2 1.0. The basic information on using JiBX is included in the Axis2
download, but as the Axis2 documentation is going through continual changes the
information on JiBX can tend to get lost. This page is intended as a primary
source of information for anyone using JiBX with Axis2, including some of the
related JiBX tools which are not included in the Axis2 distribution.
One good source of information and examples is JiBX primary developer Dennis
Sosnoski's
Axis2
Data Binding article on IBM developerWorks. This article includes examples
demonstrating how to implement the same web service using Axis2's custom ADB
binding framework, JiBX, and XMLBeans. It also includes some discussion of the
strengths and weaknesses of the different approachs.
There's also a wiki page discussing an earlier version of the same
service
example. The wiki discussion includes a separate page with details of the
Axis2 SOAP
Fault handling, a particularly confusing aspect of working with Axis2.
JiBX is currently (as of the 1.1.x releases) most beneficial when working
with existing Java code which implements the functionality which is to be
exposed as a web service. The Jibx2Wsdl tool (discussed below) is especially
useful for that purpose, even for developers using Axis2 with other data binding
frameworks.
If you're instead developing a web service starting from WSDL you can still
use JiBX, but you need to do more work "manually" since the Axis2 WSDL2Java tool
expects you to have an existing binding and classes for JiBX. The
Xsd2Jibx tool can help you to get set up for this, if
you first extract the schema definitions from your WSDL (and in the case of a
"wrapped" style WSDL you only need to extract the schema definitions for the
actual data components, not the wrapper elements). But Xsd2Jibx is very limited,
and will not handle complex schema definitions correctly. The JiBX 1.2
development includes a replacement for Xsd2Jibx which handles a much wider range
of schema constructs.
For a discussion of the issues involved in either starting from code or
starting from WSDL when developing a web service you can see Dennis Sosnoski's
"Code First" Web
Services Reconsidered.
Jibx2Wsdl
Jibx2Wsdl is a far-superior alternative to the Java2WSDL tool included in the
Axis2 distribution. It includes support for Java 5 enumerations and typed
collections, and also provides an extensive customization mechanism that allows
you to "tune" the schemas and WSDL generated from your Java code.
Jibx2Wsdl is officially part of the JiBX 1.2 development, and full
documentation will be available with the first 1.2 beta release. For now, the
best source of information on Jibx2Wsdl is the
"Code First" Web
Services Reconsidered article and the
wiki
page.
Defines the binding style for simple values. The allowed values are
"element" (values as child elements with only text content) or
"attribute" (values as attributes).
Gives the namespace URI for the element or attribute name. If this is
not used the default value is the innermost default namespace for this type,
if any.
Gives the type to be used when creating instances of the object during
unmarshalling. This gives an alternative to the factory attribute when
all you want to do is use a specific implementation for an interface or an
abstract class.
factory
Defines a factory method for constructing new instances of an object
type. This applies to bindings for unmarshalling only, and if supplied it must
be in the form of a fully-qualified class and method name (e.g.,
"com.sosnoski.jibx.ObjectBuilderFactory.newInstance" specifies
the newInstance() method of the ObjectBuilderFactory class in the
com.sosnoski.jibx package) for a static method returning
an instance of the bound class. As with the other methods in this group
(pre-set, post-set, and pre-get), three different method
signatures are allowed: No arguments; a single argument of type
java.lang.Object, in which case the owning object is passed in the
method call; or a single argument of type
org.jibx.runtime.IUnmarshallingContext, in which case the
unmarshalling context is passed in the method call (this allows access to the
entire stack of objects being unmarshalled). If not supplied, instances of the
bound class are constructed using a null argument constructor.
marshaller
Defines a custom serialization handler class, as the fully-qualified
name of a class implementing the org.jibx.runtime.Marshaller
interface. This is only allowed with an output binding; it is required if an
unmarshaller is defined for an input-output binding.
nillable
Allows the W3C XML Schema attribute xsi:nil="true" to be used on
an element in instance documents to indicate that the corresponding object is
null. The default value is "false", set this attribute "true" to
enable xsi:nil support. The marshalling behavior when the attribute is
"true" and the object reference is null depends on whether the
binding defines the corresponding element as optional or required. If the
element is optional it will simply be left out of the marshalled document. If
the element is required it will be written with an xsi:nil="true"
attribute. This attribute can only be used with objects that are bound to an
element name.
post-set
Defines a bound class method called on instances of the class after
they are populated with data from unmarshalling. This can be used for any
postprocessing or validation required by the class. Three different method
signatures are supported, as described in the factory attribute
text.
pre-get
Defines a bound class method called on new instances of the class before
they are marshalled. This can be used for any preprocessing or validation
required by the class. Three different method signatures are supported, as
described in the factory attribute text.
pre-set
Defines a bound class method called on new instances of the class before
they are populated with data from unmarshalling. This can be used for any
initialization or special handling required before a constructed instance is
used. Three different method signatures are supported, as described in the
factory attribute text.
unmarshaller
Defines a custom deserialization handler class, as the fully-qualified
name of a class implementing the org.jibx.runtime.Unmarshaller
interface. This attribute cannot be used in combination with the factory,
or pre-set attributes. It is only allowed with an input binding; it is
required if a marshaller is defined for an input-output binding.
Gives the name of the field within the containing class that supplies the
property value. This is required except for auto-generated identity fields, for
values from a collection, or when both get-method (for output bindings)
and set-method (for input bindings) definitions are supplied.
get-method
Defines a "get" method for retrieving the property value from
an instance of the containing class. This is the name of a no-argument method
returning a value (primitive or object). If a get-method is defined for
an object value represented by some form of structure in the binding (not just a
simple value, in other words), the method will be used to retrieve the
current instance of an object when unmarshalling. This follows the principle of
JiBX reusing existing objects for unmarshalled data where possible. If you
return a null value during unmarshalling, JiBX will create a new
instance of the object for unmarshalled data.
set-method
Defines a "set" method for storing the property value in
an instance of the containing class. This is the name of a method with return
type void, taking a single value (primitive or object) as a
parameter. If both get-method and set-method are defined, the
set-method parameter type must be the same as the get-method
return value.
test-method
Defines a method for checking if an optional property is present in an
instance of the containing class. This is the name of a no-argument method with
return type boolean, which must return true if the
property is present and false if it is not present. This is only
allowed in combination with usage="optional". If not specified,
a simple == comparison is used with primitive types to check for a
value different from the default, and a equals() comparison for
object types with non-null defaults
type
Supplies the fully-qualified class name for the property value. This can
be used to force a more specific type for a property value defined by the field
definition or access method signature as either a base class or an interface.
usage
Defines the usage requirement for this property. The value can either be
"required" (property is always present, the default if not specified) or
"optional" (property is optional).
Determines whether repeated elements within an unordered group should be
allowed. The default is "false", meaning that if a bound element is repeated the
runtime code will throw an exception. Setting this "true" means repeated
elements will be processed the same as in pre-1.1 versions of JiBX. A "true"
value for this attribute is only allowed when all child definitions are elements
(no attributes or text), and requires ordered="false". It cannot be used
in combination with choice="true". This attribute is ignored on a
collection element.
choice
Defines whether child binding definitions represent a choice between
alternatives, with only one allowed (value "true") or a set of possibilities of
which one or more may be present ("false", the default). A "true" value for this
attribute is only allowed when all child definitions are elements (no attributes
or text), and requires ordered="false". It cannot be used in combination
with allow-repeats="true" or flexible="true". This attribute is
ignored on a collection element.
flexible
Defines whether unknown elements within an unordered group should be
ignored. The default is "false", meaning that if an unknown element (one not
allowed by the binding) is found during unmarshalling the runtime code will
throw an exception. Setting this "true" means unknown elements will be ignored
(along with all their content). A "true" value for this attribute is only
allowed when all child definitions are elements (no attributes or text), and
requires ordered="false". It cannot be used in combination with
choice="true". This attribute is ignored on a collection
element.
label
Gives a label allowing the list of child components to be referenced
from elsewhere in the binding definition. Note that this technique has been
deprecated, and will not be supported in JiBX 2.0. In most cases an abstract
mapping can be used as a replacement.
ordered
Defines whether child binding definitions represent an ordered list
(value "true", the default) or an unordered set ("false"). When this is set
"true", each child value component must define either an element or an
attribute name (attributes are always unordered, so the ordered setting
of the grouping has no effect on attributes). value elements defining
text values (style="text") are not allowed as direct children of groups
with ordered="false".
using
References a list of child components defined elsewhere in the binding
definition. The value must match the label value used on a mapping,
structure, or collection element somewhere in the binding
definition. The child binding components of the referenced element are used as
the content of the element making the reference. The object types associated with the binding definition element making
the reference and that defining the reference must match, and the order
established by the element that defined the reference determines whether the
child definitions are considered as ordered or unordered. The element with this attribute must not have
any child definitions. Note that this technique has been
deprecated, and will not be supported in JiBX 2.0. In most cases an abstract
mapping can be used as a replacement.
Gives the default value for a conversion. This is only allowed for
optional properties. If not specified, the default for primitive types is the
same as the member variable initial state defined by the JLS, and for object
types is "null".
enum-value-method
Specifies a method to be used to obtain the XML text representation for a
Java 5 enum class. If specified, this value method is used for both marshalling
and unmarshalling instances of the enum class (in the unmarshalling case, by
checking each instance of the enum in turn until one is found matching the input
text). If not specified, the toString() method of the enum class is
instead used for marshalling, and the static valueOf enum method is
used for unmarshalling, both of which use the enum value name directly.
deserializer
Defines a custom deserialization handler method, as the fully-qualified
name of a static method with the signature Target xxxx(String text),
where xxxx is the method name and Target is the type
of the property (primitive or object type). Note that when a custom
deserialization handler method is used for an optional object type with no
default value, that method will be called with a null argument
when the corresponding value is missing in the input document. It's up to the
handler method to handle this case appropriately (by returning either a
null or an object of the expected type).
serializer
Defines a custom serialization handler method, as the fully-qualified
name of a static method with the signature String xxxx(Target value),
where xxxx is the method name and Target is the type
of the property (primitive or object type).
The binding element is the root of a binding definition. This defines
characteristics for the entire binding. It supports several unique attributes
as well as two common attribute groups:
When this optional attribute is present with value "true", the binding
compiler will add a default constructor to a bound class when necessary to make
it usable in the binding. Default constructors are needed when there's no
unmarshaller or factory method for an object reference. Constructors can only be
added to classes which are available as class files for modification during the
binding compile.
direction
Binding direction, which must be "input" (unmarshalling only),
"output" (marshalling only), or "both" (both marshalling
and unmarshalling, the default if this attribute is not given).
force-classes
When this optional attribute is present with value "true", it forces
generation of marshaller/unmarshaller classes for top-level abstract mappings
which are not extended by other mappings. Normally these classes would not be
generated, since such mappings are never used directly within the binding. The
classes can be used at runtime by custom code, though, as the equivalent of type
mappings. The default value is "false".
forwards
Controls whether forward references to ids are supported when
unmarshalling, at the cost of some (minor) additional overhead and code size.
If supplied the value must be "true" (forwards supported) or
"false" (ids must be defined before they are referenced). The
default is "true".
name
The name for this binding. The supplied name must consist only of
characters which are valid as part of a Java identifier (so no spaces, periods,
etc.). The default if this attribute is not used is to take the name of the file
containing the definition document, with any file extension suffix stripped off
and invalid characters replaced by underscores (so a binding definition in a
file named "binding-2.xml" has the default name
"binding_2").
package
Java package used for created binding factory class. By default this is
the same package as the class associated with the first mapping child
element. If present, the value must be a Java package name
(as in "org.jibx.runtime").
track-source
When this optional attribute is present with value "true", the binding
compiler adds code to each bound object class to implement the
org.jibx.runtime.ITrackSource interface and store source position
information when instance objects are unmarshalled. This interface lets you
retrieve information about the source document and specific line and column
location of the document component associated with that object. The default
value is "false".
A value-style attribute present on the binding element sets a
default for all contained elements. See the style attribute group description
for usage details.
A binding definition is an XML document that defines the rules for
converting your Java objects to and from XML. The JiBX binding compiler takes
one or more binding definitions as input, along with your actual class files.
It compiles the binding definitions into Java byte code that it adds to
the class files. Once the class files have been enhanced with this compiled
binding definition code, they're ready to work with the JiBX runtime.
You can provide as many binding definitions as you want for the same set
of classes (or for different classes). The binding compiler automatically
generates code for all the bindings you provide. It even reuses added code
between bindings, whereever possible. However, each time you marshal or
unmarshal an XML document you'll first need to decide
which particular binding you're going to use for this document. Each binding
is independent of the others, so you can't switch between bindings within a
single document.
The collection element defines the binding for a Java collection.
Many variations of list-like collections are supported, including user-defined
collection types. Arrays are also supported. Maps are not supported directly in
JiBX 1.0 (but see the JiBX extras description for
custom marshaller/unmarshaller classes which can help with this types of
structures).
Collections may consist of a single type of object or multiple types. The simplest
form of collection just uses a single mapped item type. This may either be
defined using the item-type attribute, in which case no child definitions
are necessary, or implied by the absence of child definitions (equivalent to using
item-type="java.lang.Object").
Collections consisting of multiple types are defined using multiple child
definitions within the collection element. These may be ordered
(where the different types occur in a particular sequence) or unordered (where
all are mixed together), as determined by the ordered attribute of the
structure attribute group. Child
definitions within collections must define elements rather than text or
attribute values (though the elements defined may themselves have attributes
and/or text values). Child definitions within collections are always treated as
optional, with any number of occurrances of the corresponding element allowed
(zero or more).
The collection element supports several unique attributes along with
several common attribute groups, listed below. The unique attributes are used for
special types of data access to the collection. These are all optional, and have
defaults for common collection types, including java.util.Vector and
java.util.ArrayList (as well as subclasses of these classes) along
with collection classes implementing the java.util.Collection
interface. You can use these attributes to select methods of the containing
object for accessing data within a collection (with no property definition for
the actual collection object).
One potential issue in working with collections is that JiBX generally needs
a way to create an instance of the collection when unmarshalling. If the
collection is defined using an interface such as java.util.List
you'll need to either define a concrete implementation type with a no-argument
constructor to be used for the collection (using the type attribute of
the property attribute group)
or use the factory attribute of the object attribute group to define a
factory method to call when an instance of the collection is needed. The
org.jibx.runtime.Utility.arrayListFactory is an example of such a
factory method, which can be used directly to supply instances of the
java.util.ArrayList class.
As with all object-valued properties, if the collection property is already
initialized when JiBX begins unmarshalling the existing collection instance will
be used to hold the unmarshalled items of the collection. JiBX does not clear
items from the existing collection before unmarshalling, so if you want to reuse
existing data structures with a collection you should clear the collection
yourself before unmarshalling (one easy way of doing this is with a pre-set
method on the containing object class). This is only necessary when reusing
objects, not when unmarshalling to a new instance of an object (where any
collections created by the object constructor will initially be empty in any
case). If an element name is used with an optional collection, and that name is
missing from an input XML document, the collection property will be set to
null. If you don't want the collection property to ever be set to
null, use a wrapper structure element for the optional
element name around the collection element.
This is an indexed load item method for the collection. If used, the value must
be the name of a member method of the collection class taking a single
int argument and returning the indexed item value from the
collection (which must be an instance of java.lang.Object unless
the item-type attribute is used to specify the type of items in the
collection). This attribute is only allowed in combination with
size-method. The generated code will use the specified method for loading
values from the collection when marshalling.
size-method
This is an item count method for the collection. If used, the value must
be the name of a no-argument member method of the collection class returning an
int value giving the number of items in the collection. This
attribute is only allowed in combination with load-method. The generated
code will use the specified method for finding the count of items present in the
collection when marshalling.
store-method
This is an indexed store item method for the collection. If used, the value must
be the name of a member method of the collection class taking an int
argument and a java.lang.Object argument (or the type given by the
item-type attribute, if present), with no return value. The
generated code will use the specified method for storing values to the collection
when unmarshalling..
add-method
This is an append item method for the collection. If used, the value must
be the name of a member method of the collection class taking a single
java.lang.Object argument (or the type given by the
item-type attribute, if present). Any return value from the method is
ignored. The generated code will use the specified method to append values to
the collection when unmarshalling..
iter-method
This is an iterator method for the collection. If used, the value must
be the name of a member method of the collection class taking no arguments and
returning a java.lang.Iterator or java.lang.Enumeration
object for the items in the collection. The generated code will use the specified
method to iterate through the values in the collection when marshalling.
item-type
If this attribute is used it must be the fully-qualified class name for
items contained in the collection. If the specified type is an interface or a
class with subclasses any of the implementations of that type can be
used in the collection. The default is java.lang.Object,
allowing any type of objects to be present in the collection.
A value-style attribute present on the collection element sets a
default for all contained elements. See the style attribute group description
for usage details.
Attributes from the name group define an element mapped to the collection
as a whole. The element defined in this way will be a wrapper for the XML
representations of all item values from the collection. The name is optional
unless a marshaller or unmarshaller is defined (see the object attribute
group, below), in which case it's forbidden. See the name attribute group description
for usage details.
Attributes from the object group define the way the collection object is
created and used in marshalling and unmarshalling. See the object attribute group description
for usage details.
Attributes from the property group define a property value, including how
it is accessed and whether it is optional or required. See the property attribute group description
for usage details.
Attributes from the structure group define ordering and reuse of
child binding components. See the
structure attribute group
description for usage details.
The binding definition itself uses a nested structure that's partially
recursive - some of the element types in the binding definition can contain other
instances of the same element as children. This nesting is an important part
of how the binding definition describes the rules for converting your objects.
It's used both for showing the relationships between your Java and XML structures
(see the Structure mapping discussion), and for establishing the
scope of definitions.
Each level of nesting establishes a definition context for shared information
(such as conversion formats, namespaces, and type mappings). Definitions from
an enclosing context apply automatically in all nested contexts unless they are
overridden within that context. To understand how this operates, think of the
nested elements as similar to curly brace blocks in Java - definitions from a
block are only visible within that block (including any inner blocks it
encloses). This isn't an exact comparison - for one thing, inner blocks can
override definitions from an enclosing block - but it's close.
Here's a partial example from a binding definition to illustrate how context
works:
The first mapping element (with name="base-table")
establishes a context. The contained format and mapping elements
are definitions that apply within the scope of that context. In this case the
format definition (with name="flightTime") is used within
the first mapping definition, and the second mapping definition
in turn uses the first one (by specifying an item-type that matches the
class name).
These child definitions from the first mapping element are not
available for use within the last mapping element. This element is at the
same nesting level as the first one. If you wanted to make the child definitions
from the first mapping available for use in the last one, you could do so
by moving these definitions up to a higher level, making them children of the
binding element.
JiBX defines a default set of formats used for converting property values
to and from text strings. These format definitions are effectively defined in
a context outside the root binding element of the binding definition.
Most of the conversions are based on the W3C XML Schema datatype
definitions, as described in the following table.
Default Formats
Type
Format Label
Conversion
byte
byte.default
Converts primitive byte values to and from the schema byte
representation (integer values in the range of -128 to +127).
char
char.default
Converts primitive char values to and from the schema unsigned
short representation (integer values in the range of 0 to 65535). Although this
is the default for char primitives, JiBX also supports an alternate
conversion as single-character text values using the named format
char.string (allowing the conversion to be applied on a specific value)
and a pair of conversion methods. To make the single-character text conversion
the default in your binding, just specify the format as a child of the root
binding element as follows:
Converts primitive double values to and from the schema double
representation (IEEE double-precision floating point).
float
float.default
Converts primitive float values to and from the schema float
representation (IEEE single-precision floating point).
int
int.default
Converts primitive int values to and from the schema int
representation (integer values in normal 32-bit signed value range).
long
long.default
Converts primitive long values to and from the schema long
representation (integer values in normal 64-bit signed value range).
short
short.default
Converts primitive short values to and from the schema short
representation (integer values in normal 16-bit signed value range).
boolean
boolean.default
Converts primitive boolean values to and from the schema boolean
representation ("true" or "false", or equivalently
"1" or "0" - the former values are always used when
converting to text).
byte[]
byte-array.default
Converts byte arrays to and from the schema base64 representation to allow
arbitrary binary data.
java.util.Date
Date.default
Converts instances of java.util.Date to and from the schema
dateTime representation (a text representation like "2000-03-21T01:33:00", with
optional trailing fractional seconds, and difference from UTC). Since schema
doesn't have any concept equivalent to Java time zones, this conversion always
serializes times as UTC values (identified by a trailing "Z"). When
deserializing times which do not include a "Z" or offset from UTC it treats the
values as UTC.
java.sql.Date
SqlDate.default
Converts instances of java.sql.Date to and from the schema
date representation (a text representation like
"2000-03-21").
java.sql.Time
SqlTime.default
Converts instances of java.sql.Time to and from the schema
time representation (a text representation like
"01:33:00" with optional trailing fractional seconds).
java.sql.Timestamp
Timestamp.default
Converts instances of java.sql.Timestamp to and from the
schema dateTime representation, just as the Date:default conversion does
for java.util.Date instances. The only difference is that using the
timestamp value permits greater precision in the time value represented, down to
the nanosecond level.
java.lang.String
String.default
Identity converter for java.lang.String instances.
java.lang.Object
Object.default
Converts any object to a string representation by using the
toString() method, and converts a string to any object by using
a constructor that takes a single argument of type java.lang.String.
If an optional value is not present when unmarshalling a null value
is stored to the object reference. This is the default format conversion used
for any object type without a more specific conversion defined.
These are the conversions you'll get unless you specify otherwise. If you use
a format element to override one of these defaults you'll still be
able to access the default by using the defined label for that format. Defining
your own custom serialization formats is easy, basically requiring only a pair
of static methods to convert to and from String representations.
See the format element description
for details of defining your own conversions.
The org.jibx.runtime.Utility class defines a variety of
conversion methods, including those used to implement the standard conversions
listed in the above table as well as some alternate date-related conversion
methods. The methods serializeDate and deserializeDate
may be of special interest for developers working with xs:date values, since
they support conversion of xs:date format to and from
java.util.Date instances (the equivalent to the default conversion
used for java.sql.Date instances).
The default conversions listed above don't always match conversions used by
other frameworks for working with XML in Java. In particular, many other
frameworks convert the various schema date-related types to and from
java.util.Calendar instances. This is an incorrect interpretation
of the schema types, which do not support the associated time zone which is a
necessary part of Calendar instances. JiBX by default takes the
approach of converting to and from Java objects which are the nearest possible
equivalents to the schema types. You can always change these defaults for your
own purposes using the techniques described above.
In addition to the conversions listed in the table, JiBX 1.1 and later
support automatic conversion of Java 5 enum values to and from strings.
The format element defines a conversion between some primitive or
object type and the text representation used for that type. Any type with a
format defined can be used with simple element (one with no child
elements), text, or attribute values. During unmarshalling, the text content of the
element or attribute is passed to the deserializer defined for that
format, which returns a value of the appropriate type. During
marshalling, the typed value is passed to the serializer for that format,
which returns a text string used as the element content or attribute value.
This flexibility for conversion handling is also available without using a
format element definition, by directly specifying the serializer and/or
deserializer in a value definition. The advantage to using a
format definition is that it can be easily reused. There are two ways
of doing this. When a format element does not have a label attribute, it
automatically becomes the default for values of the associated type. When a
format element is defined with a label, that label can be used
to reference it as needed.
The format element supports a pair of unique attributes along with
one common attribute group, listed below.
The label for this format. If supplied, the format can only be used when
referenced by label. If not supplied, this format automatically becomes the
default for handling the specified type within the context. As of JiBX 1.1, the
value of this attribute is interpreted as namespace qualified.
type
This required attribute gives the fully qualified class name or the
primitive type for the values handled by this format. For instance, for a
format handling instances of the java.util.Date class this would
be 'java.util.Date', and for one handling int primitive
values it would be 'int'.
Attributes from the string group set the default conversion of a value
type for all contained elements. See the string attribute group description
for usage details.
format elements are subject to the restriction that labels must be
unique, and unlabeled formats with the
same type cannot be defined in the same context.
The include element allows modular binding definitions by specifying
another binding to be read as part of the current binding definition.
Top-level format and mapping definitions from the included
binding are treated the same as if they'd been present in the original binding,
as children of the binding element. namespace definitions, on the
other hand, apply downward only: Top-level namespace definitions in the
original binding apply to the included binding just as if they were directly
present, but namespace definitions within the included binding do not apply back
to the original binding. This makes it easy to structure bindings corresponding
to different namespaces, and to combine these bindings without namespace
conflicts.
include elements can also be used within included
bindings, and circular references are allowed.
The include element uses only one unique attribute.
The path for the binding definition to be included. This may be an
absolute path, or a path relative to the including binding definition. Any type
of URL reference can be used for the path. If you're using file paths on Windows
and want to specify the absolute path (such as C:/some/directory/file.xml)
you'll need to convert this into a valid URL reference by using either '/' or
'file:///' as a prefix (so /C:/some/directory/file.xml or
file:///C:/some/directory/file.xml).
If the included binding element has a
direction attribute the value must match the direction of the
original binding; no other attributes are allowed on the included binding
element.
The mapping element defines the binding used for an object type
(instances of a particular class) within a context. A normal (or "concrete")
mapping links an object type to a particular XML element. This linkage means
that only one concrete mapping can be active (in context) for a particular Java
class at a time, and the element names used for concrete mappings within a
context must be unique. Only concrete mappings defined as children of the root
binding element can represent the root object for a marshalling or the
root element for an unmarshalling.
An abstract mapping defines a reusable XML representation for an object
type, with the actual element name defined at the point of use. This makes
abstract mappings roughly equivalent to schema named complex types. Unlike
schema complex types, it's also possible to use abstract mappings without an
element name (so that the mapping defines a grouping of attributes and or
elements that are incorporated directly into the structure at the point of
reference). Multiple abstract mappings can be defined for the same object type
within a context, as long as different type-names are used for the
mappings.
Both abstract and normal mappings can be used as bases for extension
mappings. Extension mappings provide an easy way of handling polymorphism in
your Java code, using the equivalent of schema substitution groups. A base
mapping can be extended by one or more other mappings using the extends
attribute, and the extension mappings can then be used anywhere the base
mapping is referenced within the binding. When marshalling, JiBX interprets the
actual type of the object to find the appropriate extension mapping. When
unmarshalling, JiBX uses the actual element name found to identify the extension
mapping.
Although an abstract mapping can be used as the base for extension mappings,
an abstract mapping can only extend another mapping if the abstract extension is
in turn extended. This restriction is required because element names are used to
identify the particular extension mapping used when unmarshalling, and abstract
mappings have no fixed element name. It means that abstract mappings can never
be the "leaf" mappings in an extension structure.
Mappings may use ordered child definitions (where the XML components
bound to the child definitions occur in a particular sequence) or unordered
definitions (where the XML components can occur in any order), as determined by the ordered attribute of the
structure attribute group. In
the case of unordered mappings only optional components are allowed as
child definitions.
Mapping definitions can be nested, so that the enclosed mapping definitions
are only effective within the scope of the enclosing definition. This approach
is fine for abstract mappings, but if used for non-abstract mappings it can have
a negative impact on performance. JiBX 2.0 will prohibit nesting of non-abstract
mappings, so it's best to structure your binding definitions with all
non-abstract mappings as direct children of the root element.
The mapping element supports three unique attributes along with
several common attribute groups, listed below.
This required attribute gives the fully qualified class name for the
object type handled by this mapping.
abstract
Optional flag for an abstract mapping that can be used directly as a type
mapping. This must be
"true" (abstract mapping) or "false" (normal mapping, the
default if the attribute is not specified).
extends
Optional attribute giving the fully qualified class name of a base
mapping for which this mapping can be substituted. Generally this is used with
mappings for classes which are subclasses of the class handled by the base
mapping, but it can be also be used with unrelated classes. The base mapping
may itself extend another mapping, in which case the new extensions also become
substitutes for that "inherited" base mapping. Extension is based on element
names and does not necessarily indicate any kind of inheritance in terms of the
Java class structures (though it is often used for the purpose of representing
in XML a tree of subclasses which can be used as instances of a base type).
type-name
Optional attribute giving the type name for an abstract mapping. This
allows alternative abstract mappings to be defined for the same class, and
referenced by name with a map-as attribute on a structure
element (or looked up at runtime when force-classes="true" is used on the
binding element). As of JiBX 1.1, the value of this attribute is
interpreted as namespace qualified.
A value-style attribute present on the mapping element sets a
default for all contained elements. See the style attribute group description
for usage details.
Attributes from the name group define an element mapped to the object
type handled by this mapping. The name is required on non-abstract mappings
unless a custom marshaller/unmarshaller is supplied (see the object
attribute group, below), in which case it is optional. Abstract mappings should
not define a name, but are currently allowed to do so with a warning for support
of legacy bindings. See the name attribute
group description for name usage details.
Attributes from the object group define the way object instances are
created and used in marshalling and unmarshalling. See the object attribute group description
for usage details.
Attributes from the structure group define ordering and reuse of
child binding components. See the
structure attribute group
description for usage details.
mapping elements are subject to the restriction that multiple mappings
with the same object type cannot be defined in the same context.
The namespace element defines a namespace used within the bound XML
documents. Each namespace used within the documents must be defined using one
of these elements. When marshalling to XML, the namespace definitions included
in the binding are automatically added to the appropriate XML elements.
This works differently depending upon whether the namespace definition is
in the binding element context, or that of a mapping element. If the
namespace is the child of a mapping element it will be defined on the
element associated with that mapping when it is marshalled. Only
mapping elements that define an element name are allowed to have
namespace child elements for this reason. If the namespace is a
child of the binding element, it applies to all the top-level mappings
defined within that binding. The effect is the same as if the namespace
were instead present as a child element of every top-level mapping
element.
Besides defining a namespace for the XML documents, the namespace
element can also make that namespace the default for elements and/or attributes
within the context of the definition. This is only a shortcut -
a namespace URI can always be defined directly for each element or attribute,
and a direct definition will always override the default defined by a
namespace element. However, using a default namespace definition allows
easy handling of common XML document structures. A default namespace for element
names applies to the containing mapping element name as well as child
element names.
The namespace element uses three unique attributes, but none of the
common attribute groups.
This required attribute is the namespace URI being defined.
default
Optionally gives the default usage of this namespace, which must be
"none" (only used where specified, the default if this attribute is
not given), "elements" (default for elements only),
"attributes" (default for attributes only), or "all" (both
elements and attributes use this namespace by default).
prefix
This is the prefix to map to the namespace when marshalling. It is
ignored when unmarshalling, since the namespace URI is used directly to identify
elements and attributes. This attribute is required for namespaces in an output binding
unless default="elements" is specified.
namespace elements are subject to the restrictions that namespaces with
the same prefix cannot be defined in the same context, and no two namespaces can
be defined with conflicting defaults within the same context (i.e., two
namespaces each having either default="elements"
or default="all", or two namespaces each having
default="attributes" or default="all").
The structure element defines a structure component of a binding.
This can take any of several forms. The first is where the structure is a
complex XML element (one with attributes or child elements) that's linked to
an object property of the containing object type. This is the most common form
of usage. It's essentially equivalent to an "in-line" mapping
definition. This variation applies when both an element name and an object
property are defined by the structure element (or when the property
is implied rather than defined directly, as when the structure element is
the child of a collection element).
Variations of the structure element that define either an element
name or a linked property value (but not both) are used for structure mapping. Each of these variations
works differently depending on whether the structure element is empty
(does not have any child elements). The full set of structure mapping variations
is shown in the table below.
Adds an empty element to the XML when marshalling (unless optional, in
which case it's ignored when marshalling), discards and ignores
the named element when unmarshalling.
no
Structure mapping that defines a complex element (one with attributes or
child elements) in the XML representation with no corresponding object. Child
attribute or element values are in this case linked directly to properties of
the containing object type.
Property
yes
References the mapping for the property object type, which must be
defined within some enclosing context of this definition. If the property type
exactly matches a defined mapping, that mapping will be used; if not, the
mapping will be determined by the element name when unmarshalling or the actual
object type when marshalling. This allows generic java.lang.Object
references to be used, as long as a mapping is defined for the actual type of
the item. The only restriction is that if this type of reference is defined as
optional it must be the last element in a list (otherwise, if the expected
element is missing in a document being unmarshalled the next sibling element
will be used instead).
no
Structure mapping that defines an object with no corresponding XML
element. Attributes or child elements defined within this structure
are part of the XML element defined by the containing structure or
mapping. Optional structures with no associated element name are subject to some
unmarshalling limitations. If the structure defines both attribute and element
values, the presence or absence of the structure is determined based only on the
attributes - if one of the defined attributes is present on the containing
element the structure is considered to be present, otherwise it is not and the
property will be set to null.
Structures with child definitions may be ordered (where the XML components
bound to the child definitions occur in a particular sequence) or unordered
(where the XML components can occur in any order), as determined by the ordered attribute of the
structure attribute group. In
the case of unordered structures only optional components are allowed as
child definitions.
A structure element can be used without either an
element name or a linked property value when you just want to say that some
child elements make up an unordered set:
The above binding definition unmarshals both the element sequences (a, b, c,
d) and (a, c, b, d). Since the unordered elements are (and have to be) optional,
though, the binding will also allow (a, b, d), (a, c, d), and just (a, d). The
unordered elements may also be duplicated without an error, so (a, c, b, c, d)
would also be accepted (with repeated values stored in order, so that the final
value for a property would be that of the last instance of the element). When
marshalling an unordered group the sequence used in the binding definition will
always be followed (so (a, c, b, d) would marshal as (a, b, c, d)). If you need
to control the order of elements (or preserve the order, when starting from an
unmarshalled document) you'll need to instead work with objects that can be held
in a collection.
When a structure element is used with an object property JiBX will
reuse an existing instance of the object during unmarshalling. The way this
works is that JiBX only creates a new instance of the object for use in
unmarshalling if the property value is null. If an element name is
used with an optional structure, and that name is missing from an input XML
document, the object property for that structure will always be set to
null (since the representation is missing from the XML). If you
don't want the property to ever be set to null, use a wrapper
structure element for the optional element name around the actual
structure definition.
The structure element supports one unique attribute along with
several common attribute groups, listed below. The unique attribute is used to
reference mapping definitions for objects. It may only be used when
a property is supplied (or implied).
This optional attribute can be used to override the type (or type name)
to be used for a mapping reference. If used as a type, the value of this
attribute must be the fully-qualified class name for the mapped type, and the
specified class must be assignment compatible with the actual property type (so
you can't map a java.lang.Integer field as a
java.lang.String, for instance, but can map a field typed
java.lang.Object as a java.lang.String). If used as a
type name, the name must match the type name defined by an abstract mapping.
A structure element with no property reference can use the map-as
attribute to invoke a specified mapping for the this object (where
the mapping must be assignment compatible with the this object
type). As of JiBX 1.1, the value of this attribute is interpreted as namespace
qualified.
A value-style attribute present on the structure element sets a
default for all contained elements. See the style attribute group description
for usage details.
Attributes from the name group define an element mapped to the structure
definition as a whole. The element defined in this way will be a wrapper for the
XML representations of all child values defined by the structure. The name is optional
unless this structure defines a mapping reference to the property type (property
definition with no children, see the third row of the table at the top of this
page), in which case it's forbidden. See the name attribute group description
for usage details.
Attributes from the object group define the way object instances are
created and used in marshalling and unmarshalling. See the object attribute group description
for usage details.
Attributes from the property group define a property value, including how
it is accessed and whether it is optional or required. See the property attribute group description
for usage details.
Attributes from the structure group define ordering and reuse of
child binding components. See the
structure attribute group
description for usage details.
The value element defines a simple value, one that is bound to
either an attribute or a simple element (one with no attributes or child
elements). This always makes use of a format definition. If no format is
explicitly named in the value definition the default format for the property
type is used (see Conversions for information
on default formats.
The value element supports four unique attributes along with several
common attribute groups, listed below.
This optional attribute is used to define a constant value. If present,
none of the attributes from the string group and only the usage
attribute from the property group can be present, the format
attribute is not allowed, and the only ident value allowed is
"none". If the value is defined as required it must be present and
match the constant on input; if optional, it is checked for on input and if
found must match the constant. The constant value is always included in the
output when marshalling.
format
If present, this gives the name of the format to be used for converting
the property value to and from text. The named format must be defined in an enclosing
context to the value element. As of JiBX 1.1, the
value of this attribute is interpreted as namespace qualified.
ident
This optional attribute is used to designate a property value as an
identifier type. Possible values are "none" (not an identifier type,
the default if this attribute is not used), "def" (value is a unique
identifier for the containing object), and "ref" (value is an object
with an identifier property and the identifier property of the object is used in
the XML representation rather than the actual object). Only one property with
ident="def" is allowed for a mapping; if one is present the
property must be a String, and must be defined directly as a child of the
mapping element; it is not allowed as a child of a structure
element.
Values with ident value "ref" cannot be used directly as
children of a collection; they can be used if there is a wrapper object
for the referenced object, as defined by a structure element with an
object type defined. References contained directly in a collection can be
handled by using custom marshaller/unmarshallers - see the JiBX extras description for a base custom
marshaller/unmarshaller you can extend for this
purpose, along with another custom marshaller/unmarshaller you can extend to
include the full representation of an object only at the point of first use
(with a reference if the same object is later used again).
style
A style attribute present on the value element determines
the type of XML component used to represent the value. The allowed values are
"attribute", "element", "text", and "cdata".
The last two choices are subject to some restrictions. They cannot be used directly
within a collection definition (in other words, for value
elements that have a collection element as their parent), and also
cannot be used for direct children of an unordered mapping or
structure. Even within an ordered mapping or
structure, multiple value elements using these choices must be
separated by a required value using the "element" choice.
The default handling for this attribute is also special. If it isn't specified,
it defaults to the value set by the innermost containing element with a
value-style attribute, which will always be either the "attribute"
or "element" choice. See the style attribute group description
for details of this type of usage.
Attributes from the name group supply the element or attribute name for
this value. At least the name attribute is required if the XML component
type used for this value is an attribute or element, and forbidden otherwise.
See the name attribute group description
for usage details.
Attributes from the property group define a property value, including how
it is accessed and whether it is optional or required. A property value is
required for value elements unless they're contained within
a collection element. In this case the value is always an item from
the collection, so the only attributes from this group allowed are the
"usage" and "type" attributes. See the property attribute group description
for usage details.
Both a sample XML Schema definition (binding.xsd) and a sample DTD
(binding.dtd) for JiBX binding definitions are included in the
/docs directory of the JiBX distribution. These grammars will normally be
kept current, and if you find any errors please report them so they can be fixed.
However, the HTML documentation supplied on these pages is the definitive
description of the binding definition format.
Below is a quick summary of the types of elements used by the binding
definition, along with their functions and possible child elements. Most child
elements are optional and used only where needed. All are ordered, except where
"any combination" is specified.
Defines how objects of a particular class are converted to and from
XML. Each mapping defines a rule that applies within a particular context,
associating a particular element name with objects of a particular Java class.
The mapping definition may be global or local. It's possible to redefine a
mapping within the context of another mapping, for instance. Abstract mappings
can be used to define handling for base classes which can be extended by mappings
for subclasses. Abstract mappings can also be used to define a reusable binding
structure for a Java class, which doesn't need to correspond to a particular
element name or even to a single element of the XML representation.
Children: namespace, format, mapping, followed by any
combination of value, structure, and collection elements
Gives the conversion handling for a simple value (a primitive, or an
object type with format supplied to convert it to and from text. The
XML representation can be an attribute or simple element, or text or CDATA
content within a sequence of elements.
Structure component of binding, which can represent a Java object, an
XML element, or both. The usual case is where this represents both a Java
object and an XML element linked to that object. A structure
mapping is defined when either the object or the XML element is missing from the
definition. The child elements of the structure may be ordered or unordered.
Children: any combination of value, structure, and collection
elements
Representation of a collection object. The collection may define the
name for an element wrapper that contains the XML representations of the items
in the collection. If different types of items are included in the collection
the items may be ordered or unordered.
Children: any combination of value, structure, and collection
elements
The binding definition elements define a number of different attributes.
In many cases these attributes are grouped and the attribute groups apply to
more than one element type. The table below gives a list of the basic
attribute groups and the elements that support them. The elements also have
unique attributes in addition to these common groups. In almost all cases the
attributes are optional and are used to qualify or add details to the basic
function of the element.
This group consists of only one attribute, the value-style attribute.
It's used to control whether a simple value is expressed in XML as an element
or an attribute.
Used with: binding, mapping, structure,
and collection
The object group of attributes provide handling options for Java
objects. These include factory, pre- and post-unmarshal, and pre-marshal methods
for objects.
The structure attributes deal with the children of a binding component.
They include control over whether children are ordered or unordered, as well as
linkages that allow portions of a binding definition to be referenced and reused
within the binding.
org.jibx.extras.BindingSelector
org.jibx.runtime.impl.ArrayRangeIterator