Open Source Repository

Home /cxf/cxf-api-2.5.2 | Repository Home


org/apache/cxf/databinding/BaseDataReader.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 java.util.Collection;

import javax.xml.validation.Schema;

import org.apache.cxf.message.Attachment;

/**
 * Non-parameterized base interface for DataReader<T>
 */
public interface BaseDataReader {
    String FAULT = DataReader.class.getName() "Fault";
    String ENDPOINT = DataReader.class.getName() "Endpoint";
    /**
     * Supply a schema to validate the input. Bindings silently ignore this parameter if they
     * do not support schema validation, or the particular form of validation implied by
     * a particular form of Schema.
     @param s
     */
    void setSchema(Schema s);
    /**
     * Attach a collection of attachments to a binding. This permits a binding to process the contents
     * of one or more attachments as part of reading from this reader.
     @param attachments attachments.
     */
    void setAttachments(Collection<Attachment> attachments);
    /**
     * Set an arbitrary property on the reader.
     {@link #FAULT} and {@link #ENDPOINT} specify two common properties: the Fault object being read
     * and the {@link org.apache.cxf.endpoint.Endpoint}.
     @param prop Name of the property.
     @param value Value of the property.
     */
    void setProperty(String prop, Object value);
}