org.apache.axiom.ext.stax.datahandler.DataHandlerProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of axiom-api Show documentation

The Axiom API

There is a newer version: 1.4.0

/*
 * 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.datahandler;

import java.io.IOException;

import javax.activation.DataHandler;

/**
 * Interface used for deferred loading of binary content.
 * 
 * @see DataHandlerReader#isDeferred()
 * @see DataHandlerReader#getDataHandlerProvider()
 */
public interface DataHandlerProvider {
    /**
     * Check whether the {@link DataHandler} has already been loaded. A return value of
     * true means that a call to {@link #getDataHandler()} will not block or will
     * retrieve the {@link DataHandler} without overhead. Note the return value of this method for a
     * given instance of this class may change over time due to events other than a call to
     * {@link #getDataHandler()} on the same instance. E.g. a call to {@link #getDataHandler()} on
     * one instance may change the return value of the method on another instance (because the
     * {@link DataHandler} objects can only be loaded in a certain sequence).
     * 
     * @return true if the {@link DataHandler} has already been loaded;
     *         false otherwise
     */
    boolean isLoaded();
    
    /**
     * Get the {@link DataHandler} object for the binary content.
     * 
     * @return the binary content
     * 
     * @throws IOException if an error occurs while loading the {@link DataHandler}
     */
    DataHandler getDataHandler() throws IOException;
}