aoqi@0: /* aoqi@0: * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. aoqi@0: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. aoqi@0: * aoqi@0: * This code is free software; you can redistribute it and/or modify it aoqi@0: * under the terms of the GNU General Public License version 2 only, as aoqi@0: * published by the Free Software Foundation. Oracle designates this aoqi@0: * particular file as subject to the "Classpath" exception as provided aoqi@0: * by Oracle in the LICENSE file that accompanied this code. aoqi@0: * aoqi@0: * This code is distributed in the hope that it will be useful, but WITHOUT aoqi@0: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or aoqi@0: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License aoqi@0: * version 2 for more details (a copy is included in the LICENSE file that aoqi@0: * accompanied this code). aoqi@0: * aoqi@0: * You should have received a copy of the GNU General Public License version aoqi@0: * 2 along with this work; if not, write to the Free Software Foundation, aoqi@0: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. aoqi@0: * aoqi@0: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA aoqi@0: * or visit www.oracle.com if you need additional information or have any aoqi@0: * questions. aoqi@0: */ aoqi@0: aoqi@0: package com.sun.xml.internal.bind.v2.runtime.property; aoqi@0: aoqi@0: import java.io.IOException; aoqi@0: aoqi@0: import javax.xml.bind.JAXBContext; aoqi@0: import javax.xml.bind.JAXBElement; aoqi@0: import javax.xml.stream.XMLStreamException; aoqi@0: aoqi@0: import com.sun.xml.internal.bind.api.AccessorException; aoqi@0: import com.sun.xml.internal.bind.v2.model.core.ID; aoqi@0: import com.sun.xml.internal.bind.v2.model.core.PropertyInfo; aoqi@0: import com.sun.xml.internal.bind.v2.model.core.PropertyKind; aoqi@0: import com.sun.xml.internal.bind.v2.model.runtime.RuntimePropertyInfo; aoqi@0: import com.sun.xml.internal.bind.v2.runtime.JaxBeanInfo; aoqi@0: import com.sun.xml.internal.bind.v2.runtime.XMLSerializer; aoqi@0: import com.sun.xml.internal.bind.v2.runtime.reflect.Accessor; aoqi@0: aoqi@0: import org.xml.sax.SAXException; aoqi@0: aoqi@0: /** aoqi@0: * A JAXB property that constitutes a JAXB-bound bean. aoqi@0: * aoqi@0: * @author Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com) aoqi@0: */ aoqi@0: public interface Property extends StructureLoaderBuilder { aoqi@0: aoqi@0: // // is this method necessary? --> probably not aoqi@0: // RuntimePropertyInfo owner(); aoqi@0: aoqi@0: /** aoqi@0: * Resets the property value on the given object. aoqi@0: * aoqi@0: *

aoqi@0: * ... for example by setting 0 or null. aoqi@0: */ aoqi@0: void reset( BeanT o ) throws AccessorException; aoqi@0: aoqi@0: /** aoqi@0: * @see JaxBeanInfo#serializeBody(Object, XMLSerializer) aoqi@0: * aoqi@0: * @param outerPeer aoqi@0: * used when this property is expected to print out an element aoqi@0: * and that should be associated with this outer peer. normally null. aoqi@0: * this is only used for {@link JaxBeanInfo} for {@link JAXBElement}s. aoqi@0: * @throws AccessorException aoqi@0: * If thrown, caught by the caller and reported. aoqi@0: */ aoqi@0: public void serializeBody(BeanT beanT, XMLSerializer target, Object outerPeer) throws SAXException, AccessorException, IOException, XMLStreamException; aoqi@0: aoqi@0: /** aoqi@0: * @see JaxBeanInfo#serializeURIs(Object, XMLSerializer) aoqi@0: */ aoqi@0: public void serializeURIs(BeanT beanT, XMLSerializer target) throws SAXException, AccessorException; aoqi@0: aoqi@0: /** aoqi@0: * Returns true if aoqi@0: * {@link #serializeURIs(Object,XMLSerializer)} performs some meaningful action. aoqi@0: */ aoqi@0: public boolean hasSerializeURIAction(); aoqi@0: aoqi@0: // /** aoqi@0: // * Builds the unmarshaller. aoqi@0: // * aoqi@0: // * @param grammar aoqi@0: // * the context object to which this property ultimately belongs to. aoqi@0: // * a property will only belong to one grammar, but to reduce the memory footprint aoqi@0: // * we don't keep that information stored in {@link Property}, and instead we aoqi@0: // * just pass the value as a parameter when needed. aoqi@0: // */ aoqi@0: // Unmarshaller.Handler createUnmarshallerHandler(JAXBContextImpl grammar, Unmarshaller.Handler tail); aoqi@0: aoqi@0: /** aoqi@0: * Gets the value of the property. aoqi@0: * aoqi@0: * This method is only used when the corresponding {@link PropertyInfo#id()} is {@link ID#ID}, aoqi@0: * and therefore the return type is fixed to {@link String}. aoqi@0: */ aoqi@0: String getIdValue(BeanT bean) throws AccessorException, SAXException; aoqi@0: aoqi@0: /** aoqi@0: * Gets the Kind of property aoqi@0: * @return aoqi@0: * always non-null. aoqi@0: */ aoqi@0: PropertyKind getKind(); aoqi@0: aoqi@0: aoqi@0: // UGLY HACK to support JAX-WS aoqi@0: // if other clients want to access those functionalities, aoqi@0: // we should design a better model aoqi@0: /** aoqi@0: * If this property is mapped to the specified element, aoqi@0: * return an accessor to it. aoqi@0: * aoqi@0: * @return aoqi@0: * null if the property is not mapped to the specified element. aoqi@0: */ aoqi@0: Accessor getElementPropertyAccessor(String nsUri,String localName); aoqi@0: aoqi@0: /** aoqi@0: * Called at the end of the {@link JAXBContext} initialization phase aoqi@0: * to clean up any unnecessary references. aoqi@0: */ aoqi@0: void wrapUp(); aoqi@0: aoqi@0: /** aoqi@0: * Provides more {@link RuntimePropertyInfo} information on the property. aoqi@0: * aoqi@0: * @return aoqi@0: * null if RETAIN_REFERENCE_TO_INFO property is not set on the {@link JAXBContext} aoqi@0: */ aoqi@0: public RuntimePropertyInfo getInfo(); aoqi@0: aoqi@0: public boolean isHiddenByOverride(); aoqi@0: aoqi@0: public void setHiddenByOverride(boolean hidden); aoqi@0: aoqi@0: public String getFieldName(); aoqi@0: }