Package org.kohsuke.stapler

Interface Ancestor

public interface Ancestor
Information about ancestor of the "it" node.
Author:
Kohsuke Kawaguchi

  • Method Details

    • getObject

      Object getObject()
      Gets the model object of the application.

    • getUrl

      String getUrl()
      Gets the URL to this ancestor.

      The returned string represents the portion of the request URL that matches this object. It starts with context path, and it ends without '/'. So, for example, if your web app is deployed as "mywebapp" and this ancestor object is obtained from the app root object by getFoo().getBar(3), then this string will be /mywebapp/foo/bar/3

      Any ASCII-unsafe characters are escaped.

      Returns:
      never null.

    • getRestOfUrl

      String getRestOfUrl()
      Gets the remaining URL after this ancestor.

      The returned string represents the portion of the request URL that follows this ancestor. It starts and ends without '/'. So, for example, if the request URL is "foo/bar/3" and this ancestor object is obtained from the app root object by getFoo(), then this string will be bar/3

    • getNextToken

      String getNextToken(int n)
      Of the tokens that constitute getRestOfUrl(), return the n-th token. So in the example described in getRestOfUrl(), getNextToken(0).equals("bar") and getNextToken(1).equals("3")

    • getFullUrl

      String getFullUrl()
      Gets the complete URL to this ancestor.

      This method works like getUrl() except it contains the host name and the port number.

    • getRelativePath

      String getRelativePath()
      Gets the relative path from the current object to this ancestor.

      The returned string looks like "../.." (ends without '/')

      Returns:
      never null.

    • getPrev

      Ancestor getPrev()
      Gets the previous ancestor, or null if none (meaning this is the root object.)

    • getNext

      Ancestor getNext()
      Gets the next ancestor, or null if none (meaning this is the 'it' object.