ImportOptions (The Adobe AEM Quickstart and Web Application.)

java.lang.Object
- org.apache.jackrabbit.vault.fs.io.ImportOptions

public class ImportOptions
extends java.lang.Object

Option that control the package import.

Constructor Summary

Constructors
Constructor and Description

ImportOptions()
Default constructor.

ImportOptions(ImportOptions base)
Deprecated.
use copy() instead.

Constructors
Constructor and Description
`ImportOptions()` Default constructor.
`ImportOptions(ImportOptions base)` Deprecated. use `copy()` instead.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ImportOptions`	`copy()` Creates a copy of this import options.
`AccessControlHandling`	`getAccessControlHandling()` Returns the default access control handling.
`int`	`getAutoSaveThreshold()` Returns the auto-save threshold.
`java.util.regex.Pattern`	`getCndPattern()` Returns the CND pattern
`DependencyHandling`	`getDependencyHandling()` Defines how package dependencies affect package installation and un-installation.
`WorkspaceFilter`	`getFilter()` Returns the default workspace filter.
`java.lang.ClassLoader`	`getHookClassLoader()` Returns the hook class loader.
`ImportMode`	`getImportMode()` Returns the import mode.
`ProgressTrackerListener`	`getListener()` Returns the progress tracker listener.
`java.io.File`	`getPatchDirectory()` Returns the patch directory
`java.lang.String`	`getPatchParentPath()` Returns the patch parent path
`PathMapping`	`getPathMapping()` Defines a path mapping that is applied to the incoming package paths and filter when installing the package.
`boolean`	`isDryRun()` Returns the dry run flag.
`boolean`	`isNonRecursive()` Defines the package installation should recursively install sub packages.
`boolean`	`isPatchKeepInRepo()` Returns the 'patch-keep-in-repo' flag.
`boolean`	`isStrict()` Returns the 'strict' flag.
`void`	`setAccessControlHandling(AccessControlHandling acHandling)` Sets the access control handling.
`void`	`setAutoSaveThreshold(int threshold)` Sets the auto-save threshold.
`void`	`setCndPattern(java.lang.String cndPattern)` Sets the CND file pattern.
`void`	`setDependencyHandling(DependencyHandling dependencyHandling)` Sets the dependency handling.
`void`	`setDryRun(boolean dryRun)` Sets the dry run flag.
`void`	`setFilter(WorkspaceFilter filter)` Sets the default workspace filter.
`void`	`setHookClassLoader(java.lang.ClassLoader hookClassLoader)` Sets the hook class loader.
`void`	`setImportMode(ImportMode importMode)` Sets the default import mode.
`void`	`setListener(ProgressTrackerListener listener)` Sets the progress tracker listener that receives messages during package installation.
`void`	`setNonRecursive(boolean nonRecursive)` Sets the flag to ignore sub packages.
`void`	`setPatchDirectory(java.io.File patchDirectory)` Sets the patch directory.
`void`	`setPatchKeepInRepo(boolean patchKeepInRepo)` Sets the flag if patches should be kept in the repository after there were copied to the disk.
`void`	`setPatchParentPath(java.lang.String patchParentPath)` Sets the parent path of the patch node.
`void`	`setPathMapping(PathMapping pathMapping)` Sets the path mapping
`void`	`setStrict(boolean strict)` Sets the 'strict' flag.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ImportOptions
```
public ImportOptions()
```
    Default constructor.
  - ImportOptions
```
@Deprecated
public ImportOptions(ImportOptions base)
```
    Deprecated. use copy() instead.
    
    Parameters:
    
    base - base options
- Method Detail
  - copy
```
public ImportOptions copy()
```
    Creates a copy of this import options.
    
    Returns:
    
    a copy of this.
  - isStrict
```
public boolean isStrict()
```
    Returns the 'strict' flag.
    
    Returns:
    
    the 'strict' flag.
  - setStrict
```
public void setStrict(boolean strict)
```
    Sets the 'strict' flag.
    
    Parameters:
    
    strict - the flag
  - getListener
```
public ProgressTrackerListener getListener()
```
    Returns the progress tracker listener.
    
    Returns:
    
    the progress tracker listener.
  - setListener
```
public void setListener(ProgressTrackerListener listener)
```
    Sets the progress tracker listener that receives messages during package installation.
    
    Parameters:
    
    listener - The listener
  - getPatchParentPath
```
public java.lang.String getPatchParentPath()
```
    Returns the patch parent path
    
    Returns:
    
    the patch parent path
  - setPatchParentPath
```
public void setPatchParentPath(java.lang.String patchParentPath)
```
    Sets the parent path of the patch node.
    
    Parameters:
    
    patchParentPath - the path
  - getPatchDirectory
```
public java.io.File getPatchDirectory()
```
    Returns the patch directory
    
    Returns:
    
    the patch directory
  - setPatchDirectory
```
public void setPatchDirectory(java.io.File patchDirectory)
                       throws java.io.IOException
