document.java

jxme的一些相关程序,主要是手机上程序开发以及手机和计算机通信的一些程序资料,程序编译需要Ant支持

/*
 * Copyright (c) 2001 Sun Microsystems, Inc.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *       Sun Microsystems, Inc. for Project JXTA."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact Project JXTA at http://www.jxta.org.
 *
 * 5. Products derived from this software may not be called "JXTA",
 *    nor may "JXTA" appear in their name, without prior written
 *    permission of Sun.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL SUN MICROSYSTEMS OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of Project JXTA.  For more
 * information on Project JXTA, please see
 * <http://www.jxta.org/>.
 *
 * This license is based on the BSD license adopted by the Apache Foundation.
 *
 * $Id: Document.java,v 1.2 2002/03/04 20:18:17 echtcherbina Exp $
 */

package net.jxta.document;

import java.io.InputStream;
import java.io.OutputStream;

import java.io.IOException;

/**
 * JXTA documents are simple containers for data. JXTA makes no interpretation
 * of the data contained in a Document. Each Document is typed using a
 * MIME Media Type (as defined by
 * {@link <a href=http://www.ietf.org/rfc/rfc2046.txt">IETF RFC 2046 <i>MIME : Media Types</i></a>}).
 *
 * Note : Document is intended to be somewhat analagous to HTTP streams
 * we don't provide for compression, encoding, etc. though and leave it all
 * up to the MIME media type and whatever parameters it may specify. Its not
 * clear if we should break this stuff up and include such attributes
 * or leave it as is.
 *
 * @version  $Revision: 1.2 $
 * @since JXTA 1.0
 *
 * @see         net.jxta.document.Document
 * @see         net.jxta.document.MimeMediaType
 * @see         net.jxta.document.StructuredDocument
 * @see         net.jxta.document.StructuredTextDocument
 */
public interface Document {
    
    /**
     * Returns the MIME Media type of this Document per
     * {@link <a href=http://www.ietf.org/rfc/rfc2046.txt">IETF RFC 2046 <i>MIME : Media Types</i></a>}
     *
     * <p/>Jxta does not currently support the 'Multipart' or 'Message' media types.
     *
     * @since JXTA 1.0
     *
     * @return A MimeMediaType object containing the MIME Media Type for this
     * Document.
     */
    MimeMediaType getMimeType();
    
    /**
     *  Returns the file extension type used by this Document. This value
     *  is chosen based upon the MIME Media Type for this Document.
     *
     * @since JXTA 1.0
     *
     * @return a string containing an appropriate file extension
     **/
    String getFileExtension();
    
    /**
     * Returns a stream of bytes which represent the content of this Document.
     *
     * @since JXTA 1.0
     *
     * @return An {@see java.io.InputStream InputStream} containing the bytes of this Document.
     * @exception  IOException if an I/O error occurs.
     */
    InputStream getStream() throws IOException;
    
    /**
     *  Rather than returning an InputStream like {@link #getStream}, send the
     *  document to the specified stream.
     *
     *  @since JXTA 1.0
     *
     *  @param stream   The OutputStream to which the document will be written.
     *  @exception  IOException if an I/O error occurs.
     */
    void sendToStream( OutputStream stream ) throws IOException;
}