net.adamcin.granite.client.packman

Class WspFilter

java.lang.Object

net.adamcin.granite.client.packman.WspFilter

All Implemented Interfaces:

Serializable

public final class WspFilter
extends Object
implements Serializable

A simpler representation of a workspace filter with fewer API encumbrances. Can be easily converted to/from JSON and simple spec formats, as well as from a full WorkspaceFilter implementation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WspFilter.Root
static class	WspFilter.Rule

Constructor Summary

Constructors

Constructor and Description
WspFilter(List<WspFilter.Root> roots)
WspFilter(WspFilter.Root... roots)

Method Summary

Modifier and Type	Method and Description
static WspFilter.Root	adaptFilterSet(org.apache.jackrabbit.vault.fs.api.PathFilterSet filterSet)
static WspFilter	adaptWorkspaceFilter(org.apache.jackrabbit.vault.fs.api.WorkspaceFilter filter)
boolean	equals(Object o)
List<WspFilter.Root>	getRoots()
int	hashCode()
static WspFilter	parseSimpleSpec(String text) Simple spec is defined simply as a line-by-line format where: 1.
String	toJSONString()
String	toJSONString(int indentLevel)
String	toSpec()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WspFilter

public WspFilter(WspFilter.Root... roots)

WspFilter

public WspFilter(List<WspFilter.Root> roots)

Method Detail

getRoots

public List<WspFilter.Root> getRoots()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toSpec

public String toSpec()

toJSONString

public String toJSONString()
                    throws org.json.JSONException

Throws:

org.json.JSONException

toJSONString

public String toJSONString(int indentLevel)
                    throws org.json.JSONException

Throws:

org.json.JSONException

parseSimpleSpec

public static WspFilter parseSimpleSpec(String text)

Simple spec is defined simply as a line-by-line format where: 1. each line consists of significant text before an optional comment character (#) 2. each line that begins with a "/" begins a new filter root. 2.5. the first non-empty, non-comment line must define a new filter root 3. each non-empty, non-comment line after a filter root that begins with a "+" or "-" defines an include or exclude rule, respectively.

Parameters:

text - raw text

Returns:

a constructed WspFilter or null if parsing failed

adaptWorkspaceFilter

public static WspFilter adaptWorkspaceFilter(org.apache.jackrabbit.vault.fs.api.WorkspaceFilter filter)

adaptFilterSet

public static WspFilter.Root adaptFilterSet(org.apache.jackrabbit.vault.fs.api.PathFilterSet filterSet)