java.lang.Object
- com.runemate.game.api.hybrid.queries.QueryBuilder<WorldOverview,WorldQueryBuilder,WorldQueryResults>
- - com.runemate.game.api.hybrid.queries.WorldQueryBuilder

All Implemented Interfaces:: java.lang.Cloneable

public class WorldQueryBuilder
extends QueryBuilder<WorldOverview,WorldQueryBuilder,WorldQueryResults>

Constructor Summary

Constructors
Constructor Description

WorldQueryBuilder()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`accepts(WorldOverview overview)`	Checks if the current builder accepts the argument
`WorldQueryBuilder`	`activity(java.lang.String... activity)`
`WorldQueryBuilder`	`activity(java.util.List<java.lang.String> activity)`
`WorldQueryBuilder`	`castleWars(boolean include)`	Deprecated. see `include(WorldType...)` and `exclude(WorldType...)`.
`WorldQueryBuilder`	`deadman(boolean include)`	Deprecated. see `include(WorldType...)` and `exclude(WorldType...)`.
`WorldQueryBuilder`	`exclude(WorldType... types)`	Will exclude worlds containing any of the provided WorldTypes.
`WorldQueryBuilder`	`exclude(java.util.EnumSet<WorldType> types)`	Will exclude worlds containing any of the provided WorldTypes.
`WorldQueryBuilder`	`free()`	Only include F2P worlds
`WorldQueryBuilder`	`get()`	Gets a reference to this with the correct type
`java.util.concurrent.Callable<java.util.List<? extends WorldOverview>>`	`getDefaultProvider()`	Gets the default provider of the unfiltered data entries.
`WorldQueryBuilder`	`include(WorldType... types)`	Will include worlds containing any of the provided WorldTypes.
`WorldQueryBuilder`	`include(java.util.EnumSet<WorldType> types)`	Will include worlds containing any of the provided WorldTypes.
`WorldQueryBuilder`	`lastManStanding(boolean include)`	Deprecated. see `include(WorldType...)` and `exclude(WorldType...)`.
`WorldQueryBuilder`	`lootshare(boolean on)`	Deprecated. RS3-only
`WorldQueryBuilder`	`maxPopulation(int max)`
`WorldQueryBuilder`	`member()`	Only include P2P worlds
`WorldQueryBuilder`	`minPopulation(int min)`
`WorldQueryBuilder`	`pvp(boolean include)`	Deprecated. see `include(WorldType...)` and `exclude(WorldType...)`.
`WorldQueryBuilder`	`pvpArena(boolean include)`	Deprecated. see `include(WorldType...)` and `exclude(WorldType...)`.
`WorldQueryBuilder`	`quickChat(boolean on)`	Deprecated. RS3-only
`WorldQueryBuilder`	`region(WorldRegion region)`
`WorldQueryBuilder`	`regular()`	Only include worlds using the accounts permanent primary profile, and excluding any PVP/deadman/seasonal worlds.
`WorldQueryBuilder`	`selectable(boolean selectable)`	Deprecated.
`WorldQueryBuilder`	`speedrunning(boolean include)`	Deprecated. see `include(WorldType...)` and `exclude(WorldType...)`.
`WorldQueryBuilder`	`tournament(boolean include)`	Deprecated. see `include(WorldType...)` and `exclude(WorldType...)`.

Methods inherited from class com.runemate.game.api.hybrid.queries.QueryBuilder
clone, filter, getCache, provider, results, setCache

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

- Constructor Detail
  - WorldQueryBuilder
```
public WorldQueryBuilder()
```
- Method Detail
  - activity
```
public WorldQueryBuilder activity(java.lang.String... activity)
```
  - activity
```
public WorldQueryBuilder activity(java.util.List<java.lang.String> activity)
```
  - include
```
public WorldQueryBuilder include(WorldType... types)
```
    Will include worlds containing any of the provided WorldTypes.
  - include
```
public WorldQueryBuilder include(java.util.EnumSet<WorldType> types)
```
    Will include worlds containing any of the provided WorldTypes.
  - exclude
```
public WorldQueryBuilder exclude(WorldType... types)
```
    Will exclude worlds containing any of the provided WorldTypes.
  - exclude
```
public WorldQueryBuilder exclude(java.util.EnumSet<WorldType> types)
```
    Will exclude worlds containing any of the provided WorldTypes.
  - member
