com.github.jaiimageio.stream.StreamSegmentMapper Maven / Gradle / Ivy
Show all versions of jai-imageio-core Show documentation
/*
* $RCSfile: StreamSegmentMapper.java,v $
*
*
* Copyright (c) 2005 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:
*
* - Redistribution of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistribution 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.
*
* Neither the name of Sun Microsystems, Inc. or the names of
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* This software is provided "AS IS," without a warranty of any
* kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND
* WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY
* EXCLUDED. SUN MIDROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL
* NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF
* USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
* DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR
* ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL,
* CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND
* REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR
* INABILITY TO USE THIS SOFTWARE, EVEN IF SUN HAS BEEN ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGES.
*
* You acknowledge that this software is not designed or intended for
* use in the design, construction, operation or maintenance of any
* nuclear facility.
*
* $Revision: 1.1 $
* $Date: 2005/02/11 05:01:21 $
* $State: Exp $
*/
package com.github.jaiimageio.stream;
/**
* An interface for use with the SegmentedImageInputStream
* class. An instance of the StreamSegmentMapper
* interface provides the location and length of a segment of a source
* ImageInputStream corresponding to the initial portion of
* a desired segment of the output stream.
*
* As an example, consider a mapping between a source
* ImageInputStream src and a SegmentedImageInputStream
* dst comprising bytes 100-149 and 200-249 of the source
* stream. The dst stream has a reference to an instance
* mapper of StreamSegmentMapper.
*
*
A call to dst.seek(0); dst.read(buf, 0, 10) will
* result in a call to mapper.getStreamSegment(0, 10),
* returning a new StreamSegment with a starting
* position of 100 and a length of 10 (or less). This indicates that
* in order to read bytes 0-9 of the segmented stream, bytes 100-109
* of the source stream should be read.
*
*
A call to dst.seek(10); int nbytes = dst.read(buf, 0,
* 100) is somewhat more complex, since it will require data
* from both segments of src. The method
* mapper.getStreamSegment(10, 100) will be called. This
* method will return a new StreamSegment with a starting
* position of 110 and a length of 40 (or less). The length is
* limited to 40 since a longer value would result in a read past the
* end of the first segment. The read will stop after the first 40
* bytes and an addition read or reads will be required to obtain the
* data contained in the second segment.
*/
public interface StreamSegmentMapper {
/**
* Returns a StreamSegment object indicating the
* location of the initial portion of a desired segment in the
* source stream. The length of the returned
* StreamSegment may be smaller than the desired
* length.
*
* @param pos The desired starting position in the
* SegmentedImageInputStream, as a long.
* @param length The desired segment length.
* @return a StreamSegment object
*/
StreamSegment getStreamSegment(long pos, int length);
/**
* Sets the values of a StreamSegment object
* indicating the location of the initial portion of a desired
* segment in the source stream. The length of the returned
* StreamSegment may be smaller than the desired
* length.
*
* @param pos The desired starting position in the
* SegmentedImageInputStream, as a long.
* @param length The desired segment length.
* @param seg A StreamSegment object to be overwritten.
*/
void getStreamSegment(long pos, int length, StreamSegment seg);
}