uPortal 2.4.1
API Documentation

org.jasig.portal.car
Class Path

java.lang.Object
  extended byorg.jasig.portal.car.Path

public class Path
extends java.lang.Object

Holds onto a set of String path elements to assist with tracking where in an XML structure SAX processing is currently working. So an XML structure like the following would have a path of "", "", "" when SAX processing issued a startElement event call for the "more" element. <top> <next> <more> ... Use the fromXML method to create from a more visually symbolic view of what the path represents.


Field Summary
static java.lang.String RCS_ID
           
 
Constructor Summary
Path()
          Create a new empty path.
 
Method Summary
 Path append(java.lang.String item)
          Add an item to the path.
 boolean equals(java.lang.Object o)
          Returns true if the passed in object is a path with the same number of path items and all strings in the two paths are equal.
static Path fromTag(java.lang.String tagName)
           
static Path fromXML(java.lang.String xmlPath)
          Creates a Path from the XML structured snippet.
 java.lang.String removeLast()
          Remove the last item off of the path.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

RCS_ID

public static final java.lang.String RCS_ID
See Also:
Constant Field Values
Constructor Detail

Path

public Path()
Create a new empty path.

Method Detail

fromTag

public static Path fromTag(java.lang.String tagName)

fromXML

public static Path fromXML(java.lang.String xmlPath)
Creates a Path from the XML structured snippet. The following call would create a path that contained "top", "next", and "more" in that order.


append

public Path append(java.lang.String item)
Add an item to the path.


removeLast

public java.lang.String removeLast()
Remove the last item off of the path.


equals

public boolean equals(java.lang.Object o)
Returns true if the passed in object is a path with the same number of path items and all strings in the two paths are equal.


toString

public java.lang.String toString()

uPortal 2.4.1
API Documentation