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.iso;
020
021
022/**
023 * IF_UNUSED acts as a filler for unused elements of a message packager.
024 * Packing or unpacking with this packager throws an ISOException.
025 * Use IF_NOP if you don't want an exception thrown.
026 * 
027 * @author jonathan.oconnor@xcom.de
028 * @version $Id$
029 * @see ISOComponent
030 * @see IF_NOP
031 */
032public class IF_UNUSED extends ISOFieldPackager {
033    /**
034     */
035    public IF_UNUSED () {
036        super(0, "<dummy>");
037    }
038    /**
039     * @param c - a component
040     * @return packed component
041     * @exception ISOException
042     */
043    public byte[] pack (ISOComponent c) throws ISOException {
044        throw new ISOException("IF_UNUSED: Packager should not pack field " + c.getKey());
045    }
046    /**
047     * @param c - the Component to unpack
048     * @param b - binary image
049     * @param offset - starting offset within the binary image
050     * @return consumed bytes
051     */
052    public int unpack (ISOComponent c, byte[] b, int offset) throws ISOException {
053        throw new ISOException("IF_UNUSED: Packager should not unpack field " + c.getKey());
054    }
055    public int getMaxPackedLength() {
056        return 0;
057    }
058}