com.adobe.internal.util.ByteSequence Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation
The Adobe Experience Manager SDK
There is a newer version: 2024.11.18751.20241128T090041Z-241100
/*
 *
 *	File: ByteSequence.java
 *
 *
 *	ADOBE CONFIDENTIAL
 *	___________________
 *
 *	Copyright 2005 Adobe Systems Incorporated
 *	All Rights Reserved.
 *
 *	NOTICE: All information contained herein is, and remains the property of
 *	Adobe Systems Incorporated and its suppliers, if any. The intellectual
 *	and technical concepts contained herein are proprietary to Adobe Systems
 *	Incorporated and its suppliers and may be covered by U.S. and Foreign
 *	Patents, patents in process, and are protected by trade secret or
 *	copyright law. Dissemination of this information or reproduction of this
 *	material is strictly forbidden unless prior written permission is obtained
 *	from Adobe Systems Incorporated.
 *
 */
package com.adobe.internal.util;

/**
 * @author sgill
 *
 */
public interface ByteSequence
{
    /**
     * Returns the byte at the specified index.  An index ranges from zero
     * to length() - 1.  The first byte of the sequence is at
     * index zero, the next at index one, and so on, as for array
     * indexing. 
     *
     * @param   index   the index of the character to be returned
     *
     * @return  the specified byte
     *
     * @throws  IndexOutOfBoundsException
     *          if the index argument is negative or not less than
     *          length()
     */
    byte byteAt(int index);
    
    /**
     * Returns the length of this byte sequence.  The length is the number
     * of bytes in the sequence. 
     *
     * @return  the number of bytes in this sequence
     */
    int length();
    
    /**
     * Returns a new byte sequence that is a subsequence of this sequence.
     * The subsequence starts with the byte at the specified index and
     * ends with the byte at index end - 1.  The length of the
     * returned sequence is end - start, so if start == end
     * then an empty sequence is returned. 
     * 
     * @param   start   the start index, inclusive
     * @param   end     the end index, exclusive
     *
     * @return  the specified subsequence
     *
     * @throws  IndexOutOfBoundsException
     *          if start or end are negative,
     *          if end is greater than length(),
     *          or if start is greater than end
     */
    ByteSequence subSequence(int start, int end);
    
    /**
     * Returns a byte array containing the bytes in this sequence in the same
     * order as this sequence.  The length of the byte array will be the length of
     * this sequence. 
     *
     * @return  a byte array consisting of exactly this sequence of bytes
     */
    byte[] getBytes();
    
    /**
     * Returns a byte array containing the bytes in this sequence in the same
     * order as this sequence and within the bounds given.  The length of the 
     * byte array will be equal to srcEnd - srcBegin + 1. 
     *
     * @param srcBegin the byte to start copying from
     * @param srcEnd the byte to end copying at
     * @param dst the destination to copy the bytes to
     * @param dstBegin the byte in the destination to begin the copying
     */
    void getBytes(int srcBegin, int srcEnd, byte dst[], int dstBegin);
}