doc.com.rallydev.rest.util.Ref.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rally-rest-api Show documentation

A java toolkit for interacting with the Rally Rest API

There is a newer version: 2.2.1






Ref (Rally Rest API for Java 2.1)













Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.rallydev.rest.util
Class Ref



java.lang.Object


com.rallydev.rest.util.Ref









public class Ref
extends Object
Provides utility methods for working with ref URLs.











Constructor Summary

Constructors 

Constructor and Description


Ref() 









Method Summary

Methods 

Modifier and Type
Method and Description


static String
getOidFromRef(String ref)
Get the ObjectID from the specified ref url



static String
getRelativeRef(String ref)
Create a relative ref url from the specified ref



static String
getTypeFromRef(String ref)
Get the type from the specified ref url



static boolean
isRef(String ref)
Determine whether the specified string is a valid ref url.







Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Ref
public Ref()









Method Detail





isRef
public static boolean isRef(String ref)
Determine whether the specified string is a valid ref url.
Parameters:
ref - the string to be tested.  May be either absolute or relative, e.g. /defect/1234
Returns:
whether the specified string is a valid ref url







getRelativeRef
public static String getRelativeRef(String ref)
Create a relative ref url from the specified ref
Parameters:
ref - the ref url to be made relative
Returns:
the relative ref url or null if the specified ref was not valid







getTypeFromRef
public static String getTypeFromRef(String ref)
Get the type from the specified ref url
Parameters:
ref - the ref url to extract the type from
Returns:
the extracted type or null if the specified ref was not valid







getOidFromRef
public static String getOidFromRef(String ref)
Get the ObjectID from the specified ref url
Parameters:
ref - the ref url to extract the ObjectID from
Returns:
the extracted ObjectID or null if the specified ref was not valid
















Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method

Modifier and Type	Method and Description
`static String`	`getOidFromRef(String ref)` Get the ObjectID from the specified ref url
`static String`	`getRelativeRef(String ref)` Create a relative ref url from the specified ref
`static String`	`getTypeFromRef(String ref)` Get the type from the specified ref url
`static boolean`	`isRef(String ref)` Determine whether the specified string is a valid ref url.