1 /*
   2  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.xml.internal.bind.v2.runtime.property;
  27 
  28 import java.io.IOException;
  29 
  30 import javax.xml.stream.XMLStreamException;
  31 
  32 import com.sun.xml.internal.bind.api.AccessorException;
  33 import com.sun.xml.internal.bind.v2.model.runtime.RuntimePropertyInfo;
  34 import com.sun.xml.internal.bind.v2.runtime.JAXBContextImpl;
  35 import com.sun.xml.internal.bind.v2.runtime.XMLSerializer;
  36 import com.sun.xml.internal.bind.v2.runtime.reflect.Accessor;
  37 
  38 import org.xml.sax.SAXException;
  39 
  40 /**
  41  * @author Kohsuke Kawaguchi (kk@kohsuke.org)
  42  */
  43 abstract class PropertyImpl<BeanT> implements Property<BeanT> {
  44     /**
  45      * Name of this field.
  46      */
  47     protected final String fieldName;
  48     private RuntimePropertyInfo propertyInfo = null;
  49     private boolean hiddenByOverride = false;
  50 
  51     public PropertyImpl(JAXBContextImpl context, RuntimePropertyInfo prop) {
  52         fieldName = prop.getName();
  53         if (context.retainPropertyInfo) {
  54             propertyInfo = prop;
  55         }
  56     }
  57 
  58     public RuntimePropertyInfo getInfo() {
  59         return propertyInfo;
  60     }
  61 
  62     public void serializeBody(BeanT o, XMLSerializer w, Object outerPeer) throws SAXException, AccessorException, IOException, XMLStreamException {
  63     }
  64 
  65     public void serializeURIs(BeanT o, XMLSerializer w) throws SAXException, AccessorException {
  66     }
  67 
  68     public boolean hasSerializeURIAction() {
  69         return false;
  70     }
  71 
  72     public Accessor getElementPropertyAccessor(String nsUri, String localName) {
  73         // default implementation. should be overrided
  74         return null;
  75     }
  76 
  77     public void wrapUp() {/*noop*/}
  78 
  79     public boolean isHiddenByOverride() {
  80         return hiddenByOverride;
  81     }
  82 
  83     public void setHiddenByOverride(boolean hidden) {
  84         this.hiddenByOverride = hidden;
  85     }
  86 
  87     public String getFieldName() {
  88         return fieldName;
  89     }
  90 }