This is an automated email from the ASF dual-hosted git repository. rombert pushed a commit to annotated tag org.apache.sling.fsresource-2.0.0 in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-fsresource.git
commit ee0c02d4d86b217e80b2dba7a33c004828157fc1 Author: Stefan Seifert <[email protected]> AuthorDate: Fri Mar 10 16:29:33 2017 +0000 cosmetic: use consistent wording, reorder config attributes git-svn-id: https://svn.apache.org/repos/asf/sling/trunk/bundles/extensions/fsresource@1786379 13f79535-47bb-0310-9956-ffa450edef68 --- .../apache/sling/fsprovider/internal/FsMode.java | 2 +- .../fsprovider/internal/FsResourceProvider.java | 43 +++++++++------------- .../internal/mapper/FileVaultResourceMapper.java | 2 +- .../sling/fsprovider/internal/FileMonitorTest.java | 2 +- .../internal/FileVaultFileMonitorTest.java | 2 +- .../sling/fsprovider/internal/FilesFolderTest.java | 2 +- .../fsprovider/internal/JcrXmlContentTest.java | 2 +- .../sling/fsprovider/internal/JsonContentTest.java | 2 +- 8 files changed, 25 insertions(+), 32 deletions(-) diff --git a/src/main/java/org/apache/sling/fsprovider/internal/FsMode.java b/src/main/java/org/apache/sling/fsprovider/internal/FsMode.java index 50eeebd..b255bb2 100644 --- a/src/main/java/org/apache/sling/fsprovider/internal/FsMode.java +++ b/src/main/java/org/apache/sling/fsprovider/internal/FsMode.java @@ -29,7 +29,7 @@ public enum FsMode { FILES_FOLDERS, /** - * Sling-Initial-Content filesystem layout, supports file and folders ant content files in JSON and jcr.xml format. + * Sling-Initial-Content file system layout, supports file and folders ant content files in JSON and jcr.xml format. */ INITIAL_CONTENT, diff --git a/src/main/java/org/apache/sling/fsprovider/internal/FsResourceProvider.java b/src/main/java/org/apache/sling/fsprovider/internal/FsResourceProvider.java index 8863bdf..bb6a6e5 100644 --- a/src/main/java/org/apache/sling/fsprovider/internal/FsResourceProvider.java +++ b/src/main/java/org/apache/sling/fsprovider/internal/FsResourceProvider.java @@ -80,14 +80,10 @@ public final class FsResourceProvider extends ResourceProvider<Object> { public static final String RESOURCE_METADATA_FILE_DIRECTORY = ":org.apache.sling.fsprovider.file.directory"; @ObjectClassDefinition(name = "Apache Sling File System Resource Provider", - description = "Configure an instance of the filesystem " + - "resource provider in terms of provider root and filesystem location") + description = "Configure an instance of the file system " + + "resource provider in terms of provider root and file system location") public @interface Config { - /** - * The name of the configuration property providing file system path of - * files and folders mapped into the resource tree (value is - * "provider.file"). - */ + @AttributeDefinition(name = "File System Root", description = "File system directory mapped to the virtual " + "resource tree. This property must not be an empty string. If the path is " + @@ -96,41 +92,38 @@ public final class FsResourceProvider extends ResourceProvider<Object> { "file or folder, an empty folder is created.") String provider_file(); - /** - * The name of the configuration property providing the check interval - * for file changes (value is "provider.checkinterval"). - */ - @AttributeDefinition(name = "Check Interval", - description = "If the interval has a value higher than 100, the provider will " + - "check the file system for changes periodically. This interval defines the period in milliseconds " + - "(the default is 1000). If a change is detected, resource events are sent through the event admin.") - long provider_checkinterval() default 1000; - @AttributeDefinition(name = "Provider Root", description = "Location in the virtual resource tree where the " + - "filesystem resources are mapped in. This property must not be an empty string.") + "file system resources are mapped in. This property must not be an empty string.") String provider_root(); - @AttributeDefinition(name = "Filesystem layout", - description = "Filesystem layout mode for files, folders and content.", + @AttributeDefinition(name = "File system layout", + description = "File system layout mode for files, folders and content.", options={ @Option(value="FILES_FOLDERS", label="FILES_FOLDERS - " + "Support only files and folders (classic mode)"), @Option(value="INITIAL_CONTENT", label="INITIAL_CONTENT - " - + "Sling-Initial-Content filesystem layout, supports file and folders ant content files in JSON and jcr.xml format"), + + "Sling-Initial-Content file system layout, supports file and folders ant content files in JSON and jcr.xml format"), @Option(value="FILEVAULT_XML", label="FILEVAULT_XML - " + "FileVault XML format (expanded content package)"), }) FsMode provider_fs_mode() default FsMode.FILES_FOLDERS; @AttributeDefinition(name = "Init. Content Options", - description = "Import options for Sling-Initial-Content filesystem layout. Supported options: overwrite, ignoreImportProviders.") + description = "Import options for Sling-Initial-Content file system layout. Supported options: overwrite, ignoreImportProviders.") String provider_initial_content_import_options(); @AttributeDefinition(name = "FileVault Filter", - description = "Path to META-INF/vault/filter.xml when using FileVault XML filesystem layout.") + description = "Path to META-INF/vault/filter.xml when using FileVault XML file system layout.") String provider_filevault_filterxml_path(); + + @AttributeDefinition(name = "Check Interval", + description = "If the interval has a value higher than 100, the provider will " + + "check the file system for changes periodically. This interval defines the period in milliseconds " + + "(the default is 1000). If a change is detected, resource events are sent through the event admin.") + long provider_checkinterval() default 1000; + @AttributeDefinition(name = "Cache Size", description = "Max. number of content files cached in memory.") int provider_cache_size() default 10000; @@ -150,13 +143,13 @@ public final class FsResourceProvider extends ResourceProvider<Object> { // The monitor to detect file changes. private FileMonitor monitor; - // maps filesystem to resources + // maps file system to resources private FsMode fsMode; private FsResourceMapper fileMapper; private FsResourceMapper contentFileMapper; private FileVaultResourceMapper fileVaultMapper; - // if true resources from filesystem are only "overlayed" to JCR resources, serving JCR as fallback within the same path + // if true resources from file system are only "overlayed" to JCR resources, serving JCR as fallback within the same path private boolean overlayParentResourceProvider; // cache for parsed content files diff --git a/src/main/java/org/apache/sling/fsprovider/internal/mapper/FileVaultResourceMapper.java b/src/main/java/org/apache/sling/fsprovider/internal/mapper/FileVaultResourceMapper.java index cb25230..6585d1e 100644 --- a/src/main/java/org/apache/sling/fsprovider/internal/mapper/FileVaultResourceMapper.java +++ b/src/main/java/org/apache/sling/fsprovider/internal/mapper/FileVaultResourceMapper.java @@ -104,7 +104,7 @@ public final class FileVaultResourceMapper implements FsResourceMapper { } } - // additional check for children in filesystem + // additional check for children in file system File parentFile = getFile(parentPath); if (parentFile != null && parentFile.isDirectory()) { for (File childFile : parentFile.listFiles()) { diff --git a/src/test/java/org/apache/sling/fsprovider/internal/FileMonitorTest.java b/src/test/java/org/apache/sling/fsprovider/internal/FileMonitorTest.java index bc4892f..d2b1143 100644 --- a/src/test/java/org/apache/sling/fsprovider/internal/FileMonitorTest.java +++ b/src/test/java/org/apache/sling/fsprovider/internal/FileMonitorTest.java @@ -39,7 +39,7 @@ import org.junit.Rule; import org.junit.Test; /** - * Test events when changing filesystem content (Sling-Initial-Content). + * Test events when changing file system content (Sling-Initial-Content). */ public class FileMonitorTest { diff --git a/src/test/java/org/apache/sling/fsprovider/internal/FileVaultFileMonitorTest.java b/src/test/java/org/apache/sling/fsprovider/internal/FileVaultFileMonitorTest.java index 9743027..76e0525 100644 --- a/src/test/java/org/apache/sling/fsprovider/internal/FileVaultFileMonitorTest.java +++ b/src/test/java/org/apache/sling/fsprovider/internal/FileVaultFileMonitorTest.java @@ -39,7 +39,7 @@ import org.junit.Rule; import org.junit.Test; /** - * Test events when changing filesystem content (FileVault XML). + * Test events when changing file system content (FileVault XML). */ public class FileVaultFileMonitorTest { diff --git a/src/test/java/org/apache/sling/fsprovider/internal/FilesFolderTest.java b/src/test/java/org/apache/sling/fsprovider/internal/FilesFolderTest.java index 1930a94..c1f3470 100644 --- a/src/test/java/org/apache/sling/fsprovider/internal/FilesFolderTest.java +++ b/src/test/java/org/apache/sling/fsprovider/internal/FilesFolderTest.java @@ -34,7 +34,7 @@ import org.junit.Rule; import org.junit.Test; /** - * Test access to files and folders from filesystem. + * Test access to files and folders from file system. */ public class FilesFolderTest { diff --git a/src/test/java/org/apache/sling/fsprovider/internal/JcrXmlContentTest.java b/src/test/java/org/apache/sling/fsprovider/internal/JcrXmlContentTest.java index c1dc1c2..5306566 100644 --- a/src/test/java/org/apache/sling/fsprovider/internal/JcrXmlContentTest.java +++ b/src/test/java/org/apache/sling/fsprovider/internal/JcrXmlContentTest.java @@ -46,7 +46,7 @@ import org.junit.Test; import com.google.common.collect.ImmutableList; /** - * Test access to files and folders from filesystem. + * Test access to files and folders from file system. */ public class JcrXmlContentTest { diff --git a/src/test/java/org/apache/sling/fsprovider/internal/JsonContentTest.java b/src/test/java/org/apache/sling/fsprovider/internal/JsonContentTest.java index cb5338d..32fa3ca 100644 --- a/src/test/java/org/apache/sling/fsprovider/internal/JsonContentTest.java +++ b/src/test/java/org/apache/sling/fsprovider/internal/JsonContentTest.java @@ -57,7 +57,7 @@ import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableSet; /** - * Test access to files and folders and JSON content from filesystem. + * Test access to files and folders and JSON content from file system. */ public class JsonContentTest { -- To stop receiving notification emails like this one, please contact "[email protected]" <[email protected]>.
