StreamSegmentMapper.java
上传用户:btjssb159
上传日期:2018-01-04
资源大小:241k
文件大小:5k
源码类别:

DNA

开发平台:

Java

  1. /*
  2.  * Copyright (c) 2001 Sun Microsystems, Inc. All Rights Reserved.
  3.  *
  4.  * Redistribution and use in source and binary forms, with or without 
  5.  * modification, are permitted provided that the following conditions are met:
  6.  * 
  7.  * -Redistributions of source code must retain the above copyright notice, this 
  8.  * list of conditions and the following disclaimer.
  9.  *
  10.  * -Redistribution in binary form must reproduct the above copyright notice,
  11.  * this list of conditions and the following disclaimer in the documentation
  12.  * and/or other materials provided with the distribution.
  13.  * 
  14.  * Neither the name of Sun Microsystems, Inc. or the names of contributors may
  15.  * be used to endorse or promote products derived from this software without
  16.  * specific prior written permission.
  17.  * 
  18.  * This software is provided "AS IS," without a warranty of any kind. ALL
  19.  * EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY
  20.  * IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR
  21.  * NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN AND ITS LICENSORS SHALL NOT BE
  22.  * LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING
  23.  * OR DISTRIBUTING THE SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN OR ITS
  24.  * LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT,
  25.  * INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER
  26.  * CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF
  27.  * OR INABILITY TO USE SOFTWARE, EVEN IF SUN HAS BEEN ADVISED OF THE
  28.  * POSSIBILITY OF SUCH DAMAGES.
  29.  * 
  30.  * You acknowledge that Software is not designed,licensed or intended for use in 
  31.  * the design, construction, operation or maintenance of any nuclear facility.
  32.  */
  33. /**
  34.  * An interface for use with the <code>SegmentedSeekableStream</code>
  35.  * class.  An instance of the <code>StreamSegmentMapper</code>
  36.  * interface provides the location and length of a segment of a source
  37.  * <code>SeekableStream</code> corresponding to the initial portion of
  38.  * a desired segment of the output stream.
  39.  *
  40.  * <p> As an example, consider a mapping between a source
  41.  * <code>SeekableStream src</code> and a <code>SegmentedSeekableStream
  42.  * dst</code> comprising bytes 100-149 and 200-249 of the source
  43.  * stream.  The <code>dst</code> stream has a reference to an instance
  44.  * <code>mapper</code> of <code>StreamSegmentMapper</code>.
  45.  *
  46.  * <p> A call to <code>dst.seek(0); dst.read(buf, 0, 10)</code> will
  47.  * result in a call to <code>mapper.getStreamSegment(0, 10)</code>,
  48.  * returning a new <code>StreamSegment</code> with a starting
  49.  * position of 100 and a length of 10 (or less).  This indicates that
  50.  * in order to read bytes 0-9 of the segmented stream, bytes 100-109
  51.  * of the source stream should be read.
  52.  *
  53.  * <p> A call to <code>dst.seek(10); int nbytes = dst.read(buf, 0,
  54.  * 100)</code> is somewhat more complex, since it will require data
  55.  * from both segments of <code>src</code>.  The method <code>
  56.  * mapper.getStreamSegment(10, 100)</code> will be called.  This
  57.  * method will return a new <code>StreamSegment</code> with a starting
  58.  * position of 110 and a length of 40 (or less).  The length is
  59.  * limited to 40 since a longer value would result in a read past the
  60.  * end of the first segment.  The read will stop after the first 40
  61.  * bytes and an addition read or reads will be required to obtain the
  62.  * data contained in the second segment.
  63.  *
  64.  * <p><b> This interface is not a committed part of the JAI API.  It may
  65.  * be removed or changed in future releases of JAI.</b>
  66.  */
  67. public interface StreamSegmentMapper {
  68.     /**
  69.      * Returns a <code>StreamSegment</code> object indicating the
  70.      * location of the initial portion of a desired segment in the
  71.      * source stream.  The length of the returned
  72.      * <code>StreamSegment</code> may be smaller than the desired
  73.      * length.
  74.      *
  75.      * @param pos The desired starting position in the
  76.      * <code>SegmentedSeekableStream</code>, as a <code>long</code>.
  77.      * @param length The desired segment length.
  78.      */
  79.     StreamSegment getStreamSegment(long pos, int length);
  80.     /**
  81.      * Sets the values of a <code>StreamSegment</code> object
  82.      * indicating the location of the initial portion of a desired
  83.      * segment in the source stream.  The length of the returned
  84.      * <code>StreamSegment</code> may be smaller than the desired
  85.      * length.
  86.      *
  87.      * @param pos The desired starting position in the
  88.      * <code>SegmentedSeekableStream</code>, as a <code>long</code>.
  89.      * @param length The desired segment length.
  90.      * @param seg A <code>StreamSegment</code> object to be overwritten.
  91.      */
  92.     void getStreamSegment(long pos, int length, StreamSegment seg);
  93. }