Package VASSAL.tools

Class ComponentPathBuilder

java.lang.Object

VASSAL.tools.ComponentPathBuilder

public class ComponentPathBuilder
extends Object

Provides an XPath-like syntax for identifying configuration components

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ComponentPathBuilder.PathFormatException

Constructor Summary

Constructors

Constructor	Description
ComponentPathBuilder()

Method Summary

Modifier and Type	Method	Description
String	getId(Configurable[] targetPath)	Return a string identifying the specified Configurable components as a path through the configuration parent-child hierarchy.
static ComponentPathBuilder	getInstance()
Configurable[]	getPath(String id)	Return a list of Configurable components specified by the given identifier.

Methods inherited from class java.lang.Object

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

Constructor Details

ComponentPathBuilder

public ComponentPathBuilder()

Method Details

getInstance

public static ComponentPathBuilder getInstance()

getId

public String getId(Configurable[] targetPath)

Return a string identifying the specified Configurable components as a path through the configuration parent-child hierarchy.

Parameters:

targetPath - configurable path

Returns:

string path

getPath

public Configurable[] getPath(String id)
                       throws ComponentPathBuilder.PathFormatException

Return a list of Configurable components specified by the given identifier.

Parameters:

id - identifier

Returns:

list of components

Throws:

ComponentPathBuilder.PathFormatException - if no such component exists