com.cognifide.gradle.aem.tooling.sync

Class Cleaner

com.cognifide.gradle.aem.tooling.sync.Cleaner

public class Cleaner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Cleaner.Companion

Field Summary

Fields

Modifier and Type	Field and Description
static Cleaner.Companion	Companion
static java.lang.String	JCR_CONTENT_FILE
static java.lang.String	JCR_CONTENT_NODE
static java.lang.String	JCR_MIXIN_TYPES_PROP
static java.lang.String	JCR_ROOT_PREFIX

Constructor Summary

Constructors

Constructor and Description
Cleaner(AemExtension aem)

Method Summary

Modifier and Type	Method and Description
void	beforeClean(java.io.File root)
void	clean(java.io.File root)
java.util.List<java.lang.String>	cleanNamespaces(java.util.List<java.lang.String> lines)
kotlin.jvm.functions.Function2<java.io.File,java.util.List,java.util.List>	getContentProcess() Hook for additional all lines processing for '.content.xml' files.
kotlin.jvm.functions.Function1<org.gradle.api.tasks.util.PatternFilterable,kotlin.Unit>	getFilesDeleted() Determines which files will be deleted within running cleaning (e.g after checking out JCR content).
kotlin.jvm.functions.Function1<org.gradle.api.tasks.util.PatternFilterable,kotlin.Unit>	getFilesDotContent() Allows to control which files under each root root should be cleaned.
kotlin.jvm.functions.Function1<org.gradle.api.tasks.util.PatternFilterable,kotlin.Unit>	getFilesFlattened() Determines which files will be flattened (e.g /_cq_dialog/.content.xml will be replaced by _cq_dialog.xml).
kotlin.jvm.functions.Function2<java.io.File,java.lang.String,java.lang.String>	getLineProcess() Hook for customizing particular line processing for '.content.xml' files.
java.util.List<java.lang.String>	getMixinTypesSkipped() Mixin types that will be skipped when pulling JCR content from AEM instance.
boolean	getNamespacesSkipped() Controls unused namespaces skipping.
boolean	getParentsBackupEnabled() Controls backups for parent nodes of filter roots for keeping them untouched.
java.lang.String	getParentsBackupSuffix() File suffix being added to parent node back up files. Customize it only if really needed to resolve conflict with file being checked out.
java.util.List<java.lang.String>	getPropertiesSkipped() Properties that will be skipped when pulling JCR content from AEM instance.
java.util.List<java.lang.String>	normalizeContent(java.io.File file, java.util.List<java.lang.String> lines)
java.lang.String	normalizeLine(java.io.File file, java.lang.String line)
java.lang.String	normalizeMixins(java.io.File file, java.lang.String line)
java.lang.String	pathRule(java.lang.String pattern, java.util.List<java.lang.String> excludedPaths)
java.lang.String	pathRule(java.lang.String pattern, java.util.List<java.lang.String> excludedPaths, java.util.List<java.lang.String> includedPaths)
void	prepare(java.io.File root)
void	setContentProcess(kotlin.jvm.functions.Function2<? super java.io.File,? super java.util.List<java.lang.String>,? extends java.util.List<java.lang.String>> p) Hook for additional all lines processing for '.content.xml' files.
void	setFilesDeleted(kotlin.jvm.functions.Function1<? super org.gradle.api.tasks.util.PatternFilterable,kotlin.Unit> p) Determines which files will be deleted within running cleaning (e.g after checking out JCR content).
void	setFilesDotContent(kotlin.jvm.functions.Function1<? super org.gradle.api.tasks.util.PatternFilterable,kotlin.Unit> p) Allows to control which files under each root root should be cleaned.
void	setFilesFlattened(kotlin.jvm.functions.Function1<? super org.gradle.api.tasks.util.PatternFilterable,kotlin.Unit> p) Determines which files will be flattened (e.g /_cq_dialog/.content.xml will be replaced by _cq_dialog.xml).
void	setLineProcess(kotlin.jvm.functions.Function2<? super java.io.File,? super java.lang.String,java.lang.String> p) Hook for customizing particular line processing for '.content.xml' files.
void	setMixinTypesSkipped(java.util.List<java.lang.String> p) Mixin types that will be skipped when pulling JCR content from AEM instance.
void	setNamespacesSkipped(boolean p) Controls unused namespaces skipping.
void	setParentsBackupEnabled(boolean p) Controls backups for parent nodes of filter roots for keeping them untouched.
void	setParentsBackupSuffix(java.lang.String p) File suffix being added to parent node back up files. Customize it only if really needed to resolve conflict with file being checked out.
void	setPropertiesSkipped(java.util.List<java.lang.String> p) Properties that will be skipped when pulling JCR content from AEM instance.
java.lang.String	skipProperties(java.io.File file, java.lang.String line)

Field Detail

JCR_CONTENT_FILE

@NotNull
public static java.lang.String JCR_CONTENT_FILE

See Also:

Constant Field Values

JCR_CONTENT_NODE

@NotNull
public static java.lang.String JCR_CONTENT_NODE

See Also:

Constant Field Values

JCR_MIXIN_TYPES_PROP

@NotNull
public static java.lang.String JCR_MIXIN_TYPES_PROP

See Also:

Constant Field Values

JCR_ROOT_PREFIX

@NotNull
public static java.lang.String JCR_ROOT_PREFIX

See Also:

Constant Field Values

Companion

public static Cleaner.Companion Companion

Constructor Detail

Cleaner

public Cleaner(@NotNull
               AemExtension aem)

Method Detail

getFilesDotContent

@NotNull
public kotlin.jvm.functions.Function1<org.gradle.api.tasks.util.PatternFilterable,kotlin.Unit> getFilesDotContent()

