org.opencms.configuration.CmsConfigurationCopyResource Maven / Gradle / Ivy
Show all versions of opencms-core Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software GmbH & Co. KG, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.configuration;
import org.opencms.file.CmsResource;
import org.opencms.file.CmsResource.CmsResourceCopyMode;
import org.opencms.file.types.A_CmsResourceType;
import org.opencms.util.CmsMacroResolver;
/**
* Describes a resource to copy during the creation of a new resource.
*
* Usually used in folder types to copy some default resources to the folder,
* but also usable for file resources.
*
* @since 6.0.0
*/
public class CmsConfigurationCopyResource {
/** Indicates "copy resources" should be copied with type {@link CmsResource#COPY_AS_NEW}. */
public static final String COPY_AS_NEW = "new";
/** Indicates "copy resources" should be copied with type {@link CmsResource#COPY_PRESERVE_SIBLING}. */
public static final String COPY_AS_PRESERVE = "preserve";
/** Indicates "copy resources" should be copied with type {@link CmsResource#COPY_AS_SIBLING}. */
public static final String COPY_AS_SIBLING = "sibling";
/** The source resource. */
private String m_source;
/** The target resource (may contain macros). */
private String m_target;
/** Indicates that the original configured target was null.*/
private boolean m_targetWasNull;
/** The type of the copy, for example "as new", "as sibling" etc.*/
private CmsResourceCopyMode m_type;
/** Indicates that the original configured type setting was null.*/
private boolean m_typeWasNull;
/**
* Creates a new copy resource info container.
*
* If target is null, the macro {@link A_CmsResourceType#MACRO_RESOURCE_FOLDER_PATH} is used as default.
* If type is null, the copy type {@link CmsResource#COPY_AS_NEW} is used as default.
*
* @param source the source resource
* @param target the target resource (may contain macros)
* @param type the type of the copy, for example "as new", "as sibling" etc
*/
public CmsConfigurationCopyResource(String source, String target, String type) {
m_source = source;
if (target == null) {
m_target = CmsMacroResolver.formatMacro(A_CmsResourceType.MACRO_RESOURCE_FOLDER_PATH);
m_targetWasNull = true;
} else {
m_target = target;
}
m_type = CmsResource.COPY_AS_NEW;
if (type != null) {
if (type.equalsIgnoreCase(CmsConfigurationCopyResource.COPY_AS_SIBLING)) {
m_type = CmsResource.COPY_AS_SIBLING;
} else if (type.equalsIgnoreCase(CmsConfigurationCopyResource.COPY_AS_PRESERVE)) {
m_type = CmsResource.COPY_PRESERVE_SIBLING;
}
} else {
m_typeWasNull = true;
}
}
/**
* Returns the source resource.
*
* @return the source resource
*/
public String getSource() {
return m_source;
}
/**
* Returns the target resource (may contain macros).
*
* @return the target resource (may contain macros)
*/
public String getTarget() {
return m_target;
}
/**
* Returns the type of the copy, for example "as new", "as sibling" etc.
*
* Possible types are {@link org.opencms.file.CmsResource#COPY_AS_NEW},
* {@link org.opencms.file.CmsResource#COPY_AS_SIBLING} and
* {@link org.opencms.file.CmsResource#COPY_PRESERVE_SIBLING}.
*
* @return the type of the copy, for example "as new", "as sibling" etc
*/
public CmsResourceCopyMode getType() {
return m_type;
}
/**
* Returns the copy type as String.
*
* @see #getType()
*
* @return the copy type as String
*/
public String getTypeString() {
if (CmsResource.COPY_AS_SIBLING == m_type) {
return CmsConfigurationCopyResource.COPY_AS_SIBLING;
} else if (CmsResource.COPY_PRESERVE_SIBLING == m_type) {
return CmsConfigurationCopyResource.COPY_AS_PRESERVE;
}
return CmsConfigurationCopyResource.COPY_AS_NEW;
}
/**
* Returns true if the original target configuration was null.
*
* @return true if the original target configuration was null
*/
public boolean isTargetWasNull() {
return m_targetWasNull;
}
/**
* Returns true if the original type configuration was null.
*
* @return true if the original type configuration was null
*/
public boolean isTypeWasNull() {
return m_typeWasNull;
}
/**
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuffer result = new StringBuffer();
result.append("[");
result.append(this.getClass().getName());
result.append(", source=");
result.append(getSource());
result.append(", target=");
result.append(getTarget());
result.append(", type=");
result.append(getTypeString());
result.append("]");
return result.toString();
}
}