```
    Sets the patch directory. The nt:file nodes that are placed below the getPatchParentPath() will be copied into this directory during extraction.
    
    Parameters:
    
    patchDirectory - The directory
    
    Throws:
    
    java.io.IOException - if an i/o error occurrs during obtaining the canonical file of this directory.
  - isPatchKeepInRepo
```
public boolean isPatchKeepInRepo()
```
    Returns the 'patch-keep-in-repo' flag.
    
    Returns:
    
    the 'patch-keep-in-repo' flag.
  - setPatchKeepInRepo
```
public void setPatchKeepInRepo(boolean patchKeepInRepo)
```
    Sets the flag if patches should be kept in the repository after there were copied to the disk.
    
    Parameters:
    
    patchKeepInRepo - the flag
  - getAccessControlHandling
```
public AccessControlHandling getAccessControlHandling()
```
    Returns the default access control handling.
    
    Returns:
    
    the default access control handling.
  - setAccessControlHandling
```
public void setAccessControlHandling(AccessControlHandling acHandling)
```
    Sets the access control handling.
    
    Parameters:
    
    acHandling - the ACL handling.
  - isNonRecursive
```
public boolean isNonRecursive()
```
    Defines the package installation should recursively install sub packages. Note that if this flag is enabled, the SubPackageHandling configuration has no effect, as sub packages are not evaluated at all.
    
    Returns:
    
    true if package installation should not install sub packages.
  - setNonRecursive
```
public void setNonRecursive(boolean nonRecursive)
```
    Sets the flag to ignore sub packages.
    
    Parameters:
    
    nonRecursive - true to set non recursive
    
    See Also:
    
    isNonRecursive()
  - getCndPattern
```
public java.util.regex.Pattern getCndPattern()
```
    Returns the CND pattern
    
    Returns:
    
    the CND pattern
  - setCndPattern
```
public void setCndPattern(java.lang.String cndPattern)
                   throws java.util.regex.PatternSyntaxException
```
    Sets the CND file pattern.
    
    Parameters:
    
    cndPattern - the cnd pattern
    
    Throws:
    
    java.util.regex.PatternSyntaxException - If the pattern is not valid
  - isDryRun
```
public boolean isDryRun()
```
    Returns the dry run flag.
    
    Returns:
    
    the dry run flag.
    
    Since:
    
    2.2.14
  - setDryRun
```
public void setDryRun(boolean dryRun)
```
    Sets the dry run flag.
    
    Parameters:
    
    dryRun - the dry run flag.
    
    Since:
    
    2.2.14
  - setAutoSaveThreshold
```
public void setAutoSaveThreshold(int threshold)
```
    Sets the auto-save threshold. See AutoSave
    
    Parameters:
    
    threshold - the threshold in number of nodes.
    
    Since:
    
    2.2.16
  - getAutoSaveThreshold
```
public int getAutoSaveThreshold()
```
    Returns the auto-save threshold.
    
    Returns:
    
    the auto-save threshold.
    
    Since:
    
    2.2.16
  - getImportMode
```
public ImportMode getImportMode()
```
    Returns the import mode.
    
    Returns:
    
    the import mode.
    
    Since:
    
    2.3
  - setImportMode
```
public void setImportMode(ImportMode importMode)
```
    Sets the default import mode.
    
    Parameters:
    
    importMode - The import mode.
    
    Since:
    
    2.3
  - getFilter
```
public WorkspaceFilter getFilter()
```
    Returns the default workspace filter.
    
    Returns:
    
    the default workspace filter.
    
    Since:
    
    2.3.20
  - setFilter
```
public void setFilter(WorkspaceFilter filter)
```
    Sets the default workspace filter.
    
    Parameters:
    
    filter - the filter
    
    Since:
    
    2.3.20
  - getHookClassLoader
```
public java.lang.ClassLoader getHookClassLoader()
```
    Returns the hook class loader.
    
    Returns:
    
    the hook class loader.
    
    Since:
    
    2.3.22
  - setHookClassLoader
```
public void setHookClassLoader(java.lang.ClassLoader hookClassLoader)
```
    Sets the hook class loader.
    
    Parameters:
    
    hookClassLoader - the class loader
    
    Since:
    
    2.3.22
  - getPathMapping
```
public PathMapping getPathMapping()
```
    Defines a path mapping that is applied to the incoming package paths and filter when installing the package.
    
    Returns:
    
    null if no path mapping is defined.
    
    Since:
    
    3.1.14
  - setPathMapping
```
public void setPathMapping(PathMapping pathMapping)
```
    Sets the path mapping
    
    Parameters:
    
    pathMapping - The path mapping
    
    Since:
    
    3.1.14
    
    See Also:
    
    getPathMapping()
  - getDependencyHandling
```
public DependencyHandling getDependencyHandling()
```
    Defines how package dependencies affect package installation and un-installation.
    
    Returns:
    
    the dependency handling.
  - setDependencyHandling
```
public void setDependencyHandling(DependencyHandling dependencyHandling)
```
    Sets the dependency handling.
    
    Parameters:
    
    dependencyHandling - the dependency handling.
    
    Since:
    
    3.1.32
    
    See Also:
    
    getDependencyHandling()

Class ImportOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ImportOptions

ImportOptions

Method Detail

copy

isStrict

setStrict

getListener

setListener

getPatchParentPath

setPatchParentPath

getPatchDirectory

setPatchDirectory

isPatchKeepInRepo

setPatchKeepInRepo

getAccessControlHandling

setAccessControlHandling

isNonRecursive

setNonRecursive

getCndPattern

setCndPattern

isDryRun

setDryRun

setAutoSaveThreshold

getAutoSaveThreshold

getImportMode

setImportMode

getFilter

setFilter

getHookClassLoader

setHookClassLoader

getPathMapping

setPathMapping

getDependencyHandling

setDependencyHandling