Allows to control which files under each root root should be cleaned.

setFilesDotContent

public void setFilesDotContent(@NotNull
                               kotlin.jvm.functions.Function1<? super org.gradle.api.tasks.util.PatternFilterable,kotlin.Unit> p)

Allows to control which files under each root root should be cleaned.

getFilesDeleted

@NotNull
public kotlin.jvm.functions.Function1<org.gradle.api.tasks.util.PatternFilterable,kotlin.Unit> getFilesDeleted()

Determines which files will be deleted within running cleaning (e.g after checking out JCR content).

setFilesDeleted

public void setFilesDeleted(@NotNull
                            kotlin.jvm.functions.Function1<? super org.gradle.api.tasks.util.PatternFilterable,kotlin.Unit> p)

Determines which files will be deleted within running cleaning (e.g after checking out JCR content).

getFilesFlattened

@NotNull
public kotlin.jvm.functions.Function1<org.gradle.api.tasks.util.PatternFilterable,kotlin.Unit> getFilesFlattened()

Determines which files will be flattened (e.g /_cq_dialog/.content.xml will be replaced by _cq_dialog.xml).

setFilesFlattened

public void setFilesFlattened(@NotNull
                              kotlin.jvm.functions.Function1<? super org.gradle.api.tasks.util.PatternFilterable,kotlin.Unit> p)

Determines which files will be flattened (e.g /_cq_dialog/.content.xml will be replaced by _cq_dialog.xml).

getPropertiesSkipped

@NotNull
public java.util.List<java.lang.String> getPropertiesSkipped()

Properties that will be skipped when pulling JCR content from AEM instance.

After special delimiter '!' there could be specified one or many path patterns (ANT style, delimited with ',') in which property shouldn't be removed.

setPropertiesSkipped

public void setPropertiesSkipped(@NotNull
                                 java.util.List<java.lang.String> p)

Properties that will be skipped when pulling JCR content from AEM instance.

After special delimiter '!' there could be specified one or many path patterns (ANT style, delimited with ',') in which property shouldn't be removed.

getMixinTypesSkipped

@NotNull
public java.util.List<java.lang.String> getMixinTypesSkipped()

Mixin types that will be skipped when pulling JCR content from AEM instance.

setMixinTypesSkipped

public void setMixinTypesSkipped(@NotNull
                                 java.util.List<java.lang.String> p)

Mixin types that will be skipped when pulling JCR content from AEM instance.

getNamespacesSkipped

public boolean getNamespacesSkipped()

Controls unused namespaces skipping.

setNamespacesSkipped

public void setNamespacesSkipped(boolean p)

Controls unused namespaces skipping.

getParentsBackupEnabled

public boolean getParentsBackupEnabled()

Controls backups for parent nodes of filter roots for keeping them untouched.

setParentsBackupEnabled

public void setParentsBackupEnabled(boolean p)

Controls backups for parent nodes of filter roots for keeping them untouched.

getParentsBackupSuffix

@NotNull
public java.lang.String getParentsBackupSuffix()

File suffix being added to parent node back up files. Customize it only if really needed to resolve conflict with file being checked out.

setParentsBackupSuffix

public void setParentsBackupSuffix(@NotNull
                                   java.lang.String p)

File suffix being added to parent node back up files. Customize it only if really needed to resolve conflict with file being checked out.

getLineProcess

@NotNull
public kotlin.jvm.functions.Function2<java.io.File,java.lang.String,java.lang.String> getLineProcess()

Hook for customizing particular line processing for '.content.xml' files.

setLineProcess

public void setLineProcess(@NotNull
                           kotlin.jvm.functions.Function2<? super java.io.File,? super java.lang.String,java.lang.String> p)

Hook for customizing particular line processing for '.content.xml' files.

getContentProcess

@NotNull
public kotlin.jvm.functions.Function2<java.io.File,java.util.List,java.util.List> getContentProcess()

Hook for additional all lines processing for '.content.xml' files.

setContentProcess

public void setContentProcess(@NotNull
                              kotlin.jvm.functions.Function2<? super java.io.File,? super java.util.List<java.lang.String>,? extends java.util.List<java.lang.String>> p)

Hook for additional all lines processing for '.content.xml' files.

prepare

public void prepare(@NotNull
                    java.io.File root)

beforeClean

public void beforeClean(@NotNull
                        java.io.File root)

clean

public void clean(@NotNull
                  java.io.File root)

normalizeContent

@NotNull
public java.util.List<java.lang.String> normalizeContent(@NotNull
                                                                   java.io.File file,
                                                                   @NotNull
                                                                   java.util.List<java.lang.String> lines)

cleanNamespaces

@NotNull
public java.util.List<java.lang.String> cleanNamespaces(@NotNull
                                                                  java.util.List<java.lang.String> lines)

normalizeLine

@NotNull
public java.lang.String normalizeLine(@NotNull
                                                java.io.File file,
                                                @NotNull
                                                java.lang.String line)

skipProperties

@NotNull
public java.lang.String skipProperties(@NotNull
                                                 java.io.File file,
                                                 @NotNull
                                                 java.lang.String line)

normalizeMixins

@NotNull
public java.lang.String normalizeMixins(@NotNull
                                                  java.io.File file,
                                                  @NotNull
                                                  java.lang.String line)

pathRule

@NotNull
public java.lang.String pathRule(@NotNull
                                           java.lang.String pattern,
                                           @NotNull
                                           java.util.List<java.lang.String> excludedPaths)

pathRule

@NotNull
public java.lang.String pathRule(@NotNull
                                           java.lang.String pattern,
                                           @NotNull
                                           java.util.List<java.lang.String> excludedPaths,
                                           @NotNull
                                           java.util.List<java.lang.String> includedPaths)