com.comphenix.protocol.events

Class ListeningWhitelist.Builder

java.lang.Object

com.comphenix.protocol.events.ListeningWhitelist.Builder

Enclosing class:

ListeningWhitelist

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

Represents a builder of whitelists.

Author:

Kristian

Method Summary

Methods

Modifier and Type	Method and Description
ListeningWhitelist	build() Construct a new whitelist from the values in this builder.
ListeningWhitelist.Builder	gamePhase(GamePhase gamePhase) Set the gamephase to use when constructing new whitelists.
ListeningWhitelist.Builder	gamePhaseBoth() Set the gamephase to GamePhase.BOTH.
ListeningWhitelist.Builder	high() Set the priority of the whitelist to high.
ListeningWhitelist.Builder	highest() Set the priority of the whitelist to highest.
ListeningWhitelist.Builder	low() Set the priority of the whitelist to low.
ListeningWhitelist.Builder	lowest() Set the priority of the whitelist to lowest.
ListeningWhitelist.Builder	mergeOptions(java.util.Collection<ListenerOptions> serverOptions) Options to merge into the current set of options.
ListeningWhitelist.Builder	mergeOptions(ListenerOptions... serverOptions) Options to merge into the current set of options.
ListeningWhitelist.Builder	monitor() Set the priority of the whitelist to monitor.
ListeningWhitelist.Builder	normal() Set the priority of the whitelist to normal.
ListeningWhitelist.Builder	options(java.util.Collection<ListenerOptions> options) Set the options to copy when constructing new whitelists.
ListeningWhitelist.Builder	options(ListenerOptions[] serverOptions) Set the options to copy when constructing new whitelists.
ListeningWhitelist.Builder	options(java.util.Set<ListenerOptions> options) Set the options to copy when constructing new whitelists.
ListeningWhitelist.Builder	priority(ListenerPriority priority) Set the priority to use when constructing new whitelists.
ListeningWhitelist.Builder	types(java.util.Collection<PacketType> types) Set the whitelist of packet types to copy when constructing new whitelists.
ListeningWhitelist.Builder	types(PacketType... types) Set the whitelist of packet types to copy when constructing new whitelists.
ListeningWhitelist.Builder	whitelist(java.util.Collection<java.lang.Integer> whitelist) Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

priority

public ListeningWhitelist.Builder priority(ListenerPriority priority)

Set the priority to use when constructing new whitelists.

Parameters:

priority - - the priority.

Returns:

This builder, for chaining.

monitor

public ListeningWhitelist.Builder monitor()

Set the priority of the whitelist to monitor.

Returns:

This builder, for chaining.

normal

public ListeningWhitelist.Builder normal()

Set the priority of the whitelist to normal.

Returns:

This builder, for chaining.

lowest

public ListeningWhitelist.Builder lowest()

Set the priority of the whitelist to lowest.

Returns:

This builder, for chaining.

low

public ListeningWhitelist.Builder low()

Set the priority of the whitelist to low.

Returns:

This builder, for chaining.

highest

public ListeningWhitelist.Builder highest()

Set the priority of the whitelist to highest.

Returns:

This builder, for chaining.

high

public ListeningWhitelist.Builder high()

Set the priority of the whitelist to high.

Returns:

This builder, for chaining.

whitelist

@Deprecated
public ListeningWhitelist.Builder whitelist(java.util.Collection<java.lang.Integer> whitelist)

Deprecated.

Set the whitelist of packet IDs to copy when constructing new whitelists.

Deprecated: Use types(Collection) instead.

Parameters:

whitelist - - the whitelist of packets.

Returns:

This builder, for chaining.

types

public ListeningWhitelist.Builder types(PacketType... types)

Set the whitelist of packet types to copy when constructing new whitelists.

Parameters:

types - - the whitelist of packets.

Returns:

This builder, for chaining.

types

public ListeningWhitelist.Builder types(java.util.Collection<PacketType> types)

Set the whitelist of packet types to copy when constructing new whitelists.

Parameters:

types - - the whitelist of packets.

Returns:

This builder, for chaining.

gamePhase

public ListeningWhitelist.Builder gamePhase(GamePhase gamePhase)

Set the gamephase to use when constructing new whitelists.

Parameters:

gamePhase - - the gamephase.

Returns:

This builder, for chaining.

gamePhaseBoth

public ListeningWhitelist.Builder gamePhaseBoth()

Set the gamephase to GamePhase.BOTH.

Returns:

This builder, for chaining.

options

public ListeningWhitelist.Builder options(java.util.Set<ListenerOptions> options)

Set the options to copy when constructing new whitelists.

Parameters:

options - - the options.

Returns:

This builder, for chaining.

options

public ListeningWhitelist.Builder options(java.util.Collection<ListenerOptions> options)

Set the options to copy when constructing new whitelists.

Parameters:

options - - the options.

Returns:

This builder, for chaining.

options

public ListeningWhitelist.Builder options(ListenerOptions[] serverOptions)

Set the options to copy when constructing new whitelists.

Parameters:

options - - the options array.

Returns:

This builder, for chaining.

mergeOptions

public ListeningWhitelist.Builder mergeOptions(ListenerOptions... serverOptions)

Options to merge into the current set of options.

Parameters:

options - - the options array.

Returns:

This builder, for chaining.

mergeOptions

public ListeningWhitelist.Builder mergeOptions(java.util.Collection<ListenerOptions> serverOptions)

Options to merge into the current set of options.

Parameters:

options - - the options array.

Returns:

This builder, for chaining.

build

public ListeningWhitelist build()

Construct a new whitelist from the values in this builder.

Returns:

The new whitelist.