co.codewizards.cloudstore.core.ignore

Interface IgnoreRule

All Known Implementing Classes:

IgnoreRuleImpl

public interface IgnoreRule

An IgnoreRule specifies when to ignore a file.

If a file matches an IgnoreRule, this file is not touched by CloudStore at all. It is neither synchronised to a remote location nor is it deleted or otherwise treated.

There are 2 ways to declare an ignore-rule:

One is using a simple (shell-like) pattern on the name like "*.bak", for example. There are only the wild-cards '*' and '?' supported having the usual meaning:

• '*' matches 0 or more arbitrary characters.
• '?' matches exactly one arbitrary character.

The simple pattern is specified as namePattern.

The other one is using a regular expression. If the property nameRegex is specified, the namePattern is ignored.

Author:

Marco หงุ่ยตระกูล-Schulze - marco at codewizards dot co

Method Summary

Modifier and Type	Method and Description
String	getIgnoreRuleId()
String	getNamePattern() Gets a shell-style name-pattern or null.
String	getNameRegex() Gets a regular expression or null.
Pattern	getNameRegexPattern() Gets a regular-expression-Pattern compiled from nameRegex or namePattern.
boolean	isCaseSensitive()
boolean	isEnabled()
void	setCaseSensitive(boolean caseSensitive)
void	setEnabled(boolean enabled)
void	setIgnoreRuleId(String ignoreRuleId)
void	setNamePattern(String namePattern)
void	setNameRegex(String nameRegex)

Method Detail

getIgnoreRuleId

String getIgnoreRuleId()

setIgnoreRuleId

void setIgnoreRuleId(String ignoreRuleId)

getNamePattern

String getNamePattern()

Gets a shell-style name-pattern or null.

An ignore-rule may be specified using shell-patterns like "*.jpg" or "*.b?k". They are implicitly converted to regular expressions.

This name-pattern is checked against the file's name without path as returned by File.getName() (e.g. "image_938732.jpg").

If both, a regular expression and a shell-pattern are specified, the regular expression is used and this pattern ignored.

Returns:

a shell-style name-pattern or null.

See Also:

getNameRegex()

setNamePattern

void setNamePattern(String namePattern)

getNameRegex

String getNameRegex()

Gets a regular expression or null.

This regular expression must match the entire file name (without path) - not only be contained in it. For example the regular expression "tree\.jpg" matches only the file "tree.jpg" and not the file "large_tree.jpg".

This name-regex is checked against the file's name without path as returned by File.getName() (e.g. "image_938732.jpg").

Returns:

a regular expression or null.

See Also:

getNamePattern()

setNameRegex

void setNameRegex(String nameRegex)

isEnabled

boolean isEnabled()

setEnabled

void setEnabled(boolean enabled)

isCaseSensitive

boolean isCaseSensitive()

setCaseSensitive

void setCaseSensitive(boolean caseSensitive)

getNameRegexPattern

Pattern getNameRegexPattern()

Gets a regular-expression-Pattern compiled from nameRegex or namePattern. If nameRegex is specified, it overrules namePattern, i.e. namePattern is used only, if nameRegex == null.

Returns:

a regular-expression-Pattern compiled from nameRegex or namePattern. null, if both nameRegex and namePattern are null.