```
public WorldQueryBuilder member()
```
    Only include P2P worlds
    default: F2P & P2P
  - free
```
public WorldQueryBuilder free()
```
    Only include F2P worlds
    default: F2P & P2P
  - regular
```
public WorldQueryBuilder regular()
```
    Only include worlds using the accounts permanent primary profile, and excluding any PVP/deadman/seasonal worlds.
  - region
```
public WorldQueryBuilder region(WorldRegion region)
```
  - minPopulation
```
public WorldQueryBuilder minPopulation(int min)
```
  - maxPopulation
```
public WorldQueryBuilder maxPopulation(int max)
```
  - get
```
public WorldQueryBuilder get()
```
    Description copied from class: QueryBuilder
    
    Gets a reference to this with the correct type
    
    Specified by:
    
    get in class QueryBuilder<WorldOverview,WorldQueryBuilder,WorldQueryResults>
  - getDefaultProvider
```
public java.util.concurrent.Callable<java.util.List<? extends WorldOverview>> getDefaultProvider()
```
    Description copied from class: QueryBuilder
    
    Gets the default provider of the unfiltered data entries. Must be thread-safe.
    
    Specified by:
    
    getDefaultProvider in class QueryBuilder<WorldOverview,WorldQueryBuilder,WorldQueryResults>
    
    Returns:
    
    A non-null Callable provider that is used by default.
  - accepts
```
public boolean accepts(WorldOverview overview)
```
    Description copied from class: QueryBuilder
    
    Checks if the current builder accepts the argument
    
    Overrides:
    
    accepts in class QueryBuilder<WorldOverview,WorldQueryBuilder,WorldQueryResults>
    
    Parameters:
    
    overview - The argument to be tested against the built query.
    
    Returns:
    
    true if the provided argument is accepted by the built query.
  - tournament
```
@Deprecated
public WorldQueryBuilder tournament(boolean include)
```
    Deprecated.
    see include(WorldType...) and exclude(WorldType...).
    
    Whether to include tournament worlds.
    default: false
  - castleWars
```
@Deprecated
public WorldQueryBuilder castleWars(boolean include)
```
    Deprecated.
    see include(WorldType...) and exclude(WorldType...).
    
    Whether to include tournament worlds.
    default: either
  - deadman
```
@Deprecated
public WorldQueryBuilder deadman(boolean include)
```
    Deprecated.
    see include(WorldType...) and exclude(WorldType...).
    
    Whether to include deadman worlds.
    default: false
  - lastManStanding
```
@Deprecated
public WorldQueryBuilder lastManStanding(boolean include)
```
    Deprecated.
    see include(WorldType...) and exclude(WorldType...).
    
    Whether to include LMS worlds.
    default: either
  - pvp
```
@Deprecated
public WorldQueryBuilder pvp(boolean include)
```
    Deprecated.
    see include(WorldType...) and exclude(WorldType...).
    
    Whether to include PVP worlds.
    default: false
  - pvpArena
```
@Deprecated
public WorldQueryBuilder pvpArena(boolean include)
```
    Deprecated.
    see include(WorldType...) and exclude(WorldType...).
    
    Whether to include PVP-Arena worlds.
    default: false
  - speedrunning
```
@Deprecated
public WorldQueryBuilder speedrunning(boolean include)
```
    Deprecated.
    see include(WorldType...) and exclude(WorldType...).
    
    Whether to include Speedrunning worlds.
    default: false
  - selectable
```
@Deprecated
public WorldQueryBuilder selectable(boolean selectable)
```
    Deprecated.
  - quickChat
```
@RS3Only
@Deprecated
public WorldQueryBuilder quickChat(boolean on)
```
    Deprecated.
    RS3-only
  - lootshare
```
@RS3Only
@Deprecated
public WorldQueryBuilder lootshare(boolean on)
```
    Deprecated.
    RS3-only

Class WorldQueryBuilder

Constructor Summary

Method Summary

Methods inherited from class com.runemate.game.api.hybrid.queries.QueryBuilder

Methods inherited from class java.lang.Object

Constructor Detail

WorldQueryBuilder

Method Detail

activity

activity

include

include

exclude

exclude

member

free

regular

region

minPopulation

maxPopulation

get

getDefaultProvider

accepts

tournament

castleWars

deadman

lastManStanding

pvp

pvpArena

speedrunning

selectable

quickChat

lootshare