Page.Builder (sonar-plugin-api 7.9.2)

java.lang.Object
- org.sonar.api.web.page.Page.Builder

Enclosing class:: Page

public static class Page.Builder
extends java.lang.Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Page`	`build()`
`Page.Builder`	`setAdmin(boolean admin)`	if set to true, display the page in the administration section, depending on the scope
`Page.Builder`	`setComponentQualifiers(Page.Qualifier... qualifiers)`	Define the components where the page is displayed.
`Page.Builder`	`setName(java.lang.String name)`	Page name displayed in the UI.
`Page.Builder`	`setScope(Page.Scope scope)`	Define where the page is displayed, either in the global menu or in a component page

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

- Method Detail
  - setName
```
public Page.Builder setName(java.lang.String name)
```
    Page name displayed in the UI. Mandatory.
  - setAdmin
```
public Page.Builder setAdmin(boolean admin)
```
    if set to true, display the page in the administration section, depending on the scope
  - setScope
```
public Page.Builder setScope(Page.Scope scope)
```
    Define where the page is displayed, either in the global menu or in a component page
    
    Parameters:
    
    scope - - default is GLOBAL
  - setComponentQualifiers
```
public Page.Builder setComponentQualifiers(Page.Qualifier... qualifiers)
```
    Define the components where the page is displayed. If set, setScope(Scope) must be set to COMPONENT
    
    See Also:
    
    Page.Qualifier
  - build
```
public Page build()
```