Package org.opencms.xml.containerpage
Class CmsConfigurationItem
- java.lang.Object
-
- org.opencms.xml.containerpage.CmsConfigurationItem
-
public class CmsConfigurationItem extends java.lang.Object
A single item of the ADE file type configuration.A configuration item describes which file should be used as a template for new content elements, and at which location in the VFS they should be created.
It does not contain a type, since the type is given by the type of the source file.
- Since:
- 7.6
-
-
Constructor Summary
Constructors Constructor Description CmsConfigurationItem(CmsResource sourceFile, CmsResource destinationFolder, CmsLazyFolder lazyFolder, java.lang.String pattern, boolean isDefault)
Creates a new type configuration item.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CmsResource
getFolder()
Returns the destination folder uri.CmsLazyFolder
getLazyFolder()
Returns a helper object which represents a folder which may still have to be created.java.lang.String
getPattern()
Returns the file pattern.CmsResource
getSourceFile()
Gets the source file uri.boolean
isDefault()
Returns if this item is default for it's resource-type.
-
-
-
Constructor Detail
-
CmsConfigurationItem
public CmsConfigurationItem(CmsResource sourceFile, CmsResource destinationFolder, CmsLazyFolder lazyFolder, java.lang.String pattern, boolean isDefault)
Creates a new type configuration item.- Parameters:
sourceFile
- the source filedestinationFolder
- the destination folderlazyFolder
- the lazy folder objectpattern
- the file patternisDefault
-true
if this item is default for it's resource-type
-
-
Method Detail
-
getFolder
public CmsResource getFolder()
Returns the destination folder uri.- Returns:
- the destination folder uri
-
getLazyFolder
public CmsLazyFolder getLazyFolder()
Returns a helper object which represents a folder which may still have to be created.- Returns:
- a lazy folder object
-
getPattern
public java.lang.String getPattern()
Returns the file pattern.- Returns:
- the file pattern
-
getSourceFile
public CmsResource getSourceFile()
Gets the source file uri.- Returns:
- the source file uri
-
isDefault
public boolean isDefault()
Returns if this item is default for it's resource-type.- Returns:
true
if this item is default for it's resource-type
-
-