Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/com/sun/xml/internal/bind/v2/runtime/property/Property.java@b0610cd08440 (annotated)
src/share/jaxws_classes/com/sun/xml/internal/bind/v2/runtime/property/Property.java
Fri, 04 Oct 2013 16:21:34 +0100
- author
- mkos
- date
- Fri, 04 Oct 2013 16:21:34 +0100
- changeset 408
- b0610cd08440
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
8025054: Update JAX-WS RI integration to 2.2.9-b130926.1035
Reviewed-by: chegar
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package com.sun.xml.internal.bind.v2.runtime.property; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import java.io.IOException; |
| aoqi@0 | 29 | |
| aoqi@0 | 30 | import javax.xml.bind.JAXBContext; |
| aoqi@0 | 31 | import javax.xml.bind.JAXBElement; |
| aoqi@0 | 32 | import javax.xml.stream.XMLStreamException; |
| aoqi@0 | 33 | |
| aoqi@0 | 34 | import com.sun.xml.internal.bind.api.AccessorException; |
| aoqi@0 | 35 | import com.sun.xml.internal.bind.v2.model.core.ID; |
| aoqi@0 | 36 | import com.sun.xml.internal.bind.v2.model.core.PropertyInfo; |
| aoqi@0 | 37 | import com.sun.xml.internal.bind.v2.model.core.PropertyKind; |
| aoqi@0 | 38 | import com.sun.xml.internal.bind.v2.model.runtime.RuntimePropertyInfo; |
| aoqi@0 | 39 | import com.sun.xml.internal.bind.v2.runtime.JaxBeanInfo; |
| aoqi@0 | 40 | import com.sun.xml.internal.bind.v2.runtime.XMLSerializer; |
| aoqi@0 | 41 | import com.sun.xml.internal.bind.v2.runtime.reflect.Accessor; |
| aoqi@0 | 42 | |
| aoqi@0 | 43 | import org.xml.sax.SAXException; |
| aoqi@0 | 44 | |
| aoqi@0 | 45 | /** |
| aoqi@0 | 46 | * A JAXB property that constitutes a JAXB-bound bean. |
| aoqi@0 | 47 | * |
| aoqi@0 | 48 | * @author Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com) |
| aoqi@0 | 49 | */ |
| aoqi@0 | 50 | public interface Property<BeanT> extends StructureLoaderBuilder { |
| aoqi@0 | 51 | |
| aoqi@0 | 52 | // // is this method necessary? --> probably not |
| aoqi@0 | 53 | // RuntimePropertyInfo owner(); |
| aoqi@0 | 54 | |
| aoqi@0 | 55 | /** |
| aoqi@0 | 56 | * Resets the property value on the given object. |
| aoqi@0 | 57 | * |
| aoqi@0 | 58 | * <p> |
| aoqi@0 | 59 | * ... for example by setting 0 or null. |
| aoqi@0 | 60 | */ |
| aoqi@0 | 61 | void reset( BeanT o ) throws AccessorException; |
| aoqi@0 | 62 | |
| aoqi@0 | 63 | /** |
| aoqi@0 | 64 | * @see JaxBeanInfo#serializeBody(Object, XMLSerializer) |
| aoqi@0 | 65 | * |
| aoqi@0 | 66 | * @param outerPeer |
| aoqi@0 | 67 | * used when this property is expected to print out an element |
| aoqi@0 | 68 | * and that should be associated with this outer peer. normally null. |
| aoqi@0 | 69 | * this is only used for {@link JaxBeanInfo} for {@link JAXBElement}s. |
| aoqi@0 | 70 | * @throws AccessorException |
| aoqi@0 | 71 | * If thrown, caught by the caller and reported. |
| aoqi@0 | 72 | */ |
| aoqi@0 | 73 | public void serializeBody(BeanT beanT, XMLSerializer target, Object outerPeer) throws SAXException, AccessorException, IOException, XMLStreamException; |
| aoqi@0 | 74 | |
| aoqi@0 | 75 | /** |
| aoqi@0 | 76 | * @see JaxBeanInfo#serializeURIs(Object, XMLSerializer) |
| aoqi@0 | 77 | */ |
| aoqi@0 | 78 | public void serializeURIs(BeanT beanT, XMLSerializer target) throws SAXException, AccessorException; |
| aoqi@0 | 79 | |
| aoqi@0 | 80 | /** |
| aoqi@0 | 81 | * Returns true if |
| aoqi@0 | 82 | * {@link #serializeURIs(Object,XMLSerializer)} performs some meaningful action. |
| aoqi@0 | 83 | */ |
| aoqi@0 | 84 | public boolean hasSerializeURIAction(); |
| aoqi@0 | 85 | |
| aoqi@0 | 86 | // /** |
| aoqi@0 | 87 | // * Builds the unmarshaller. |
| aoqi@0 | 88 | // * |
| aoqi@0 | 89 | // * @param grammar |
| aoqi@0 | 90 | // * the context object to which this property ultimately belongs to. |
| aoqi@0 | 91 | // * a property will only belong to one grammar, but to reduce the memory footprint |
| aoqi@0 | 92 | // * we don't keep that information stored in {@link Property}, and instead we |
| aoqi@0 | 93 | // * just pass the value as a parameter when needed. |
| aoqi@0 | 94 | // */ |
| aoqi@0 | 95 | // Unmarshaller.Handler createUnmarshallerHandler(JAXBContextImpl grammar, Unmarshaller.Handler tail); |
| aoqi@0 | 96 | |
| aoqi@0 | 97 | /** |
| aoqi@0 | 98 | * Gets the value of the property. |
| aoqi@0 | 99 | * |
| aoqi@0 | 100 | * This method is only used when the corresponding {@link PropertyInfo#id()} is {@link ID#ID}, |
| aoqi@0 | 101 | * and therefore the return type is fixed to {@link String}. |
| aoqi@0 | 102 | */ |
| aoqi@0 | 103 | String getIdValue(BeanT bean) throws AccessorException, SAXException; |
| aoqi@0 | 104 | |
| aoqi@0 | 105 | /** |
| aoqi@0 | 106 | * Gets the Kind of property |
| aoqi@0 | 107 | * @return |
| aoqi@0 | 108 | * always non-null. |
| aoqi@0 | 109 | */ |
| aoqi@0 | 110 | PropertyKind getKind(); |
| aoqi@0 | 111 | |
| aoqi@0 | 112 | |
| aoqi@0 | 113 | // UGLY HACK to support JAX-WS |
| aoqi@0 | 114 | // if other clients want to access those functionalities, |
| aoqi@0 | 115 | // we should design a better model |
| aoqi@0 | 116 | /** |
| aoqi@0 | 117 | * If this property is mapped to the specified element, |
| aoqi@0 | 118 | * return an accessor to it. |
| aoqi@0 | 119 | * |
| aoqi@0 | 120 | * @return |
| aoqi@0 | 121 | * null if the property is not mapped to the specified element. |
| aoqi@0 | 122 | */ |
| aoqi@0 | 123 | Accessor getElementPropertyAccessor(String nsUri,String localName); |
| aoqi@0 | 124 | |
| aoqi@0 | 125 | /** |
| aoqi@0 | 126 | * Called at the end of the {@link JAXBContext} initialization phase |
| aoqi@0 | 127 | * to clean up any unnecessary references. |
| aoqi@0 | 128 | */ |
| aoqi@0 | 129 | void wrapUp(); |
| aoqi@0 | 130 | |
| aoqi@0 | 131 | /** |
| aoqi@0 | 132 | * Provides more {@link RuntimePropertyInfo} information on the property. |
| aoqi@0 | 133 | * |
| aoqi@0 | 134 | * @return |
| aoqi@0 | 135 | * null if RETAIN_REFERENCE_TO_INFO property is not set on the {@link JAXBContext} |
| aoqi@0 | 136 | */ |
| aoqi@0 | 137 | public RuntimePropertyInfo getInfo(); |
| aoqi@0 | 138 | |
| aoqi@0 | 139 | public boolean isHiddenByOverride(); |
| aoqi@0 | 140 | |
| aoqi@0 | 141 | public void setHiddenByOverride(boolean hidden); |
| aoqi@0 | 142 | |
| aoqi@0 | 143 | public String getFieldName(); |
| aoqi@0 | 144 | } |
