BanManager (common 2.3 API)

java.lang.Object
- com.elikill58.negativity.universal.ban.BanManager

```
public class BanManager
extends Object
```

Field Summary

Fields
Modifier and Type Field and Description

static boolean autoBan

static boolean banActive

Fields
Modifier and Type	Field and Description
`static boolean`	`autoBan`
`static boolean`	`banActive`

Constructor Summary

Constructors
Constructor and Description

BanManager()

Constructors
Constructor and Description
`BanManager()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static BanResult`	`executeBan(Ban ban)` Executes the given ban.
`static @Nullable Ban`	`getActiveBan(UUID playerId)`
`static List<Ban>`	`getActiveBanOnSameIP(String ip)` Get all active ban on the given IP Return an empty array if ban feature is disabled
`static AltAccountBan`	`getAltBanFor(int nb)`
`static Configuration`	`getBanConfig()`
`static int`	`getInt(Cheat where, String key)`
`static List<Ban>`	`getLoggedBans(UUID playerId)`
`static @Nullable BanProcessor`	`getProcessor()`
`static List<String>`	`getProcessorDescription()`
`static String`	`getProcessorId()`
`static String`	`getProcessorName()`
`static Map<String,BanProcessor>`	`getProcessors()`
`static List<Sanction>`	`getSanctions()`
`static String`	`getString(Cheat where, String key)`
`static void`	`init()`
`static boolean`	`isBanned(UUID playerId)`
`static void`	`registerProcessor(String id, BanProcessor processor)`
`static BanResult`	`revokeBan(UUID playerId)` Revokes the active ban of the player identified by the given UUID.
`static void`	`setAutoBan(boolean b)` Change the state of auto ban This doesn't save the config
`static void`	`setBanActive(boolean b)` Change the state of ban This doesn't save the config
`static void`	`setProcessorId(String processorId)`
`static boolean`	`shouldNegativityHandleBans()` Indicates whether Negativity should kick banned players

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

- Field Detail
  - banActive
```
public static boolean banActive
```
  - autoBan
```
public static boolean autoBan
```
- Constructor Detail
  - BanManager
```
public BanManager()
```
- Method Detail
  - getLoggedBans
```
public static List<Ban> getLoggedBans(UUID playerId)
```
  - isBanned
```
public static boolean isBanned(UUID playerId)
```
  - getActiveBan
```
public static @Nullable Ban getActiveBan(UUID playerId)
```
  - executeBan
```
public static BanResult executeBan(Ban ban)
```
    Executes the given ban. The executed ban may contain different information than the one you provided. Therefore, it is advised to use the returned BanResult data instead of what was passed to this method's parameters.
    The ban may not be executed if bans are disabled, or for any BanProcessor-specific reason, like if the player bypassed the ban.
    
    Returns:
    
    the result of the ban with success informations
  - revokeBan
```
public static BanResult revokeBan(UUID playerId)
```
    Revokes the active ban of the player identified by the given UUID.
    The revocation may fail if the player is not banned or bans are disabled.
    If ban logging is disabled, a LoggedBan will still be returned even though it will not be saved.
    
    Parameters:
    
    playerId - the UUID of the player to unban
    
    Returns:
    
    the logged revoked ban or null if the revocation failed.
  - getActiveBanOnSameIP
```
public static List<Ban> getActiveBanOnSameIP(String ip)
```
    Get all active ban on the given IP
    Return an empty array if ban feature is disabled
    
    Parameters:
    
    ip - the IP where we are looking for ban
    
    Returns:
    
    the list of active ban on this IP
  - getAltBanFor
```
public static AltAccountBan getAltBanFor(int nb)
```
  - shouldNegativityHandleBans
```
public static boolean shouldNegativityHandleBans()
```
    Indicates whether Negativity should kick banned players
  - getSanctions
```
public static List<Sanction> getSanctions()
```
  - getProcessorId
```
public static String getProcessorId()
```
  - setProcessorId
```
public static void setProcessorId(String processorId)
```
  - getProcessor
```
public static @Nullable BanProcessor getProcessor()
```
  - getProcessorName
```
public static String getProcessorName()
```
  - getProcessorDescription
```
public static List<String> getProcessorDescription()
```
  - getProcessors
```
public static Map<String,BanProcessor> getProcessors()
```
  - registerProcessor
```
public static void registerProcessor(String id,
                                     BanProcessor processor)
```
  - init
```
public static void init()
```
  - setBanActive
```
public static void setBanActive(boolean b)
```
    Change the state of ban
    This doesn't save the config
    
    Parameters:
    
    b - true if the ban feature should be enabled
  - setAutoBan
```
public static void setAutoBan(boolean b)
```
    Change the state of auto ban
    This doesn't save the config
    
    Parameters:
    
    b - true if the auto ban feature should be enabled
  - getBanConfig
```
public static Configuration getBanConfig()
```
  - getInt
```
public static int getInt(Cheat where,
                         String key)
```
  - getString
```
public static String getString(Cheat where,
                               String key)
```

Class BanManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

banActive

autoBan

Constructor Detail

BanManager

Method Detail

getLoggedBans

isBanned

getActiveBan

executeBan

revokeBan

getActiveBanOnSameIP

getAltBanFor

shouldNegativityHandleBans

getSanctions

getProcessorId

setProcessorId

getProcessor

getProcessorName

getProcessorDescription

getProcessors

registerProcessor

init

setBanActive

setAutoBan

getBanConfig

getInt

getString