TagHeader.java

// Copyright 2001, FreeHEP.
package org.freehep.util.io;

/**
 * Keeps the tagID and Length of a specific tag. To be used in the InputStream
 * to return the tagID and Length, and in the OutputStream to write them.
 * 
 * @author Mark Donszelmann
 * @author Charles Loomis
 * @version $Id: TagHeader.java 8584 2006-08-10 23:06:37Z duns $
 */
public class TagHeader {

    int tagID;

    long length;

    /**
     * Creates a tag header
     * 
     * @param tagID id of tag
     * @param length length of the tag, including the header
     */
    public TagHeader(int tagID, long length) {
        this.tagID = tagID;
        this.length = length;
    }

    /**
     * Sets the tag id
     * 
     * @param tagID new tag id
     */
    public void setTag(int tagID) {
        this.tagID = tagID;
    }

    /**
     * @return tagID
     */
    public int getTag() {
        return tagID;
    }

    /**
     * Sets the length of the tag
     * 
     * @param length new length
     */
    public void setLength(long length) {
        this.length = length;
    }

    /**
     * @return tag length
     */
    public long getLength() {
        return length;
    }
}