org.glassfish.jaxb.runtime.v2.runtime.unmarshaller.Scope Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package org.glassfish.jaxb.runtime.v2.runtime.unmarshaller;
import org.glassfish.jaxb.runtime.api.AccessorException;
import org.glassfish.jaxb.runtime.v2.runtime.reflect.Accessor;
import org.glassfish.jaxb.runtime.v2.runtime.reflect.Lister;
import org.xml.sax.SAXException;
/**
* Holds the information about packing scope.
*
*
* When no packing is started yet, all the fields should be set to null.
*
* @author Kohsuke Kawaguchi
*/
public final class Scope {
public final UnmarshallingContext context;
private BeanT bean;
private Accessor acc;
private PackT pack;
private Lister lister;
Scope(UnmarshallingContext context) {
this.context = context;
}
/**
* Returns true if this scope object is filled by a packing in progress.
*/
public boolean hasStarted() {
return bean!=null;
}
/**
* Initializes all the fields to null.
*/
public void reset() {
if(bean==null) {
// already initialized
assert clean();
return;
}
bean = null;
acc = null;
pack = null;
lister = null;
}
/**
* Finishes up the current packing in progress (if any) and
* resets this object.
*/
public void finish() throws AccessorException {
if(hasStarted()) {
lister.endPacking(pack,bean,acc);
reset();
}
assert clean();
}
private boolean clean() {
return bean==null && acc==null && pack==null && lister==null;
}
/**
* Adds a new item to this packing scope.
*/
public void add( Accessor acc, Lister lister, ItemT value) throws SAXException{
try {
if(!hasStarted()) {
this.bean = (BeanT)context.getCurrentState().getTarget();
this.acc = acc;
this.lister = lister;
this.pack = lister.startPacking(bean,acc);
}
lister.addToPack(pack,value);
} catch (AccessorException e) {
Loader.handleGenericException(e,true);
// recover from this error by ignoring future items.
this.lister = Lister.getErrorInstance();
this.acc = Accessor.getErrorInstance();
}
}
/**
* Starts the packing scope, without adding any item.
*
* This allows us to return an empty pack, thereby allowing the user
* to distinguish empty array vs null array.
*/
public void start( Accessor acc, Lister lister) throws SAXException{
try {
if(!hasStarted()) {
this.bean = (BeanT)context.getCurrentState().getTarget();
this.acc = acc;
this.lister = lister;
this.pack = lister.startPacking(bean,acc);
}
} catch (AccessorException e) {
Loader.handleGenericException(e,true);
// recover from this error by ignoring future items.
this.lister = Lister.getErrorInstance();
this.acc = Accessor.getErrorInstance();
}
}
}