001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library 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 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.xml.content;
029
030import org.opencms.loader.I_CmsFileNameGenerator;
031
032import java.util.Iterator;
033
034/**
035 * Name generator which appends a numeric suffix to a given base string.<p>
036 *
037 * @since 8.0.0
038 */
039public class CmsNumberSuffixNameSequence implements Iterator<String> {
040
041    /** The base name from which the names should be generated. */
042    private String m_baseName;
043
044    /** The counter which keeps track of how often the next() method has been called. */
045    private int m_counter;
046
047    /** The name prefix. */
048    private String m_prefix;
049
050    /** The name suffix. */
051    private String m_suffix;
052
053    /**
054     * Creates a new instance.<p>
055     *
056     * @param str the base name which should be used for generating the names
057     * @param splitExtension if true, the number will be inserted before the 'extension', i.e. the sequence of characters starting with the last occurrence of a dot in str.
058     */
059    public CmsNumberSuffixNameSequence(String str, boolean splitExtension) {
060
061        m_baseName = str;
062        if (splitExtension) {
063            int dot = m_baseName.lastIndexOf(".");
064            if (dot > 0) {
065                m_prefix = m_baseName.substring(0, dot);
066                m_suffix = m_baseName.substring(dot);
067            }
068        }
069    }
070
071    /**
072     * @see java.util.Iterator#hasNext()
073     */
074    public boolean hasNext() {
075
076        return true;
077    }
078
079    /**
080     * @see java.util.Iterator#next()
081     */
082    public String next() {
083
084        String result = m_baseName;
085        if (m_counter > 0) {
086            String numberSuffix = "-" + I_CmsFileNameGenerator.NUMBER_FORMAT.sprintf(m_counter);
087            if (m_prefix == null) {
088                result = m_baseName + numberSuffix;
089            } else {
090                result = m_prefix + numberSuffix + m_suffix;
091            }
092        }
093        m_counter += 1;
094        return result;
095    }
096
097    /**
098     * @see java.util.Iterator#remove()
099     */
100    public void remove() {
101
102        throw new UnsupportedOperationException();
103    }
104}