axiom-api/src/main/java/org/apache/axiom/ext/stax/BlobProvider.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.axiom.ext.stax;

import java.io.IOException;

import org.apache.axiom.blob.Blob;

/**
 * Interface used for deferred loading of binary content.
 * 
 * @see BlobReader#isDeferred()
 * @see BlobReader#getBlobProvider()
 */
public interface BlobProvider {
    /**
     * Get the {@link Blob} object for the binary content.
     * 
     * @return the binary content
     * 
     * @throws IOException if an error occurs while loading the {@link Blob}
     */
    Blob getBlob() throws IOException;
}