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 * An interface for padding and unpadding strings and byte arrays.
024 * 
025 * @author joconnor
026 * @version $Revision$ $Date$
027 */
028public interface Padder
029{
030    /**
031         * Returns a padded string upto a maximum length. If the data is longer
032         * than maxLength, then the data is truncated.
033         * 
034         * @param data
035         *            The string to pad.
036         * @param maxLength
037         *            The maximum length of the padded string.
038         * @return A padded string.
039     * @throws ISOException on error
040         */
041    String pad(String data, int maxLength) throws ISOException;
042
043    /**
044         * Removes the padding from a padded string.
045         * 
046         * @param paddedData
047         *            The string to unpad.
048         * @return The unpadded string.
049     * @throws ISOException on error
050         */
051    String unpad(String paddedData) throws ISOException;
052}