001/*
002 * JRecordBind, fixed-length file (un)marshaller
003 * Copyright 2019, Federico Fissore, and individual contributors. See
004 * AUTHORS.txt in the distribution for a full listing of individual
005 * contributors.
006 *
007 * This is free software; you can redistribute it and/or modify it
008 * under the terms of the GNU Lesser General Public License as
009 * published by the Free Software Foundation; either version 2.1 of
010 * the License, or (at your option) any later version.
011 *
012 * This software is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * You should have received a copy of the GNU Lesser General Public
018 * License along with this software; if not, write to the Free
019 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021 */
022
023package org.fissore.jrecordbind;
024
025/**
026 * Used when writing records to a file. Some record definitions require data to be left or right
027 * padded. By default the {@link Marshaller} will left pad using spaces.
028 * JRecordBind comes with 4 built-in padders that left or right pad using spaces or zeros.
029 * If you need a different padding, you can specify it by implementing this interface. <br>
030 * The default padder is specified in the "main" tag of the record definition, and each element can have its own specific padder
031 */
032public interface Padder {
033
034  /**
035   * Pads a string to the given length
036   *
037   * @param input  the string to pad
038   * @param length the length of the final string
039   * @return the padded string
040   */
041  String pad(String input, int length);
042
043  String unpad(String input);
044
045}