001: /*
002: * Copyright 2006 Sun Microsystems, Inc. All Rights Reserved.
003: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004: *
005: * This code is free software; you can redistribute it and/or modify it
006: * under the terms of the GNU General Public License version 2 only, as
007: * published by the Free Software Foundation. Sun designates this
008: * particular file as subject to the "Classpath" exception as provided
009: * by Sun in the LICENSE file that accompanied this code.
010: *
011: * This code is distributed in the hope that it will be useful, but WITHOUT
012: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014: * version 2 for more details (a copy is included in the LICENSE file that
015: * accompanied this code).
016: *
017: * You should have received a copy of the GNU General Public License version
018: * 2 along with this work; if not, write to the Free Software Foundation,
019: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020: *
021: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022: * CA 95054 USA or visit www.sun.com if you need additional information or
023: * have any questions.
024: */
025:
026: package com.sun.xml.internal.bind.v2.runtime.property;
027:
028: import java.io.IOException;
029:
030: import javax.xml.bind.JAXBContext;
031: import javax.xml.bind.JAXBElement;
032: import javax.xml.stream.XMLStreamException;
033:
034: import com.sun.xml.internal.bind.api.AccessorException;
035: import com.sun.xml.internal.bind.v2.model.core.ID;
036: import com.sun.xml.internal.bind.v2.model.core.PropertyInfo;
037: import com.sun.xml.internal.bind.v2.model.core.PropertyKind;
038: import com.sun.xml.internal.bind.v2.runtime.JaxBeanInfo;
039: import com.sun.xml.internal.bind.v2.runtime.XMLSerializer;
040: import com.sun.xml.internal.bind.v2.runtime.reflect.Accessor;
041:
042: import org.xml.sax.SAXException;
043:
044: /**
045: * A JAXB property that constitutes a JAXB-bound bean.
046: *
047: * @author Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
048: */
049: public interface Property<BeanT> extends StructureLoaderBuilder {
050:
051: // // is this method necessary? --> probably not
052: // RuntimePropertyInfo owner();
053:
054: /**
055: * Resets the property value on the given object.
056: *
057: * <p>
058: * ... for example by setting 0 or null.
059: */
060: void reset(BeanT o) throws AccessorException;
061:
062: /**
063: * @see JaxBeanInfo#serializeBody(Object, XMLSerializer)
064: *
065: * @param outerPeer
066: * used when this property is expected to print out an element
067: * and that should be associated with this outer peer. normally null.
068: * this is only used for {@link JaxBeanInfo} for {@link JAXBElement}s.
069: * @throws AccessorException
070: * If thrown, caught by the caller and reported.
071: */
072: public void serializeBody(BeanT beanT, XMLSerializer target,
073: Object outerPeer) throws SAXException, AccessorException,
074: IOException, XMLStreamException;
075:
076: /**
077: * @see JaxBeanInfo#serializeURIs(Object, XMLSerializer)
078: */
079: public void serializeURIs(BeanT beanT, XMLSerializer target)
080: throws SAXException, AccessorException;
081:
082: /**
083: * Returns true if
084: * {@link #serializeURIs(Object,XMLSerializer)} performs some meaningful action.
085: */
086: public boolean hasSerializeURIAction();
087:
088: // /**
089: // * Builds the unmarshaller.
090: // *
091: // * @param grammar
092: // * the context object to which this property ultimately belongs to.
093: // * a property will only belong to one grammar, but to reduce the memory footprint
094: // * we don't keep that information stored in {@link Property}, and instead we
095: // * just pass the value as a parameter when needed.
096: // */
097: // Unmarshaller.Handler createUnmarshallerHandler(JAXBContextImpl grammar, Unmarshaller.Handler tail);
098:
099: /**
100: * Gets the value of the property.
101: *
102: * This method is only used when the corresponding {@link PropertyInfo#id()} is {@link ID#ID},
103: * and therefore the return type is fixed to {@link String}.
104: */
105: String getIdValue(BeanT bean) throws AccessorException,
106: SAXException;
107:
108: /**
109: * Gets the Kind of property
110: * @return
111: * always non-null.
112: */
113: PropertyKind getKind();
114:
115: // UGLY HACK to support JAX-WS
116: // if other clients want to access those functionalities,
117: // we should design a better model
118: /**
119: * If this property is mapped to the specified element,
120: * return an accessor to it.
121: *
122: * @return
123: * null if the property is not mapped to the specified element.
124: */
125: Accessor getElementPropertyAccessor(String nsUri, String localName);
126:
127: /**
128: * Called at the end of the {@link JAXBContext} initialization phase
129: * to clean up any unnecessary references.
130: */
131: void wrapUp();
132: }
|