org.apache.cxf.aegis.AegisXMLStreamDataWriter Maven / Gradle / Ivy
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.cxf.aegis;
import java.util.logging.Logger;
import javax.xml.namespace.QName;
import javax.xml.stream.XMLStreamWriter;
import org.apache.cxf.aegis.type.AegisType;
import org.apache.cxf.aegis.type.TypeCreator;
import org.apache.cxf.aegis.type.TypeUtil;
import org.apache.cxf.aegis.xml.MessageWriter;
import org.apache.cxf.aegis.xml.stax.ElementWriter;
import org.apache.cxf.common.i18n.Message;
import org.apache.cxf.common.logging.LogUtils;
public class AegisXMLStreamDataWriter extends AbstractAegisIoImpl implements AegisWriter {
private static final Logger LOG = LogUtils.getL7dLogger(AegisXMLStreamDataWriter.class);
AegisXMLStreamDataWriter(AegisContext globalContext) {
super(globalContext);
}
/**
* Write an object to the output. This method always writes xsi:type attributes.
* @param obj The object to write.
* @param elementName the QName of the XML Element.
* @param optional set this for minOccurs = 0. It omits null elements.
* @param output the output stream
* @param aegisType the aegis type. This may be null if the object is non-null
* and the type of the object is covered in the mapping. Warning, for collections
* this will not do what you want, you must call the alternative version of
* write that takes a {@link java.lang.reflect.Type}.
* @throws Exception
*/
public void write(Object obj,
QName elementName,
boolean optional,
XMLStreamWriter output,
AegisType aegisType) throws Exception {
if (obj == null && aegisType == null && !optional) {
Message message = new Message("WRITE_NULL_NEEDS_TYPE", LOG);
throw new DatabindingException(message);
}
if (obj != null && aegisType == null) {
aegisType = getContext().getTypeMapping().getType(obj.getClass());
if (aegisType == null) {
TypeCreator creator = getContext().getTypeMapping().getTypeCreator();
aegisType = creator.createType(obj.getClass());
}
}
if (obj != null) {
// look for overrides declared in the context.
aegisType = TypeUtil.getWriteType(aegisContext, obj, aegisType);
}
if (aegisType == null) {
Message message = new Message("WRITE_NEEDS_TYPE", LOG, obj);
throw new DatabindingException(message);
}
if (obj == null) {
if (optional) { // minOccurs = 0
return;
}
if (aegisType.isNillable() && aegisType.isWriteOuter()) {
ElementWriter writer = new ElementWriter(output);
MessageWriter w2 = writer.getElementWriter(elementName);
w2.writeXsiNil();
w2.close();
return;
}
}
ElementWriter writer = new ElementWriter(output);
MessageWriter w2 = writer.getElementWriter(elementName);
if (getContext().isWriteXsiTypes()
&& aegisType != null
&& aegisType.getSchemaType() != null) {
// if we know the type, write it. We are standalone, and the reader needs it.
w2.writeXsiType(aegisType.getSchemaType());
}
aegisType.writeObject(obj, w2, context);
w2.close();
}
/**
* {@inheritDoc}
*/
public void write(Object obj, QName elementName, boolean optional, XMLStreamWriter output,
java.lang.reflect.Type objectType) throws Exception {
AegisType aegisType = null;
if (objectType instanceof Class) {
aegisType = getContext().getTypeMapping().getType((Class)objectType);
}
if (aegisType == null) {
TypeCreator creator = getContext().getTypeMapping().getTypeCreator();
aegisType = creator.createType(objectType);
}
if (aegisType == null) {
Message message = new Message("NO_MAPPING_FOR_TYPE", LOG, objectType);
throw new DatabindingException(message);
}
write(obj, elementName, optional, output, aegisType);
}
}