001/*
002 * jPOS Project [http://jpos.org]
003 * Copyright (C) 2000-2026 jPOS Software SRL
004 *
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Affero General Public License as
007 * published by the Free Software Foundation, either version 3 of the
008 * License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
013 * GNU Affero General Public License for more details.
014 *
015 * You should have received a copy of the GNU Affero General Public License
016 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
017 */
018
019package org.jpos.tlv;
020
021/**
022 * A composite TLV structure that supports offset-based indexed access to its elements.
023 * @author Vishnu Pillai
024 *         Date: 1/24/14
025 */
026public interface OffsetIndexedComposite {
027
028    /** Increments the current offset by one. */
029    void incOffset();
030
031    /** Sets the current offset.
032     * @param offset the new offset value
033     */
034    void setOffset(int offset);
035
036    /** Resets the offset to its initial value. */
037    void resetOffset();
038
039    /** Returns the current offset.
040     * @return the current offset
041     */
042    int getOffset();
043}