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.gwt.shared.property;
029
030import org.opencms.util.CmsStringUtil;
031
032/**
033 * A bean which represents a value together with a path which indicates from where the value has been read.<p>
034 *
035 * @since 8.0.0
036 */
037public class CmsPathValue {
038
039    /** The path. */
040    private final String m_path;
041
042    /** The value. */
043    private final String m_value;
044
045    /**
046     * Creates a new instance.<p>
047     * @param value the value
048     * @param path the path
049     */
050    public CmsPathValue(String value, String path) {
051
052        m_path = path;
053        m_value = value;
054    }
055
056    /**
057     * Gets the path.<p>
058     *
059     * @return the path
060     */
061    public String getPath() {
062
063        return m_path;
064    }
065
066    /**
067     * Gets the value.<p>
068     *
069     * @return the value
070     */
071    public String getValue() {
072
073        return m_value;
074    }
075
076    /**
077     * Creates a new path value with the same value as this one, but with a prefix prepended to the path.<p>
078     *
079     * @param pathPart the path part which should be prepended to the path
080     *
081     * @return the new path value
082     */
083    public CmsPathValue prepend(String pathPart) {
084
085        return new CmsPathValue(m_value, CmsStringUtil.joinPaths(pathPart, m_path));
086    }
087
088}