Open Source Repository

Home /cxf/cxf-api-2.4.6 | Repository Home


org/apache/cxf/databinding/DataWriter.java
/**
 * 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.cxf.databinding;

import org.apache.cxf.service.model.MessagePartInfo;

/**
 * The 'write' side of the data binding abstraction of CXF. A DataWriter<T> serializes
 * objects to a 'sink' of type T.
 @param <T> The type of sink. Each data binding defines the set of sink types that it supports.
 */
public interface DataWriter<T> extends BaseDataWriter {
    String ENDPOINT = DataWriter.class.getName() "Endpoint";
    
    /**
     * Write an object to an output sink.
     @param obj the object to write.
     @param output the output sink.
     */
    void write(Object obj, T output);
    /**
     * Write an object to an output sink, including extra processing based on the WSDL 
     * service model for a particular message part.
     @param obj The object to write.
     @param part the message part. 
     @param output the output sink.
     */
    void write(Object obj, MessagePartInfo part, T output);
}