/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.axis2.rmi.databind;

import org.apache.axis2.rmi.exception.XmlSerializingException;
import org.apache.axis2.rmi.util.NamespacePrefix;

import javax.xml.namespace.QName;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;

/**
 * this interface is used to customize the
 * the default way axis2 rmi works
 */
public interface RMIBean {

    /**
     * serialize the class accordingly.
     * this method supposed to serialize this object to the
     * writer. ParentQname is passed so that this method should wirte
     * the start and end elements for the bean as well.
     * @param writer
     * @param parentQName
     */
    public void serialize(XMLStreamWriter writer,
                         JavaObjectSerializer serializer,
                         QName parentQName,
                         NamespacePrefix namespacePrefix)
            throws XMLStreamException, XmlSerializingException;

}