java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

com.gmt2001.datastore2.datatype.AbstractDatabaseMap<String,PanelUserHandler.Permission>

tv.phantombot.panel.PanelUser.PermissionMap

All Implemented Interfaces:: AttachableDataType, Serializable, Cloneable, Map<String,PanelUserHandler.Permission>

public final class PermissionMap extends AbstractDatabaseMap<String,PanelUserHandler.Permission>

Class to allow a HashMap of <String, Permission> to be used in PermissionConverter

Also provides conversion methods

Author:

gmt2001

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K extends Object,V extends Object>
Field Summary

Fields

Modifier and Type

Field

Description

static final List<String>

SPECIALPERMISSIONS

Special permissions which are only included in toJSON(boolean, boolean) if the isSave parameter is set to true
Constructor Summary

Constructors

Constructor

Description

PermissionMap()
Method Summary

Modifier and Type

Method

Description

static PermissionMap

fromJSON(String json)

Converts a stringified JSONArray created by toJSON(boolean, boolean) into a PermissionMap

static PermissionMap

fromJSON(JSONArray permissionsJSON)

Converts a JSONArray created by toJSON(boolean, boolean) into a PermissionMap

static PermissionMap

fromMap(Map<String,PanelUserHandler.Permission> map)

Converts a plain Map of <String, Permission> into a PermissionMap

JSONArray

toJSON(boolean displayName, boolean isSave)

Converts the permissions data to a JSONArray

Methods inherited from class com.gmt2001.datastore2.datatype.AbstractDatabaseMap
attach, clear, compute, computeIfAbsent, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll

Methods inherited from class java.util.HashMap
clone, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, size, values

Methods inherited from class java.util.AbstractMap
equals, hashCode, toString

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

Methods inherited from interface java.util.Map
equals, hashCode

Field Details
- SPECIALPERMISSIONS
  
  public static final List<String> SPECIALPERMISSIONS
  
  Special permissions which are only included in toJSON(boolean, boolean) if the isSave parameter is set to true
Constructor Details
- PermissionMap
  
  public PermissionMap()
Method Details
- fromMap
  
  public static PermissionMap fromMap(Map<String,PanelUserHandler.Permission> map)
  
  Converts a plain Map of <String, Permission> into a PermissionMap
  
  Parameters:
  
  map - a Map of <String, Permission>
  
  Returns:
  
  a PermissionMap
- fromJSON
  
  public static PermissionMap fromJSON(String json)
  
  Converts a stringified JSONArray created by toJSON(boolean, boolean) into a PermissionMap
  
  Parameters:
  
  json - the stringified JSONArray
  
  Returns:
  
  a PermissionMap
- fromJSON
  
  public static PermissionMap fromJSON(JSONArray permissionsJSON)
  
  Converts a JSONArray created by toJSON(boolean, boolean) into a PermissionMap
  
  Parameters:
  
  permissionsJSON - the JSONArray
  
  Returns:
  
  a PermissionMap
- toJSON
  
  public JSONArray toJSON(boolean displayName, boolean isSave)
  
  Converts the permissions data to a JSONArray
  
  Parameters:
  
  displayName - true to encode the display name of the value; false to encode the numeric value
  
  isSave - true to include canRestartBot, canManageUsers, and other special permissions
  
  Returns:
  
  the permissions data as a JSONArray

Class PermissionMap

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.gmt2001.datastore2.datatype.AbstractDatabaseMap

Methods inherited from class java.util.HashMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Field Details

SPECIALPERMISSIONS

Constructor Details

PermissionMap

Method Details

fromMap

fromJSON

fromJSON

toJSON