You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by tr...@apache.org on 2018/02/01 07:54:39 UTC
svn commit: r1822852 -
/jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/
Author: tripod
Date: Thu Feb 1 07:54:38 2018
New Revision: 1822852
URL: http://svn.apache.org/viewvc?rev=1822852&view=rev
Log:
adding nullable annotations
Modified:
jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/Dumpable.java
jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/FilterSet.java
jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/MultiPathMapping.java
jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/PathFilter.java
jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/PathFilterSet.java
jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/PathMapping.java
jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/RegexpPathMapping.java
jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/SimplePathMapping.java
jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/WorkspaceFilter.java
jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/package-info.java
Modified: jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/Dumpable.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/Dumpable.java?rev=1822852&r1=1822851&r2=1822852&view=diff
==============================================================================
--- jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/Dumpable.java (original)
+++ jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/Dumpable.java Thu Feb 1 07:54:38 2018
@@ -17,6 +17,8 @@
package org.apache.jackrabbit.vault.fs.api;
+import javax.annotation.Nonnull;
+
/**
* {@code Dumpable}...
*
@@ -29,5 +31,5 @@ public interface Dumpable {
* @param ctx the dump context
* @param isLast specifies if this is the last element to dump on this level
*/
- void dump(DumpContext ctx, boolean isLast);
+ void dump(@Nonnull DumpContext ctx, boolean isLast);
}
\ No newline at end of file
Modified: jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/FilterSet.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/FilterSet.java?rev=1822852&r1=1822851&r2=1822852&view=diff
==============================================================================
--- jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/FilterSet.java (original)
+++ jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/FilterSet.java Thu Feb 1 07:54:38 2018
@@ -22,6 +22,9 @@ import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
/**
* The item filter set holds a set of item filters each attributed as include
* or exclude filter. The evaluation of the set allows included items and
@@ -36,16 +39,19 @@ public abstract class FilterSet<E extend
/**
* root path of this definition
*/
+ @Nonnull
private String root;
/**
* root patten to check for inclusion
*/
+ @Nonnull
private String rootPattern;
/**
* filter entries
*/
+ @Nullable
private List<Entry<E>> entries;
/**
@@ -56,6 +62,7 @@ public abstract class FilterSet<E extend
/**
* import mode. defaults to {@link ImportMode#REPLACE}.
*/
+ @Nonnull
private ImportMode mode = ImportMode.REPLACE;
/**
@@ -77,15 +84,16 @@ public abstract class FilterSet<E extend
* Returns the root path
* @return root path
*/
+ @Nonnull
public String getRoot() {
- return root.equals("") ? "/" : root;
+ return "".equals(root) ? "/" : root;
}
/**
* Sets the root path
* @param path root path
*/
- public void setRoot(String path) {
+ public void setRoot(@Nonnull String path) {
if (sealed) {
throw new UnsupportedOperationException("FilterSet is sealed.");
}
@@ -104,6 +112,7 @@ public abstract class FilterSet<E extend
*
* @return the import mode.
*/
+ @Nonnull
public ImportMode getImportMode() {
return mode;
}
@@ -112,7 +121,7 @@ public abstract class FilterSet<E extend
* Sets the import mode.
* @param mode import mode
*/
- public void setImportMode(ImportMode mode) {
+ public void setImportMode(@Nonnull ImportMode mode) {
if (sealed) {
throw new UnsupportedOperationException("FilterSet is sealed.");
}
@@ -123,6 +132,7 @@ public abstract class FilterSet<E extend
* Seals this list, i.e. makes it unmodifiable.
* @return this list
*/
+ @Nonnull
public FilterSet seal() {
if (!sealed) {
if (entries == null) {
@@ -148,15 +158,14 @@ public abstract class FilterSet<E extend
* @param set the set of entries
* @return {@code this} suitable for chaining.
*/
- public FilterSet addAll(FilterSet<E> set) {
+ @Nonnull
+ public FilterSet addAll(@Nonnull FilterSet<E> set) {
if (sealed) {
throw new UnsupportedOperationException("FilterSet is sealed.");
}
- if (entries == null) {
- entries = new LinkedList<Entry<E>>(set.entries);
- } else {
- entries.clear();
- entries.addAll(set.entries);
+ entries = null;
+ if (set.entries != null) {
+ entries = new LinkedList<>(set.entries);
}
return this;
}
@@ -166,8 +175,9 @@ public abstract class FilterSet<E extend
* @param filter the filter
* @return {@code this} suitable for chaining.
*/
- public FilterSet addInclude(E filter) {
- addEntry(new Entry<E>(filter, true));
+ @Nonnull
+ public FilterSet addInclude(@Nonnull E filter) {
+ addEntry(new Entry<>(filter, true));
return this;
}
@@ -176,8 +186,9 @@ public abstract class FilterSet<E extend
* @param filter the filter
* @return {@code this} suitable for chaining.
*/
- public FilterSet addExclude(E filter) {
- addEntry(new Entry<E>(filter, false));
+ @Nonnull
+ public FilterSet addExclude(@Nonnull E filter) {
+ addEntry(new Entry<>(filter, false));
return this;
}
@@ -185,12 +196,12 @@ public abstract class FilterSet<E extend
* Internally adds a new entry to the list
* @param e the entry
*/
- private void addEntry(Entry<E> e) {
+ private void addEntry(@Nonnull Entry<E> e) {
if (sealed) {
throw new UnsupportedOperationException("FilterSet is sealed.");
}
if (entries == null) {
- entries = new LinkedList<Entry<E>>();
+ entries = new LinkedList<>();
}
entries.add(e);
}
@@ -199,8 +210,10 @@ public abstract class FilterSet<E extend
* Returns the list of entries
* @return the list of entries
*/
+ @Nonnull
public List<Entry<E>> getEntries() {
seal();
+ //noinspection ConstantConditions
return entries;
}
@@ -219,7 +232,7 @@ public abstract class FilterSet<E extend
* @param path path of the item
* @return {@code true} if this set covers the given item
*/
- public boolean covers(String path) {
+ public boolean covers(@Nonnull String path) {
return path.equals(root) || path.startsWith(rootPattern);
}
@@ -228,15 +241,15 @@ public abstract class FilterSet<E extend
* @param path path of the item to check
* @return {@code true} if the given item is an ancestor
*/
- public boolean isAncestor(String path) {
- return path.equals(root) || root.startsWith(path + "/") || path.equals("/");
+ public boolean isAncestor(@Nonnull String path) {
+ return path.equals(root) || root.startsWith(path + "/") || "/".equals(path);
}
/**
* {@inheritDoc}
*/
@Override
- public void dump(DumpContext ctx, boolean isLast) {
+ public void dump(@Nonnull DumpContext ctx, boolean isLast) {
ctx.printf(false, "root: %s", getRoot());
if (entries != null) {
Iterator<Entry<E>> iter = entries.iterator();
@@ -279,6 +292,7 @@ public abstract class FilterSet<E extend
/**
* The item filter
*/
+ @Nonnull
protected final E filter;
/**
@@ -291,7 +305,7 @@ public abstract class FilterSet<E extend
* @param filter the filter
* @param include the include flag
*/
- public Entry(E filter, boolean include) {
+ public Entry(@Nonnull E filter, boolean include) {
this.filter = filter;
this.include = include;
}
@@ -300,6 +314,7 @@ public abstract class FilterSet<E extend
* Returns the filter of this entry
* @return the filter
*/
+ @Nonnull
public E getFilter() {
return filter;
}
@@ -316,7 +331,7 @@ public abstract class FilterSet<E extend
* {@inheritDoc}
*/
@Override
- public void dump(DumpContext ctx, boolean isLast) {
+ public void dump(@Nonnull DumpContext ctx, boolean isLast) {
if (include) {
ctx.println(isLast, "include");
} else {
Modified: jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/MultiPathMapping.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/MultiPathMapping.java?rev=1822852&r1=1822851&r2=1822852&view=diff
==============================================================================
--- jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/MultiPathMapping.java (original)
+++ jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/MultiPathMapping.java Thu Feb 1 07:54:38 2018
@@ -19,17 +19,20 @@ package org.apache.jackrabbit.vault.fs.a
import java.util.HashMap;
import java.util.Map;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
import org.apache.jackrabbit.vault.util.Text;
/**
- * Implements a path mapping that supports multiple synlinks
+ * Implements a path mapping that supports multiple symlinks
* @since 3.1.10
*/
public class MultiPathMapping implements PathMapping {
- private final Map<String, String> links = new HashMap<String, String>();
+ private final Map<String, String> links = new HashMap<>();
- private final Map<String, String> reverseLinks = new HashMap<String, String>();
+ private final Map<String, String> reverseLinks = new HashMap<>();
/**
* Creates a new link from the path {@code src} to the path {@code dst}
@@ -37,7 +40,7 @@ public class MultiPathMapping implements
* @param dst destination path
* @return this
*/
- public MultiPathMapping link(String src, String dst) {
+ public MultiPathMapping link(@Nonnull String src, @Nonnull String dst) {
links.put(src, dst);
reverseLinks.put(dst, src);
return this;
@@ -48,7 +51,8 @@ public class MultiPathMapping implements
* @param base base mapping
* @return this
*/
- public MultiPathMapping merge(MultiPathMapping base) {
+ @Nonnull
+ public MultiPathMapping merge(@Nullable MultiPathMapping base) {
if (base != null) {
this.links.putAll(base.links);
this.reverseLinks.putAll(base.reverseLinks);
@@ -60,7 +64,8 @@ public class MultiPathMapping implements
* {@inheritDoc}
*/
@Override
- public String map(String path) {
+ @Nonnull
+ public String map(@Nonnull String path) {
return map(path, false);
}
@@ -68,8 +73,9 @@ public class MultiPathMapping implements
* {@inheritDoc}
*/
@Override
- public String map(String path, boolean reverse) {
- if (path == null || path.length() == 0 || "/".equals(path)) {
+ @Nonnull
+ public String map(@Nonnull String path, boolean reverse) {
+ if (path.length() == 0 || "/".equals(path)) {
return path;
}
Map<String, String> lookup = reverse ? reverseLinks : links;
Modified: jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/PathFilter.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/PathFilter.java?rev=1822852&r1=1822851&r2=1822852&view=diff
==============================================================================
--- jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/PathFilter.java (original)
+++ jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/PathFilter.java Thu Feb 1 07:54:38 2018
@@ -17,6 +17,9 @@
package org.apache.jackrabbit.vault.fs.api;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
/**
* The item filter is used to include or exclude a set of paths.
* It is usually part of a {@link PathFilterSet}.
@@ -27,7 +30,7 @@ public interface PathFilter extends Filt
/**
* The "Catch all" item filter.
*/
- public static final PathFilter ALL = new PathFilter() {
+ PathFilter ALL = new PathFilter() {
/**
* Returns always {@code true}
@@ -61,7 +64,7 @@ public interface PathFilter extends Filt
/**
* The "Miss all" item filter.
*/
- public static final PathFilter NONE = new PathFilter() {
+ PathFilter NONE = new PathFilter() {
/**
* Returns always {@code false}
@@ -99,7 +102,7 @@ public interface PathFilter extends Filt
* @return {@code true} if this filter matches the criteria;
* {@code false} otherwise.
*/
- boolean matches(String path);
+ boolean matches(@Nonnull String path);
/**
* Checks if the pattern is absolute, i.e. does not start with a wildcard.
@@ -113,5 +116,6 @@ public interface PathFilter extends Filt
* @return the new filter
* @since 2.4.10
*/
- PathFilter translate(PathMapping mapping);
+ @Nonnull
+ PathFilter translate(@Nullable PathMapping mapping);
}
\ No newline at end of file
Modified: jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/PathFilterSet.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/PathFilterSet.java?rev=1822852&r1=1822851&r2=1822852&view=diff
==============================================================================
--- jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/PathFilterSet.java (original)
+++ jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/PathFilterSet.java Thu Feb 1 07:54:38 2018
@@ -55,6 +55,7 @@ public class PathFilterSet extends Filte
/**
* specifies the filter type.
*/
+ @Nullable
private String type;
/**
@@ -68,7 +69,7 @@ public class PathFilterSet extends Filte
* Creates a new path filter set and sets the respective root path
* @param root path
*/
- public PathFilterSet(String root) {
+ public PathFilterSet(@Nonnull String root) {
super(root);
}
@@ -83,7 +84,7 @@ public class PathFilterSet extends Filte
* @param path the path to check
* @return {@code true} if this set matches the item
*/
- public boolean contains(String path) {
+ public boolean contains(@Nonnull String path) {
if (!covers(path)) {
return false;
}
@@ -102,6 +103,7 @@ public class PathFilterSet extends Filte
}
@Override
+ @Nonnull
public FilterSet seal() {
if (!isSealed()) {
super.seal();
@@ -123,7 +125,8 @@ public class PathFilterSet extends Filte
* @return the new filter
* @since 2.4.10
*/
- public PathFilterSet translate(PathMapping mapping) {
+ @Nonnull
+ public PathFilterSet translate(@Nullable PathMapping mapping) {
if (mapping == null) {
return this;
}
Modified: jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/PathMapping.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/PathMapping.java?rev=1822852&r1=1822851&r2=1822852&view=diff
==============================================================================
--- jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/PathMapping.java (original)
+++ jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/PathMapping.java Thu Feb 1 07:54:38 2018
@@ -16,6 +16,8 @@
*/
package org.apache.jackrabbit.vault.fs.api;
+import javax.annotation.Nonnull;
+
/**
* Provides an interface for a general path mapping.
*
@@ -44,7 +46,8 @@ public interface PathMapping {
* @param path the path
* @return the mapped path.
*/
- String map(String path);
+ @Nonnull
+ String map(@Nonnull String path);
/**
* Maps the given path to a new location.
@@ -52,7 +55,8 @@ public interface PathMapping {
* @param reverse if {@code true} a reverse mapping is applied
* @return the mapped path.
*/
- String map(String path, boolean reverse);
+ @Nonnull
+ String map(@Nonnull String path, boolean reverse);
}
\ No newline at end of file
Modified: jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/RegexpPathMapping.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/RegexpPathMapping.java?rev=1822852&r1=1822851&r2=1822852&view=diff
==============================================================================
--- jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/RegexpPathMapping.java (original)
+++ jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/RegexpPathMapping.java Thu Feb 1 07:54:38 2018
@@ -22,8 +22,6 @@ import java.util.Map.Entry;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
-import org.apache.jackrabbit.vault.fs.api.PathMapping;
-
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
@@ -33,7 +31,8 @@ import javax.annotation.Nullable;
*/
public final class RegexpPathMapping implements PathMapping {
- private final Map<Pattern, String> pathsMapping = new HashMap<Pattern, String>();
+ @Nonnull
+ private final Map<Pattern, String> pathsMapping = new HashMap<>();
/**
* Allows importing mappings specified in data structure such as Map or Properties.
Modified: jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/SimplePathMapping.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/SimplePathMapping.java?rev=1822852&r1=1822851&r2=1822852&view=diff
==============================================================================
--- jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/SimplePathMapping.java (original)
+++ jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/SimplePathMapping.java Thu Feb 1 07:54:38 2018
@@ -16,14 +16,18 @@
*/
package org.apache.jackrabbit.vault.fs.api;
+import javax.annotation.Nonnull;
+
/**
* Implements a simple path mapping that strips and prefixes a path.
* @since 2.4.10
*/
public class SimplePathMapping implements PathMapping {
+ @Nonnull
private final String strip;
+ @Nonnull
private final String root;
/**
@@ -31,7 +35,7 @@ public class SimplePathMapping implement
* @param strip the string to strip from the beginning of the path
* @param root the prefix to add to the path.
*/
- public SimplePathMapping(String strip, String root) {
+ public SimplePathMapping(@Nonnull String strip, @Nonnull String root) {
this.strip = strip;
this.root = root;
}
@@ -40,7 +44,8 @@ public class SimplePathMapping implement
* {@inheritDoc}
*/
@Override
- public String map(String path) {
+ @Nonnull
+ public String map(@Nonnull String path) {
return map(path, false);
}
@@ -48,13 +53,12 @@ public class SimplePathMapping implement
* {@inheritDoc}
*/
@Override
- public String map(String path, boolean reverse) {
+ @Nonnull
+ public String map(@Nonnull String path, boolean reverse) {
String strip = reverse ? this.root : this.strip;
String root = reverse ? this.strip : this.root;
if (path.startsWith(strip)) {
- StringBuilder b = new StringBuilder(root);
- b.append(path.substring(strip.length()));
- return b.toString();
+ return root + path.substring(strip.length());
} else {
return path;
}
Modified: jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/WorkspaceFilter.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/WorkspaceFilter.java?rev=1822852&r1=1822851&r2=1822852&view=diff
==============================================================================
--- jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/WorkspaceFilter.java (original)
+++ jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/WorkspaceFilter.java Thu Feb 1 07:54:38 2018
@@ -20,6 +20,8 @@ package org.apache.jackrabbit.vault.fs.a
import java.io.InputStream;
import java.util.List;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
import javax.jcr.Node;
import javax.jcr.RepositoryException;
import javax.jcr.Session;
@@ -33,12 +35,14 @@ public interface WorkspaceFilter extends
* Returns a list of path filter sets for node items.
* @return the list of path filter sets.
*/
+ @Nonnull
List<PathFilterSet> getFilterSets();
/**
* Returns a list of path filter sets for property items.
* @return the list of path filter sets.
*/
+ @Nonnull
List<PathFilterSet> getPropertyFilterSets();
/**
@@ -46,7 +50,8 @@ public interface WorkspaceFilter extends
* @param path the path
* @return the filter set or {@code null}
*/
- PathFilterSet getCoveringFilterSet(String path);
+ @Nullable
+ PathFilterSet getCoveringFilterSet(@Nonnull String path);
/**
* Returns the import mode for the given node path.
@@ -54,7 +59,8 @@ public interface WorkspaceFilter extends
* @return the import mode or {@link ImportMode#REPLACE} if the given path
* is not covered by this filter.
*/
- ImportMode getImportMode(String path);
+ @Nonnull
+ ImportMode getImportMode(@Nonnull String path);
/**
* Checks if the given node path is contained in this workspace filter.
@@ -64,7 +70,7 @@ public interface WorkspaceFilter extends
* @param path to check
* @return {@code true} if the given path is included in this filter.
*/
- boolean contains(String path);
+ boolean contains(@Nonnull String path);
/**
* Checks if the given node path is covered in this workspace filter.
@@ -74,7 +80,7 @@ public interface WorkspaceFilter extends
* @param path the pathto check
* @return {@code true} if the given path is covered by this filter.
*/
- boolean covers(String path);
+ boolean covers(@Nonnull String path);
/**
* Checks if the given node path is an ancestor of any of the filter sets.
@@ -82,7 +88,7 @@ public interface WorkspaceFilter extends
* @param path the item to check
* @return {@code true} if the given item is an ancestor
*/
- boolean isAncestor(String path);
+ boolean isAncestor(@Nonnull String path);
/**
* Checks if the given node path is globally ignored.
@@ -90,18 +96,20 @@ public interface WorkspaceFilter extends
* @param path the path to check.
* @return {@code true} if the item is globally ignored.
*/
- boolean isGloballyIgnored(String path);
+ boolean isGloballyIgnored(@Nonnull String path);
/**
* Returns the source xml that constructs this filter
* @return the source xml
*/
+ @Nonnull
InputStream getSource();
/**
* Returns the source xml that constructs this filter
* @return the source xml
*/
+ @Nonnull
String getSourceAsString();
/**
@@ -111,7 +119,8 @@ public interface WorkspaceFilter extends
* @return a new workspace filter
* @since 2.4.10
*/
- WorkspaceFilter translate(PathMapping mapping);
+ @Nonnull
+ WorkspaceFilter translate(@Nullable PathMapping mapping);
/**
* Dumps the coverage of this filter against the given node to the listener.
@@ -119,7 +128,7 @@ public interface WorkspaceFilter extends
* @param listener listener
* @throws RepositoryException if an error occurs
*/
- void dumpCoverage(Node rootNode, ProgressTrackerListener listener)
+ void dumpCoverage(@Nonnull Node rootNode, @Nonnull ProgressTrackerListener listener)
throws RepositoryException;
/**
@@ -132,6 +141,6 @@ public interface WorkspaceFilter extends
* @param skipJcrContent {@code true} to skip jcr:content nodes
* @throws RepositoryException if an error occurs
*/
- void dumpCoverage(Session session, ProgressTrackerListener listener, boolean skipJcrContent)
+ void dumpCoverage(@Nonnull Session session, @Nonnull ProgressTrackerListener listener, boolean skipJcrContent)
throws RepositoryException;
}
\ No newline at end of file
Modified: jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/package-info.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/package-info.java?rev=1822852&r1=1822851&r2=1822852&view=diff
==============================================================================
--- jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/package-info.java (original)
+++ jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/fs/api/package-info.java Thu Feb 1 07:54:38 2018
@@ -15,7 +15,7 @@
* limitations under the License.
*/
-@Version("2.6.0")
+@Version("2.6.1")
package org.apache.jackrabbit.vault.fs.api;
import org.osgi.annotation.versioning.Version;
\ No newline at end of file