Module com.aoapps.net.pathspace

Package com.aoapps.net.pathspace

Class Prefix

java.lang.Object

com.aoapps.net.pathspace.Prefix

All Implemented Interfaces:

Serializable, Comparable<Prefix>

public final class Prefix
extends Object
implements Comparable<Prefix>, Serializable

Path prefix for wildcard matching support.

Author:

AO Industries, Inc.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Prefix.MultiLevelType	The set of supported multi-level nesting types.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GREEDY_SUFFIX	See Prefix.MultiLevelType.GREEDY.
static final String	UNBOUNDED_SUFFIX	See Prefix.MultiLevelType.UNBOUNDED.
static final char	WILDCARD_CHAR	The character used for wildcards.
static final String	WILDCARD_SUFFIX	See Path.SEPARATOR_STRING, WILDCARD_CHAR.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Prefix other)	The natural ordering is such that an iterative call to matches(com.aoapps.net.Path) will return.
boolean	conflictsWith(Prefix other)	Checks if two prefixes are conflicting.
boolean	equals(Object obj)
Path	getBase()	Gets the base of this path space.
Prefix.MultiLevelType	getMultiLevelType()	Gets the multi-level type attached to the base and any wildcard levels.
int	getWildcards()	Gets the number of wildcard levels attached to the base.
int	hashCode()
int	matches(Path path)	Checks if a given path matches this prefix.
String	toString()	Gets the unambiguous string representation of this prefix.
static Prefix	valueOf(Path base, int wildcards, Prefix.MultiLevelType multiLevelType)	Gets an instance of a prefix given the individual fields.
static Prefix	valueOf(String prefix)	Parses the unambiguous string representation of a prefix.

Methods inherited from class java.lang.Object

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

Field Details

WILDCARD_CHAR

public static final char WILDCARD_CHAR

The character used for wildcards.

See Also:

• Constant Field Values

WILDCARD_SUFFIX

public static final String WILDCARD_SUFFIX

See Path.SEPARATOR_STRING, WILDCARD_CHAR.

UNBOUNDED_SUFFIX

public static final String UNBOUNDED_SUFFIX

See Prefix.MultiLevelType.UNBOUNDED.

GREEDY_SUFFIX

public static final String GREEDY_SUFFIX

See Prefix.MultiLevelType.GREEDY.

Method Details

valueOf

public static Prefix valueOf(Path base,
 int wildcards,
 Prefix.MultiLevelType multiLevelType)

Gets an instance of a prefix given the individual fields.

Parameters:

base - May not be null. May not end in "/" unless it is the root "/". May not end in "/*", "/**", or "/***". May not contain "/*/", "/**/", or "/***/" to avoid any expectations of infix matching, which is not supported.

wildcards - Must be >= 0. Must be >= 1 when multiLevelType is Prefix.MultiLevelType.NONE

multiLevelType - May not be null

See Also:

• valueOf(java.lang.String)

valueOf

public static Prefix valueOf(String prefix)

Parses the unambiguous string representation of a prefix.

This is the inverse function of toString().

Parameters:

prefix - The prefix to parse. Must adhere to all rules of valueOf(com.aoapps.net.Path, int, com.aoapps.net.pathspace.Prefix.MultiLevelType)

See Also:

• toString()
• valueOf(com.aoapps.net.Path, int, com.aoapps.net.pathspace.Prefix.MultiLevelType)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Gets the unambiguous string representation of this prefix.

This is the inverse function of valueOf(java.lang.String).

Overrides:

toString in class Object

See Also:

• Prefix.MultiLevelType.getSuffix()
• valueOf(java.lang.String)

compareTo

public int compareTo(Prefix other)

The natural ordering is such that an iterative call to matches(com.aoapps.net.Path) will return. true on the most specific matching space. This match is consistent with PathSpace.get(com.aoapps.net.Path).

This ordering is useful for human review, as it represents the path space conceptually in a top-to-bottom list.

The implementation of TODO: Link findSpace, should be much faster than an iterative search, however.

TODO: There are no ordering guarantees between prefixes that conflict with one another?

Specified by:

compareTo in interface Comparable<Prefix>

See Also:

• conflictsWith(com.aoapps.net.pathspace.Prefix)
• matches(com.aoapps.net.Path)

getBase

public Path getBase()

Gets the base of this path space. This does not include any trailing wildcard or multi-level suffixes. This will not end in a slash (/) unless this is the root "/" (Path.ROOT) itself.

getWildcards

public int getWildcards()

Gets the number of wildcard levels attached to the base. This will be at least one when getMultiLevelType() is Prefix.MultiLevelType.NONE. Otherwise, may also be zero.

getMultiLevelType

public Prefix.MultiLevelType getMultiLevelType()

Gets the multi-level type attached to the base and any wildcard levels.

conflictsWith

public boolean conflictsWith(Prefix other)

Checks if two prefixes are conflicting. Conflicts include either occupying the same space or a subspace of another greedy space, with all wildcards considered.

matches

public int matches(Path path)

Checks if a given path matches this prefix.

Returns:

the number of characters in the path that match the prefix or -1 for no match. When matches the root, returns 0.