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.unmarshaller;
aoqi@0:
aoqi@0: import com.sun.xml.internal.bind.api.AccessorException;
aoqi@0: import com.sun.xml.internal.bind.v2.runtime.reflect.Accessor;
aoqi@0: import com.sun.xml.internal.bind.v2.runtime.reflect.Lister;
aoqi@0:
aoqi@0: import org.xml.sax.SAXException;
aoqi@0:
aoqi@0: /**
aoqi@0: * Holds the information about packing scope.
aoqi@0: *
aoqi@0: *
aoqi@0: * When no packing is started yet, all the fields should be set to null.
aoqi@0: *
aoqi@0: * @author Kohsuke Kawaguchi
aoqi@0: */
aoqi@0: public final class Scope {
aoqi@0:
aoqi@0: public final UnmarshallingContext context;
aoqi@0:
aoqi@0: private BeanT bean;
aoqi@0: private Accessor acc;
aoqi@0: private PackT pack;
aoqi@0: private Lister lister;
aoqi@0:
aoqi@0: Scope(UnmarshallingContext context) {
aoqi@0: this.context = context;
aoqi@0: }
aoqi@0:
aoqi@0: /**
aoqi@0: * Returns true if this scope object is filled by a packing in progress.
aoqi@0: */
aoqi@0: public boolean hasStarted() {
aoqi@0: return bean!=null;
aoqi@0: }
aoqi@0:
aoqi@0: /**
aoqi@0: * Initializes all the fields to null.
aoqi@0: */
aoqi@0: public void reset() {
aoqi@0: if(bean==null) {
aoqi@0: // already initialized
aoqi@0: assert clean();
aoqi@0: return;
aoqi@0: }
aoqi@0:
aoqi@0: bean = null;
aoqi@0: acc = null;
aoqi@0: pack = null;
aoqi@0: lister = null;
aoqi@0: }
aoqi@0:
aoqi@0: /**
aoqi@0: * Finishes up the current packing in progress (if any) and
aoqi@0: * resets this object.
aoqi@0: */
aoqi@0: public void finish() throws AccessorException {
aoqi@0: if(hasStarted()) {
aoqi@0: lister.endPacking(pack,bean,acc);
aoqi@0: reset();
aoqi@0: }
aoqi@0: assert clean();
aoqi@0: }
aoqi@0:
aoqi@0: private boolean clean() {
aoqi@0: return bean==null && acc==null && pack==null && lister==null;
aoqi@0: }
aoqi@0:
aoqi@0: /**
aoqi@0: * Adds a new item to this packing scope.
aoqi@0: */
aoqi@0: public void add( Accessor acc, Lister lister, ItemT value) throws SAXException{
aoqi@0: try {
aoqi@0: if(!hasStarted()) {
aoqi@0: this.bean = (BeanT)context.getCurrentState().target;
aoqi@0: this.acc = acc;
aoqi@0: this.lister = lister;
aoqi@0: this.pack = lister.startPacking(bean,acc);
aoqi@0: }
aoqi@0:
aoqi@0: lister.addToPack(pack,value);
aoqi@0: } catch (AccessorException e) {
aoqi@0: Loader.handleGenericException(e,true);
aoqi@0: // recover from this error by ignoring future items.
aoqi@0: this.lister = Lister.getErrorInstance();
aoqi@0: this.acc = Accessor.getErrorInstance();
aoqi@0: }
aoqi@0: }
aoqi@0:
aoqi@0: /**
aoqi@0: * Starts the packing scope, without adding any item.
aoqi@0: *
aoqi@0: * This allows us to return an empty pack, thereby allowing the user
aoqi@0: * to distinguish empty array vs null array.
aoqi@0: */
aoqi@0: public void start( Accessor acc, Lister lister) throws SAXException{
aoqi@0: try {
aoqi@0: if(!hasStarted()) {
aoqi@0: this.bean = (BeanT)context.getCurrentState().target;
aoqi@0: this.acc = acc;
aoqi@0: this.lister = lister;
aoqi@0: this.pack = lister.startPacking(bean,acc);
aoqi@0: }
aoqi@0: } catch (AccessorException e) {
aoqi@0: Loader.handleGenericException(e,true);
aoqi@0: // recover from this error by ignoring future items.
aoqi@0: this.lister = Lister.getErrorInstance();
aoqi@0: this.acc = Accessor.getErrorInstance();
aoqi@0: }
aoqi@0: }
aoqi@0: }