com.github.junrar.unpack.ppm.Pointer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of junrar Show documentation

rar decompression library in plain java

The newest version!

/*
 * Copyright (c) 2007 innoSysTec (R) GmbH, Germany. All rights reserved.
 * Original author: Edmund Wagner
 * Creation date: 14.06.2007
 *
 * Source: $HeadURL$
 * Last changed: $LastChangedDate$
 * 
 * the unrar licence applies to all junrar source and binary distributions 
 * you are not allowed to use this source to re-create the RAR compression algorithm
 * 
 * Here some html entities which can be used for escaping javadoc tags:
 * "&":  "&" or "&"
 * "<":  "<" or "<"
 * ">":  ">" or ">"
 * "@":  "@" 
 */
package com.github.junrar.unpack.ppm;

/**
 * Simulates Pointers on a single mem block as a byte[]
 *
 * @author $LastChangedBy$
 * @version $LastChangedRevision$
 */
public abstract class Pointer {
    protected byte[] mem;
    protected int pos;

    /**
     * Initialize the object with the array (may be null)
     *
     * @param mem the byte array
     */
    public Pointer(byte[] mem) {
        this.mem = mem;
    }

    /**
     * returns the position of this object in the byte[]
     *
     * @return the address of this object
     */
    public int getAddress() {
        assert (mem != null);
        return pos;
    }

    /**
     * needs to set the fields of this object to the values in the byte[]
     * at the given position.
     * be aware of the byte order
     *
     * @param pos the position this object should point to
     */
    public void setAddress(int pos) {
        assert (mem != null);
        assert (pos >= 0) && (pos < mem.length) : pos;
        this.pos = pos;
    }
}