org.apache.commons.xmlio.in
Class SimplePath

java.lang.Object
  org.apache.commons.xmlio.in.SimplePath

public class SimplePath

extends java.lang.Object

Rudimentary representation of a path to an XML element.
Two paths match in two cases:

1. If they are really equal in terms of the equals(java.lang.Object) method.
2. If the path to match to is relative, i.e. it has no leading '/' and it is the suffix of the matching path.

For example
/root/tag matches /root/tag and
/root/tag matches tag.

Field Summary

protected java.lang.String	path
protected Item[]	pathList

Constructor Summary

SimplePath(SimplePath path)
Copy ctor.

SimplePath(java.lang.String path)
Creates a path object from a string describing it.

SimplePath(java.lang.String path, Item[] pathList)
Creates a path object from a string describing it.

Method Summary

boolean	equals(java.lang.Object o)
boolean	matches(Item name) Checks if an item matches the last segment of this path.
boolean	matches(Item[] path) Checks if the given array of items matches this path.
boolean	matches(Item[] path, boolean isRelative) Checks if the given array of items matches this path.
boolean	matches(SimplePath matchPath) Finds out if the the given path matches this one.
boolean	matches(java.lang.String matchPath) Finds out if the path represented by the given string matches this one.
boolean	matchesFromRoot(Item[] path) Checks if the given array of items matches this path from the root.
boolean	matchsAny(java.util.Collection paths) Checks if this path matches any of the paths stored in paths collection.
boolean	matchsAny(java.lang.String[] paths) Checks if this path matches any of the paths stored in paths collection.
static java.lang.String	stripEndingSlash(java.lang.String path) Strips off ending slash from a string if there is one.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

path

protected final java.lang.String path

pathList

protected final Item[] pathList

Constructor Detail

SimplePath

public SimplePath(java.lang.String path)

Creates a path object from a string describing it. The describing string uses '/' characters to seperate the paths parts.

SimplePath

public SimplePath(java.lang.String path,
                  Item[] pathList)

Creates a path object from a string describing it. The describing string uses '/' characters to seperate the paths parts.

SimplePath

public SimplePath(SimplePath path)

Copy ctor.

Method Detail

stripEndingSlash

public static final java.lang.String stripEndingSlash(java.lang.String path)

Strips off ending slash from a string if there is one.

matches

public boolean matches(Item name)

Checks if an item matches the last segment of this path.

matches

public boolean matches(Item[] path,
                       boolean isRelative)

Checks if the given array of items matches this path.

matchesFromRoot

public boolean matchesFromRoot(Item[] path)

Checks if the given array of items matches this path from the root. The given path is to be considered relative. Useful to distinguish between something like /rootPath/valid/*\/valid and /rootPath/invalid/*\/valid. You will need two matches for this:

 matchesFromRoot(new Item[] { new Item("rootPath"), new Item("valid")}) 
 &&
 matches(new Item("valid"))
 

matches

public boolean matches(Item[] path)

Checks if the given array of items matches this path. The given path is to be considered relative.

matches

public boolean matches(SimplePath matchPath)

Finds out if the the given path matches this one.

matches

public boolean matches(java.lang.String matchPath)

Finds out if the path represented by the given string matches this one.

See Also:

matches(SimplePath)

matchsAny

public boolean matchsAny(java.util.Collection paths)

Checks if this path matches any of the paths stored in paths collection. This means we iterate through paths and match every entry to this path.

matchsAny

public boolean matchsAny(java.lang.String[] paths)

Checks if this path matches any of the paths stored in paths collection. This means we iterate through paths and match every entry to this path.

toString

public java.lang.String toString()

equals

public boolean equals(java.lang.Object o)