001/*
002 * $RCSfile: StreamSegment.java,v $
003 *
004 * 
005 * Copyright (c) 2005 Sun Microsystems, Inc. All  Rights Reserved.
006 * 
007 * Redistribution and use in source and binary forms, with or without
008 * modification, are permitted provided that the following conditions
009 * are met: 
010 * 
011 * - Redistribution of source code must retain the above copyright 
012 *   notice, this  list of conditions and the following disclaimer.
013 * 
014 * - Redistribution in binary form must reproduce the above copyright
015 *   notice, this list of conditions and the following disclaimer in 
016 *   the documentation and/or other materials provided with the
017 *   distribution.
018 * 
019 * Neither the name of Sun Microsystems, Inc. or the names of 
020 * contributors may be used to endorse or promote products derived 
021 * from this software without specific prior written permission.
022 * 
023 * This software is provided "AS IS," without a warranty of any 
024 * kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND 
025 * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, 
026 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY
027 * EXCLUDED. SUN MIDROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL 
028 * NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF 
029 * USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
030 * DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR 
031 * ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL,
032 * CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND
033 * REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR
034 * INABILITY TO USE THIS SOFTWARE, EVEN IF SUN HAS BEEN ADVISED OF THE
035 * POSSIBILITY OF SUCH DAMAGES. 
036 * 
037 * You acknowledge that this software is not designed or intended for 
038 * use in the design, construction, operation or maintenance of any 
039 * nuclear facility. 
040 *
041 * $Revision: 1.1 $
042 * $Date: 2005/02/11 05:01:20 $
043 * $State: Exp $
044 */
045package com.github.jaiimageio.stream;
046
047/**
048 * A utility class representing a segment within a stream as a
049 * <code>long</code> starting position and an <code>int</code>
050 * length.
051 */
052public class StreamSegment {
053    
054    private long startPos = 0L;
055    private int segmentLength = 0;
056
057    /**
058     * Constructs a <code>StreamSegment</code>.
059     * The starting position and length are set to 0.
060     */
061    public StreamSegment() {}
062
063    /**
064     * Constructs a <code>StreamSegment</code> with a
065     * given starting position and length.
066     *
067     * @param startPos The initial position of the segment.
068     * @param segmentLength The length of the segment.
069     */
070    public StreamSegment(long startPos, int segmentLength) {
071        this.startPos = startPos;
072        this.segmentLength = segmentLength;
073    }
074
075    /**
076     * Returns the starting position of the segment.
077     *
078     * @return The initial position of the segment.
079     * @see #setStartPos
080     */
081    public final long getStartPos() {
082        return startPos;
083    }
084
085    /**
086     * Sets the starting position of the segment.
087     *
088     * @param startPos The initial position of the segment.
089     * @see #getStartPos
090     */
091    public final void setStartPos(long startPos) {
092        this.startPos = startPos;
093    }
094
095    /**
096     * Returns the length of the segment.
097     *
098     * @return The length of the segment.
099     * @see #setSegmentLength
100     */
101    public final int getSegmentLength() {
102        return segmentLength;
103    }
104
105    /**
106     * Sets the length of the segment.
107     *
108     * @param segmentLength The length of the segment.
109     * @see #getSegmentLength
110     */
111    public final void setSegmentLength(int segmentLength) {
112        this.segmentLength = segmentLength;
113    }
114}