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 GmbH & Co. KG, 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.workplace.list;
029
030import org.opencms.i18n.CmsMessageContainer;
031
032import java.text.MessageFormat;
033import java.util.Locale;
034
035/**
036 * This list formatter uses the <code>{@link MessageFormat}</code> class for macro like formatting.<p>
037 *
038 * @since 6.0.0
039 */
040public class CmsListMacroFormatter implements I_CmsListFormatter {
041
042    /** pattern for <code>{@link MessageFormat}</code>. */
043    private final CmsMessageContainer m_mask;
044
045    /**
046     * Default constructor that sets the mask to use.<p>
047     *
048     * @param mask pattern for <code>{@link MessageFormat}</code>
049     */
050    public CmsListMacroFormatter(CmsMessageContainer mask) {
051
052        m_mask = mask;
053    }
054
055    /**
056     * @see org.opencms.workplace.list.I_CmsListFormatter#format(java.lang.Object, java.util.Locale)
057     */
058    public String format(Object data, Locale locale) {
059
060        if (data == null) {
061            return null;
062        }
063        String locMask = m_mask.key(locale);
064        MessageFormat formatter = new MessageFormat(locMask, locale);
065        return formatter.format(new Object[] {data});
066    }
067
068    /**
069     * Returns the mask.<p>
070     *
071     * @return the mask
072     */
073    public CmsMessageContainer getMask() {
074
075        return m_mask;
076    }
077}