UserResourceReference (XWiki Rendering - Api 15.2 API)

java.lang.Object
- org.xwiki.rendering.listener.reference.ResourceReference
- - org.xwiki.rendering.listener.reference.UserResourceReference

All Implemented Interfaces:

Cloneable
```
public class UserResourceReference
extends ResourceReference
```
Represents a reference to a User.

Since:

5.3M2

Version:

$Id: 0d56f51f1407ce04cad3450cbb8674d741b2782c $

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ANCHOR`	The name of the parameter representing the Anchor.
`static String`	`QUERY_STRING`	The name of the parameter representing the Query String.

Constructor Summary

Constructors
Constructor Description

UserResourceReference(String reference)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getAnchor()`
`String`	`getQueryString()`
`void`	`setAnchor(String anchor)`
`void`	`setQueryString(String queryString)`

Methods inherited from class org.xwiki.rendering.listener.reference.ResourceReference
addBaseReference, addBaseReferences, clone, equals, getBaseReferences, getParameter, getParameters, getReference, getType, hashCode, isTyped, removeParameter, setParameter, setParameters, setReference, setType, setTyped, toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - QUERY_STRING
```
public static final String QUERY_STRING
```
    The name of the parameter representing the Query String.
    
    See Also:
    
    Constant Field Values
  - ANCHOR
```
public static final String ANCHOR
```
    The name of the parameter representing the Anchor.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UserResourceReference
```
public UserResourceReference(String reference)
```
    Parameters:
    
    reference - see ResourceReference.getReference()
- Method Detail
  - getQueryString
```
public String getQueryString()
```
    Returns:
    
    the query string for specifying parameters that will be used in the rendered URL or null if no query string has been specified. Example: mydata1=5&mydata2=Hello
  - setQueryString
```
public void setQueryString(String queryString)
```
    Parameters:
    
    queryString - see getQueryString()
  - getAnchor
```
public String getAnchor()
```
    Returns:
    
    the anchor name pointing to an anchor defined in the referenced user profile or null if no anchor has been specified (in which case the reference points to the top of the user profile). Note that in XWiki anchors are automatically created for titles. Example: "TableOfContentAnchor"
  - setAnchor
```
public void setAnchor(String anchor)
```
    Parameters:
    
    anchor - see getAnchor()