/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.xml.bind.v2.runtime.property;
import java.io.IOException;
import java.lang.reflect.Modifier;
import javax.xml.bind.JAXBElement;
import javax.xml.stream.XMLStreamException;
import com.sun.xml.bind.api.AccessorException;
import com.sun.xml.bind.v2.model.core.ID;
import com.sun.xml.bind.v2.model.core.PropertyKind;
import com.sun.xml.bind.v2.model.runtime.RuntimeElementPropertyInfo;
import com.sun.xml.bind.v2.model.runtime.RuntimeTypeRef;
import com.sun.xml.bind.v2.runtime.ClassBeanInfoImpl;
import com.sun.xml.bind.v2.runtime.JAXBContextImpl;
import com.sun.xml.bind.v2.runtime.Name;
import com.sun.xml.bind.v2.runtime.XMLSerializer;
import com.sun.xml.bind.v2.runtime.reflect.Accessor;
import com.sun.xml.bind.v2.runtime.reflect.TransducedAccessor;
import com.sun.xml.bind.v2.runtime.unmarshaller.ChildLoader;
import com.sun.xml.bind.v2.runtime.unmarshaller.DefaultValueLoaderDecorator;
import com.sun.xml.bind.v2.runtime.unmarshaller.LeafPropertyLoader;
import com.sun.xml.bind.v2.runtime.unmarshaller.LeafPropertyXsiLoader;
import com.sun.xml.bind.v2.runtime.unmarshaller.Loader;
import com.sun.xml.bind.v2.runtime.unmarshaller.XsiNilLoader;
import com.sun.xml.bind.v2.util.QNameMap;
import org.xml.sax.SAXException;
/**
* {@link Property} that contains a leaf value.
*
* @author Kohsuke Kawaguchi (kk@kohsuke.org)
*/
final class SingleElementLeafProperty<BeanT> extends PropertyImpl<BeanT> {
private final Name tagName;
private final boolean nillable;
private final Accessor acc;
private final String defaultValue;
private final TransducedAccessor<BeanT> xacc;
private final boolean improvedXsiTypeHandling;
private final boolean idRef;
public SingleElementLeafProperty(JAXBContextImpl context, RuntimeElementPropertyInfo prop) {
super(context, prop);
RuntimeTypeRef ref = prop.getTypes().get(0);
tagName = context.nameBuilder.createElementName(ref.getTagName());
assert tagName != null;
nillable = ref.isNillable();
defaultValue = ref.getDefaultValue();
this.acc = prop.getAccessor().optimize(context);
xacc = TransducedAccessor.get(context, ref);
assert xacc != null;
improvedXsiTypeHandling = context.improvedXsiTypeHandling;
idRef = ref.getSource().id() == ID.IDREF;
}
public void reset(BeanT o) throws AccessorException {
acc.set(o, null);
}
public String getIdValue(BeanT bean) throws AccessorException, SAXException {
return xacc.print(bean).toString();
}
@Override
public void serializeBody(BeanT o, XMLSerializer w, Object outerPeer) throws SAXException, AccessorException, IOException, XMLStreamException {
boolean hasValue = xacc.hasValue(o);
Object obj = null;
try {
obj = acc.getUnadapted(o);
} catch (AccessorException ae) {
; // noop
}
Class valueType = acc.getValueType();
// check for different type than expected. If found, add xsi:type declaration
if (xsiTypeNeeded(o, w, obj, valueType)) {
w.startElement(tagName, outerPeer);
w.childAsXsiType(obj, fieldName, w.grammar.getBeanInfo(valueType), false);
w.endElement();
} else { // current type is expected
if (hasValue) {
xacc.writeLeafElement(w, tagName, o, fieldName);
} else if (nillable) {
w.startElement(tagName, null);
w.writeXsiNilTrue();
w.endElement();
}
}
}
/**
* Checks if xsi type needed to be specified
*/
private boolean xsiTypeNeeded(BeanT bean, XMLSerializer w, Object value, Class valueTypeClass) {
if (!improvedXsiTypeHandling) // improved xsi type set
return false;
if (acc.isAdapted()) // accessor is not adapted
return false;
if (value == null) // value is not null
return false;
if (value.getClass().equals(valueTypeClass)) // value represented by different class
return false;
if (idRef) // IDREF
return false;
if (valueTypeClass.isPrimitive()) // is not primitive
return false;
return acc.isValueTypeAbstractable() || isNillableAbstract(bean, w.grammar, value, valueTypeClass);
}
/**
* Checks if element is nillable and represented by abstract class.
*/
private boolean isNillableAbstract(BeanT bean, JAXBContextImpl context, Object value, Class valueTypeClass) {
if (!nillable) // check if element is nillable
return false;
if (valueTypeClass != Object.class) // required type wasn't recognized
return false;
if (bean.getClass() != JAXBElement.class) // is JAXBElement
return false;
JAXBElement jaxbElement = (JAXBElement) bean;
Class valueClass = value.getClass();
Class declaredTypeClass = jaxbElement.getDeclaredType();
if (declaredTypeClass.equals(valueClass)) // JAXBElement<class> is different from unadapted class)
return false;
if (!declaredTypeClass.isAssignableFrom(valueClass)) // and is subclass from it
return false;
if (!Modifier.isAbstract(declaredTypeClass.getModifiers())) // declared class is abstract
return false;
return acc.isAbstractable(declaredTypeClass); // and is not builtin type
}
public void buildChildElementUnmarshallers(UnmarshallerChain chain, QNameMap<ChildLoader> handlers) {
Loader l = new LeafPropertyLoader(xacc);
if (defaultValue != null)
l = new DefaultValueLoaderDecorator(l, defaultValue);
if (nillable || chain.context.allNillable)
l = new XsiNilLoader.Single(l, acc);
// LeafPropertyXsiLoader doesn't work well with nillable elements
if (improvedXsiTypeHandling)
l = new LeafPropertyXsiLoader(l, xacc, acc);
handlers.put(tagName, new ChildLoader(l, null));
}
public PropertyKind getKind() {
return PropertyKind.ELEMENT;
}
@Override
public Accessor getElementPropertyAccessor(String nsUri, String localName) {
if (tagName.equals(nsUri, localName))
return acc;
else
return null;
}
}