org.opencms.configuration
Class CmsConfigurationCopyResource

java.lang.Object
  org.opencms.configuration.CmsConfigurationCopyResource

public class CmsConfigurationCopyResource
extends Object

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

Field Summary

static String	COPY_AS_NEW Indicates "copy resources" should be copied with type CmsResource.COPY_AS_NEW.
static String	COPY_AS_PRESERVE Indicates "copy resources" should be copied with type CmsResource.COPY_PRESERVE_SIBLING.
static String	COPY_AS_SIBLING Indicates "copy resources" should be copied with type CmsResource.COPY_AS_SIBLING.

Constructor Summary

CmsConfigurationCopyResource(String source, String target, String type)
Creates a new copy resource info container.

Method Summary

String	getSource() Returns the source resource.
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.
String	getTypeString() Returns the copy type as String.
boolean	isTargetWasNull() Returns true if the original target configuration was null.
boolean	isTypeWasNull() Returns true if the original type configuration was null.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

COPY_AS_NEW

public static final String COPY_AS_NEW

Indicates "copy resources" should be copied with type CmsResource.COPY_AS_NEW.

See Also:

Constant Field Values

COPY_AS_PRESERVE

public static final String COPY_AS_PRESERVE

Indicates "copy resources" should be copied with type CmsResource.COPY_PRESERVE_SIBLING.

See Also:

Constant Field Values

COPY_AS_SIBLING

public static final String COPY_AS_SIBLING

Indicates "copy resources" should be copied with type CmsResource.COPY_AS_SIBLING.

See Also:

Constant Field Values

Constructor Detail

CmsConfigurationCopyResource

public CmsConfigurationCopyResource(String source,
                                    String target,
                                    String type)

Creates a new copy resource info container.

If target is null, the macro A_CmsResourceType.MACRO_RESOURCE_FOLDER_PATH is used as default. If type is null, the copy type CmsResource.COPY_AS_NEW is used as default.

Parameters:

source - the source resource

target - the target resource (may contain macros)

type - the type of the copy, for example "as new", "as sibling" etc

Method Detail

getSource

public String getSource()

Returns the source resource.

Returns:

the source resource

getTarget

public 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 and CmsResource.COPY_PRESERVE_SIBLING.

Returns:

the type of the copy, for example "as new", "as sibling" etc

getTypeString

public String getTypeString()

Returns the copy type as String.

Returns:

the copy type as String

See Also:

getType()

isTargetWasNull

public boolean isTargetWasNull()

Returns true if the original target configuration was null.

Returns:

true if the original target configuration was null

isTypeWasNull

public boolean isTypeWasNull()

Returns true if the original type configuration was null.

Returns:

true if the original type configuration was null

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()