Package org.opencms.configuration
Class CmsConfigurationCopyResource
- java.lang.Object
-
- org.opencms.configuration.CmsConfigurationCopyResource
-
- All Implemented Interfaces:
java.io.Serializable
public class CmsConfigurationCopyResource extends java.lang.Object implements java.io.Serializable
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
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
COPY_AS_NEW
Indicates "copy resources" should be copied with typeCmsResource.COPY_AS_NEW
.static java.lang.String
COPY_AS_PRESERVE
Indicates "copy resources" should be copied with typeCmsResource.COPY_PRESERVE_SIBLING
.static java.lang.String
COPY_AS_SIBLING
Indicates "copy resources" should be copied with typeCmsResource.COPY_AS_SIBLING
.
-
Constructor Summary
Constructors Constructor Description CmsConfigurationCopyResource(java.lang.String source, java.lang.String target, java.lang.String type)
Creates a new copy resource info container.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getSource()
Returns the source resource.java.lang.String
getTarget()
Returns the target resource (may contain macros).CmsResource.CmsResourceCopyMode
getType()
Returns the type of the copy, for example "as new", "as sibling" etc.java.lang.String
getTypeString()
Returns the copy type as String.boolean
isTargetWasNull()
Returnstrue
if the original target configuration wasnull
.boolean
isTypeWasNull()
Returnstrue
if the original type configuration wasnull
.java.lang.String
toString()
-
-
-
Field Detail
-
COPY_AS_NEW
public static final java.lang.String COPY_AS_NEW
Indicates "copy resources" should be copied with typeCmsResource.COPY_AS_NEW
.- See Also:
- Constant Field Values
-
COPY_AS_PRESERVE
public static final java.lang.String COPY_AS_PRESERVE
Indicates "copy resources" should be copied with typeCmsResource.COPY_PRESERVE_SIBLING
.- See Also:
- Constant Field Values
-
COPY_AS_SIBLING
public static final java.lang.String COPY_AS_SIBLING
Indicates "copy resources" should be copied with typeCmsResource.COPY_AS_SIBLING
.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsConfigurationCopyResource
public CmsConfigurationCopyResource(java.lang.String source, java.lang.String target, java.lang.String type)
Creates a new copy resource info container.If target is
null
, the macroA_CmsResourceType.MACRO_RESOURCE_FOLDER_PATH
is used as default. If type isnull
, the copy typeCmsResource.COPY_AS_NEW
is used as default.- Parameters:
source
- the source resourcetarget
- the target resource (may contain macros)type
- the type of the copy, for example "as new", "as sibling" etc
-
-
Method Detail
-
getSource
public java.lang.String getSource()
Returns the source resource.- Returns:
- the source resource
-
getTarget
public java.lang.String getTarget()
Returns the target resource (may contain macros).- Returns:
- the target resource (may contain macros)
-
getType
public CmsResource.CmsResourceCopyMode getType()
Returns the type of the copy, for example "as new", "as sibling" etc.Possible types are
CmsResource.COPY_AS_NEW
,CmsResource.COPY_AS_SIBLING
andCmsResource.COPY_PRESERVE_SIBLING
.- Returns:
- the type of the copy, for example "as new", "as sibling" etc
-
getTypeString
public java.lang.String getTypeString()
Returns the copy type as String.- Returns:
- the copy type as String
- See Also:
getType()
-
isTargetWasNull
public boolean isTargetWasNull()
Returnstrue
if the original target configuration wasnull
.- Returns:
true
if the original target configuration wasnull
-
isTypeWasNull
public boolean isTypeWasNull()
Returnstrue
if the original type configuration wasnull
.- Returns:
true
if the original type configuration wasnull
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
- See Also:
Object.toString()
-
-