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;
aoqi@0: 
aoqi@0: import java.io.IOException;
aoqi@0: 
aoqi@0: import javax.xml.bind.annotation.XmlValue;
aoqi@0: import javax.xml.datatype.XMLGregorianCalendar;
aoqi@0: import javax.xml.namespace.QName;
aoqi@0: import javax.xml.stream.XMLStreamException;
aoqi@0: 
aoqi@0: import com.sun.istack.internal.NotNull;
aoqi@0: import com.sun.xml.internal.bind.api.AccessorException;
aoqi@0: import com.sun.xml.internal.bind.v2.model.runtime.RuntimePropertyInfo;
aoqi@0: import com.sun.xml.internal.bind.v2.runtime.reflect.opt.OptimizedTransducedAccessorFactory;
aoqi@0: 
aoqi@0: import org.xml.sax.SAXException;
aoqi@0: 
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Responsible for converting a Java object to a lexical representation
aoqi@0:  * and vice versa.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * An implementation of this interface hides how this conversion happens.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * {@link Transducer}s are immutable.
aoqi@0:  *
aoqi@0:  * @author Kohsuke Kawaguchi (kk@kohsuke.org)
aoqi@0:  */
aoqi@0: public interface Transducer<ValueT> {
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * If this {@link Transducer} is the default transducer for the <code>ValueT</code>,
aoqi@0:      * this method returns true.
aoqi@0:      *
aoqi@0:      * Used exclusively by {@link OptimizedTransducedAccessorFactory#get(RuntimePropertyInfo)}
aoqi@0:      */
aoqi@0:     boolean isDefault();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * If true, this {@link Transducer} doesn't declare any namespace,
aoqi@0:      * and therefore {@link #declareNamespace(Object, XMLSerializer)} is no-op.
aoqi@0:      *
aoqi@0:      * It also means that the {@link #parse(CharSequence)} method
aoqi@0:      * won't use the context parameter.
aoqi@0:      */
aoqi@0:     boolean useNamespace();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Declares the namespace URIs used in the given value to {@code w}.
aoqi@0:      *
aoqi@0:      * @param o
aoqi@0:      *      never be null.
aoqi@0:      * @param w
aoqi@0:      *      may be null if {@code !{@link #useNamespace()}}.
aoqi@0:      */
aoqi@0:     void declareNamespace( ValueT o, XMLSerializer w ) throws AccessorException;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Converts the given value to its lexical representation.
aoqi@0:      *
aoqi@0:      * @param o
aoqi@0:      *      never be null.
aoqi@0:      * @return
aoqi@0:      *      always non-null valid lexical representation.
aoqi@0:      */
aoqi@0:     @NotNull CharSequence print(@NotNull ValueT o) throws AccessorException;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Converts the lexical representation to a value object.
aoqi@0:      *
aoqi@0:      * @param lexical
aoqi@0:      *      never be null.
aoqi@0:      * @throws AccessorException
aoqi@0:      *      if the transducer is used to parse an user bean that uses {@link XmlValue},
aoqi@0:      *      then this exception may occur when it tries to set the leaf value to the bean.
aoqi@0:      * @throws SAXException
aoqi@0:      *      if the lexical form is incorrect, the error should be reported
aoqi@0:      *      and SAXException may thrown (or it can return null to recover.)
aoqi@0:      */
aoqi@0:     ValueT parse(CharSequence lexical) throws AccessorException, SAXException;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Sends the result of the {@link #print(Object)} operation
aoqi@0:      * to one of the {@link XMLSerializer#text(String, String)} method,
aoqi@0:      * but with the best representation of the value, not necessarily String.
aoqi@0:      */
aoqi@0:     void writeText(XMLSerializer w, ValueT o, String fieldName) throws IOException, SAXException, XMLStreamException, AccessorException;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Sends the result of the {@link #print(Object)} operation
aoqi@0:      * to one of the {@link XMLSerializer#leafElement(Name, String, String)} method.
aoqi@0:      * but with the best representation of the value, not necessarily String.
aoqi@0:      */
aoqi@0:     void writeLeafElement(XMLSerializer w, Name tagName, @NotNull ValueT o, String fieldName) throws IOException, SAXException, XMLStreamException, AccessorException;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Transducers implicitly work against a single XML type,
aoqi@0:      * but sometimes (most notably {@link XMLGregorianCalendar},
aoqi@0:      * an instance may choose different XML types.
aoqi@0:      *
aoqi@0:      * @return
aoqi@0:      *      return non-null from this method allows transducers
aoqi@0:      *      to specify the type it wants to marshal to.
aoqi@0:      *      Most of the time this method returns null, in which case
aoqi@0:      *      the implicitly associated type will be used.
aoqi@0:      */
aoqi@0:     QName getTypeName(@NotNull ValueT instance);
aoqi@0: }